Skip to main content
PUT
Update Collection

Headers

authorization
string | null
X-API-Key
string | null
X-Stella-Merchant-Id
string | null

Path Parameters

collection_id
string<uuid>
required

Body

application/json

Schema for updating a collection.

title
string | null
Maximum string length: 255
description
string | null
handle
string | null
Maximum string length: 255
image_url
string | null
sort_order
string | null
Pattern: ^(manual|alpha-asc|alpha-desc|price-asc|price-desc|created-desc)$
published
boolean | null

Response

Successful Response

Schema for collection in responses.

id
string<uuid>
required
merchant_id
string<uuid>
required
title
string
required
description
string | null
required
handle
string | null
required
type
string
required
image_url
string | null
required
sort_order
string
required
published
boolean
required
published_at
string<date-time> | null
required
products_count
integer
required
created_at
string<date-time>
required
updated_at
string<date-time>
required