Introduction
The Zenchef API will allow restaurants to connect and distribute their data to third party tools that Zenchef is currently not partnering with. Examples are:
- A marketing agency wishing to retrieve the data of the restaurant's guests to send messages to them via its own communication tool.
- A data company wishing to retrieve the data of the restaurant's reservations so they can build custom dashboards for the restaurant.
Which subscription is required?
The restaurant must have a Grow subscription or a special agreement must have been made. If you are not sure whether you have the right subscription you can verify this via https://app.zenchef.com/billing/index. If you do not have the correct subscription please contact your account manager or our support team.
How to retrieve the API documentation and have access to a demo restaurant?
Send a request for the Zenchef API documentation and, if desired, a demo restaurant on our pre-production environment to api-tech-help@zenchef.com. We also recommend mentioning the Zenchef restaurantId and giving more details why you wish to make use of the Zenchef API. This way, we can provide you with targeted information.
Usage of Zenchef API
All calls are monitored by Zenchef. We trust our customers and partners to handle the Zenchef API responsibly. If not, Zenchef has the right to unilaterally shut down the integration.
What is supported?
Below you can find a list of what is supported. If you can't find your specific use case please reach out to api-tech-help@zenchef.com to get more information.
Reservations & availabilities |
Check availability and opening hours of the restaurant. | ✅ | |
Reservations & availabilities | Get reservations with some additional filters. | ✅ | |
Reservations & availabilities | Create new reservations and modify existing reservations. | ✅ | |
Reservations & availabilities | Update the status of a reservation. For example cancel. | ✅ | |
Reservations & availabilities | Get an overview of the sold experiences, gift vouchers and takeaway orders. | ✅ | |
Services | Get the details of the service and update the settings. | ✅ | |
Restaurant metadata | Get the general information of the restaurant. | ✅ | |
Restaurant metadata | Update the restaurant settings. | ✅ | |
Tables & rooms | Get rooms and tables of the restaurant. | ✅ | |
Guest management | Get the guest profiles. | ✅ | |
Guest management | Create and modify guest profiles. | ✅ | |
Reviews | Get reviews. Create replies. | ✅ | |
Webhooks | Get notification when a reservation is made or updated. | ✅ | |
Get installed webhooks | ❌ | Only 1 webhook URL can be set per restaurant. This can be modified directly via ZenchefOS. | |
Add new webhooks and modify existing webhooks. | ❌ | Only 1 webhook URL can be set per restaurant. This can be modified directly via ZenchefOS. | |
Delete webhooks. | ❌ | Only 1 webhook URL can be set per restaurant. This can be modified directly via ZenchefOS. | |
Get messages from guests. | ❌ | ||
Send messages to guests. | ❌ |