Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Items

Retrieve item

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

Retrieve an item.

get/v2/items/{item_id}

Path parameters

item_idstring required
Example: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 item, must be unique.

namestring required

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

suggested_scoreinteger

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

updated_atstring date-time required

A date when the item or any of item's variations were 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
  }
}