Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Variations

Retrieve variation

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

Retrieve an item variation.

get/v2/variations/{variation_id}

Path parameters

variation_idstring required
Example:red-nike-shoes

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

Response

OK

idstring required

The ID of the variation, must be unique.

item_idstring required

The ID of the item this variation is attached to.

namestring

The name of the variation, as it will appear in the results. Contains at least one alphanumeric character.

suggested_scoreinteger

A number that will influence the variation's initial ranking relative to other variation scores (the higher the score, the higher in the list of suggestions the variation will appear).

updated_atstring date-time required

A date when the variation was updated.

Example response

{
  "data": {
    "keywords": [
      "running"
    ],
    "url": "http://www.example.com/product/123",
    "image_url": "http://www.example.com/images/product.jpg",
    "group_ids": [
      "shoes"
    ],
    "description": "A comfortable running shoe with cushioned sole",
    "active": true,
    "is_default": true
  }
}