Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2473175248.0 KB
6. Orders

Get a list of Orders placed under this Platform.

get/orders

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

elementsPerBlockinteger

specify the number of elements in a block.

pageinteger

specify the page number to return.

minAmountnumber

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

maxAmountnumber

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.

sendEmailboolean

specify if sendEmail is true or false to be queried.

deliveryMethod'NONE' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'EMBEDDED' | 'BULKSHIPMENT' | 'QRCODE' | 'BULKDIGITAL' | 'EMBEDDED_COMPONENT' | 'WHATSAPP'

specify the delivery method to be queried.

status'PENDING' | 'QUEUED' | 'PENDING_MR' | 'ON_HOLD' | 'CANCELLED' | 'COMPLETE' | 'FAILED' | 'PARTIAL' | 'DELETED' | 'PENDING_KYB' | 'PENDING_PAYMENT'

specify the status to be queried.

orderStatus'PENDING' | 'QUEUED' | 'PENDING_MR' | 'ON_HOLD' | 'CANCELLED' | 'COMPLETE' | 'FAILED' | 'PARTIAL' | 'DELETED' | 'PENDING_KYB' | 'PENDING_PAYMENT'

specify the order status to be queried.

lineItemStatus'COMPLETE' | 'PENDING' | 'FAILED' | 'DELETED' | 'CANCELLED' | 'RETURNED'

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.

Response

OK