Retrieve by pod

get

https://offsite-discovery.cnstrc.com/v1/recommendations/pods/{pod_id}

Retrieves AI-optimized recommendation results for products by pod identifier for use in Offsite Discovery.

Path Params

pod_id

string

required

The unique identifier of the recommendation pod containing the product set.

Query Params

key

string

required

length between 1 and 100

The key of the index to use.

campaign_id

string

required

Email campaign identifier for tracking and analytics.

item_id

Seed item ID used for item-based recommendations (e.g., complementary).

filters

Facet filters to apply to the recommendation request. Allows for complex filtering with multiple values per attribute. Example: &filters[brand]=AwesomeBrand&filters[category]=Shoes&filters[category]=Boots

filter_name

string

Name of the product attribute to filter by (e.g., brand, category, color). Must be provided together with filter_value.

filter_value

string

Value to filter the specified attribute by. Must be provided together with filter_name.

num_results

integer

1 to 100

Defaults to 10

Number of results requested. For Offsite Discovery recommendations, this is the number to return. For snippet requests, this defines the expected number of results that were available. Default is 10.

string

Unique identifier for the user to personalize recommendation results.

Responses

Language

Loading…

Response

Choose an example:

application/json

👋 Welcome to Constructor's new and improved documentation

200OK. A list of recommended products.

400Bad Request - Invalid syntax or missing required parameters.

404Not Found - The requested pod ID or resource could not be found.

500Internal Server Error - An unexpected error occurred on the server.