acquia-dam-sdk / Components / OrdersApi
new OrdersApi(
client):OrdersApi
Create an instance of the OrdersApi class
Provides information about Orders and Conversions
Provide an instance of ApiClient.
https://docs.acquia.com/acquia-dam/api-v1#tag/Orders
cleanAssets(
assets):Promise<CleanAssetsResult>
This can be called before attempting to create an order to determine which items will be removed from the order. Situations include an asset that has been deleted or an asset the user does not have permission to order. Any items returned in the removedItems list, will be removed automatically when the order is submitted.
string[]
Array of asset UUIDs
Promise<CleanAssetsResult>
Promise containing the assets that will not be ordered
https://docs.acquia.com/acquia-dam/api-v1#tag/Orders/operation/cleanOrderItems
createOrder(
params):Promise<CreateOrderResult>
Create an asset order.
Information about the request
Promise<CreateOrderResult>
Promise containing information about the created order
https://docs.acquia.com/acquia-dam/api-v1#tag/Orders/operation/createOrder
createZipArchive(
uuid):Promise<void>
Used to submit a request to begin the creation of a zip archive for a specific order
string
The order UUID
Promise<void>
Promise containing no information
https://docs.acquia.com/acquia-dam/api-v1#tag/Orders/operation/createZipForOrder
getOrderDetails(
params):Promise<GetOrderDetailsResult>
Gets order information by uuid or sequence number and, if the order conversion status is 'Completed', up to 100 assets and associated conversions and pickup urls for that order. If the order conversion status is not 'Completed', only order details (uuid, conversion status, assets in order, and sequence number) will appear in the response.
Information about the request
Promise<GetOrderDetailsResult>
Promise containing information about the order
getZipStatus(
uuid):Promise<GetZipStatusResult>
Used to check the status of an archive operation that has previously been submitted. If the archive operation is complete, this call returns a download link for the zip archive.
string
The order UUID
Promise<GetZipStatusResult>
Promise containing information about the status of the Zip archive
https://docs.acquia.com/acquia-dam/api-v1#tag/Orders/operation/getZipStatusOrDownloadLink
listConversionsForOrder(
params):Promise<ListConversionsForOrderResult>
Retrieves the list of conversions available for a specific order profile and set of assets.
Information about the request
Promise<ListConversionsForOrderResult>
Promise containing the list of available conversions
https://docs.acquia.com/acquia-dam/api-v1#tag/Orders/operation/getApplicableConversions
listOrderProfiles():
Promise<ListOrderProfileResult>
Gets the Order Profiles available for sending orders via the internet
Promise<ListOrderProfileResult>
Promise containing the list of available order profiles
https://docs.acquia.com/acquia-dam/api-v1#tag/Orders/operation/getDirectorInternetProfiles
Acquia DAM