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.

Catalog filters

Perform GET {URI}/catalogs to get details for specific items or groupings using the following endpoint filters:

Endpoint filter	Description
`GET {URI}/catalogs?utid={{utid}}`	Return the details for a specific item (UTID).
`GET {URI}/catalogs?brandKey={{brandKey}}`	Return all the items and details for a specific brand.
`GET {URI}/catalogs?currencyCode=\*{{currencyCode}}`	Return items of 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.
`GET {URI}/catalogs?country=((2-digit country code))`	Return items from a specific country; the value can be found in the countries collection.

Here are the query parameters for this endpoint to filter the data. If you select PHYSICAL for "fulfillmentType", you can see a list of physical UTIDs which requires you to submit recipient addresses:

Query Params	Data type	Description
verbose	boolean (false/true)	When true, returns 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".
currencyCode	string	Return all brands and item details associated with a specific currency. We only accept CAD, EUR, GBP, or USD. 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 -DIGITAL -PHYSICAL	array of strings	Returns all brands and item details for a specific fulfillment type.
categoryIds	array of strings	Returns all brands and item details for specific brand categories.

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": "2023-10-12T21:23:43.900Z",
      "lastUpdateDate": "2023-10-12T21:23:43.900Z",
      "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": boolean",
          "isWholeAmountValueRequired": true,
          "exchangeRateRule": "string",
          "minValue": 0,
          "maxValue": 0,
          "faceValue": 0,
          "fee": {
            "type": "string",
            "value": 0
          },
          "createdDate": "2023-10-12T21:23:43.900Z",
          "lastUpdateDate": "2023-10-12T21:23:43.900Z",
          "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": "2023-10-12T21:23:43.900Z",
      "lastUpdateDate": "2023-10-12T21:23:43.900Z",
      "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": boolean",
         "isWholeAmountValueRequired": true,
          "exchangeRateRule": "string",
          "minValue": 0,
          "maxValue": 0,
          "faceValue": 0,
          "fee": {
            "type": "string",
            "value": 0
          },
          "createdDate": "2023-10-12T21:23:43.900Z",
          "lastUpdateDate": "2023-10-12T21:23:43.900Z",
          "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
404 Not Found
500 Internal Server Error
503 Service Unavailable