API Reference
Release NotesProof ScheduleĀ®UI LibrariesClient LibrariesBlog

Retrieve by query

get
https://ac.cnstrc.com/v1/search/

Retrieve AI optimized search results for products (or optionally other sections) by search query.

Related content

Path Params
string
required
Query Params
string
required
length between 1 and 100

The key of the index to use.

string
length between 1 and 100

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

filters
object

Any number of filtering criteria (accessible to end users) used to narrow the result set, such as color=blue or group_id=sandals or price=100-200. Facets and Item Groups and Collections can be used as filters. If filter_value has the form <min>-<max>, it is interpreted as a range. Filters with the same key are ORed together and filters with different keys are ANDed together by default. Only results that match the filters are returned. Boolean values are serialized with the first letter capitalized (e.g., True / False) as a convention.

filter_match_types
object

An object specifying whether results must match all, any or none of a given filter when multiple options of the same facet (e.g: color: yellow & blue) are selected.

object | Encoded JSON string

A JSON-encoded filter expression containing any number of filters (inaccessible to end users) used to narrow the result set. Applied before user-selected filters. Only items that match this expression are considered in facet counts. Only results that match the filters are returned. Read more.

integer
1 to 200
Defaults to 20

The number of results per page to return.

integer
ā‰„ 1

The page of results to return.

integer
ā‰„ 0

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

string
Defaults to relevance

The method to sort results by. The default value relevance sorts by Constructor's attractiveness & personalization algorithms and is reserved. Alternative sort criteria can be configured using the Sort options API.

string
enum
Defaults to descending

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

Allowed:
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.

json

A JSON string containing a instructions on how to map item variation data in the response (typically used for swatches). More details, including the exact schema for this value can be found here

fmt_options
object

An object containing options to format different aspect of the response.

json

A JSON-encoded query string. Any query parameters listed for this endpoint can be serialized into a JSON string and parsed thru the qs param.

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.

us
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.

us
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.

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.

string
enum

A specification of the user query language. When provided, this parameter enables language-specific processing such as stemming to improve relevance and recall.

Responses

400

Validation Error

Updated about 1 month ago

Language
LoadingLoadingā€¦
Response
Choose an example:
application/json

Updated about 1 month ago