Skip to main content
POST
Search your listings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A search query includes a free text query property, refinements in the form of facets, pagination controls and optional sorting.

query
string

One or more free text search terms

filters
object[]
facets
object

Facets to refine the search results. Values are case-sensitive unless noted otherwise.

from
number | null
default:0

Offset for pagination

size
number
default:25

Number of results to return

Required range: 1 <= x <= 50
sorting
object

Sort results by field and order

Response

Seller listings

Result of a listings search query

total
number
required

Total number of results

hits
object[]
required

List of listings

facets
object
required

Facets that can be applied to further refine the search results