Skip to main content
GET
List Collections 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

Query Parameters

collection_type
enum<string> | null
Available options:
long_tail_collection,
campaign,
category,
smart_pick,
style,
brand,
look
parent_id
string | null
search
string | null
Maximum string length: 256
sort_by
enum<string>
default:updated_at_desc
Available options:
updated_at_desc,
updated_at_asc,
title_asc,
title_desc,
product_count_desc,
product_count_asc
limit
integer
default:50
Required range: 1 <= x <= 100
cursor
string | null
include_metrics
boolean
default:false
locale
string | null

Response

Successful Response

collections
CollectionSummary · object[]
required
next_cursor
string | null
has_more
boolean
default:false