Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

collection_id
string
required

Query Parameters

version
string<uuid> | null
merchant_id
string
required

Response

Successful Response

collection_id
string
required
title
string
required
description
string
required
handle
string
required
image_urls
string[]
required
shopify_sort_order
enum<string>
required
Available options:
ALPHA_ASC,
ALPHA_DESC,
BEST_SELLING,
CREATED,
CREATED_DESC,
MANUAL,
PRICE_ASC,
PRICE_DESC
sort_order
enum<string>
required
Available options:
ALPHA_ASC,
ALPHA_DESC,
BEST_SELLING,
TRENDING,
CREATED,
CREATED_DESC,
PRICE_ASC,
PRICE_DESC,
STOCK_DESC,
CLICKS_DESC,
MANUAL
has_depict_configuration
boolean
required

'Depict configuration' meaning sort order, pinned products, content blocks, etc.

sync_back_to_shopify
boolean
required
unpin_oos
boolean
required
shopify_updated_at
string<date-time>
required
use_collection_specific_boost_bury
boolean
required
main_version
string<uuid> | null
required
pinned_main_product_ids
string[]
required
collection_boost_rules
(BadgeBoostBuryRule · object | CollectionBoostBuryRule · object | TagBoostBuryRule · object)[]
required
version
string<uuid> | null
required
updated_at
string<date-time> | null

The last time the Depict configuration for this collection was updated