Skip to main content
GET
Get Listing

Path Parameters

listing_id
string<uuid> | null
required

Query Parameters

merchant
string
required
market
string
required
locale
string
required
session_id
string
default:""
external_id
string | null

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,
look
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
ancestors
ProductListing · object[]
required

Ordered list of ancestors of the listing, useful for navigation breadcrumbs.

siblings
ProductListing · object[]
required

Siblings of the listing, i.e. listings that share the same parent, INCLUDING the listing itself.

children
ProductListing · object[]
required

Children of the listing, i.e. listings that have the listing as their parent.

content_blocks
ContentBlock · object[]
required

List of content blocks to be displayed on the listing page.

external_id
string | null

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

slug
string | null