​

Connector Details

​

Integration methods

There are two supported ways to integrate with Toast:

• using Toast APIs (there are restrictions here)
• using SFTP exports

​

Using APIs

Toast has two types of API access:

• integration partner access -> requires going through a lengthy partnership and approval process
• standard API access -> only available on RMS Essentials plan or higher. Full requirements listed on the Toast docs

​

Configuration

To generate standard API access credentials, you can follow the guide in the Toast docs. You will be given the following:

• API access URL
• client id
• client secret

​

Supported data

You can review Toast’s official Postman collection to review what their APIs support. Our connector currently supports the following data:

Show supported tables

• Alternate Payment Types
• Break Types
• Cash Drawers
• Cash Management Deposits
• Cash Management Entries
• Dining Options
• Discounts
• Employees
• Menu Groups
• Menu Items
• Menu Option Groups
• Menus
• No Sale Reasons
• Orders
• Payments
• Payout Reasons
• Pre Modifier Groups
• Pre Modifiers
• Premodifier Groups
• Premodifiers
• Price Groups
• Printers
• Restaurant Services
• Restaurants
• Revenue Centers
• Sales Categories
• Service Areas
• Tables
• Tax Rates
• Tip Withholding
• Void Reasons

​

SFTP exports

Alternatively, Toast does offer the ability to create data exports and access them via SFTP.

​

Configuration

Generally, the steps are as follows:

• The Toast user will need to request SFTP access from Toast (it is typically not enabled by default)
• Once Toast provisions the SFTP connection, the user can configure the data exports they want. This is the most tedious part of the configuration. This is managed directly in the Toast UI under Reports -> Settings -> Data Exports.
• Configure the SFTP credentials in Hotglue

From there, Toast will generate the files on a schedule and upload them to SFTP. From there, Hotglue will pick them up and process.

​

Supported data

Currently, our toast-sftp connector supports importing the following data from the data exports:

Show supported tables

Stream Name	File Name	Format	Description
accounting_report	AccountingReport.xls	Excel	Accounting data export with revenue amounts for each GL code
all_items_report	AllItemsReport.csv	CSV	Information about all menu items
cash_entries	CashEntries.csv	CSV	Information about cash payments
check_details	CheckDetails.csv	CSV	Information about checks in orders
house_account_export	HouseAccountExport.csv	CSV	Information about house accounts
item_selection_details	ItemSelectionDetails.csv	CSV	Information about items ordered
kitchen_timings	KitchenTimings.csv	CSV	Information about kitchen tickets
menu_export	MenuExport_*.json	JSON	Information about menus
menu_export_v2	MenuExportV2_*.json	JSON	Enhanced information about menus
menu_menus	MenuExport*.json	JSON	Toast menu objects (flat, one per menu)
menu_groups	MenuExport*.json	JSON	Toast menu group objects with parent menu context
menu_items	MenuExport*.json	JSON	Toast menu item objects with full parent context
menu_option_groups	MenuExport*.json	JSON	Toast menu option group objects with full parent context
menu_option_items	MenuExport*.json	JSON	Toast menu option item objects with full parent context
menu_prices	MenuExport*.json	JSON	Toast menu item price objects with full parent context
modifiers_selection_details	ModifiersSelectionDetails.csv	CSV	Information about modifiers applied to items
order_details	OrderDetails.csv	CSV	Information about orders
payment_details	PaymentDetails.csv	CSV	Information about payments
time_entries	TimeEntries.csv	CSV	Information about employee shifts