Get catalog for a specific Choice product

This endpoint in the Tango API allows you to retrieve the full list of reward items (gift cards, denominations, brands, etc.) associated with a particular Choice product, identified by its UTID (Unique Tango ID).

Use case

Acme Health runs a wellness rewards program where members earn incentives for completing health‑related activities. When a member earns a reward, Acme Health issues a Choice Product UTID, which corresponds to a flexible reward allowing the member to choose from multiple gift card options.

Acme Health uses this endpoint to retrieve the catalog of reward items linked to that specific Choice product. The portal then displays these options—such as retail, pharmacy, grocery, or fitness gift cards—so the member can select their preferred reward. Once the member chooses, the system fulfills the order using Tango’s ordering APIs. This process enables Acme Health to provide personalized, flexible incentives, maintain an easy user experience, and keep catalog options up-to-date.

Endpoint

Use the following endpoint to get the catalog for a specific choice product in your platform:

Function	Purpose
`GET {URI}/choiceProducts/{choiceProductUtid}/catalog`	Get catalog for a specific Choice product utid.

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
choiceProductUtid	string	Utid is a unique Tango Card ID. (required)

The following query parameters are used with this endpoint to return detailed and specific results:

Query params	Data type	Description
verbose	boolean	True or false. When true, will return the additional brand fields: status, disclaimer, description, shortDescription, terms, brandRequirements collection, and imageUrls collection.
brandKey	string	Returns the brand and item details for a specific brand ID.
brandName	string	Returns the brand and item details for a specific brand name.
utid	string	Returns the brand and item details for a specific utid. The utid is the unique identifier for a specific reward.
rewardName	string	Returns the brand and item details of the specified reward name.
status	string	Returns all brands and item details with the specified status. Possible statuses are: `Test, Active, Inactive, Deleted.`
rewardType	string	Returns all brands and item details with the specified reward type: all gift card (such as Starbucks, Amazon.com, Target, and many others in a variety of currencies.) promo (See Promo Link™ ) donation (such as American Cancer Society, American Red Cross, etc.) Reward Link (See Reward Link® ) payment ACH (See Pay with ACH or Wire ) payment card reporting payment-paypal Tango open loop cash equivalent physical gift card
currencyCode	string	Return all brands and item details associated with a specific currency. We accept AUD, CAD, EUR, GBP, or USD currency. Only one currency can be specified. Currency can never be changed. The currency defaults to USD if no currency is specified.
country	string	Returns all brands and item details from a specific country.
itemAttribute	string	Is used to filter catalog items based on specific attributes, instead of browsing the entire catalog. It returns all brands and item details that match the selected attribute. Each matching item includes a UTID for ordering. You can query items by a specific attribute. The system returns all UTIDs that match that attribute. Available attributes are: EMAIL, PHONE, ADDRESS, EMBEDDED.
categoryIds	array of strings	Returns all brands and item details for specific brand categories. (coming in Q1 of 2024)

📘
Note:

isExpirable indicates whether or not the gift card has an expiry date. The value forisExpirable =boolean\ is true or false.

Expiration date only applies to Promo Links.

Response body 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:

verbose defaults to true: Set it to false to get a lighter response if you don't need brand descriptions, disclaimers, terms, status, imageUrls, or brandRequirements.
Check valueType before reading value fields: FIXED_VALUE uses faceValue; VARIABLE_VALUE uses minValue/maxValue. Using the wrong one returns null.
fulfillmentType is deprecated: Use attributes (EMAIL, PHONE, ADDRESS, EMBEDDED) for determining delivery method.
isWholeAmountValueRequired=true means decimal amounts will be rejected: Validate before submitting orders.
brandRequirements.alwaysShowDisclaimer=true is a compliance requirement: You must display the disclaimer to end users.
Use requestId from error responses when contacting support: It's the fastest way to trace issues.

Examples

The following example shows the payload for a specific Choice Product UTID for when verbose=false.

