Skip to main content
GET
Get Collection Endpoint

Authorizations

Authorization
string
header
required

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

Path Parameters

merchant_id
string
required
collection_id
string<uuid>
required

Query Parameters

market
string | null
locale
string | null
market_group_id
string | null

Response

Successful Response

collection_id
string<uuid>
required
collection_type
enum<string>
required
Available options:
long_tail_collection,
campaign,
category,
smart_pick,
style,
brand,
look
externally_owned
boolean
required
title
string
required
uri
string
required
permissions
CollectionPermissions · object
required
market_context
CollectionMarketContext · object
required
parent_id
string<uuid> | null
localized_titles
Localized Titles · object
n_main_products
integer | null
manual_product_count
integer | null
image_urls
string[]
cover_image_url
string | null
content_blocks
ContentBlock · object[]
chunk_type
enum<string> | null
Available options:
similar,
complementary
ranking_type
enum<string>
default:top
Available options:
top,
similar,
complementary
show_in_filter
boolean
default:true
show_in_search_suggestions
boolean
default:false
display_breadcrumb
boolean
default:true
children
CollectionChild · object[]