Get Listing

Returns a single listing, including its ancestors, siblings and children. Listings can be queried by either their Depict ID, or "external" ID, which is the ID used by the merchant's system (ie Shopify, Centra, WooCommerce, etc) to refer to the listing. Useful for showing breadcrumbs and other navigation elements while showing a product listing page. Example response: <pre> { "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", "ancestors": [ { "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" } ], "siblings": [ { "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>

Path Parameters

listing_id

string | null

required

Query Parameters

merchant

string

required

market

string

required

locale

string

required

external_id

string | null

session_id

string

default:

Response

200 - application/json

ancestors

object[]

required

Ordered list of ancestors of the listing, useful for navigation breadcrumbs. The first element is the root listing.

Show child attributes

ancestors.image_urls

string[]

required

List of image URLs for the listing.

ancestors.listing_id

string

required

Depict ID of the listing.

ancestors.listing_type

enum<string>

required

Available options:

long_tail_collection,

campaign,

category,

smart_pick,

style,

brand,

look

ancestors.show_in_breadcrumbs

boolean

required

Show or hide this listing in navigation breadcrumbs.

ancestors.show_in_quicklinks

boolean

required

Show or hide this listing in quicklinks.

ancestors.title

string

required

ancestors.external_id

string | null

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

ancestors.slug

string | null

children

object[]

required

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

Show child attributes

children.image_urls

string[]

required

List of image URLs for the listing.

children.listing_id

string

required

Depict ID of the listing.

children.listing_type

enum<string>

required

Available options:

long_tail_collection,

campaign,

category,

smart_pick,

style,

brand,

look

children.show_in_breadcrumbs

boolean

required

Show or hide this listing in navigation breadcrumbs.

children.show_in_quicklinks

boolean

required

Show or hide this listing in quicklinks.

children.title

string

required

children.external_id

string | null

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

children.slug

string | null

content_blocks

object[]

required

List of content blocks to be displayed on the listing page. If none no content blocks should be displayed.

Show child attributes

content_blocks.content

object

required

• Content
• Content

Show child attributes

content_blocks.content.link

string | null

required

content_blocks.content.url

string

required

content_blocks.content.type

enum<string>

default:

image

Available options:

image

content_blocks.position

enum<string>

required

Available options:

left,

right,

center

content_blocks.row

integer

required

content_blocks.span_columns

integer

required

content_blocks.span_rows

integer

required

image_urls

string[]

required

List of image URLs for the listing.

listing_id

string

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_in_quicklinks

boolean

required

Show or hide this listing in quicklinks.

siblings

object[]

required

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

Show child attributes

siblings.image_urls

string[]

required

List of image URLs for the listing.

siblings.listing_id

string

required

Depict ID of the listing.

siblings.listing_type

enum<string>

required

Available options:

long_tail_collection,

campaign,

category,

smart_pick,

style,

brand,

look

siblings.show_in_breadcrumbs

boolean

required

Show or hide this listing in navigation breadcrumbs.

siblings.show_in_quicklinks

boolean

required

Show or hide this listing in quicklinks.

siblings.title

string

required

siblings.external_id

string | null

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

siblings.slug

string | null

title

string

required

external_id

string | null

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

slug

string | null