Retrieve refined collections

get

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

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

Retrieve all refined collections.

Query Params

key

string

required

length between 1 and 100

The key of the index to use.

response_section

string

enum

Defaults to results

The section of the response to apply rules to, such as results or facets.

Allowed:

section

string

length between 1 and 100

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

filter_names_to_exclude

array of strings

A list of filter names to exclude from results.

Filter Names To Exclude

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.

Allowed:

sort_order

string

enum

Defaults to ascending

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

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.

segments

object

Filtering conditions by segment type

filter

object

A list of filters to retrieve

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