This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Reservation integration checklist

This section provides a checklist you can use to build a reservation integration with the Toast POS system.

This checklist is a guideline, not a definitive list of what you need to do to build your integration. Please consider whether you need to incorporate things into your integration that are not on this list, or whether any items on this list do not apply to your integration.

You can download a CSV version of the checklist.

Area

Task

Additional information

Configuration Syncing

Retrieve employees from the labor API on a recurring basis.

More information

If your reservation functionality assigns reservation orders to specific employees, you need to have up-to-date information about the employees at the restaurant.

Configuration Syncing

Retrieve restaurant tables from the configuration API on a recurring basis.

More information

If your reservation functionality reserves places at specific tables, you need to have up-to-date information about the tables at the restaurant.

Configuration Syncing

Retrieve restaurant hours from the restaurants API on a recurring basis.

More information

Having current information about a restaurant's hours allows you to prevent guests from placing reservations at times when the restaurant is not open.

Configuration Syncing

Retrieve revenue centers from the configuration API on a recurring basis.

More information

Including revenue centers on your orders allow restaurants to choose how to categorize your orders in their revenue reporting.

Configuration Syncing

Retrieve dining options from the configuration API on a recurring basis.

More information

The dining option governs certain other elements of how an order should be structured.

To be accepted by the Toast platform, the order must contain the order dining option.

Order Placement

Develop the capability to place a reservation order at the reserved table at the reservation time.

Assign a revenue center and server to this order if appropriate.

More information

By placing an order at a restaurant table at the time of a reservation, the restaurant can take the reserved party's order more quickly, and you can have a direct linkage between your reservation and its associated order.

Consider assigning a server so that the correct employee sees this order in their list of open orders.

Consider assigning a revenue center to the order so that it appears correctly on the restaurant's revenue reports.

Reporting

Retrieve all configuration data that you will use in your reporting and analytics.

Examples of configuration data that you may want include discounts, service charges, payment types, sales categories, menu items, and menu groups.

More information

If your reports allow users to see the names or other attributes of information that is associated with your reservation orders, you need to periodically poll the configuration or menus APIs for the associated data.

Reporting

Retrieve updates about orders associated with your reservations using using the startDate/endDate parameters of the /orders endpoint of the orders API.

More information

By retrieving order status updates on a recurring basis, you can know the item selections placed on your order, that total amount spent, and other order data that you can use for your analytics and reporting.