Skip to main content

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.

CreateReservation

Bookings

POST REST /v1/reservations

REQUEST
RESPONSE
WS CreateReservationV1

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

Bookings

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.

UpdateReservationById

Bookings

PUT REST /v1/reservations/{reservationId}

REQUEST
RESPONSE
WS UpdateReservationV1

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

Bookings

DELETE REST /v1/reservations/{reservationId}

This capability allows Dojos to delete a specific reservation by using the reservation Id.

SearchReservations

Bookings

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.