🔒
Requires read_collection access scope. More access scope

The Get Collect List API retrieves a list of collect objects, representing the associations between products and collections. This enables users to efficiently manage and display product categorization within collections.This API is especially useful for:

1.Fetching all products within a specific collection.

2.Retrieving collections a specific product belongs to.

3.Managing inventory or marketing strategies based on product categorization.

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`
`collection_id`	string	No	UUID of the collection to filter collects	`coll_789abc`
`product_id`	string	No	UUID of the product to filter collects	`prod_456def`

Important Note on Query Parameters

Both collection_id and product_id are optional query parameters. It is essential to clarify the query logic when:

Both Parameters Are Provided:
- The API will prioritize filtering the results based on both collection_id and product_id. This means that only products belonging to the specified collection and matching the given product ID will be returned.
Neither Parameter Is Provided:
- If neither collection_id nor product_id is provided, the API will return results based on the default query logic (e.g., all products or collections depending on the endpoint's default behavior). Ensure developers understand this fallback behavior to avoid confusion.
Only One Parameter Is Provided:
- If only collection_id is provided, the API will return all products within the specified collection.
- If only product_id is provided, the API will return details or results specific to that 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.collects`	array of objects	`[ {...}, {...} ]`	List of collect objects
`data.cursor`	string	`cursor_123456`	Cursor for pagination
`data.has_more`	boolean	`true`	Indicates if there are more results available

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