younifyd
Menu

List Catalog Items

List items in a catalog

GET/v1/catalogs/{catalogId}/items

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the List Catalog Items action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{listCatalogItems.response.data}}.

Request

Path parameters

catalogIdinteger (int64)required

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

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

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.

skuarray<string>

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

productNamesarray<string>

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

Response

Returns 200 with an object. Read it in later steps with {{listCatalogItems.response.data.<field>}}.

hasMoreboolean
totalResultSizeinteger (int64)
dataarray<object>
idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

skustringrequired

The stock keeping unit of the item.

pricenumber

Price of the item.

catalogidinteger (int64)required

The ID of the catalog the item belongs to.

versioninteger (int64)required

The version of the catalog item.

attributesarray<object>3 fields
productobject1 fields

The specific properties of the product this item belongs to, if available.

json
{
  "data": [
    {
      "product": {
        "name": "sample_product"
      },
      "catalogid": 6,
      "created": {},
      "price": 99.99,
      "attributes": [
        {
          "attributeid": 6,
          "name": "name",
          "value": "{}"
        },
        {
          "attributeid": 6,
          "name": "name",
          "value": "{}"
        }
      ],
      "id": 6,
      "sku": "SKU1241028",
      "version": 5
    }
  ],
  "hasMore": false,
  "totalResultSize": 1
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.