Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Product details

Retrieve variation product details

Retrieve product details for variations of an item.

get/v1/variations

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp

The key of the index to use.

sectionstring required

The section of the index to use (e.g. 'Products').

Example:Products

The section of the index to use (e.g. 'Products').

variation_idstring[] required

One or more variation IDs to retrieve product details for. This parameter may be repeated to specify multiple IDs.

One or more variation IDs to retrieve product details for. This parameter may be repeated to specify multiple IDs.

cstring nullable

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

Example:cio-js-client-2.35.2

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

uistring nullable

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.

Example:customer-user-id-456

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.

sinteger nullable

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

Example:1

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

istring nullable

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

Example:user-device-id-123

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

Response

OK

trace_idstring required

Example response

{
  "response": {
    "variations": [
      {
        "enriched_attributes": {
          "badges": [
            {
              "metadata": {
                "times_was_seen_last_week": "123"
              }
            }
          ],
          "attributes": {
            "color": [
              {
                "type": "standard",
                "value": "red"
              },
              {
                "type": "standard",
                "value": "green"
              },
              {
                "type": "standard",
                "value": "blue"
              }
            ],
            "neckline": [
              {
                "type": "standard",
                "value": "round"
              }
            ]
          }
        }
      }
    ]
  }
}