Get Products

Query Parameters

port

integer | null

Body

application/json

market

string

required

query_id

string

required

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

Minimum length: 1

tenant

string

required

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.

Maximum length: 500

dsid

string | null

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

Minimum length: 1

filters

object[] | null

List of filters to apply to the results.

Show child attributes

filters.field

string

required

The field to filter by.

filters.op

enum<string>

required

The operation used for filtering. The filtering should be read as field op data, for example brand in ["Nike", "Adidas"].

Available options:

eq,

neq,

in,

nin,

leq,

geq,

inrange

filters.data

Data for the filter.

Available options:

true,

false

filters.id

string | null

ID of the filter. If multiple filters share the same ID, they should be grouped together in the UI.

filters.meta

object | null

Metadata about the filter that can be used for rendering. For example, this could contain the possible values to filter by and their counts in the results.

• Meta
• Meta
• Meta

Show child attributes

filters.meta.max

number

required

The maximum value that can be selected in the range.

filters.meta.min

number

required

The minimum value that can be selected in the range.

filters.meta.type

enum<string>

required

Available options:

range

filters.meta.currency

string | null

The currency of the range values.

filters.meta.group_expanded

boolean | null

Whether the filter group should be expanded by default or not.

filters.meta.group_title

string | null

Title of the group, where a group consists of all the filters that share an ID.

filters.meta.unit

string | null

The unit of the range values.

limit

integer | null

Used for cursor-based pagination. Maximum number of results per response.

Required range: 1 < x < 250

locale

string | null

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

metadata

object | null

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

Show child attributes

metadata.{key}

string

session_id

string | null

Session identifier

Minimum length: 1

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.

Show child attributes

sort.field

string

required

The field to sort by.

sort.order

enum<string>

required

The order to sort by.

Available options:

asc,

desc

sort.meta

object | null

Metadata about the sort that can be used for rendering.

Show child attributes

sort.meta.title

string

required

sort.meta.names

string[] | null

Names for orders (this is what you should display in the UI, not values)

sort.meta.values

enum<string>[]

Selectable values

Available options:

asc,

desc

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

user_id

string | null

User identifier

Minimum length: 1

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.

product_listing_request_id

string

required

breadcrumb

object[] | null

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

Show child attributes

breadcrumb.category_id

string

required

Unique identifier of the category.

breadcrumb.title

string

required

The title of the category

breadcrumb.category_type

enum<string>

default:

CATEGORY

The type of category, for example CAMPAIGN, TAG, or CATEGORY

Available options:

TAG,

CATEGORY,

TENANT_CATEGORY,

TENANT_SECONDARY_CATEGORY,

CAMPAIGN,

BRAND

breadcrumb.page_url

string | null

The full URL to the category page

breadcrumb.query_id

string | null

Optionally a unique query ID for the category

breadcrumb.uri

string | null

Optionally a unique URI for the category, for example men/shoes

cursor

string | null

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

Maximum length: 500

filters

object[] | null

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

Show child attributes

filters.field

string

required

The field to filter by.

filters.op

enum<string>

required

The operation used for filtering. The filtering should be read as field op data, for example brand in ["Nike", "Adidas"].

Available options:

eq,

neq,

in,

nin,

leq,

geq,

inrange

filters.data

Data for the filter.

Available options:

true,

false

filters.id

string | null

ID of the filter. If multiple filters share the same ID, they should be grouped together in the UI.

filters.meta

object | null

Metadata about the filter that can be used for rendering. For example, this could contain the possible values to filter by and their counts in the results.

• Meta
• Meta
• Meta

Show child attributes

filters.meta.max

number

required

The maximum value that can be selected in the range.

filters.meta.min

number

required

The minimum value that can be selected in the range.

filters.meta.type

enum<string>

required

Available options:

range

filters.meta.currency

string | null

The currency of the range values.

filters.meta.group_expanded

boolean | null

Whether the filter group should be expanded by default or not.

filters.meta.group_title

string | null

Title of the group, where a group consists of all the filters that share an ID.

filters.meta.unit

string | null

The unit of the range values.

metadata

object | null

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

Show child attributes

metadata.title

string

required

metadata.description

string | null

metadata.replace_meta_tags

boolean

default:

false

Whether to replace the page meta tags, e.g., title and description, with the ones from the collection.

quick_links

object[] | null

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

Show child attributes

quick_links.category_id

string

required

Unique identifier of the category.

quick_links.title

string

required

The title of the category

quick_links.category_type

enum<string>

default:

CATEGORY

The type of category, for example CAMPAIGN, TAG, or CATEGORY

Available options:

TAG,

CATEGORY,

TENANT_CATEGORY,

TENANT_SECONDARY_CATEGORY,

CAMPAIGN,

BRAND

quick_links.page_url

string | null

The full URL to the category page

quick_links.query_id

string | null

Optionally a unique query ID for the category

quick_links.uri

string | null

Optionally a unique URI for the category, for example men/shoes

sorts

object[] | null

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

Show child attributes

sorts.field

string

required

The field to sort by.

sorts.order

enum<string>

required

The order to sort by.

Available options:

asc,

desc

sorts.meta

object | null

Metadata about the sort that can be used for rendering.

Show child attributes

sorts.meta.title

string

required

sorts.meta.names

string[] | null

Names for orders (this is what you should display in the UI, not values)

sorts.meta.values

enum<string>[]

Selectable values

Available options:

asc,

desc