Connectors
Operations Applications

Toast POS

6min

Toast is a point-of-sale software system for restaurants that provides order tracking and a reporting and analytics solution. Use the DataLakeHouse.io connector to retrieve data about orders, menu items, and payments. To learn more about the Toast API, visit their page (https://pos.toasttab.com/integrations).

Prerequisites

To connect to your Toast account, you must have the following:

  • Your Toast client ID
  • Your Toast client secret
  • The Toast restaurant ID for one of the restaurants in your restaurant management group

For information about obtaining these credentials, reach out to your Toast representative or open a ticket with Toast support ([email protected]). Below is the starting point to your request.

Hello, we are leveraging DataLakeHouse.io, a Toast integration partner, to build a data and analytics platform to analyze various aspects of our business by combining data from multiple source systems (Toast, Marketman, Paycom, QuickBooks, etc) into a central data cloud. In order to replicate data from Toast we'd like to leverage the Toast API. We only need read access to the Toast data. One item that we need information from you is the URL highlighted in red below:

https://hostname.toasttab.com/authentication/v1/authentication/login

Thank you in advance for your help!

Toast Won't Give Us API Access

Depending on your experience in requesting API access, Toast may tell you that API access is in Beta and you won't receive access for 12+ months. This is incorrect since API access has been available since early 2021.

As an alternative, use a Nightly Data Export from Toast instead.

Connecting to Your Toast Account

This section enumerates the options in the Credentials and Details panes in the Toast Connector page within DataLakeHouse.io. 

Credentials Pane

This pane contains fields for entering credentials to connect to your Toast account. The following table describes what is needed for each field:  

Field

Description

Domain

Enter the hostname for your Toast account. This should be in the format https://hostname.toasttab.com

Client ID

Enter your Toast client ID.

Client Secret

Enter your Toast client secret.

Restaurant ID

Enter the ID for any one restaurant in your restaurant management group (this is necessary to make API requests).



Replicated Entities

The following Toast entities are replicated to your target destination. These are the table names you will see:

  • BREAK_TYP
  • DINING_OPTIONS
  • DISCOUNT
  • EMPLOYEE
  • JOBS
  • MENU
  • MENU_GROUPS
  • MENU_ITEMS
  • NO_SALE_REASON
  • ORDERS
  • ORDERS_CHECKS
  • ORDERS_CHECKS_DISCOUNTS
  • ORDERS_CHECKS_PAYMENTS
  • ORDERS_CHECKS_SELECTIONS
  • ORDERS_DELIVERY_INFO
  • RESTAURANTS
  • RESTAURANT_DETAILS
  • REVENUE_CENTER
  • SALES_CATEGORIES
  • SERVICE_AREAS
  • SHIFTS
  • TIME_ENTRY