PUT /v1/commerce/collections/{collectionID}

PUT/v1/commerce/collections/{collectionID}

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

collectionIDstringrequired

Request body

requiredapplication/json

activebooleanrequired

descriptionstring

image_urlstring

slugstringrequired

sort_orderinteger<int32>

titlestringrequired

Responses

200OK

activebooleanrequired

descriptionstring

idstringrequired

image_urlstring

product_countinteger<int32>

slugstringrequired

sort_orderinteger<int32>required

titlestringrequired

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X PUT "/v1/commerce/collections/string" \
  -H "Content-Type: application/json" \
  -d '{
  "active": true,
  "description": "string",
  "image_url": "string",
  "slug": "string",
  "sort_order": 0,
  "title": "string"
}'

const response = await fetch("/v1/commerce/collections/string", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "active": true,
  "description": "string",
  "image_url": "string",
  "slug": "string",
  "sort_order": 0,
  "title": "string"
})
});

import requests

response = requests.put(
    "/v1/commerce/collections/string",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "active": True,
  "description": "string",
  "image_url": "string",
  "slug": "string",
  "sort_order": 0,
  "title": "string"
},
)

Response

{
  "active": true,
  "description": "string",
  "id": "string",
  "image_url": "string",
  "product_count": 0,
  "slug": "string",
  "sort_order": 0,
  "title": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}