v2
latestOpenAPI 3.1.02026-08-05245967.6 KBSearch
V3
Get Results
post/v3/search/results
Query parameters
portinteger nullable
Request body
cursorstring nullable
Used for cursor-based pagination. Set it to the cursor from the last response. If not set, will return the first results.
limitinteger nullable
Used for cursor-based pagination. Maximum number of results per response.
pageinteger nullable
Used for Page-based pagination. 1-based index
hits_per_pageinteger nullable
Used for Page-based pagination. If using page-based pagination, this is a required field.
marketstring required
session_idstring nullable
Session identifier
metadataobject nullable
Metadata that can be used to modify the behaviour of the search.
merchantstring required
localestring required
querystring nullable
The search query.
Response
Successful Response
n_hitsinteger required
Total number of results for this query. Not necessarily exact.
search_request_idstring required
cursorstring nullable
Cursor that can be used in the next request to get subsequent results. If this is not set, there are no more results.
displaysobject[] required
The search results.
{"stackTrail":"components:schemas:SearchResponse:properties:debug_info:anyOf","oasType":"schema","type":"unknown","title":"Debug Info","nullable":true}