Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Collections

Delete item from a collection

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

Delete an item from a collection.

delete/v1/collections/{collection_id}/items/{item_id}

Path parameters

collection_idstring required
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
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

Response

OK

idstring required

The ID of the item, added to the collection.

sourcestring

Arbitrary identifier of the source of the item manually added to the collection.

variation_idsstring[]

List of variation IDs to include in this collection for the item. If not provided, all variations of the item are included.

created_atstring date-time

Collection Item creation date in ISO 8601 format. Present only for manually added items.

updated_atstring date-time

Collection Item update date in ISO 8601 format. Present only for manually added items.

type'manual' | 'dynamic'

Example response

{
  "source": "manual_upload",
  "variation_ids": [
    "var-red"
  ]
}