GET
/
v3
/
listings
[
  {
    "listing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "listing_type": "long_tail_collection",
    "show_in_breadcrumbs": true,
    "show_in_quicklinks": true,
    "image_urls": [
      "<string>"
    ],
    "title": "<string>",
    "slug": "<string>",
    "children": [
      {
        "listing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "<string>",
        "listing_type": "long_tail_collection",
        "show_in_breadcrumbs": true,
        "show_in_quicklinks": true,
        "image_urls": [
          "<string>"
        ],
        "title": "<string>",
        "slug": "<string>",
        "children": [
          {
            "listing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "external_id": "<string>",
            "listing_type": "long_tail_collection",
            "show_in_breadcrumbs": true,
            "show_in_quicklinks": true,
            "image_urls": [
              "<string>"
            ],
            "title": "<string>",
            "slug": "<string>",
            "children": [
              {
                "listing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "external_id": "<string>",
                "listing_type": "long_tail_collection",
                "show_in_breadcrumbs": true,
                "show_in_quicklinks": true,
                "image_urls": [
                  "<string>"
                ],
                "title": "<string>",
                "slug": "<string>",
                "children": [
                  {
                    "listing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "external_id": "<string>",
                    "listing_type": "long_tail_collection",
                    "show_in_breadcrumbs": true,
                    "show_in_quicklinks": true,
                    "image_urls": [
                      "<string>"
                    ],
                    "title": "<string>",
                    "slug": "<string>",
                    "children": [
                      {
                        "listing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                        "external_id": "<string>",
                        "listing_type": "long_tail_collection",
                        "show_in_breadcrumbs": true,
                        "show_in_quicklinks": true,
                        "image_urls": [
                          "<string>"
                        ],
                        "title": "<string>",
                        "slug": "<string>",
                        "children": [
                          "<any>"
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
]

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

Was this page helpful?

Query SuggestionsGet Listing Via External Id