Public API v1

List a venue's orders

Orders only, newest first. A service request ("more napkins") has no money on it and does not appear here.

READ-ONLY, and it will stay that way. An order is created by the guest flow on the request origin, priced from the venue's own catalogue at submit time, and moved through its states by the staff standing in the room. There is no POST, PATCH or DELETE on this surface, because an API-created order has no scan, no signed cart and no table behind it, and an API-cancelled one would silently contradict a ticket already printed in the kitchen.

KEYSET PAGINATION, not offsets. cursor is the reference of the last order you saw; a cursor that names no order in this venue is a 400 invalid_cursor rather than page one, because answering page one would make a broken walk look like a complete one. Walk until nextCursor is null.

MONEY IS INTEGER MINOR UNITS in the currency beside it — 1250 is €12.50. There are no floats anywhere on this surface. Every amount was COPIED onto the order at submit time, so a later menu edit cannot restate an order this endpoint has already reported. totalMinor is null for a market-priced order, which is why analytics reports unpricedOrders separately.

note is the guest's own free text for the kitchen ("no peanuts"). It is included because it is already venue-visible content — the console's request view returns it and staff read it off the printed ticket — so withholding it here would leave an integration printing an incomplete ticket.

paidAt is the moment staff confirmed payment. It is a timestamp and never an amount held: Scanduro holds no funds.

get/api/v1/venues/{id}/orders

Request

  • Base URL: https://scanduro.com
  • URL: https://scanduro.com/api/v1/venues/{id}/orders
  • Auth: HTTP bearer

Query parameters

fromstring

Inclusive UTC day. A half-typed date is a 400, not an ignored filter.

tostring

Inclusive UTC day.

status'received' | 'accepted' | 'preparing' | 'ready' | 'served' | 'cancelled'
limitinteger
cursorstring

The reference of the last order on the previous page.

Response

One page of orders, newest first.

nextCursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.