Get a list of orders placed under this platform

Use the following endpoint to get a list of orders placed under this platform:

Endpoint	Purpose
`GET {URI}/orders`	Get a list of Orders placed under this platform.

📘
Note:
GET {URI}/orders currently only returns 10K results. Use query parameters to better filter your search results.

Here is a list of query parameters for when you use GET {URI}/orders to get a list of orders placed under this platform.

Query parameter	Data type	Description
accountIdentifier	string	Specify the account to be queried. The string must have 5-100 characters.
customerIdentifier	string	Specify the customer to be queried. The string must have 5-100 characters.
externalRefID	string	Specify the external reference ID to be queried. The string may have up to 100 alphanumeric characters.
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	double	Specify the minimum face value of the reward to be queried. 👍 Best practice: When you are searching for an amount, we recommend you to enter a minimum and a maximum amount for the search.
maxAmount	double	Specify the maximum face value of the reward to be queried. 👍 Best practice: When you are searching for an amount, we recommend you to enter a minimum and a maximum amount for the search.
currencyCode	string	Specify the currency code of the reward to be queried. The string must be three characters.
utid	string	Specify the unique identifier of the reward to be queried.
ptid	string	🚧 Coming soon Specify the unique identifier of the physical delivery template to be queried. ptid is required for orders where the UTID is Reward Type = Reward Link, Fulfillment Type = Physical.
rewardName	string	Specify the reward name of the reward to be queried.
senderFirstName	string	Specify the sender's first name to be queried. This information is for tracking purposes only and doesn’t change the email address the reward is sent from when `sendEmail: true`. The `senderFirstName` may have up to 100 characters. You cannot use < or > or / in the name.
senderLastName	string	Specify the sender's last name to be queried. This information is for tracking purposes only and doesn’t change the email address the reward is sent from when `sendEmail: true`. The `senderlastName` may have up to 100 characters. You cannot use < or > or / in the name..
senderEmail	string	Specify the sender email address to be queried. This information is for tracking purposes only and doesn’t change the email address the reward is sent from when `sendEmail: true`.
recipientEmail	string	Specify the recipient’s email address to be queried.
recipientFirstName	string	Specify the recipient’s first name to be queried. The `recipientFirstName` may have up to 100 characters. You cannot use < or > or / in the name.
recipientLastName	string	Specify the recipient’s last name to be queried. The `recipientLastName` may have up to 100 characters. You cannot use < or > or / in the name.
sendEmail	boolean	Specify if sendEmail is true or false to be queried. ❗️ Disclaimer: When placing orders, you are responsible to deliver rewards if `sendEmail=false`. Tango does not deliver the reward email when `sendEmail= false`.
status	string	Specify the status to be queried.
lineItemStatus	string	Specify the status to be queried.
campaign	string	Specify the campaign to be queried. The string may have up to 100 characters.
notes	string	Specify the notes to be queried. The string may have up to 150 characters.
lineItemNotes	string	Specify the notes to be queried.
purchaseOrderNumber	string	specify the purchaseOrderNumber to be queried.

The following example shows the example response including pagination when you use GET {URI}/orders:

{
  "page": {
    "number": 0,
    "elementsPerBlock": 0,
    "resultCount": 0,
    "totalCount": 0
  },
  "orders": [
    {
      "referenceOrderID": "string",
      "externalRefID": "string",
      "customerIdentifier": "string",
      "accountIdentifier": "string",
      "accountNumber": "string",
      "amountCharged": {
        "value": 0,
        "currencyCode": "string",
        "exchangeRate": 0,
        "fee": 0,
        "total": 0
      },
      "denomination": {
        "value": 0,
        "currencyCode": "string",
        "exchangeRate": 0,
        "fee": 0,
        "total": 0
      },
      "utid": "string",
      "ptid": "string",
      "rewardName": "string",
      "sender": {
        "firstName": "string",
        "lastName": "string",
        "email": "string"
      },
      "recipient": {
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "address": {
          "streetLine1": "string",
          "streetLine2": "string",
          "city": "string",
          "stateOrProvince": "string",
          "postalCode": "string",
          "country": "string"
        }
      },
      "emailSubject": "string",
      "message": "string",
      "sendEmail": true,
      "etid": "string",
      "status": "string",
      "campaign": "string",
      "createdAt": "2023-10-12T16:28:34.439Z",
      "notes": "string",
      "orderClientSource": "string",
      "purchaseOrderNumber": "string"
    }
  ]
}

The response message for this endpoint is:

200 OK
400 Bad request
401 Unauthorized
403 Forbidden

📘Note:

📘
Note: