Listing (v3)
Get Listing Via External Id
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>
GET
/
v3
/
listings
/
external_id
/
{external_id}
Path Parameters
Query Parameters
Response
200 - application/json
Depict ID of the listing.
Available options:
long_tail_collection, campaign, category, smart_pick, style, brand, look Show or hide this listing in navigation breadcrumbs.
Show or hide this listing in quicklinks.
List of image URLs for the listing.
Ordered list of ancestors of the listing, useful for navigation breadcrumbs. The first element is the root listing.
Siblings of the listing, i.e. listings that share the same parent, INCLUDING the listing itself. Sortet by title.
Children of the listing, i.e. listings that have the listing as their parent. Sorted by title.
List of content blocks to be displayed on the listing page. If none no content blocks should be displayed.
ID of the listing in the merchant PIM, CMS or similar.
Was this page helpful?