Get Listings

Returns the full listing hierarchy. Useful for navigation menus, listing selection dialogs, etc. Can optionally be filtered to only show listings of certain types. Example response: <pre> [ { "listing_id": "f346c448-4cf1-4373-9156-49e222cd6db0", "listing_type": "smart_pick", "show_in_breadcrumbs": false, "show_in_quicklinks": false, "title": "Trending", "children": [] }, { "listing_id": "2efca23d-f077-4477-8830-cc7143c49173", "external_id": "1001", "listing_type": "category", "show_in_breadcrumbs": true, "show_in_quicklinks": true, "title": "Clothes", "slug": "mens-cloths", "children": [ { "listing_id": "06b234cf-ce21-4252-90e6-db47246b1d98", "external_id": "1011", "listing_type": "category", "show_in_breadcrumbs": true, "show_in_quicklinks": true, "title": "Suits", "slug": "mens-suits", "children": [] }, { "listing_id": "1e648857-4aad-4606-9e7a-5290cb3576e5", "external_id": "1012", "listing_type": "category", "show_in_breadcrumbs": true, "show_in_quicklinks": true, "title": "Shirts", "slug": "mens-shirts", "children": [] } ] } ] </pre>

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,

look

Response

200 - application/json

listing_id

string

required

Depict ID of the listing.

external_id

string | null

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

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_in_quicklinks

boolean

required

Show or hide this listing in quicklinks.

image_urls

string[]

required

List of image URLs for the listing.

title

string

required

slug

string | null

children

object[]

required

Show child attributes