🔒
Requires write_collection access scope. More access scope

The Create Collect API associates a product with a collection by creating a collect object. For every single product in a collection there's a collect that tracks the ID of both the product and collection. This enables users to organize products into collections for easier management and display.This API is especially useful for:

Add a product to a specific collection.
Organize products for marketing, inventory, or categorization purposes.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Body Parameters

Field	Type	Required	Example	Description
collect.collection_id	string	Yes	`a60fe556-43ad-4e07-9125-507ac1bf71f7`	Unique identifier of the collection.
collect.product_id	string	Yes	`c34da7b1-26af-4c2b-8a7b-3474d73cdab1`	Unique identifier of the product.

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.collect`	object	`{...}`	List of collect objects

Collect Object Structure

Parameter	Type	Example	Description
`id`	string	`coll_123456`	Unique identifier of the collect
`collection_id`	string	`coll_789abc`	Identifier of the associated collection
`product_id`	string	`prod_456def`	Identifier of the associated product
`position`	string	`1`	Position of the product in the collection
`created_at`	string	`2023-06-20T15:30:00Z`	Timestamp when the collect was created
`updated_at`	string	`2023-06-21T09:15:00Z`	Timestamp when the collect was last updated

Error Response

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

API Structure Overview

200OK