Skip to main content
GET
Get Listings

Authorizations

api_key
string
query
required

Query Parameters

merchant
string
required
market
string
required
locale
string
required
types
enum<string>[]
Available options:
long_tail_collection,
campaign,
category,
smart_pick,
style,
brand

Response

Successful Response

listing_id
string<uuid>
required

Depict ID of the listing.

listing_type
enum<string>
required
Available options:
long_tail_collection,
campaign,
category,
smart_pick,
style,
brand
show_in_breadcrumbs
boolean
required

Show or hide this listing in navigation breadcrumbs.

Show or hide this listing in quicklinks.

image_urls
string[]
required

List of image URLs for the listing.

title
string
required
children
Children · array
required
external_id
string | null

ID of the listing in the merchant PIM, CMS or similar.

slug
string | null