Skip to main content
GET
Global search across Customers, Orders, and Products

Authorizations

Authorization
string
header
required

Sign in to the admin dashboard and use the resulting ID token for a store and operation you can access. The authenticated dashboard cookie is accepted when the Authorization header is absent. Missing or insufficient access returns 401.

Query Parameters

attributesToRetrieve
string

JSON-encoded option.

attributesToSearchOn
string

JSON-encoded option.

facets
string

JSON-encoded option.

filter
string

search filter expression, e.g. id=01KXQD8EACBDCEM5Y8HTJ3Q71T. Returns 400 if it references an attribute that is not filterable.

include_parent_product
boolean
index
enum<string>

Search index to query

Available options:
Customers,
Orders,
Products
limit
integer

Results per page. Values below 1 use 1; values above 500 return 400. Non-integer input returns 400.

Required range: 1 <= x <= 500
matchingStrategy
string
offset
integer
default:0

Search query string

showMatchesPosition
boolean
sort
string

JSON-encoded option.

Response

Success

success
boolean
required
message
string
required
content
object
required