Articles in this section

Available Toast APIs

When you configure an export, import, or other type of flow step using the prebuilt Toast connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Toast API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Configuration service charges

Get a service charge type

X

Get service charges

X

Stock

Get menu item inventory for a restaurant

X

Updates inventory information for specific menu items

X

Get inventory information for specific menu items

X

Restaurant availability

Get online ordering availability

X

Orders payments

Get payment identifiers

X

Get a payment

X

Post payments

X

Update a tip amount

X

Configuration tables

Get a table

X

Get tables

X

Configuration tax rates

Get a tax rate

X

Get tax rates

X

Configuration no sale reasons

Get a no sale reason

X

Get no sale reasons

X

Cash management

Get cash entries

X

Get deposits

X

Configuration tip with holding

Get the percentage withheld for credit card tips

X

Orders discounts

Get applicable discounts

X

Add check level discounts

X

Configuration menu groups

Get a menu group

X

Get menu groups

X

Order management configuration

Get online ordering schedule

X

Configuration revenue centers

Get a revenue center

X

Get revenue centers

X

Configuration restaurant services

Get a restaurant service period

X

Get restaurant service periods

X

Configuration dining options

Get a dining option

X

Get dining options

X

Configuration menus

Get a menu

X

Get menus

X

Packaging configuration

Get a restaurant's published packaging configuration

X

Configuration printers

Get a printer

X

Get printers

X

Partners

Get accessible restaurants

X

Get connected restaurants

X

Credit cards

Authorize a credit card

X

Configuration discounts

Get a discount

X

Get discounts

X

Kitchen

Get a prep station

X

Configuration cash drawers

Get a cash drawer

X

Get cash drawers

X

Configuration modifier groups

Get a modifier group

X

Get modifier groups

X

Labor jobs

Get jobs

X

Get one job

X

Add an external identifier

X

Add or replace an external identifier

X

Labor employees

Get employees

X

Get information about one employee

X

Add an employee

X

Delete an employee

X

Update employee information

X

Add an external identifier

X

Add or replace an external identifier

X

Replace a jobs list

X

Replace wage overrides

X

Configuration menu items

Get a menu item or modifier

X

Get menu items and modifiers

X

Labor shifts

Get shifts

X

Get a shift

X

Create a shift

X

Update a shift

X

Delete a shift

X

Configuration pre modifiers

Get a pre modifier

X

Get pre modifiers

X

Configuration break types

Get a break type

X

Get break types

X

Configuration payout reasons

Get a payout reason

X

Get payout reasons

X

Configuration void reasons

Get a void sale reason

X

Get void sale reasons

X

Labor time entries

Get time entries

X

Get one time entry

X

Configuration price groups

Get a price level for menu items

X

Get price levels for menu items

X

Configuration sales categories

Get a menu item sales category

X

Get menu item sales categories

X

Authentication

Get an authentication token

X

Orders

Get an order

X

Get orders

X

Get multiple orders

X

Get order prices

X

Add items to a check

X

Update delivery information

X

Post an order

X

Configuration pre modifier groups

Get a pre modifier group

X

Get pre modifier groups

X

Restaurants

Get restaurant configuration information

X

Get restaurants in a management group

X

Menus v3

Get menus

X

Get menu last modified timestamp

X

Configuration service areas

Get a service area

X

Get service areas

X

Menus v2

Get menus

X

Get menu last modified timestamp

X

Configuration alternate payment types

Get an alternative payment type

X

Get alternative payment types

X