v1
latestOpenAPI 3.1.02026-07-241765501.1 MBCollections
Add or update items in a collection
🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: collections(w).
Add items to a collection, or update existing items. Items already in the collection are updated, others are added. Note that the total number of items per collection is limited, and the request will fail if adding items would exceed this limit.
put/v1/collections/{collection_id}/items
Path parameters
collection_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
on_missing'IGNORE' | 'FAIL' | 'CREATE'
Request body
Example request
{
"items": [
{
"id": "nike-shoes",
"source": "manual_upload",
"variation_ids": [
"var-red"
]
}
]
}Response
OK
Example response
{
"items": [
{
"source": "manual_upload",
"variation_ids": [
"var-red"
]
}
]
}