v1

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

Get a list of Async Orders placed under this Platform.

get/asyncOrders

Query parameters

accountIdentifierstring

specify the account to be queried.

customerIdentifierstring

specify the customer to be queried

externalRefIDstring

specify the external reference ID to be queried

startDatestring

specify the starting date or date time to be queried according to RFC 3339, i.e. "2016-01-01" or "2016-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt

endDatestring

specify the ending date or date time to be queried according to RFC 3339, i.e. "2016-01-01" or "2016-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt

maxResultsstring

specify the number of maxResults per page.

elementsPerBlockstring

specify the number of elements in a block.

pagestring

specify the page number to return.

minAmountstring

specify the minimum face value of the reward to be queried.

maxAmountstring

specify the maximum face value of the reward to be queried.

currencyCodestring

specify the currency code of the reward to be queried.

utidstring

specify the unique identifier of the reward to be queried.

ptidstring

specify the unique identifier of the physical delivery template to be queried.

rewardNamestring

specify the reward name of the reward to be queried.

senderFirstNamestring

specify the sender's first name to be queried.

senderLastNamestring

specify the sender's last name to be queried.

senderEmailstring

specify the sender email address to be queried.

recipientEmailstring

specify the recipient's email address to be queried.

recipientMobileNumberstring

specify the recipient's mobile number to be queried.

recipientFirstNamestring

specify the recipient's first name to be queried.

recipientLastNamestring

specify the recipient's last name to be queried.

sendEmailstring

specify if sendEmail is true or false to be queried.

deliveryMethodstring

specify the delivery method to be queried.

orderStatusstring

specify the order status to be queried.

lineItemStatusstring

specify the line item status to be queried.

campaignstring

specify the campaign to be queried.

notesstring

specify the notes to be queried.

lineItemNotesstring

specify the notes to be queried.

purchaseOrderNumberstring

specify the purchaseOrderNumber to be queried.

prevCursorstring
nextCursorstring

Response

OK

prevCursorstring

Cursor for the previous page of results

nextCursorstring

Cursor for the next page of results

prevPageAvailableboolean

Indicates if a previous page is available

nextPageAvailableboolean

Indicates if a next page is available

maxResultsinteger

Maximum number of results per page