Retrieve product URL resource

get

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

Redirects to a product detail page URL or returns JSON based on its pod ID and position in a recommendation result set (pod_id and position as path parameters). Parameter values should correspond to a previously generated set of recommendations.

Path Params

pod_id

string

required

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

position

integer

required

≥ 1

The position of the desired product within the recommendation results.

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

array | string

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

filters

object

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.

base_url

string

ex.: https://example.com, used for redirecting to PDP

format

string

enum

Defaults to redirect

Format of the response, either 'redirect' (default for 302 redirect) or 'json' (for 200 OK with JSON body for debugging).

Allowed:

Responses

👋 Welcome to Constructor's new and improved documentation

200OK - JSON response with URL resource details (if format=json).

302Found - Redirects to the product detail page.

400Bad Request - Invalid syntax or missing required parameters.

404Not Found - The requested resource could not be found based on the provided parameters, possibly due to expired recommendations or out-of-range position.

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