POST
/
v3
/
search
/
results

Query Parameters

port
integer | null

Body

application/json
market
string
required
merchant
string
required
locale
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
limit
integer | null

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

Required range: 1 < x < 250
page
integer | null

Used for Page-based pagination. 1-based index

Required range: x > 1
hits_per_page
integer | null

Used for Page-based pagination. If using page-based pagination, this is a required field.

Required range: 1 < x < 200
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

Minimum length: 1
metadata
object | null

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

query
string | null

The search query.

Response

200 - application/json
n_hits
integer
required

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

search_request_id
string
required
displays
object[]
required

The search results.

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.

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.

Maximum length: 500
content_search_links
object[]

List of links to content pages that match the search query.

debug_info
any | null

Was this page helpful?

Get Products In ListingGet Suggestions