Documentation

Get details for a specific order

Suggest Edits

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.

An order status affects all rewards in the order. The following order statuses are available in Tango:

Order statusDescription
CompleteThe order is processed, and all rewards in the order have been sent. See line item status.
PendingThe order needs a little longer to process. Pending orders should be processed and delivered within one (1) business day. Orders placed on Friday afternoon or over the weekend may be processed on the following Monday or the next business day. Once the order is delivered, its status changes to Complete.
Note: Your order may take longer to review for a variety of reasons. See why your order is being reviewed. Contact your Customer Success Manager (CSM) or [email protected] with questions or concerns. to open a support case with Tango, use the Chat agent at the bottom right of the screen to open a support case with Tango.
PartialSome of the line items in the order are processed successfully while others have not. Check the specific line item status and determine which rewards were sent or failed.
FailedThe entire order is unable to be sent. Your account is refunded for the total value of the order. We recommend sending rewards again to ensure your rewards are still sent. See Resend a specific order.

For more information on why your order is failed, see the Tango Reward Status page, or email your Customer Success Manager (CSM) or [email protected] . Make sure you include the Reference Order ID of your failed order.

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

EndpointPurpose
GET {URI}/orders/{referenceOrderID}Get details for a specific Order.

Use the following path parameter with this endpoint:

Path paramsData typeDescription
referenceOrderIDstringReference Order ID is returned in the order response payload

The following example shows the payload for the order placed in the past. Perform a GET {URI}/orders/{referenceOrderID} to view the details of an old order placed in the system.

{
  "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 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 message for this endpoint is:

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found

Updated 13 days ago

Rewards as a Service™ and the RaaS® API are provided by Tango Card, Inc. © 2024 Tango Card, Inc.