Listing (v3)

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>

GET

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": [
      {}
    ]
  }
]

Authorizations

api_key

string

query

required

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

Response

200

application/json

Successful Response

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

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

children

object[]

required

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

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.image_urls

string[]

required

List of image URLs for the listing.

children.title

string

required

children.children

object[]

required

children.children.listing_id

string

required

Depict ID of the listing.

children.children.listing_type

enum<string>

required

Available options:

long_tail_collection,

campaign,

category,

smart_pick,

style,

brand

children.children.show_in_breadcrumbs

boolean

required

Show or hide this listing in navigation breadcrumbs.

children.children.show_in_quicklinks

boolean

required

Show or hide this listing in quicklinks.

children.children.image_urls

string[]

required

List of image URLs for the listing.

children.children.title

string

required

children.children.children

object[]

required

children.children.external_id

string | null

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

children.children.slug

string | null

children.external_id

string | null

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

children.slug

string | null

external_id

string | null

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

slug

string | null

Was this page helpful?

Query Suggestions Get Listing Via External Id

[
  {
    "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": [
      {}
    ]
  }
]

Glossary

Shopify app

Data ingestion

Search

Product Listing Pages

Product Listing Pages and Search

Looks

Recommendations SDK

Tracking Product Interactions

HTTP API

Get Listings

Authorizations

Query Parameters

Response