Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Product resources

Retrieve recommendation result item image

Redirects to a recommended item image 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}/image_url

Path parameters

pod_idstring required

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

Example:homepage_products

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

positioninteger required

The position of the desired product within the results.

Example:1

The position of the desired product within the results.

Query parameters

keystring required

The key of the index to use.

Example:ZqXaOfXuBWD4s3XzCI1q

The key of the index to use.

campaign_idstring required

Email campaign identifier for tracking and analytics.

Example:email_campaign_2024_01

Email campaign identifier for tracking and analytics.

string[]
OR
string

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

style_idstring required

Specific style ID within a product, used for retrieving style-specific images.

Example:style_ABC

Specific style ID within a product, used for retrieving style-specific images.

object
OR
object

Any number of filtering criteria used to narrow the result set, such as color=blue or group_id=sandals or price=100-200. Facets, item groups and collection IDs 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_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

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.

filter_valuestring

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

Example:nike

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

num_resultsinteger

The maximum number of recommended items to retrieve.

Example:10

The maximum number of recommended items to retrieve.

cstring

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

Example:cio-dashboard

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

string[]
OR
string

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.

uistring

Unique identifier for the user to personalize recommendation results.

Example:user_12345

Unique identifier for the user to personalize recommendation results.

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 image 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"
  }
}