Version: 202607
Get collection
GET/openapi/2026-07/collections/:id
Retrieves detailed information about a specific collection by providing its unique identifier.
Request
Path Parameters
id stringrequired
Collection ID. Must be a valid UUID
Responses
- 200
OK
- application/json
- Schema
- Example
Schema
- Array [
- Array [
- ]
- ]
codestring
error code
messagestring
error message
data object
collection object
Collection
idstring
Collection ID
titlestring
Title
descriptionstring
Description
handlestring
URL-friendly identifier (handle)
smartboolean
Smart
image object
Image
srcstring
The source URL of the image
widthint32
The width of the image in pixels
heightint32
The height of the image in pixels
altstring
Alt text for the image
seo_titlestring
SEO title
seo_keywordsstring[]
SEO keywords
seo_descriptionstring
SEO description
sort_orderstring
Sort order
created_atstring
Creation timestamp, in ISO-8601 format
updated_atstring
Last update timestamp, in ISO-8601 format
match_rules object
Smart collection match rules
disjunctiveboolean
Whether conditions are disjunctive (OR)
rule_modules object[]
List of rule modules
disjunctiveboolean
Whether conditions are disjunctive (OR)
rules object[]
List of rules in this module
columnstring
Column
relationstring
Relation
conditionstring
Condition
tagsstring[]
List of tags for the collection
product_countint64
Number of products in the collection
{
"code": "string",
"message": "string",
"data": {
"collection": {
"id": "string",
"title": "string",
"description": "string",
"handle": "string",
"smart": true,
"image": {
"src": "string",
"width": 0,
"height": 0,
"alt": "string"
},
"seo_title": "string",
"seo_keywords": [
"string"
],
"seo_description": "string",
"sort_order": "string",
"created_at": "string",
"updated_at": "string",
"match_rules": {
"disjunctive": true,
"rule_modules": [
{
"disjunctive": true,
"rules": [
{
"column": "string",
"relation": "string",
"condition": "string"
}
]
}
]
},
"tags": [
"string"
],
"product_count": 0
}
}
}