🔒
Requires read_collection access scope. More access scope

The Get Collect Detail API retrieves detailed information about a specific collect by its unique identifier (id). This enables users to access and manage relationships between products and collections efficiently.This API is especially useful for:

Fetching specific collect details for display or management purposes.
Validating the relationship between a product and a collection.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Example	Description
id	string	Yes	`a1b2c3d4-e5f6-7890-abcd-1234567890ef`	The unique identifier of the collect. Must be a valid UUID.

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	`{...}`	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