COconstructor
Product resources

Retrieve recommendation result item URL

Redirects to a recommended item PDP 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.

get/v1/recommendations/pods/{pod_id}/positions/{position}/url

Request

  • Base URL
    https://offsite-discovery.cnstrc.com
  • URL
    https://offsite-discovery.cnstrc.com/v1/recommendations/pods/{pod_id}/positions/{position}/url
  • Auth
    none required

Path parameters

pod_idstring required

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

Example:homepage_products
positioninteger required

The position of the desired product within the results.

Example:1

Query parameters

keystring required

The key of the index to use.

Example:ZqXaOfXuBWD4s3XzCI1q
campaign_idstring required

Email campaign identifier for tracking and analytics.

Example:email_campaign_2024_01
string[]
OR
string
object
OR
object
filter_namestring

DEPRECATED. Please, use 'filters' instead. Name of the product attribute to filter by (e.g., brand, category, color). Must be provided together with filter_value.

Example:brand
filter_valuestring

DEPRECATED. Please, use 'filters' instead. Value to filter the specified attribute by. Must be provided together with filter_name.

Example:nike
num_resultsinteger

The maximum number of recommended items to retrieve.

Example:10
cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-dashboard
string[]
OR
string
uistring

Unique identifier for the user to personalize recommendation results.

Example:user_12345
base_urlstring

Base URL used to construct the product detail page redirect URL (e.g., 'https://example.com').

format'redirect' | 'json'

Enumeration of possible response formats for snippet requests.

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

Response

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

statusstring

Status of the response.

redirect_urlstring url required

The URL the client would be redirected to if format was 'redirect'.

resource_typestring required

Type of resource requested (e.g., 'image', 'url').

Example response

{
  "status": "success",
  "redirect_url": "https://images.example.com/products/PROD_001_main.jpg",
  "resource_type": "image",
  "product": {
    "id": "PROD_001",
    "variation_id": "VAR_001_BLUE",
    "url": "https://shop.example.com/products/premium-sneakers",
    "image_url": "https://images.example.com/products/PROD_001_main.jpg"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.