Requires read_collection access scope. More access scope
The Get Collection Detail API retrieves detailed information about a specific collection by providing its unique identifier. The identifier must be a valid UUID to avoid errors.This API is especially useful for:
Fetch comprehensive details of a collection for display or management purposes.
Retrieve specific metadata and settings for a collection.
Object containing details of the collection image.
collection.image.src
string
//cdn.shoplazza.com/loading.png
Source URL of the collection image.
collection.image.width
integer
100
Width of the collection image in pixels.
collection.image.height
integer
100
Height of the collection image in pixels.
collection.image.alt
string
""
Alt text for the collection image.
collection.image.path
string
loading.png
File path of the collection image.
collection.seo_title
string
seo_title
SEO title of the collection.
collection.seo_description
string
Desc
SEO description of the collection.
collection.seo_keywords
string
test
SEO keywords associated with the collection.
collection.sort_order
string
title-asc
Merchandise sorting rules. Options include: manual (default), sales-desc, price-asc, price-desc, views-desc, vendor-asc, vendor-desc, created-desc, and more. (see Sort Order Options).
collection.created_at
string
2024-04-16T10:31:12Z
Timestamp when the collection was created.
collection.updated_at
string
2024-04-16T10:31:12Z
Timestamp when the collection was last updated.
Error Response
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
[ "Collection not found"]
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
404
Collection Not Found
The Collection ID provided in the request does not exist.
{ "errors": ["Collection not found"] }
422
Invalid or empty collection_id
missing required collection_id or collection_id with incorrect UUID types
{ "errors": [ "productId has an invalid UUID"]}
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
