Search API Overview
Product listing pages
Query Suggestions
Endpoints
- Listing (v3)
- Search (v3)
- Recommendations (v3)
- Other (v3)
- Listing (v2)
- Search (v2)
- Recommendations (v2)
- Events (v2)
- Catalog Push API (v0)

Search (v3)

Get Related Recommendations

Returns recommendations for products related to the search query. Note that this endpoint takes the same request body as the /v3/search/results endpoint, excluding the pagination parameters. It should be called once the user has exhausted the search results for their query and the recommended products are typically shown below the search results.

POST

port

integer

port

integer

object

market

string

market

Required

string

filters

array

filters

array

List of filters to apply to the results.

sort

object

sort

object

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.

field

string

field

Required

string

The field to sort by.

order

enum<string>

order

Required

enum<string>

The order to sort by.

Query Parameters

port

integer | null

Body

application/json

market

string

required

merchant

string

required

locale

string

required

filters

object[] | null

List of filters to apply to the results.

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

filters.meta.type

enum<string>

required

Available options:

range

filters.meta.min

number

required

The minimum value that can be selected in the range.

filters.meta.max

number

required

The maximum value that can be selected in the range.

filters.meta.group_title

string | null

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

filters.meta.group_expanded

boolean | null

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

filters.meta.unit

string | null

The unit of the range values.

filters.meta.currency

string | null

The currency of the range values.

filters.id

string | null

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

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.

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.

sort.meta.title

string

required

sort.meta.values

enum<string>[]

Selectable values

Available options:

asc,

desc

sort.meta.names

string[] | null

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

session_id

string | null

Session identifier

Minimum length: 1

metadata

object | null

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

metadata.{key}

string

query

string | null

The search query.

Response

200 - application/json

displays

object[]

required

error

string | null

variant

integer | null

experiment_id

string | null

Was this page helpful?

Get Suggestions Recommendations

website linkedin