Get details for a specific Choice product
This Tango API endpoint allows you to fetch metadata about a specific Choice Product—such as a gift card or nonprofit donation option—using its UTID (Unique Tango ID).
Use case
Acme Health runs a global employee‑recognition program and needs to ensure that rewards shown to employees are valid for their country and currency. When an employee selects a reward, Acme uses this endpoint to retrieve real‑time details—such as the reward name, currency, and the list of eligible countries. Acme then checks whether the employee’s country appears in the product’s countries list and whether the currency matches program requirements. Currencies are fixed per UTID and default to USD if unspecified.
If everything is valid, Acme allows the employee to proceed and then uses the same UTID for the final reward‑fulfillment API call. This ensures accurate, globally compliant reward offerings and reduces failed redemptions.
Endpoint
Use the following endpoint to return the details for a specific Choice Product on your Tango platform:
| Function | Purpose |
|---|---|
GET {URI}/choiceProducts/{utid} | Get details for a specific Choice Product. |
Parameters
The following path parameter is required for this endpoint. UTID is Unique Tango ID for the item being ordered such as gift cards or nonprofit donations.
| Path params | Data type | Description |
|---|---|---|
| utid | string | (Required) Specify the unique identifier of the Choice Product to be queried. |
Response code notes
On a successful request (200 OK), the response body includes several important fields. Below are some key notes and considerations to help you understand field behaviors and best practices:
- No 404 is defined: handle "not found" scenarios within your 400 error handling, not as a separate case.
Examples
The following payload example is returned with this endpoint:
{
"utid": "string",
"rewardName": "string",
"currencyCode": "string",
"countries": [
"string"
]
}The following payload example shows the available details such as currency and country for a specific UTID.
Note:We accept AUD, CAD, EUR, GBP, and USD for Global Choice Links. Only one currency can be specified. Currency can never be changed. The currency defaults to USD if no currency is specified.
{
"utid": "U431828",
"rewardName": "Global Choice Link (SV CAD)",
"currencyCode": "CAD",
"countries": [
"BE",
"TH",
"PL",
"BG",
"SE",
"US",
"BD",
"ID",
"ES",
"MY",
"GR",
"CZ",
"EG"
]
}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": [
{}
]
}Response code
The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:
| Response code | Meaning |
|---|---|
| 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. |
Updated 6 days ago
