Retrieve by pod

get

https://ac.cnstrc.com/recommendations/v1/pods/{pod_id}

Retrieve AI optimized recommendation results for products (or optionally other sections) by pod identifier. To learn more about pods, go here.

Path Params

pod_id

string

required

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.

item_id

The ID of the item to recommend additional items for. This parameter is required for the following recommendation strategies

alternative_items
complementary_items
bundles

variation_id

The ID of the item variation to recommend additional items for. This parameter can be used with exactly one item_id specified in the request and is not required.

term

string

length between 0 and 100

The term to recommend items for. This parameter is required for the following recommendation strategies

query_recommendations

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 Object containing any number of filters (inaccessible to end users) used to narrow the result set. Applied before filters accessible to end users. Only results that match the filters are returned.

num_results

integer

0 to 100

Defaults to 10

The maximum number of recommended items to retrieve

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 the results returned

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

User segment is a client context value (such as platform, location, etc.) that is used to evaluate redirect or refined tag rules. You can supply 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.

At least one of the parameters i or ui is required for the following recommendation strategies

recently_viewed_items
user_featured_items
abandoned_in_cart

integer

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

object

SL data

string

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

At least one of the parameters i or ui is required for the following recommendation strategies

recently_viewed_items
user_featured_items
abandoned_in_cart

string

length between 0 and 100

deprecated

DEPRECATED. Please, use term instead

Responses

400

Validation Error

404

Not Found

👋 Welcome to Constructor's new and improved documentation

200OK