Get Products In Listing, Via External Id

Returns products in a listing, optionally filtered. Used for product listing pages. Example response: <pre> { "displays": [ { "variant_index": 1, "variant_displays": [ { "in_stock": true, "original_price": 1999, "sale_price": 1999, "title": "Short Sleeve Polo Shirt", "size": "210", "product_id": "1500-10-210", "image_urls": [ "https://example.cdn.com/1.jpg", "https://example.cdn.com/2.jpg", ] }, { "in_stock": true, "original_price": 1999, "sale_price": 1999, "title": "Short Sleeve Polo Shirt", "size": "200", "product_id": "1500-10-200", "image_urls": [ "https://example.cdn.com/1.jpg", "https://example.cdn.com/2.jpg", ] }, ], "product_listing_result_id": "50877e3b-26a4-4ea7-a6e1-1a7696f76f66" }, { "variant_index": 0, "variant_displays": [ { "in_stock": false, "original_price": 1400, "sale_price": 1200, "title": "Collar Polo Shirt", "size": "210", "product_id": "1600-10-210", "image_urls": [ "https://example.cdn.com/10.jpg", "https://example.cdn.com/11.jpg", ] } ], "product_listing_result_id": "671740b5-6828-41fc-8a3f-2869993d000c" } ], "n_hits": 2, "sorts": [ { "field": "_relevance", "order": "desc", "meta": { "title": "Recommended", "values": [ "desc" ], "names": [ "Recommended" ] } }, { "field": "title", "order": "asc", "meta": { "title": "Alphabetical, A-Z", "values": [ "asc" ], "names": [ "Alphabetical, A-Z" ] } }, { "field": "title", "order": "desc", "meta": { "title": "Alphabetical, Z-A", "values": [ "desc" ], "names": [ "Alphabetical, Z-A" ] } }, { "field": "sale_price", "order": "asc", "meta": { "title": "Price, low to high", "values": [ "asc" ], "names": [ "Price, low to high" ] } }, { "field": "sale_price", "order": "desc", "meta": { "title": "Price, high to low", "values": [ "desc" ], "names": [ "Price, high to low" ] } } ], "filters": [ { "field": "sale_price", "op": "inrange", "data": [ 1200, 1999 ], "meta": { "group_title": "Price", "type": "range", "min": 1200, "max": 1999, "currency": "SEK" }, "id": "price0" }, { "field": "size_name", "op": "in", "meta": { "group_title": "Size", "type": "checkbox-grid", "values": [ "200", "210", ], "counts": [ 1, 2 ] }, "id": "size1" } ], "product_listing_request_id": "4bf1eeb0-0b0a-4b0e-9b0a-0a0b0a0b0a0b", "cursor": "eyJjIjogMjAsICJyIjogMjB9" } </pre>

Assistant

Responses are generated using AI and may contain mistakes.

Authorizations

api_key · string · query · required

Headers

x-use-db-display-store · boolean · default: false

Path Parameters

external_id · string | null · required

Query Parameters

listing_id · string | null

Body

application/json

Response

200

application/json

Successful Response

The response is of type object.