v1

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

Update an Async Order under a specific Account.

patch/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

Request body

campaignstring

Optional. Campaign that may be used to administratively categorize a specific order. Must be between 0 and 1024 characters in length.

purchaseOrderNumberstring

The Purchase Order Number associated with this order.

notesstring

Optional order notes (up to 150 characters)

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