Retrieve collections

get

https://ac.cnstrc.com/v1/collections

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: collections(r).

Retrieve all collections. By default, only base collections (collections with no overridden_collection_id) are returned. Use the overridden_collection_id query parameter to retrieve overriding collections for a specific base collection.

Query Params

key

string

required

length between 1 and 100

The key of the index to use.

section

string

length between 1 and 100

The section of the index to use. Defaults to Products.

array of strings

length ≤ 100

The ID(s) of collections to filter by.

overridden_collection_id

string

length between 1 and 100

When provided, returns only collections that override the specified collection ID.

query

string

A query to narrow the result set when listing collections. Matches on id or display_name.

num_results_per_page

integer

1 to 100

Defaults to 20

The number of results per page to return.

page

integer

≥ 1

The page of results to return.

offset

integer

≥ 0

The number of results to skip from the beginning. Cannot be used together with page.

sort_by

string

enum

Defaults to id

The attribute to sort by. Accepted values are 'created_at', 'updated_at', 'display_name', 'start_time', 'end_time'

Allowed:

sort_order

string

enum

Defaults to ascending

The order by which results should be sorted. Only valid in conjunction with sort_by. Accepted values are 'ascending' and 'descending'.

Allowed:

string

length between 1 and 100

The ID of the client and version that the request is coming from, such as cio-js-2.90.

has_future_items

boolean

When true, only collections that have future items (items not yet in the catalog) will be returned. When false, only collections that do not have future items will be returned.

Responses

400

Validation Error

401

Credentials are not passed or action is forbidden.

403

The supplied token does not have the required permissions.

429

Rate limit breached

👋 Welcome to Constructor's new and improved documentation

200OK