🔒
Requires write_collection access scope. More access scope

The Update Collection API allows users to update details of an existing collection by providing the collection ID and the desired updates in the request body. This API supports updates to various attributes, including the title, description, SEO details, associated products, and more.This API is especially useful for:

Modify collection details such as title, description, or handle.
Update the associated image, SEO metadata, and sorting order for merchandise.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Description	Example
`id`	string	Yes	`a60fe556-43ad-4e07-9125-507ac1bf71f7`	Unique identifier of the collection.

Body Parameters

Parameter	Type	Required	Description	Example
`collection`	object	Yes	The collection configuration object	`{...}`
`collection.title`	string	Yes	The name of the collection	`Summer Sale 2023`
`collection.handle`	string	No	A unique URL-friendly identifier for the collection	`summer-sale-2023`
`collection.description`	string	No	The description of the collection	`Discounted summer products`
`collection.image`	object	No	Image details for the collection	`{...}`
`collection.seo_title`	string	No	The SEO title for the collection	`Summer Sale Collection`
`collection.seo_keywords`	array of object	No	The keywords for SEO	`{ "values": [ "a","b", ] }`
`collection.seo_description`	string	No	The SEO description for the collection	`Discounted summer products collection`
`collection.sort_order`	string	No	Merchandise sorting rules. Options include: manual (default), sales-desc, price-asc, price-desc, views-desc, vendor-asc, vendor-desc, created-desc, and more	`price-asc`
`collection.product_ids`	array of object	No	List of product IDs to include in the collection. Must be valid UUIDs	`{ "values": [ "a","b", ] }`

Image Object Structure

Parameter	Type	Required	Description	Example
`src`	string	Yes	The source URL of the collection image	`https://example.com/summer.jpg`
`width`	int32	No	The width of the collection image in pixels	`800`
`height`	int32	No	The height of the collection image in pixels	`600`
`alt`	string	No	Alt text for the collection image	`Summer collection image`

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Parameter	Type	Example	Description
`code`	string	`200`	Error code (200 indicates success)
`message`	string	`Success`	Error message
`data`	object	`{...}`	Contains the collects data
`data.collection`	collection object	`{...}`	collection object

Collection Object Structure

Parameter	Type	Example	Description
`id`	string	`coll_123456`	Unique identifier of the collection
`title`	string	`Summer Collection`	Name of the collection
`description`	string	`Our best summer products`	Description of the collection
`handle`	string	`summer-collection`	URL-friendly identifier
`smart`	boolean	`false`	Whether this is a smart collection (dynamically filtered)
`image`	object	`{...}`	Image details for the collection
`seo_title`	string	`Summer Collection 2023`	SEO-optimized title
`seo_keywords`	array of strings	`["summer", "2023", "sale"]`	SEO keywords for the collection
`seo_description`	string	`Discount on summer products`	SEO description
`sort_order`	string	`manual`	How products are sorted in this collection
`created_at`	string	`2023-06-20T15:30:00Z`	Timestamp when the collection was created
`updated_at`	string	`2023-06-21T09:15:00Z`	Timestamp when the collection was last updated

Image Object Structure

Parameter	Type	Example	Description
`src`	string	`https://example.com/image.jpg`	URL of the collection image
`width`	int32	`800`	Image width in pixels
`height`	int32	`600`	Image height in pixels
`alt`	string	`Summer products`	Alternative text for the image

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message

API Structure Overview

200OK