Skip to main content

Tables

The Table entity represents a physical place within a location and/or area where customers are designated. Tables are mostly static, but expected to change if there are physical layout changes at a location. Tables may have multiple active orders and/or parties sitting at them at any one time.

Capabilities

In the Dojo EPOS Data API, capabilities represent specific actions that the POS system can perform. These capabilities are linked to corresponding API endpoints in the POS system. By defining these capabilities, the POS system communicates to Dojo which features are supported and accessible.

See Registering capabilities for how each capability is registered with Dojo.

Registering a capability: the heading for each capability below (for example SearchOrders, GetOrderById, CreateOrderLock, RecordOrderPaymentById) is the exact name value to send in the body of PUT /epos/integrations/rest or PUT /epos/integrations/ws. The version is sent alongside as a separate field ("version": "v1"); appending V1 to the heading gives you the wire-level method Dojo invokes after registration (for example RecordOrderPaymentByIdV1). See Registering capabilities for the full body schema.

For backwards compatibility, registration also accepts the four legacy names GetOrderBill, RecordOrderPayment, UpdatePartyById, and UpdateReservationById — they are equivalent to GetOrderBillById, RecordOrderPaymentById, UpdateParty, and UpdateReservation respectively. New integrations should prefer the wire-aligned form shown in the headings below.

SearchTables

Bookings
QR Pay

POST REST /v1/tables

REQUEST
RESPONSE
WS SearchTablesV1

This capability enables searching for Tables from the POS system.