Reservations
The Reservation entity represents an upcoming party or booking. Reservations may be created, updated and deleted by Dojo products. Once a reservation has been seated within the venue, it becomes a party.
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.
CreateReservation
This capability allows for the creation of a new reservation within the POS system. This enables the creation of bookings on the POS by Dojo products.
GetReservationById
GET REST /v1/reservations/{reservationId}
This capability allows Dojo to retrieve up-to-date information from the POS about a specific reservation such as the start-time, end-time and any booked table IDs.
UpdateReservation
PUT REST /v1/reservations/{reservationId}
This capability allows Dojo to update reservations on the POS. For example, this could be changes to the reservation's covers, time-slot or table IDs.
DeleteReservationById
DELETE REST /v1/reservations/{reservationId}
This capability allows Dojos to delete a specific reservation by using the reservation Id.
SearchReservations
POST REST /v1/reservations/search
This capability allows Dojo to retrieve reservations from a POS and can include filters such as table Id and time slot.