Skip to main content
GET
Search the storefront the rep may share

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company.

Query Parameters

q
string

Search text, matched within words of titles, descriptions, slugs and translations.

Required string length: 2 - 200
filter[kind]
string

Comma-separated storefront kinds to search, such as products,media,sites; every kind by default. Required without q.

Maximum string length: 200
page[cursor]
string

Opaque cursor from meta.pagination.next_cursor, valid for one hour with the same q and kinds.

page[limit]
integer
default:25

Maximum number of hits returned.

Required range: 1 <= x <= 50

Response

A page of hits.

One page of search results.

status
integer
required

HTTP response status.

data
object[]
required

Hits, best match first.

meta
object
required

Envelope metadata with per-kind facets and the search cursor.