v1

latestOpenAPI 3.1.0Apache 2.02026-07-2473175248.0 KB
5. Catalogs

Get all items in the Platform's Catalog.

get/catalogs

Query parameters

verboseboolean

When true, will return the additional brand fields: status, disclaimer, description, shortDescription, terms, brandRequirements collection, and imageUrls collection.

brandKeystring

Returns the brand and item details for a specific brand ID.

brandNamestring

Returns the brand and item details for a specific brand name.

utidstring

Returns the brand and item details for a specific utid. The utid is the unique identifier for a specific reward.

rewardNamestring

Returns the brand and item details of the specified reward name.

statusstring

Returns all brands and item details with the specified status. Possible statuses are: "test", "active", "inactive", "deleted"

rewardTypestring[]

Returns all brands and item details with the specified rewardType.

currencyCodestring

Return all brands and item details associated with a specific currency.

countrystring

Returns all brands and item details from a specific country.

fulfillmentTypestring[]

Returns all brands and item details for a specific fulfillment type.

itemAttributestring[]

Returns all brands and item details for a specific item attribute.

categoryIdsstring[]

Returns all brands and item details for specific brand categories.

Response

OK

catalogNamestring required

Example response

{
  "brands": [
    {
      "items": [
        {
          "quantityConstraints": {
            "minQuantity": 1,
            "maxQuantity": 1
          }
        }
      ]
    }
  ]
}