Retrieve a list of product collections. The product collections can be filtered by fields such as handle or created_at. The product collections can also be paginated.
Request
Query Params
offset
integer
optional
The number of product collections to skip when retrieving the product collections.
limit
integer
optional
Limit the number of product collections returned.
handle
array[string]
optional
Filter by handles
lt
array[string]
optional
filter by dates less than this date
Example:
["",""]
gt
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:
["",""]
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl--location--request GET '/store/collections'
Responses
🟢200OK
application/json
Body
The list of product collections with pagination fields.
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 product collections details
id
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.
