v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Variations

Create or replace variations

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: catalog(w), search_suggestions(w).

Create item variations or replace the data of existing item variations. Returns an identifier for a background task.

put/v2/variations

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
sectionstring

The section of the index to use. Defaults to Products.

Example:Products
cstring

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

Example:cio-js-2.90
forceboolean

A flag to process the catalog even if it will invalidate a large part of existing data. Defaults to False.

notification_emailstring[]

The email address(es) to send a notification to if the task fails. Multiple addresses may be specified for multiple recipients.

[
  "user@example.com"
]

Request body

Example request

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

Response

OK

task_idinteger required
task_status_pathstring required