🔒
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.
📘
| Field | Type | Required | Example | Description |
|---|
| id | string | Yes | a60fe556-43ad-4e07-9125-507ac1bf71f7 | Unique identifier of the collection. Must be a valid UUID. |
📘
| Parameter | Type | Example | Description |
|---|
code | string | 200 | Error code (200 indicates success) |
message | string | Success | Error message |
data | object | {...} | Contains the collects data |
data.collection | object | {...} | collection object |
| Parameter | Type | Example | Description |
|---|
id | string | coll_123456 | Unique identifier of the collection |
title | string | Summer Collection | Name of the collection |
description | string | Our best summer products | Description of the collection |
handle | string | summer-collection | URL-friendly identifier |
smart | boolean | false | Whether this is a smart collection (dynamically filtered) |
image | object | {...} | Image details for the collection |
seo_title | string | Summer Collection 2023 | SEO-optimized title |
seo_keywords | array of strings | ["summer", "2023", "sale"] | SEO keywords for the collection |
seo_description | string | Discount on summer products | SEO description |
sort_order | string | manual | How products are sorted in this collection |
created_at | string | 2023-06-20T15:30:00Z | Timestamp when the collection was created |
updated_at | string | 2023-06-21T09:15:00Z | Timestamp when the collection was last updated |
| Parameter | Type | Example | Description |
|---|
src | string | https://example.com/image.jpg | URL of the collection image |
width | int32 | 800 | Image width in pixels |
height | int32 | 600 | Image height in pixels |
alt | string | Summer products | Alternative text for the image |
| Field | Type | Example | Description |
|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |
