COconstructor
Product details

Retrieve variation product details

Retrieve requested product detail fields for one or more variations. Results preserve request order and repeated IDs. Every requested ID has a corresponding response entry.

get/v1/variations

Request

  • Base URL
    https://product-details.cnstrc.com
  • URL
    https://product-details.cnstrc.com/v1/variations
  • Auth
    none required

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
sectionstring required

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

Example:Products
variation_idstring[] required

1 to 100 variation IDs to retrieve product details for. Repeat this parameter 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
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
fieldsstring[] required

One or more product detail fields to include in the response. This parameter may be repeated to specify multiple fields.

[
  "enriched_attributes"
]
sinteger nullable

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

Example:1
istring nullable

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

Example:user-device-id-123

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

Changes

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