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.
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "ProductId is required"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
Array
"store is not active"
Indicates an error encountered during the process.
Error Details
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
422
Invalid or empty product_id
missing required product_id or product_id with incorrect UUID types
{ "errors": [ "productId has an invalid UUID"]}
product_id is already linked to the collection.
Product is already included in current collection.
{ "errors": ["Product is already included in current collection."] }
Product not found
The product ID provided in the request does not exist.
{ "errors": ["Product not found."] }
404
Record Not Found
The database query for retrieving the collect returned no result.
{ "errors": ["Record not found"] }
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
