ShopEazydevelopers
API referenceMerchant API BetaPoint Of Sale

Till sales waiting to be paid

Beta
Credentials, one of
  • Station token
  • OAuth access token
Scopes
orders:read
GET
/v1/merchant/stores/{storeId}/till/waiting

Sales kept with keepScanToPay and not paid yet, oldest first: who still owes the merchant, and how much. A sale leaves the list once its money lands (from the link, or settleTillWaiting) or it is cancelled. Read from the server, so every till shows the same list.

Access: OAuth scope orders:read; not write-gated.

Authorization

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

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

Query Parameters

cursor?string

The nextCursor of the previous page, unchanged. A cursor that is not one we gave you is 400 bad_request.

limit?integer

Page size: default 100, at most 200 (more is 200; a missing or unusable value is 100).

Range1 <= value <= 200
Default100

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/till/waiting' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "items": [      {        "orderId": "string",        "number": "string",        "customer": "string",        "phone": "string",        "email": "string",        "totalMinor": 0,        "dueMinor": 0,        "placedAt": 0      }    ],    "nextCursor": "string"  }}