Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Item groups

Create or update item group (Deprecated)

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

Create or update an item group.

put/v1/item_groups/{group_id}

Path parameters

group_idstring required

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

Request body

dataobject

Object containing additional data, that should be attached to this item group. The maximum size of data object is limited to 5kb. The average size of data objects for all ingested item groups should not exceed 1kb.

namestring

Item group display name.

parent_idstring

Parent item group ID or null for root item groups.

Example request

{
  "name": "Electronics",
  "parent_id": "parent-group-1"
}

Response

OK

dataobject

Object containing additional data, that should be attached to this item group. The maximum size of data object is limited to 5kb. The average size of data objects for all ingested item groups should not exceed 1kb.

idstring required

ID of the item group.

namestring required

Item group display name.

parent_idstring

Parent item group ID or null for root item groups.

path_liststring[] required

A list of item group IDs in the hierarchy.

pathstring required

Path to a item group IDs in the hierarchy (forward slash-separated).

Example response

{
  "id": "category-electronics",
  "name": "Electronics"
}