ShopEazydevelopers
API referenceMerchant API BetaStations

The calling station

Beta
Credentials
  • Station token
GET
/v1/merchant/station

What the calling station is: its kind, store, name and (for a door) its event. A station reads this when it starts, to open straight into its job.

Access: a station's token only.

Authorization

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

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/station' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "id": "string",    "storeId": "string",    "kind": "till",    "name": "string",    "eventItemId": "string"  }}

Change the home hero in the design draft PUT

The big banner at the top of the home page: headline, the line under it, button words and photo (one the business stored itself). Only what is sent changes. Lands in the draft. Access: OAuth scope `design:write`; owner/admin only; write-gated by the subscription.

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.