v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Item groups

Create or replace item groups

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

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

put/v2/item_groups

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
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

{
  "item_groups": [
    {
      "id": "category-electronics",
      "name": "Electronics",
      "parent_ids": [
        "parent-1"
      ]
    }
  ]
}

Response

OK

task_idinteger required
task_status_pathstring required