The Favouritetable Booking API provides endpoints for managing restaurant bookings, billing, booking status updates, and order-of-service operations. All endpoints require an authentication token passed as part of the URL path. Use the bookingapi_base_url and auth_token environment variables to configure requests.
Retrieves a list of bookings for a specific site and shift on a given date.
\nMethod: GET
URL: {{bookingapi_base_url}}/Booking/GetBookingList/{{auth_token}}
yyyyMMdd format
\n","type":"text/plain"},"key":"BookingDate","value":""}],"variable":[]}},"response":[],"_postman_id":"3f7800c0-6577-4223-bbec-b2d638102b69"},{"name":"GetDepositReport","id":"66bfb490-9991-4201-a866-8f44a05362d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"SiteCode\": {{site_code}},\r\n \"StartDate\": \"{{start_date}}\",\r\n \"EndDate\": \"{{end_date}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{bookingapi_base_url}}/Booking/GetDepositReport/{{auth_token}}","description":"Retrieves all bookings with associated deposit information for a specified site within the requested date range.
\nMethod: POST
URL: {{bookingapi_base_url}}/Booking/GetDepositReport/{{auth_token}}
Submits the bill for a booking, including itemised bill details, subtotals, VAT, and gross totals.
\nMethod: POST
URL: {{bookingapi_base_url}}/Booking/SubmitBookingBill/{{auth_token}}
Request Body (JSON):
\n","urlObject":{"path":["Booking","SubmitBookingBill","{{auth_token}}"],"host":["{{bookingapi_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"bd66a73d-8af8-4220-8942-82acfc7e78f2","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"BookingCode\": 59763,\r\n \"SiteCode\": 37,\r\n \"GrossTotal\": 89,\r\n \"BillItemList\": [\r\n {\r\n \"ItemName\": \"Naan\",\r\n \"Quantity\": 4\r\n },\r\n {\r\n \"ItemName\": \"Mixed Vegetable\",\r\n \"Quantity\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{bookingapi_base_url}}/Booking/SubmitBookingBill/{{auth_token}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"Description\": \"BookingBill submitted successfully!\",\"ErrorCode\": 0,\"IsSuccess\": true,\"ResultInfo\": true}"},{"id":"1c78930b-7188-42d4-99bb-121def91947d","name":"Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"BookingCode\": 59763,\r\n \"SiteCode\": 37,\r\n \"GrossTotal\": 89,\r\n \"BillItemList\": [\r\n {\r\n \"ItemName\": \"Naan\",\r\n \"Quantity\": 4\r\n },\r\n {\r\n \"ItemName\": \"Mixed Vegetable\",\r\n \"Quantity\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{bookingapi_base_url}}/Booking/SubmitBookingBill/{{auth_token}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{ \"Description\": \"Unknown Error\", \"ErrorCode\": 9999, \"IsSuccess\": false}"}],"_postman_id":"d0451a89-1af6-4f6f-8518-c4f0ad7d775a"}],"id":"826654ea-631c-4830-8b0e-7627ceb6b2a6","description":"Endpoints for retrieving booking lists, deposits and submitting booking bills. These operations cover the core booking lifecycle from listing active bookings for a shift to finalising the bill for a booking.
\n","_postman_id":"826654ea-631c-4830-8b0e-7627ceb6b2a6"},{"name":"BookingStatus","item":[{"name":"Complete","id":"45b08e92-467e-4310-9fec-d053c8d36595","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\r\n \"BookingCode\": ,\r\n \"Description\": {{description}},\r\n \"TotalAmount \": {{total_amount}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{bookingapi_base_url}}/BookingStatus/Complete/{{auth_token}}","description":"Marks a booking as complete. This should be called after the dining experience has ended and the bill has been settled.
\nMethod: POST
URL: {{bookingapi_base_url}}/BookingStatus/Complete/{{auth_token}}
Request Body (JSON):
\n","urlObject":{"path":["BookingStatus","Complete","{{auth_token}}"],"host":["{{bookingapi_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"75d08374-f515-431c-a2ce-7a74774e8cd5","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"BookingCode\": 51186,\r\n \"Description\": \"Customer left\",\r\n \"TotalAmount \": 100.24\r\n}","options":{"raw":{"language":"json"}}},"url":"{{bookingapi_base_url}}/BookingStatus/Complete/{{auth_token}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n\"Description\":\"\",\r\n\"ErrorCode\":0,\r\n\"IsSuccess\":true,\r\n\"ResultInfo\":true\r\n}"},{"id":"d4a42f8c-20be-45e9-9ea9-95e02cd80658","name":"Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"BookingCode\": 51186,\r\n \"Description\": \"Customer left\",\r\n \"TotalAmount \": 100.24\r\n}","options":{"raw":{"language":"json"}}},"url":"{{bookingapi_base_url}}/BookingStatus/Complete/{{auth_token}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{ \"Description\": \"Unknown Error\", \"ErrorCode\": 9999, \"IsSuccess\": false}"}],"_postman_id":"45b08e92-467e-4310-9fec-d053c8d36595"}],"id":"53b60972-5bd4-44aa-87bb-ec736cada48b","description":"Endpoints for updating the status of a booking. Use these to mark a booking as complete once the dining experience has concluded and payment has been processed.
\n","_postman_id":"53b60972-5bd4-44aa-87bb-ec736cada48b"},{"name":"OrderofService","item":[{"name":"Update","id":"76ab4617-08c9-46ac-8fbd-175ae6cdfaeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\r\n \"BookingCode\": ,\r\n \"OrderOfServiceCode\": {{order_of_service}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{bookingapi_base_url}}/OrderofService/Update/{{auth_token}}","description":"Updates the order-of-service code assigned to a booking.
\nMethod: POST
URL: {{bookingapi_base_url}}/OrderofService/Update/{{auth_token}}
Request Body (JSON):
\n","urlObject":{"path":["OrderofService","Update","{{auth_token}}"],"host":["{{bookingapi_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"af8f0f37-c90a-4520-b045-5194f7bb762e","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"BookingCode\":51186,\r\n\"OrderOfServiceCode \":2\r\n}","options":{"raw":{"language":"json"}}},"url":"{{bookingapi_base_url}}/OrderofService/Update/{{auth_token}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n\"Description\":\"\",\r\n\"ErrorCode\":0,\r\n\"IsSuccess\":true,\r\n\"ResultInfo\":true\r\n}\r\n"}],"_postman_id":"76ab4617-08c9-46ac-8fbd-175ae6cdfaeb"}],"id":"f4343bfb-fa06-4787-8dc4-a70469222c42","description":"Endpoints for managing the order of service associated with a booking. Use these to update the assigned order-of-service code for a given booking.
\nFollowing are the valid OrderOfServiceCode values and their description.
\n","_postman_id":"f4343bfb-fa06-4787-8dc4-a70469222c42"},{"name":"Appendix","item":[],"id":"21ecb665-b1a8-49da-afd9-f9cb15c3957f","description":"