Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Product Collections

List Products in Collection

Retrieves list of products from a product collection; works for both dynamic and static product collections.

get/v1/product-collections/{productCollectionId}/products

Query parameters

limitinteger

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

pageinteger

Which page of results to return. The lowest value is 1.

order'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'type' | '-type' | 'code' | '-code' | 'campaign' | '-campaign' | 'category' | '-category'

Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

starting_afterstring date-time
Example:2023-12-22T10:13:06.487Z

Timestamp representing the date and time to use in starting_after cursor to get more data. Represented in ISO 8601 format.

Response

Returns a dictionary of products and/or SKUs grouped in the collection with each product's/SKU's details.

objectstring required

The type of the object represented by JSON. This object stores information about products and SKUs.

data_refstring required

Identifies the name of the JSON property that contains the array of products and SKUs.

totalinteger required

Total number of products & SKUs in the product collection.

Example response

{
  "data": [
    {
      "id": "prod_0b1da8105693710357",
      "source_id": "productSourceID16",
      "name": "T-shirt",
      "image_url": "https://images.com/original.jpg",
      "created_at": "2022-05-23T06:52:55.008Z",
      "updated_at": "2022-05-23T09:24:07.405Z"
    }
  ]
}