Skip to main content
GET
Totals for a date range
Every payment method is present in byPaymentMethod even when it had no sales, so a till UI can render its four buckets without filling gaps itself.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side, so never send a shop id.

Query Parameters

from
string<date-time>

Inclusive lower bound on the sale date (ISO 8601).

to
string<date-time>

Inclusive upper bound on the sale date (ISO 8601).

Response

The totals.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object

Totals for in-person sales in a date range, plus the same figures split by payment method. Every method is present even when it had no sales.