Get all items in the platform catalog

Use GET {URI}/catalogs endpoint to get all items in the platform's Catalog. This endpoint provides the credential types information for each item in the catalog. See about Get credential types .

Endpoint	Purpose
`GET {URI}/catalogs`	Get all items in the platform's catalog.

You can query the catalog based on rewardType such as gift card, donation, Reward Link, etc. to retrieve item details for specific types of rewards.

You can filter and return all brands and item details based on the specified fulfillment type or type of delivery. If you select PHYSICAL for "fulfillmentType", you can see a list of physical UTIDs which requires you to submit recipient addresses.

The following query parameters are available with this endpoint to better filter your search results:

Query params	Data type	Description
verbose	boolean	Default is True. When true, will return the additional brand fields: status, disclaimer, description, short description, terms, brand requirements collection, and image urls collection.
brankKey	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. 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. Country codes are two-digits.
fulfillmentType	array of strings	Returns all brands and item details for a specific fulfillment type: - DIGITAL: Items that are delivered digitally. - MOBILE: Items that are delivered via mobile. - PHYSICAL: Items that are delivered physically.
categoryIds	arrays of uuids	Returns all brands and item details for specific brand categories. -Add UUID (Universally Unique Identifier)

Retrieve catalog items when verbose is true

Use the GET {URI}/catalogs endpoint to view the items in your platform’s catalog and see what you can order. When the verbose is true, it returns the additional brand fields, such as status, disclaimer, description, shortDescription, terms, brandRequirements collection, and imageUrls collection.

isExpirable indicates whether or not the gift card has an expiry date. The value for isExpirable =boolean is true or false. The following payload example is for when verbose=true:

{
  "catalogName": "string",
  "brands": [
    {
      "brandKey": "string",
      "brandName": "string",
      "disclaimer": "string",
      "description": "string",
      "shortDescription": "string",
      "terms": "string",
      "createdDate": "2025-04-29T02:12:17.642Z",
      "lastUpdateDate": "2025-04-29T02:12:17.642Z",
      "brandRequirements": {
        "displayInstructions": "string",
        "termsAndConditionsInstructions": "string",
        "disclaimerInstructions": "string",
        "alwaysShowDisclaimer": true
      },
      "imageUrls": {
        "additionalProp": "string"
      },
      "status": "string",
      "items": [
        {
          "utid": "string",
          "rewardName": "string",
          "currencyCode": "string",
          "status": "string",
          "valueType": "string",
          "rewardType": "string",
          "isExpirable": true,
          "isWholeAmountValueRequired": true,
          "exchangeRateRule": "string",
          "minValue": 0,
          "maxValue": 0,
          "faceValue": 0,
          "fee": {
            "type": "string",
            "value": 0
          },
          "createdDate": "2025-04-29T02:12:17.642Z",
          "lastUpdateDate": "2025-04-29T02:12:17.642Z",
          "countries": [
            "string"
          ],
          "credentialTypes": [
            "string"
          ],
          "redemptionInstructions": "string",
          "fulfillmentType": "DIGITAL"
        }
      ],
      "categories": [
        {
          "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string"
        }
      ]
    }
  ]
}

Retrieve catalog items when verbose is false

Use GET {URI}/catalogs to retrieve catalog items. isExpirable indicates whether or not the gift card has an expiry date. The value for isExpirable =boolean is true or false. The following payload example is for when verbose=false:

{
  "catalogName": "string",
  "brands": [
    {
      "brandKey": "string",
      "brandName": "string",
      "disclaimer": "string",
      "description": "string",
      "shortDescription": "string",
      "terms": "string",
      "createdDate": "2025-04-29T02:12:17.642Z",
      "lastUpdateDate": "2025-04-29T02:12:17.642Z",
      "brandRequirements": {
        "displayInstructions": "string",
        "termsAndConditionsInstructions": "string",
        "disclaimerInstructions": "string",
        "alwaysShowDisclaimer": true
      },
      "imageUrls": {
        "additionalProp": "string"
      },
      "status": "string",
      "items": [
        {
          "utid": "string",
          "rewardName": "string",
          "currencyCode": "string",
          "status": "string",
          "valueType": "string",
          "rewardType": "string",
          "isExpirable": true,
          "isWholeAmountValueRequired": true,
          "exchangeRateRule": "string",
          "minValue": 0,
          "maxValue": 0,
          "faceValue": 0,
          "fee": {
            "type": "string",
            "value": 0
          },
          "createdDate": "2025-04-29T02:12:17.642Z",
          "lastUpdateDate": "2025-04-29T02:12:17.642Z",
          "countries": [
            "string"
          ],
          "credentialTypes": [
            "string"
          ],
          "redemptionInstructions": "string",
          "fulfillmentType": "DIGITAL"
        }
      ],
      "categories": [
        {
          "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string"
        }
      ]
    }
  ]
}

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": [
    {}
  ]
}

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

200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
500 Internal Server Error
503 Service Unavailable