Search the store
Matches orders (number, customer name or e-mail), customers (name,
e-mail, phone digits), products (title, slug, SKU), e-mail campaigns and
conversations, returning up to limit of each. Groups the caller has
no read permission for come back empty.
Authorization
bearer_auth Authorization: Bearer <token>. Either a session access token from POST /auth/login (refresh it with POST /auth/refresh) or a store API token (mobi_st_…). A store API token works only for the store it was issued in, and can do at most what its issuing user can there, narrowed to the scopes it was issued with.
In: header
Path Parameters
Store id
uuidQuery Parameters
Search text; at least 2 characters or every group comes back empty.
Hits per group, 1 to 20. Defaults to 5.
int641 <= value <= 20Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/search?q=string"{
"campaigns": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"status": "string",
"subject": "string"
}
],
"conversations": [
{
"channel": "string",
"email": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"preview": "string",
"status": "string"
}
],
"customers": [
{
"email": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"phone": "string",
"total_orders": 0,
"total_spent": 0
}
],
"orders": [
{
"created_at": "2019-08-24T14:15:22Z",
"customer_email": "string",
"customer_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"number": "string",
"status": "string",
"total_cents": 0
}
],
"products": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"image_url": "string",
"sku": "string",
"slug": "string",
"status": "string",
"title": "string"
}
]
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}