API overview

The Toast platform REST web service APIs make working with your restaurant more flexible and efficient. This guide is intended for software engineers, managers, and technical staff who are responsible for integrating third-party systems with the Toast platform.

Toast provides the following APIs:

API

Description

Cash management (cashmgmt)

The cash management (cashmgmt) API provides access to information about cash drawer events such as cash received and cash paid out.

For information about using the cash management API, see Cash management overview.

Configuration (config)

The configuration (config) API provides access to information about the configuration of your restaurant. You can use the configuration API to get information about the menu, dining options, devices, payment options, and other aspects of a restaurant.

The configuration API returns the Globally Unique IDentifiers (GUIDs) that the Toast platform assigns to the configuration objects for your restaurant. You can use these GUIDs to interact with other Toast APIs.

For information about using the configuration API, see Getting menu information from the configuration API.

Credit cards (ccpartner)

The credit cards (ccpartner) API authorizes credit card payments that you can apply to checks in the orders API.

For information about using the credit cards API, see Credit card payments.

Gift cards

The gift cards API specification describes an API that you can implement to allow the Toast platform to process gift card transactions using your gift card provider service.

For information about implementing the gift card integration API, see Gift Card Integrations.

Labor (labor)

The labor API provides access to employment and work schedule configuration information. You can use the labor API to get information about and configure employee records, job types, scheduled work shifts, and work shift time entries.

For information about using the labor API, see Getting all employees of a restaurant and Adding an employee.

Loyalty

The loyalty integration API specification describes an API that you can implement to allow the Toast platform to process loyalty program transactions using your loyalty program service.

For information about implementing the loyalty integration API, see Loyalty program integrations.

Menus (menus)

The menus API lets you retrieve a fully resolved set of menus for the restaurant you specify. With this data, you can construct a menu that satisfies your business requirements.

For information about using the menus API, see Menus API overview.

Orders (orders)

The orders API provides access to information about menu orders. You can use the orders API to get information about and create menu orders, checks, and payment.

For information about using the orders API, see Orders API overview.

Order management configuration (ordermgmt-config)

The order management configuration API provides information about a restaurant location's online ordering schedule.

For information about using the order management configuration API, see Getting online ordering schedules.

Partners

The partners API provides information about restaurants a partner API client has access to.

For information about using the partners API, see Restaurant connections.

Restaurants (restaurants)

The restaurants API provides access to configuration information for Toast platform restaurants. You can use the restaurants API to get information such as the location, hours, services, and dining options for a restaurant.

For information about using the restaurants API, see Restaurant information overview.

Stock (stock)

The stock API provides access to information about inventory for menu items and modifier options at Toast platform restaurants. You can use the stock API to determine whether a menu item or modifier option is in stock or what quantity is in stock.

For information about using the stock API, see Stock overview.