Sign in

v1

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

List Product Collections

This method returns a list of product collections.

get/v1/product-collections

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.

Response

Returns a dictionary containing a list of product collections and details about each product collection.

object'list' required

The type of the object represented by JSON. This object stores information about product collections.

data_ref'data' required

Identifies the name of the JSON property that contains the array of product collections.

totalinteger required

Total number of product collections.

Example response

{
  "data": [
    {
      "name": "All Products",
      "products": [
        {
          "id": "prod_0a41bcf807c5fcaaf6"
        }
      ],
      "created_at": "2021-12-09T12:51:29.898Z"
    }
  ]
}