The till shift that is open now
- Credentials, one of
- Station token
- OAuth access token
- Scopes
orders:read
{ register }: the open shift with its float, or null when none is open. A client reads it to know whether to open one, and to get the id it closes. One shift is open at a time per store.
Access: OAuth scope orders:read; not write-gated.
AuthorizationBearer <token>It may call only the operations whose x-stations lists its kind, on its own store, and acts through the access of the owner or admin who paired it. Unpairing it, or that person leaving the business, ends it (401 station_revoked).
storeId*stringA store the person can reach. Any other id answers 404, never 403.
OK
application/json- response
data*curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/registers/current' \ -H 'Authorization: Bearer <access_token>'{ "data": { "register": null }}The station says it is alive POST
Sent about once a minute: the app version and how many writes the device is holding, for the owner's list of stations. No `Idempotency-Key`: a repeat only says "still here" again. Access: a station's token only.
Open the register with a cash float POST
Starts a till shift with `floatMinor` (cents) in the drawer. One shift is open at a time: opening another is 422 `validation_error` ("The register is already open."). Sales are not tagged with a register: the shift is the window of time since it opened, and every counter sale in it belongs to it. Cash handling is accountable: the shift records who opened it, and the call joins the Activity log. Without PINs it is the signed-in person. Access: OAuth scope `orders:write`; write-gated by the subscription. Any role that can sell, as in the console's Sell page.