v1

latestOpenAPI 3.1.0Apache 2.02026-07-2473175248.0 KB
7. Async Orders

Get an Async Order by external reference ID with cursor-based pagination.

get/asyncOrders/customers/{customerIdentifier}/accounts/{accountIdentifier}/{externalRefID}

Path parameters

customerIdentifierstring required

specify the customer to be queried

accountIdentifierstring required

Specify the account to be queried.

externalRefIDstring required

External reference ID of the async order

Query parameters

prevCursorstring

Cursor for navigating to previous page

nextCursorstring

Cursor for navigating to next page

maxResultsinteger

Maximum number of line items to return

externalRefLineItemIDsstring[]

Specify the externalRefLineItemIDs to be queried. A maximum of 50 externalRefLineItemIDs can be provided.

referenceLineItemIDsstring[]

Specify the referenceLineItemIDs to be queried. A maximum of 50 referenceLineItemIDs can be provided.

failedOnlyboolean

Specify true to return only failed line items

Response

OK

referenceOrderIDstring

Internal reference order ID

externalRefIDstring

External reference ID provided by client

orderStatusstring

Current status of the order

createdAtstring date-time

Order creation timestamp

completedAtstring date-time

Order completion timestamp

customerIdentifierstring

Customer identifier

accountIdentifierstring

Account identifier

campaignstring

Campaign name

purchaseOrderNumberstring

Purchase order number

notesstring

Order notes

totalLineItemsinteger

Total number of line items