{
  "catalogName": "Global Choice Link Catalog",
  "brands": [
    {
      "brandKey": "B570932",
      "brandName": "1-800-FLOWERS.COM®",
      "createdDate": "2016-04-26T17:27:19Z",
      "lastUpdateDate": "2024-02-20T18:42:36Z",
      "items": [
        {
          "utid": "U935268",
          "rewardName": "1-800-FLOWERS.COM® Gift Card $10.00",
          "currencyCode": "USD",
          "status": "active",
          "valueType": "FIXED_VALUE",
          "rewardType": "gift card",
          "isExpirable": false,
          "isWholeAmountValueRequired": false,
          "faceValue": 10,
          "createdDate": "2016-07-19T18:41:23.217Z",
          "lastUpdateDate": "2024-05-09T17:09:48.07Z",
          "countries": [
            "US"
          ],
          "credentialTypes": [
            "cardNumber",
            "pin",
            "rewardSecurityCode",
            "rewardSecurityUrl"
          ],
          "redemptionInstructions": "<p>Where you can redeem your Gift Card:</p>\n<ol>\n<li>Online at <a href=\"http://www.1800baskets.com\">www.1800baskets.com</a>, <a href=\"http://www.1800flowers.com\">www.1800flowers.com</a>, <a href=\"http://www.cheryls.com\">www.cheryls.com</a>, and <a href=\"http://www.thepopcornfactory.com\">www.thepopcornfactory.com</a>. By phone on orders for 1-800-BASKETS.COM, 1-800-FLOWERS.com®, Cheryl's®, and The Popcorn Factory.</li>\n<li>At our company owned and participating franchised retail store locations of Fannie May at certain, but not all, franchised retail store locations of 1-800-Flowers.com®, Conroy's, and Conroy's 1-800-Flowers®.</li>\n</ol>\n<p>Limit one Gift Card, Fresh Rewards pass and/or Savings Pass per order. Some promotions may restrict redemption to certain brands and will be clearly noted on the promotion. May become redeemable at additional brands and locations, which information will be updated on this page. See conditions and restrictions as detailed below. </p>",
          "fulfillmentType": "DIGITAL"
        },
        {
          "utid": "U683701",
          "rewardName": "1-800-FLOWERS.COM® Gift Card $25.00",
          "currencyCode": "USD",
          "status": "active",
          "valueType": "FIXED_VALUE",
          "rewardType": "gift card",
          "isExpirable": false,
          "isWholeAmountValueRequired": false,
          "faceValue": 25,
          "createdDate": "2016-07-19T19:44:16.151Z",
          "lastUpdateDate": "2024-05-09T17:13:24.97Z",
          "countries": [
            "US"
          ],
          "credentialTypes": [
            "cardNumber",
            "pin",
            "rewardSecurityCode",
            "rewardSecurityUrl"
          ],
          "redemptionInstructions": "<p>Where you can redeem your Gift Card:</p>\n<ol>\n<li>Online at <a href=\"http://www.1800baskets.com\">www.1800baskets.com</a>, <a href=\"http://www.1800flowers.com\">www.1800flowers.com</a>, <a href=\"http://www.cheryls.com\">www.cheryls.com</a>, and <a href=\"http://www.thepopcornfactory.com\">www.thepopcornfactory.com</a>. By phone on orders for 1-800-BASKETS.COM, 1-800-FLOWERS.com®, Cheryl's®, and The Popcorn Factory.</li>\n<li>At our company owned and participating franchised retail store locations of Fannie May at certain, but not all, franchised retail store locations of 1-800-Flowers.com®, Conroy's, and Conroy's 1-800-Flowers®.</li>\n</ol>\n<p>Limit one Gift Card, Fresh Rewards pass and/or Savings Pass per order. Some promotions may restrict redemption to certain brands and will be clearly noted on the promotion. May become redeemable at additional brands and locations, which information will be updated on this page. See conditions and restrictions as detailed below. </p>",
          "fulfillmentType": "DIGITAL"
        },

The following example shows the payload for a specific Choice Product UTID for when verbose=true

{
  "catalogName": "Global Choice Link Catalog",
  "brands": [
    {
      "brandKey": "B570932",
      "brandName": "1-800-FLOWERS.COM®",
      "disclaimer": "<p>*1-800-FLOWERS.COM is not a sponsor of the rewards or otherwise affiliated with this company. The logos and other identifying marks attached are trademarks of and owned by each represented company and/or its affiliates.&nbsp; Please visit each company&#39;s website for additional terms and conditions.</p>\r\n",
      "description": "<p>Gift-giving has never been easier with the 1-800-FLOWERS.COM&reg; Gift Card! Browse a wide selection of fresh flowers, delicious gourmet treats and desserts, beautiful plants, stunning gift baskets and more &ndash; and then choose exactly what you want!</p>\r\n",
      "shortDescription": "<p>Gift-giving has never been easier with the 1-800-FLOWERS.COM&reg; Gift Card! Browse a wide selection of fresh flowers, delicious gourmet treats and desserts, beautiful plants, stunning gift baskets and more &ndash; and then choose exactly what you want!</p>\r\n",
      "terms": "<p>You can use your eGift Card at any Cheryls® or Harry &amp; David® retail stores and online at <a href=\"https://www.1800baskets.com/\">www.1800baskets.com</a>, <a href=\"https://www.1800flowers.com/\">www.1800flowers.com</a>, <a href=\"https://www.cheryls.com/\">www.cheryls.com</a>, <a href=\"https://www.fruitbouquets.com/\">www.fruitbouquets.com</a>, <a href=\"https://www.harryanddavid.com/\">www.harryanddavid.com</a>, <a href=\"https://www.stockyards.com/\">www.stockyards.com</a>, <a href=\"https://www.thepopcornfactory.com/\">www.thepopcornfactory.com</a> and <a href=\"https://www.wolfermans.com/\">www.wolfermans.com</a>. Acceptance of this card constitutes acceptance of these terms and conditions, which may change at any time. To view your eGift Card balance, go to <a href=\"http://freshgift.com/\">http://freshgift.com/</a>. This eGift Card does not expire.</p>",
      "createdDate": "2016-04-26T17:27:19Z",
      "lastUpdateDate": "2024-02-20T18:42:36Z",
      "brandRequirements": {
        "displayInstructions": "<p>&nbsp;&nbsp;</p>\r\n\r\n<p>&nbsp;</p>\r\n\r\n<p>&nbsp; &nbsp;</p>\r\n",
        "termsAndConditionsInstructions": "<p>&nbsp;&nbsp;</p>\r\n\r\n<p>&nbsp;</p>\r\n\r\n<p>&nbsp;</p>\r\n",
        "disclaimerInstructions": "<p>Brand Disclaimer to be used when 1-800-FLOWERS.COM is the only brand presented on a page or in an email. Otherwise, if it&rsquo;s one of two or more brands being shown, you may use the General Merchant Disclaimer.&nbsp;<br />\r\nPresent the Terms and Conditions anytime you&rsquo;re presenting specific gift card use details.</p>\r\n",
        "alwaysShowDisclaimer": false
      },
      "imageUrls": {
        "80w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b276872-80w-326ppi.png",
        "130w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b276872-130w-326ppi.png",
        "200w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b276872-200w-326ppi.png",
        "278w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b276872-278w-326ppi.png",
        "300w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b276872-300w-326ppi.png",
        "1200w-326ppi": "https://dwwvg90koz96l.cloudfront.net/images/brands/b276872-1200w-326ppi.png"
      },
      "status": "active",
      "items": [
        {
          "utid": "U935268",
          "rewardName": "1-800-FLOWERS.COM® Gift Card $10.00",
          "currencyCode": "USD",
          "status": "active",
          "valueType": "FIXED_VALUE",
          "rewardType": "gift card",
          "isExpirable": false,
          "isWholeAmountValueRequired": false,
          "faceValue": 10,
          "createdDate": "2016-07-19T18:41:23.217Z",
          "lastUpdateDate": "2024-05-09T17:09:48.07Z",
          "countries": [
            "US"
          ],
          "credentialTypes": [
            "cardNumber",
            "pin",
            "rewardSecurityCode",
            "rewardSecurityUrl"
          ],
          "redemptionInstructions": "<p>Where you can redeem your Gift Card:</p>\n<ol>\n<li>Online at <a href=\"http://www.1800baskets.com\">www.1800baskets.com</a>, <a href=\"http://www.1800flowers.com\">www.1800flowers.com</a>, <a href=\"http://www.cheryls.com\">www.cheryls.com</a>, and <a href=\"http://www.thepopcornfactory.com\">www.thepopcornfactory.com</a>. By phone on orders for 1-800-BASKETS.COM, 1-800-FLOWERS.com®, Cheryl's®, and The Popcorn Factory.</li>\n<li>At our company owned and participating franchised retail store locations of Fannie May at certain, but not all, franchised retail store locations of 1-800-Flowers.com®, Conroy's, and Conroy's 1-800-Flowers®.</li>\n</ol>\n<p>Limit one Gift Card, Fresh Rewards pass and/or Savings Pass per order. Some promotions may restrict redemption to certain brands and will be clearly noted on the promotion. May become redeemable at additional brands and locations, which information will be updated on this page. See conditions and restrictions as detailed below. </p>",
          "fulfillmentType": "DIGITAL"
        },
        {
          "utid": "U683701",
          "rewardName": "1-800-FLOWERS.COM® Gift Card $25.00",
          "currencyCode": "USD",
          "status": "active",
          "valueType": "FIXED_VALUE",
          "rewardType": "gift card",
          "isExpirable": false,
          "isWholeAmountValueRequired": false,
          "faceValue": 25,
          "createdDate": "2016-07-19T19:44:16.151Z",
          "lastUpdateDate": "2024-05-09T17:13:24.97Z",
          "countries": [
            "US"
          ],
          "credentialTypes": [
            "cardNumber",
            "pin",
            "rewardSecurityCode",
            "rewardSecurityUrl"
          ],
          "redemptionInstructions": "<p>Where you can redeem your Gift Card:</p>\n<ol>\n<li>Online at <a href=\"http://www.1800baskets.com\">www.1800baskets.com</a>, <a href=\"http://www.1800flowers.com\">www.1800flowers.com</a>, <a href=\"http://www.cheryls.com\">www.cheryls.com</a>, and <a href=\"http://www.thepopcornfactory.com\">www.thepopcornfactory.com</a>. By phone on orders for 1-800-BASKETS.COM, 1-800-FLOWERS.com®, Cheryl's®, and The Popcorn Factory.</li>\n<li>At our company owned and participating franchised retail store locations of Fannie May at certain, but not all, franchised retail store locations of 1-800-Flowers.com®, Conroy's, and Conroy's 1-800-Flowers®.</li>\n</ol>\n<p>Limit one Gift Card, Fresh Rewards pass and/or Savings Pass per order. Some promotions may restrict redemption to certain brands and will be clearly noted on the promotion. May become redeemable at additional brands and locations, which information will be updated on this page. See conditions and restrictions as detailed below. </p>",
          "fulfillmentType": "DIGITAL"
        },

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 codes

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.