Get a list of orders placed on this platform
You can review and manage previously paced orders using Tango API. Use the following endpoint to get a list of orders placed under your 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 Tango API query parameters to better filter your search results.
Coming soon:This endpoint will soon be modified to include query parameters:
deliveryMethod
,recipientMobileNumber
, anddeliveryStatus
. Once released, you can query rewards using delivery methods such as PHONE, ADDRESS, and EMBEDDED besides EMAIL.
Here is a list of query parameters offered with this endpoint to better filter your search results:
Query params | Data type | Description |
---|---|---|
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 | double | Specify the minimum face value of the reward to be queried. |
maxAmount | double | 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. 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 |
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 |
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 |
recipientEmail | string | Specify the recipient’s email address to be queried. |
recipientMobileNumber | string | Specify the recipient mobile number to be queried. The
|
deliveryStatus | string | Will contain the email, phone, and physical delivery status. |
recipientFirstName | string | Specify the recipient’s first name to be queried. |
recipientLastName | string | Specify the recipient’s last name to be queried. |
sendEmail | boolean | Specify if |
deliveryMethod | string | Specify the delivery method for an order to determine how a reward is sent to a recipient. |
orderStatus | string | Specify the status to be queried. See order status. |
lineItemStatus | string | Specify the status to be queried. See line item status . |
campaign | string | Specify the campaign to be queried. The maximum length is 1024 characters including the special characters such as @, #, %, etc. |
notes | string | Specify the notes to be queried. |
lineItemNotes | string | Specify the notes to be queried. |
purchaseOrderNumber | string | specify the |
The following example shows the payload 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",
"orderStatus": "string",
"lineItemStatus": "string",
"campaign": "string",
"createdAt": "2025-07-29T00:33:41.306Z",
"notes": "string",
"orderClientSource": "string",
"purchaseOrderNumber": "string",
"orderExternalRefIdDupe": true
}
]
}
Here's an example payload for when you receive an error:
{
"timestamp": "2025-02-21T23:23:13.930Z",
"requestId": "string",
"path": "string",
"httpCode": 0,
"httpPhrase": "string",
"i18nKey": "string",
"message": "The error message will show here for error codes ",
"errors": [
{}
]
}
The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:
- 200 OK
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
Updated 5 days ago