Retrieve by prefix

get

https://ac.cnstrc.com/v1/autocomplete/{prefix}

Retrieve AI optimized autocomplete results for products and search suggestions (and/or optionally other sections). Prefix length is limited to 200 characters.

Path Params

prefix

string

required

Query Params

key

string

required

length between 1 and 100

The key of the index to use.

num_section_results_per_page

object

The number of section results per page to return.

offset_per_section

object

The offset of section results to return.

page_per_section

object

The page of section results to return.

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.

pre_filter_expression

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. Supports per-section format using bracket notation: applies to specific sections.

num_results

integer

0 to 50

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.

variations_map

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.

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.

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.

lang

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

👋 Welcome to Constructor's new and improved documentation

200OK