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.
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
[ "collect_id has an invalid UUID"]
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 collect_id
missing required collect_id or collect_id with incorrect UUID types
{ "errors": [ "collect_id has an invalid UUID"]}
Collect not found
The Collect ID provided in the request does not exist.
{ "errors": ["Record not found"] }
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
