Error
A valid request URL is required to generate request examples{
"collection_id": "<string>",
"title": "<string>",
"description": "<string>",
"handle": "<string>",
"image_urls": [
"<string>"
],
"shopify_sort_order": "ALPHA_ASC",
"sort_order": "ALPHA_ASC",
"has_depict_configuration": true,
"sync_back_to_shopify": true,
"unpin_oos": true,
"shopify_updated_at": "2023-11-07T05:31:56Z",
"use_collection_specific_boost_bury": true,
"main_version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pinned_main_product_ids": [
"<string>"
],
"collection_boost_rules": [
{
"strength": 123,
"badge": "on_sale",
"type": "badge"
}
],
"version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Get Collection
GET
/
collections
/
{collection_id}
Error
A valid request URL is required to generate request examples{
"collection_id": "<string>",
"title": "<string>",
"description": "<string>",
"handle": "<string>",
"image_urls": [
"<string>"
],
"shopify_sort_order": "ALPHA_ASC",
"sort_order": "ALPHA_ASC",
"has_depict_configuration": true,
"sync_back_to_shopify": true,
"unpin_oos": true,
"shopify_updated_at": "2023-11-07T05:31:56Z",
"use_collection_specific_boost_bury": true,
"main_version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pinned_main_product_ids": [
"<string>"
],
"collection_boost_rules": [
{
"strength": 123,
"badge": "on_sale",
"type": "badge"
}
],
"version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Response
Successful Response
Available options:
ALPHA_ASC, ALPHA_DESC, BEST_SELLING, CREATED, CREATED_DESC, MANUAL, PRICE_ASC, PRICE_DESC Available options:
ALPHA_ASC, ALPHA_DESC, BEST_SELLING, TRENDING, CREATED, CREATED_DESC, PRICE_ASC, PRICE_DESC, STOCK_DESC, CLICKS_DESC, MANUAL 'Depict configuration' meaning sort order, pinned products, content blocks, etc.
collection_boost_rules
(BadgeBoostBuryRule · object | CollectionBoostBuryRule · object | TagBoostBuryRule · object)[]
required
- BadgeBoostBuryRule
- CollectionBoostBuryRule
- TagBoostBuryRule
Show child attributes
Show child attributes
The last time the Depict configuration for this collection was updated
Was this page helpful?

