Get a list of Orders placed under this Platform.

accountIdentifier

string

specify the account to be queried.

customerIdentifier

string

specify the customer to be queried

externalRefID

string

specify the external reference ID to be queried

startDate

string

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

endDate

string

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

elementsPerBlock

int32

specify the number of elements in a block.

page

int32

specify the page number to return.

minAmount

number

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

maxAmount

number

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

currencyCode

string

specify the currency code of the reward to be queried.

utid

string

specify the unique identifier of the reward to be queried.

ptid

string

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

rewardName

string

specify the reward name of the reward to be queried.

senderFirstName

string

specify the sender's first name to be queried.

senderLastName

string

specify the sender's last name to be queried.

senderEmail

string

specify the sender email address to be queried.

recipientEmail

string

specify the recipient's email address to be queried.

recipientMobileNumber

string

specify the recipient's mobile number to be queried.

recipientFirstName

string

specify the recipient's first name to be queried.

recipientLastName

string

specify the recipient's last name to be queried.

sendEmail

boolean

deprecated

specify if sendEmail is true or false to be queried.

deliveryMethod

string

enum

specify the delivery method to be queried.

status

string

enum

deprecated

specify the status to be queried.

orderStatus

string

enum

specify the order status to be queried.

lineItemStatus

string

enum

specify the line item status to be queried.

Allowed:

campaign

string

specify the campaign to be queried.

notes

string

specify the notes to be queried.

lineItemNotes

string

specify the notes to be queried.

purchaseOrderNumber

string

specify the purchaseOrderNumber to be queried.

200OK

400Bad Request

401Unauthorized

403Forbidden