Supported Toast APIs

Tanisha Ray

Updated April 26, 2024 06:31

When you configure an export, import, or lookup using the form view designed for the Toast connector, the following API operations are supported:

Note: You can also create a composite endpoint for this application. For more information, see Application-specific (simple) forms.

Resource	API endpoint	Export	Import
Configuration service charges	Get a service charge type	X
Stock	Get menu item inventory for a restaurant	X
Stock	Updates 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
Configuration tax rates	Get a tax rate	X
Configuration no sale reasons	Get a no sale reason	X
Cash management	Get cash entries	X
Cash management	Get deposits	X
Configuration tip with holding	Get the percentage withheld for credit card tips	X
Orders discounts	Get applicable discounts	X
Orders discounts	Add check level discounts		X
Configuration menu groups	Get a menu group	X
Order management configuration	Get online ordering schedule	X
Configuration revenue centers	Get a revenue center	X
Configuration restaurant services	Get a restaurant service period	X
Configuration dining options	Get a dining option	X
Configuration menus	Get a menu	X
Packaging configuration	Get a restaurant's published packaging configuration	X
Configuration printers	Get a printer	X
Partners partners	Get accessible restaurants	X
Credit cards	Authorize a credit card		X
Configuration discounts	Get a discount	X
Kitchen	Get a prep station	X
Configuration cash drawers	Get a cash drawer	X
Configuration modifier groups	Get a modifier group	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
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
Configuration break types	Get a break type	X
Configuration payout reasons	Get a payout reason	X
Configuration void reasons	Get a void sale reason	X
Labor time entries	Get time entries	X
Labor time entries	Get one time entry	X
Configuration price groups	Get a price level for menu items	X
Configuration sales categories	Get a menu item sales category	X
Authentication	Get an authentication token		X
Orders	Get an order	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
Restaurants	Get restaurant configuration information	X
Restaurants	Get restaurants in a management group	X
Menus v3	Get menus	X
Menus v3	Get menu last modified timestamp	X
Configuration service areas	Get a service area	X
Menus v2	Get menus	X
Menus v2	Get menu last modified timestamp	X
Configuration alternate payment types	Get an alternative payment type	X