TAtalon
Catalogs

List items in a catalog

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Return a paginated list of cart items in the given catalog.

get/v1/catalogs/{catalogId}/items

Request

Path parameters

catalogIdinteger required

The ID of the catalog. You can find the ID in the Campaign Manager in Account > Tools > Cart item catalogs.

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

The number of items to skip when paging through large result sets.

withTotalResultSizeboolean

When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets.

  • When true: totalResultSize contains the total number of results for this query.
  • When false: Only hasMore is returned, and it is set to true when there are more results than shown on the page.
skustring[]

Filter results by one or more SKUs. Must be exact match.

productNamesstring[]

Filter results by one or more product names. Must be exact match.

Response

OK

hasMoreboolean
totalResultSizeinteger

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "id": 6,
      "created": "2020-06-10T09:05:27.993483Z",
      "sku": "SKU1241028",
      "price": 99.99,
      "catalogid": 6,
      "version": 5,
      "attributes": [
        {
          "attributeid": 6
        }
      ],
      "product": {
        "name": "sample_product"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.