Toast
Version 0.0.0
Please read the Toast API Docs for more information.
Set up
Before you can begin using the connector make sure you have the following information available:
- Domain: If your application is hosted at
https://toast-api.toasttab.com, the domain is toast-api.toasttab.com, excluding the "https://" portion.
- Client ID & Client Secret: Please retrieve your Client ID and Client Secret from the Toast API Access product, available under your Integrations section.
For more details on Client Credentials please see here in the Toast documentation. Be sure to keep a record of your Toast-Restaurant-External-ID or restaurantGuid, as these are required to generate restaurant specific reports using this connector.
Features
| Feature | Support | Notes |
|---|---|---|
| Backfill | ✅ | Backfill is supported for the 'Orders' and 'Payments' reports. |
| Incremental | ✅ | Incremental is supported for the 'Orders' and 'Payments' reports. |
| API reliability | 🟢 | Reliable |
Reports detail
| ⬇️ Report | 🔑 Incremental key | 🔑 Primary key | 📄 Link to API endpoint |
|---|---|---|---|
| Orders | MODIFIED_DATE | GUID | Get Orders |
| Payments | PAID_DATE | GUID | Get Payment |
| Restaurant Configuration | N/A | GUID | Get Restaurant Configuration Information |
| Discounts | N/A | GUID | Discounts |
| Menu Items | N/A | GUID | Menu Items |
| Menu Groups | N/A | GUID | Menu Groups |
| Employees | N/A | GUID | Employees |
| Service Areas | N/A | GUID | Service Areas |
| Sales Categories | N/A | GUID | Sales Categories |
Limitations
Connector up-versioning from 0.0.0 to newer version (Backfill considerations)
Please note that if you are up-versioning an existing Toast connector source from 0.0.0 to a higher version, you will have to edit extracts that have a
Backfilloption, re-select the desired option and re-save the extract.
Updated 9 days ago