Skip to main content
GET
List in-person sales
Only records with source pos are returned, so this route cannot be used to read online orders. Use from and to for the date range, paymentMethod to split cash, card, transfer and other, and page/limit to paginate.

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).

paymentMethod
enum<string>
Available options:
cash,
card,
transfer,
other
status
enum<string>
Available options:
pending,
processing,
paid,
cancelled,
refunded
page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100

Response

The matching sales and pagination metadata.

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