Get details for a specific order
Use the following endpoint to retrieve details for a specific order.
| Endpoint | Purpose |
|---|---|
GET {URI}/orders/{referenceOrderID} | Get details for a specific Order. |
Here is the path parameter when you use GET {URI}/orders/{referenceOrderID} to get details for a specific order.
| Path parameter | Data type | Description |
|---|---|---|
| referenceOrderID | string | Reference Order ID is returned in the order response payload |
The following example shows a response for the order placed in the past. Perform a GET {URI}/orders/{referenceOrderID} to view the details of an old order you have placed in the system.
Note:
We have deprecated
credentials. UsecredentialListinstead.
{
"referenceOrderID": "string",
"externalRefID": "string", (100 chars)
"customerIdentifier": "string", (5-100 chars)
"accountIdentifier": "string", (5-100 chars)
"accountNumber": "string", (5-100 chars)
"amountCharged": {
"value": 0,
"currencyCode": "string",
"exchangeRate": 0,
"fee": 0,
"total": 0
},
"denomination": {
"value": 0,
"currencyCode": "string",
"exchangeRate": 0,
},
"denomination": {
"value": 0,
"currencyCode": "string",
"exchangeRate": 0,
"fee": 0,
},
"denomination": {
"value": 0,
"currencyCode": "string",
"exchangeRate": 0,
"fee": 0,
"total": 0
},
"utid": "string",
"rewardName": "string",
"sender": {
"firstName": "string", (100 chars)
"lastName": "string", (100 chars)
"email": "string"
},
"recipient": {
"email": "string",
"firstName": "string", (100 chars)
"lastName": "string", (100 chars)
"address": {
"streetLine1": "string",
"streetLine2": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"country": "string"
}
},
"emailSubject": "string",
"message": "string", (1024 chars)
"sendEmail": true,
"etid": "string",
"ptid": "string",
"status": "string",
"campaign": "string", (100 chars)
"createdAt": "2023-09-18T19:36:27.589Z",
"notes": "string", (150 chars)
"orderClientSource": "string",
"purchaseOrderNumber": "string",
"reward": {
"credentials": {
"additionalProp": "string"
},
"credentialList": [
{
"label": "string",
"value": "string",
"type": "string",
"credentialType": "string"
}
],
"redemptionInstructions": "string"
}
}
The following example shows a Promo Link with an expiration date when you perform a GET {URI}/orders/{referenceOrderID} to view the details of a previously placed order. Note that expirationDate is now part of the reward credentialList:
Note:
- Expiration date only applies to Promo Links.
- We have deprecated
credentials. UsecredentialListinstead. Note thatexpirationDateis now part of the rewardcredentialList:
{
"referenceOrderID": "string",
"externalRefID": "string",
"customerIdentifier": "string",
"accountIdentifier": "string",
"accountNumber": "string",
"amountCharged": {
"value": 10.00,
"currencyCode": "USD",
"total": 10.0
},
"denomination": {
"value": 10,
"currencyCode": "USD"
},
"utid": "string",
"rewardName": "Promo Link",
"sender": {
"firstName": "string",
"lastName": "string",
"email": "string"
},
"recipient": {
"email": "string",
"firstName": "string",
"lastName": "string",
"address": null
},
"sendEmail": false,
"status": "COMPLETE",
"createdAt": "2023-10-11T23:10:55.284Z",
"reward": {
"credentials": {
"redemptionUrl": "string",
"expirationDate": "2024-12-31T06:59:59Z"
},
"credentialList": [
{
"label": "redemptionUrl",
"value": "string",
"type": "url",
"credentialType": "redemptionUrl"
},
{
"label": "expirationDate",
"value": "2024-12-31T06:59:59Z",
"type": "date",
"credentialType": "expirationDate"
}
],
"redemptionInstructions": "Promo Link Test Redemption Instructions"
}
}
Order history:
Orders placed via the Tango API are v1 available via the v2
GET {URI}/orderscall and are combined with Orders placed via the Tango API v2. To retrieve full order details, including reward credentials, make aGET {URI}/orders/{referenceOrderId}call.
The response message for this endpoint is:
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
Updated 4 days ago