List Collections

Retrieve a list of Product Collection. The product collections can be filtered by fields such as handle or title. The collections can also be sorted or paginated.

Request

Query Params

limit

integer

optional

The number of collections to return.

offset

integer

optional

The number of collections to skip when retrieving the collections.

title

string

optional

Filter collections by their title.

handle

string

optional

Filter collections by their handle.

string

optional

a term to search collections by their title or handle.

discount_condition_id

string

optional

Filter collections by a discount condition ID associated with them.

array[string]

optional

filter by dates less than this date

Example:

["","",""]

array[string]

optional

filter by dates greater than this date

Example:

["","",""]

lte

array[string]

optional

filter by dates less than or equal to this date

Example:

["","",""]

gte

array[string]

optional

filter by dates greater than or equal to this date

Example:

["","",""]

Responses

🟢200OK

application/json

Body

count

integer

required

The total number of items available

offset

integer

required

The number of product collections skipped when retrieving the product collections.

limit

integer

required

The number of items per page

collections

array[object (Product Collection) {8}]

required

an array of collection details

string

required

The product collection's ID

Example:

pcol_01F0YESBFAZ0DV6V831JXWH0BG

title

string

required

The title that the Product Collection is identified by.

Example:

Summer Collection

handle

string | null

required

A unique string that identifies the Product Collection - can for example be used in slug structures.

Example:

summer-collection

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

products

array [object]

optional

The details of the products that belong to this product collection.

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

Example

{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "collections": [
    {
      "id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
      "title": "Summer Collection",
      "handle": "summer-collection",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "products": [
        {}
      ],
      "metadata": {
        "car": "white"
      }
    }
  ]
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

List Collections

Request

Request samples

Responses