API reference
Every endpoint of the Cibusy API: venues, menus, tables, orders, reservations and the webhook test, with their parameters, fields, error codes and code samples in five languages.
The Cibusy API is a REST API that speaks JSON. Every request goes over HTTPS to this base URL:
https://api.cibusy.com/public/v1Every call carries the venue's API key in the X-Api-Key header; keep the key on your server, as Authentication explains. The envelope of every answer, times and money are covered in Requests and responses, and every error code in Errors.
The endpoints' fields come from the API's OpenAPI document, which you can also use to generate a client: openapi/v1.json.
Venues
- GET
/venuesList venuesThe venues the API key can read, its own first. - GET
/venues/{venueId}Get a venueA venue's address, location, time zone, opening hours and menu languages, and whether it would take an order right now. - GET
/venues/{venueId}/menuGet the menuThe venue's categories and products, with their portions, prices, extras, option groups, removable ingredients, allergens and stock status. - GET
/venues/{venueId}/tablesList tablesThe venue's floors, terraces and rooms, each with its tables, in the order the venue's till shows them.
Orders
- POST
/venues/{venueId}/orders/previewPrice a basketPrice the order you would place without placing it: the lines, what campaigns take off, the service fee and the total. - POST
/venues/{venueId}/ordersPlace an orderSend the order straight to the venue's kitchen. There is no approval step; the kitchen ticket prints at once. - GET
/orders/{orderId}Get an orderRead one order as the venue has it now. - GET
/ordersList ordersThe orders placed through the API, newest first, a page at a time.
Reservations
- GET
/venues/{venueId}/reservation-availabilityList bookable timesThe venue's booking calendar: the days asked for, each with the times still bookable. - POST
/venues/{venueId}/reservationsTake a reservationSend in a booking your site took. It lands on the venue's reservation list; whether it is confirmed at once is the venue's own setting. - GET
/reservations/{reservationId}Get a reservationRead one reservation as the venue has it now. - GET
/reservationsList reservationsThe reservations taken through the API, a page at a time; the open ones soonest first. - POST
/reservations/{reservationId}/cancelCancel a reservationCall off the reservation of a guest who changes their mind on your site. It is the guest's cancellation, and the venue is told.