Retrieve collections

get

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

Retrieve collections for end users. To get specific collection items use the /browse/collection_id/<collection_id> endpoint.

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.

num_results_per_page

integer

1 to 200

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 method to sort collections by.

Allowed:

sort_order

string

enum

Defaults to descending

The order by which results should be sorted. Only valid in conjunction with sort_by.

Allowed:

now

date-time

A date time representing the current moment in time when applying filtering by product age. Used to emulate "past/future" requests. Requires authentication.

origin_referrer

string

The url or app location where the request originated.

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.

array of strings

A customer defined context (such as vip-club-member) used to evaluate redirect or refined tag rules. Pass multiple segments by passing multiple us arguments.

string

A customer generated anonymized identifier for a user on a customer website. It should only be sent for logged in customers and helps Constructor to tie multiple client and session IDs together to form a behavioral data profile across devices.

display_name

Filter collections by display name.

integer

An integer representing the users session number (starting with 1), incremented after a 30 minute period of inactivity.

string

A globally unique identifier for the user browser (or mobile application instance) making the request.

Responses

400

Validation Error

👋 Welcome to Constructor's new and improved documentation

200OK