Item groups

Update item groups

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

Update existing item groups. Data included in the request is merged with the existing item group data.

This endpoint does not accept the on_missing parameter. It always uses FAIL: if an item group does not exist in the index, ingestion fails. CREATE and IGNORE are not supported. To create item groups, use Create or replace item groups.

Returns an identifier for a background task.

patch/v2/item_groups

Request

Base URL
https://ac.cnstrc.com
URL
https://ac.cnstrc.com/v2/item_groups
Auth
- HTTP basic
- or HTTP bearer

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",
      "parent_ids": [
        "parent-1"
      ]
    }
  ]
}

Response

task_idinteger required

task_status_pathstring required

Changes

No recorded changes to this operation across all 1 revision of this API.