| Name | Type | Description | Additional information |
|---|---|---|---|
| ReservationID | string |
The Reservation ID, if the ID already exists on the POS this will act as an Update to that Reservation |
Required |
| State | TableStatusEnum |
Current Status of the Table. |
|
| TableNumber | Collection of integer |
Reservations can support multiple tables for a booking, e.g. booking for 10 guests, tables can seat max size 4, can send the reservation to book 3 tables. |
Required |
| Origin | string |
Free text to show Integration Name in the POS |
Required |
| ScheduledTimeUtc | date |
Arrival Time |
Required |
| CreatedDateUtc | date |
Date booking was Created |
Required |
| Duration | integer |
Optional - Shows in the booking list, populates table time - Minutes from the arrival time e.g. arrive at 1pm, duration 1hr finishes at 2pm |
|
| BookingReference | string |
Optional - Third party Reference for Guests to use |
|
| BookingType | string |
Optional - Shows in the booking list as free text e.g. Restaurant, Bar |
|
| Covers | integer |
Cover Count, e.g. how many guests |
|
| GuestNotes | string |
Optional - Free text - shown on booking details |
|
| RestaurantNotes | string |
Optional - Free text - shown on booking details |
|
| Cancelled | boolean |
Optional - Whether the reservation has been cancelled |
|
| RestaurantID | string |
Optional - If using a Multi-Restaurant to One Site setup, then this will be the Restaurant ID |
|
| Guest | ReservationGuestApiModel |
Required |
|
| SubmitCalculatedOnlineOrderV2ApiModel | SubmitCalculatedOnlineOrderV2ApiModel |
Optional - If you want to include Pre-Orders against the bill when it is seated. Status must be Booked/Seated. For more information please see the Online Orders V2 Guide |
|
| PrePayments | Collection of ReservationPrePaymentApiModel |
Optional - If you want to include any Pre-Payments/Deposits against the bill when it is seated. Status must be Booked/Seated. |