List Collections

GET/store/collections

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

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:

["",""]

Request samples

Responses

OK(200)

Client Error or Multiple Errors(400)

Not Found Error(404)

Invalid State Error(409)

Invalid Request Error(422)

Server Error(500)

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

Not configured

Last modified: a year ago