POST
/
v2
/
product-listing
{
  "displays": [
    {}
  ],
  "n_hits": 123,
  "sorts": [
    {
      "field": "<string>",
      "order": "asc",
      "meta": {
        "title": "<string>",
        "values": [
          "asc"
        ],
        "names": [
          "<string>"
        ]
      }
    }
  ],
  "filters": [
    {
      "field": "<string>",
      "op": "eq",
      "data": "true",
      "meta": {
        "group_title": "<string>",
        "group_expanded": true,
        "type": "<any>",
        "min": 123,
        "max": 123,
        "unit": "<string>",
        "currency": "<string>"
      },
      "id": "<string>"
    }
  ],
  "product_listing_request_id": "<string>",
  "cursor": "<string>",
  "breadcrumb": [
    {
      "category_id": "<string>",
      "title": "<string>",
      "page_url": "<string>",
      "query_id": "<string>",
      "uri": "<string>",
      "category_type": "TAG"
    }
  ],
  "quick_links": [
    {
      "category_id": "<string>",
      "title": "<string>",
      "page_url": "<string>",
      "query_id": "<string>",
      "uri": "<string>",
      "category_type": "TAG"
    }
  ],
  "metadata": {
    "title": "<string>",
    "description": "<string>",
    "replace_meta_tags": true
  }
}

Authorizations

api_key
string
queryrequired

Headers

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

Body

application/json
cursor
string | null

Used for cursor-based pagination. Set it to the cursor from the last response. If not set, will return the first results.

limit
integer | null

Maximum number of results per response.

market
string
required
filters
object[] | null

List of filters to apply to the results.

sort
object | null

Specifies the sorting method. By default, the results are ordered by relevance. To find the possible values for this field, query the endpoint and look at the sorts field.

session_id
string | null

Session identifier

metadata
object | null

Metadata that can be used to modify the behaviour of the search.

tenant
string
required
locale
string | null

The locale to use for the search. If not set, the default locale will be used.

user_id
string | null

User identifier

dsid
string | null

Populated for integrations performed by Depict.ai only. Depict.ai Session Id

query_id
string
required

ID of the page to get products for. This is typically the slug, for example hoodies-and-sweaters.

type
enum<string> | null

The type of query. If not set the endpoint will look up query id in the following type order: collections, categories.

Available options:
category,
collection,
scollection

Response

200 - application/json
displays
object[]
required

The products to be shown on the product listing page.

n_hits
integer
required

Total number of results for this query. Not necessarily exact.

sorts
object[] | null

Available methods for sorting the response. Any element from this list can be sent as sort in subsequent requests.

filters
object[] | null

Available filters that can be used for filtering in the subsequent request.

product_listing_request_id
string
required
cursor
string | null

Cursor that can be used in the next request to get subsequent results. If this is not set, there are no more results.

breadcrumb
object[] | null

Breadcrumb for the current page. Ordered from less to more specific, where the last element is the current page.

quick_links
object[] | null

List of pages that can be used as quick links. Will return child pages if they exist, otherwise sibling pages.

metadata
object | null

Metadata about the PLP requested, for example Collection/Category title, description, etc.