Sign in

v2

latestOpenAPI 3.1.02026-07-26102336742.6 KB
Collections

Update a collection

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Updates collection name, description, and/or product list

put/open-api/v1.0/collections/{collectionId}

Path parameters

collectionIdstring required

Request body

namestring
descriptionstring
offerIdsstring[]

List of product IDs to set in the collection

Example request

{
  "name": "My collection",
  "description": "My collection description"
}

Response

OK

idstring required
shopIdstring required
namestring required
slugstring required
descriptionstring required
availableboolean required
offerIdsstring[] required

Example response

{
  "id": "col_b1EVARkUTcCTSfspQaXr1Q",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "name": "My collection",
  "slug": "my-collection",
  "description": "My collection description"
}