🔒
Requires read_collection access scope. More access scope

The Get Collections API retrieves a list of collections based on various filter criteria, such as product_id, title, or update timestamps. It allows users to paginate results and specify query limits for efficient retrieval.This API is especially useful for:

1.Fetch all collections for specific product association.

2.Filter collections by title or update timestamps.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Query Parameters

Parameter	Type	Required	Description	Example
`cursor`	string	No	Cursor for pagination	`cursor_123456`
`page_size`	int32	No	A limit on the number of objects to return. Range: 1-100 (default is 10)	`20`
`ids`	array of strings	No	List of collection IDs to retrieve specific collections	`["coll_123", "coll_456"]`
`title`	string	No	Filter collections by their title (supports partial matching)	`"summer"`
`updated_at_min`	string	No	Minimum timestamp for filtering collections by their last updated date. Format: YYYY-MM-DDTHH:mm:ssZ	`2023-01-01T00:00:00Z`
`updated_at_max`	string	No	Maximum timestamp for filtering collections by their last updated date. Format: YYYY-MM-DDTHH:mm:ssZ	`2023-12-31T23:59:59Z`
`product_id`	string	No	UUID of a product to filter collections that include the product	`prod_789abc`

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.collections`	array of objects	`[ {...}, {...} ]`	List of collection objects
`data.cursor`	string	`cursor_123456`	Cursor for pagination
`data.has_more`	boolean	`true`	Indicates if there are more results available

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