v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Variations

Update catalog variations

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

Update variations in the catalog. If a variation does not exist, it will be created.

patch/v2/variations

Query parameters

keystring required

The key of the index to use.

The key of the index to use.

sectionstring required

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

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

on_missing'CREATE'

Strategy for handling records that do not exist in the system.

Strategy for handling variations that do not exist. Only CREATE is supported.

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

Accepted

messagestring required

Success message

countinteger required

Number of items/variations accepted.