Get details for a specific order

An order consists of a single or multiple rewards sent at the same time with Tango. Inquiry about an order returns information such as the reward value, currency, reward name, sender and recipient information. It also returns email status and line item status, credential list, credential type etc. To get details for a specific order, you need to have the referenceOrderID ready. referenceOrderID helps identify the order more clearly when retrieving it.

Use the following endpoint to retrieve details of a specific order:

Endpoint	Purpose
`GET {URI}/orders/{referenceOrderID}`	Get details for a specific Order.

Reference order ID

referenceOrderID is used as a path parameter, a unique identifier for an order placed through the Tango API. It's like a tracking number for a reward order which helps you retrieve, manage, or audit a specific order later. The GET {URI}/orders/{referenceOrderID} endpoint lets you look up the details of a specific order using its referenceOrderID:

Path params	Data type	Description
referenceOrderID	string	Reference Order ID is returned in the order response payload.

With referenceOrderID, you can verify that an order was processed correctly, track delivery or redemption status, and reissue or cancel a reward if needed (using the referenceLineItemID from the order).

The following example shows the payload for the order when you perform a GET {URI}/orders/{referenceOrderID} to view the details of an order placed in the system. You can get the order status, reward details, recipient info, and much more in the response:

{
  "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": {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "mobileNumber": "string",
    "address": {
      "companyName": "string",
      "streetLine1": "string",
      "streetLine2": "string",
      "city": "string",
      "stateOrProvince": "string",
      "postalCode": "string",
      "country": "string"
    }
  },
  "emailSubject": "string",
  "message": "string",
  "deliveryMethod": "NONE",
  "etid": "string",
  "status": "string",
  "orderStatus": "string",
  "lineItemStatus": "string",
  "campaign": "string",
  "createdAt": "2025-10-23T21:52:43.041Z",
  "notes": "string",
  "orderClientSource": "string",
  "purchaseOrderNumber": "string",
  "orderExternalRefIdDupe": true,
  "asyncOrderEntity": {
    "externalRefID": "string",
    "status": "string",
    "totalLineItems": 0,
    "createdAt": "2025-10-23T21:52:43.041Z",
    "failedLineItems": [
      {
        "lineItemId": "string",
        "externalRefLineItemID": "string",
        "utid": "string",
        "errors": [
          {
            "field": "string",
            "errorCodeValue": 0,
            "errorCodeName": "string",
            "message": "string"
          }
        ]
      }
    ],
    "duplicateLineItemRefIds": {
      "additionalProp": 0
    }
  },
  "reward": {
    "credentials": {
      "additionalProp": "string"
    },
    "credentialList": [
      {
        "label": "string",
        "value": "string",
        "type": "string",
        "credentialType": "string"
      }
    ],
    "redemptionInstructions": "string"
  }
}

The following payload example shows the credentialList details for a specific order.

📘
Note:
We have deprecated credentials . Use credentialList instead. credentailList contains type, label, and value, and stable parameters that allow our clients to display rewards within an application or by email.

 
  "reward": {
    "credentials": {
      "rewardSecurityCode": "331XHT75",
      "rewardSecurityUrl": "https://sandbox.rewardcodes.com/r2/1/Y4blCPqUsr7fsiLYAws6yvrcJSPer1AyR3AJ5yz_niiKekq-4RcrY19u6MCsRima"
    },
    "credentialList": [
      {
        "label": "rewardSecurityCode",
        "value": "331XHT75",
        "type": "text",
        "credentialType": "rewardSecurityCode"
      },
      {
        "label": "rewardSecurityUrl",
        "value": "https://sandbox.rewardcodes.com/r2/1/Y4blCPqUsr7fsiLYAws6yvrcJSPer1AyR3AJ5yz_niiKekq-4RcrY19u6MCsRima",
        "type": "url",
        "credentialType": "rewardSecurityUrl"
      }
    ],
    "redemptionInstructions": "<ol>\n<li><strong>Copy</strong> the security code.</li>\n<li><strong>Click</strong> on the Redemption URL and <strong>paste</strong> the code.</li>\n<li>Agree to the Cardholder agreement to unlock the card. </li>\n</ol>\n<p> </p>"
  }
}

The following payload 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.

expirationDate is now part of the reward credentialList. Note that we have deprecated credentials and use credentialList instead.

{
  "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}/orders call and are combined with Orders placed via the Tango API v2. To retrieve full order details, including reward credentials, make a GET {URI}/orders/{referenceOrderId} call.

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

Response	Description
200	The request was successful.
400	The server could not understand the request due to invalid syntax.
401	Authentication is required and has either not been provided or failed.
403	The server understood the request but refuses to authorize it.
404	The server could not find the requested resource. In other words, the URL you’re trying to access doesn’t point to anything that exists on the server.