The Toast platform REST web service APIs make it easier and more efficient to work with location data. This guide is intended for software engineers, technical managers, and other staff responsible for integrating third-party systems with the Toast platform.
Toast APIs support both read and write operations. Read access is
performed using GET requests. Write access includes
POST, PUT, PATCH, and
DELETE methods, as well as interaction with outbound APIs,
which send data from the Toast platform to your system and await your
response.
Access to the APIs is further classified by the integration type. To determine what integration access type you have (partner integrations, custom integrations, standard API access, or analytics API access), see Integration types.
|
Note |
|
Partner and custom integration access is granted based on specific implementation requirements. While the methods listed represent the full range of possible access, actual permissions are limited to only what is necessary to support each integration's functionality. |
Toast provides the following APIs:
|
API |
Description |
Supported Methods by Integration Type |
|---|---|---|
|
Analytics API ( |
The analytics
( For more information about using the analytics API, see Analytics API overview. |
|
|
Cash management ( |
The cash
management ( For information about using the cash management API, see Cash management overview. |
|
|
Configuration ( |
The configuration
( The configuration API returns the Globally Unique Identifiers (GUIDs) that the Toast platform assigns to configuration objects. 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 ( |
The credit
cards ( 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 enable the Toast platform to process gift card transactions through your gift card provider service. For information about implementing the gift card integration API, see Gift card integration overview. |
This API is outbound. You must host an HTTPS endpoint
that accepts
|
|
Kitchen ( |
The kitchen API provides access to kitchen prep station information. For more information about the kitchen API, see Kitchen API reference. |
|
|
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 enable the Toast platform to process loyalty program transactions through your loyalty service. For information about implementing the loyalty integration API, see Loyalty program integration overview. |
This API is outbound. You must host an HTTPS endpoint
that accepts
|
|
Menus ( |
The menus API lets you retrieve a fully resolved set of menus for the location 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 ( |
The orders
API provides access to information about menu orders. You can
use the For information about using the orders API, see Orders API overview. |
|
|
Order management configuration
( |
The order
management configuration ( For information about using the order management configuration API, see Getting online ordering schedules. |
|
|
Packaging configuration
( |
The packaging
configuration ( For information about using the packing configuration API, see Packaging preferences. |
|
|
Partners ( |
The partners API provides information about locations an API client has access to. For information about using the partners API, see Location access. |
|
|
Restaurant availability
( |
The restaurant availability API provides access to information about a location's availability to accept online orders. For more information about using the restaurant availability API, see Getting a restaurant's online ordering availability. |
|
|
Restaurants ( |
The restaurants API provides access to configuration information for a location. You can use the restaurants API to get information such as location name, address, hours, and schedules. For information about using the restaurants API, see Restaurant information overview. |
|
|
Stock ( |
The stock API provides access to information about inventory for menu items and modifier options at a location. 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. |
|
|
Tender |
The tender integration API specification describes an API that you can implement to allow the Toast platform to provide information about tender transactions processed by the Toast POS system. Your tender system can use this data to maintain a complete record of payments, refunds, and other transaction activity. For information about implementing the tender integration API, see Tender provider integrations overview. |
This API is outbound. You must host an HTTPS endpoint
that accepts
|