# Toast API

> Toast online ordering menus, restaurant details, schedules and item modifiers

- Vendor: `toastapi` · version 1.0 · category Food · tags toast api, toasttab api, toast takeout api, toast menu api, toast online ordering api, restaurant menu api, toast modifiers api
- Datasource: custom HTTP routes
- Marketplace page: https://apiclay.com/api/toastapi
- This document: https://apiclay.com/docs/toastapi.md
- OpenAPI 3.1: https://apiclay.com/api/toastapi/openapi.json
- MCP: connect https://api.apiclay.com/v1/mcp (see https://apiclay.com/llms.txt), then `apiclay_describe_api` with vendor `toastapi`
- Updated: 2026-11-09

## About

## Toast API

Read the online-ordering menu of any restaurant on Toast (menus, groups, items with prices and images, popular items), its ordering schedule and details, and the full modifier tree of any item.

Data comes from **toasttab.com** (https://www.toasttab.com). Every route below calls the site's own endpoint directly and returns the upstream response unchanged.

Typical flow: `/store` -&gt; `/menus` -&gt; `/customizations`

Every route is a GraphQL call: send the `variables` object in the JSON body; the query itself is fixed. The restaurant GUID identifies the restaurant; the short URL is the last part of its ordering URL (`order.toasttab.com/online/pho-mph-4616-triangle-ave-203` -&gt; `pho-mph-4616-triangle-ave-203`). A guest session for Toast's API is opened automatically before each call.

### Routes

#### POST `/menus` - Menus (menu items with popular items)
Returns the restaurant's menus with groups and items, plus its popular items.

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| variables.input.restaurantGuid | body | string | yes | Restaurant GUID, e.g. `abe3d655-02e5-4e8a-8c1c-948c13ec1f9c`. |
| variables.input.menuApi | body | string | yes | `DO`. |
| variables.input.visibility | body | string | yes | `TOAST_ONLINE_ORDERING`. |
| variables.input.respectAvailability | body | boolean | no | `true` hides items outside their schedule. |
| variables.input.hideOutOfStockItems | body | boolean | no | `true` hides out-of-stock items. |
| variables.input.offset | body | number | no | Paging offset, `0` for the first page. |
| variables.input.dateTime | body | string | no | Menu at a given time, e.g. `2026-11-09T18:00:00+0000`. |
| variables.popularItemsInput | body | object | yes | Same restaurant GUID and menu settings for the popular items list (see the sample body). |

Returns (fields read by the source code; not yet verified live):
- `data.paginatedMenuItems.menus[].guid`, `.name`: menu
- `data.paginatedMenuItems.menus[].groups[].guid`, `.name`, `.description`, `.items[]`: menu group and its items
- `...items[].guid`, `.itemGroupGuid`, `.name`, `.description`, `.prices`, `.outOfStock`, `.imageUrls`: item (`guid` + `itemGroupGuid` feed `/customizations`)
- `data.paginatedMenuItems.totalCount`, `.count`: paging counts
- `data.popularItems.items[]`: popular items

#### POST `/schedules` - Schedules (online ordering schedule of restaurants)
Returns time zone, online-ordering state and schedules for one or more restaurants.

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| variables.restaurantGuids | body | array | yes | Restaurant GUIDs, e.g. `["abe3d655-02e5-4e8a-8c1c-948c13ec1f9c"]`. |

Returns (fields read by the source code; not yet verified live):
- `data.restaurants[].guid`, `.timeZoneId`, `.onlineOrderingEnabled`: restaurant state
- `data.restaurants[].deliveryProviders`, schedules: delivery setup and service hours

#### POST `/store` - Store (restaurant details and dining options)
Returns the restaurant's details (name, address, hours, settings) and its dining options.

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| variables.restaurantGuid | body | string | yes | Restaurant GUID, e.g. `abe3d655-02e5-4e8a-8c1c-948c13ec1f9c`. |

Returns (fields read by the source code; not yet verified live):
- `data.restaurantV2.name`, `.shortUrl`, `.location`, `.timeZoneId`: restaurant details
- `data.restaurantV2.hasOnlineOrderingModule`, `.onlineOrderingEnabled`: ordering state
- `data.restaurantV2.schedule.upcomingSchedules`: service hours
- `data.diningOptions[].behavior`, `.asapSchedule`, `.futureSchedule`: takeout/delivery options

#### POST `/customizations` - Customizations (modifier groups of an item)
Returns one item's details with its nested modifier groups.

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| variables.input.itemGuid | body | string | yes | Item `guid` from `/menus`. |
| variables.input.itemGroupGuid | body | string | yes | Item `itemGroupGuid` from `/menus`. |
| variables.input.shortUrl | body | string | yes | Restaurant short URL, e.g. `pho-mph-4616-triangle-ave-203`. |
| variables.input.restaurantGuid | body | string | yes | Restaurant GUID. |
| variables.input.menuApi | body | string | yes | `DO`. |
| variables.input.visibility | body | string | yes | `TOAST_ONLINE_ORDERING`. |
| variables.input.dateTime | body | string | no | Time to price the item at, e.g. `2026-11-09T18:00:00+0000`. |
| variables.nestingLevel | body | number | no | Depth of nested modifier groups, `10`. |

Returns (fields read by the source code; not yet verified live):
- `data.menuItemDetails.name`, `.description`, `.prices`, `.outOfStock`, `.imageUrls`: item details
- `data.menuItemDetails.modifierGroups[]`: modifier groups with `modifiers[]` and their nested `modifierGroups`
- `errors[].extensions.code`: `MENU_ITEM_NOT_FOUND` when the item is not on the menu at that time

### Caveats

- Upstream calls change over time (embedded keys, field names). Verify responses before relying on them.
- The source site uses bot protection (Cloudflare); calls may be blocked until that is handled.
- These routes were translated from working client code but have not yet been called through ApiClay. Expect adjustments once they are tested.
- Not affiliated with toasttab.com.

## Pricing

- Pay as you go: 0.01 credits/request
- Trial: 1 free requests per buyer
- Billing order: trial requests -> subscribed plan requests -> pay as you go. 1 credit's USD value is shown on the marketplace page.

## HTTP routes

Only the public, buyer-facing parts of each route are listed; vendor-side credentials stay on the gateway.

### POST /menus — Menus (menu items with popular items)
- Gateway: `POST https://api.apiclay.com/v1/api/toastapi/menus`
- Body sample (JSON):

```json
{"variables": {"input": {"restaurantGuid": "abe3d655-02e5-4e8a-8c1c-948c13ec1f9c", "menuApi": "DO", "visibility": "TOAST_ONLINE_ORDERING", "respectAvailability": true, "hideOutOfStockItems": false, "offset": 0, "filters": null}, "popularItemsInput": {"menusInput": {"restaurantGuid": "abe3d655-02e5-4e8a-8c1c-948c13ec1f9c", "menuApi": "DO", "visibility": "TOAST_ONLINE_ORDERING", "respectAvailability": true, "hideOutOfStockItems": false}, "restaurantGuid": "abe3d655-02e5-4e8a-8c1c-948c13ec1f9c"}}}
```

- Upstream proxy: ApiClay proxy paid by the vendor (data cap 10 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### POST /schedules — Schedules (online ordering schedule of restaurants)
- Gateway: `POST https://api.apiclay.com/v1/api/toastapi/schedules`
- Body sample (JSON):

```json
{"variables": {"restaurantGuids": ["abe3d655-02e5-4e8a-8c1c-948c13ec1f9c"]}}
```

- Upstream proxy: ApiClay proxy paid by the vendor (data cap 10 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### POST /store — Store (restaurant details and dining options)
- Gateway: `POST https://api.apiclay.com/v1/api/toastapi/store`
- Body sample (JSON):

```json
{"variables": {"restaurantGuid": "abe3d655-02e5-4e8a-8c1c-948c13ec1f9c"}}
```

- Upstream proxy: ApiClay proxy paid by the vendor (data cap 10 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### POST /customizations — Customizations (modifier groups of an item)
- Gateway: `POST https://api.apiclay.com/v1/api/toastapi/customizations`
- Body sample (JSON):

```json
{"variables": {"input": {"itemGuid": "<item guid>", "itemGroupGuid": "<item group guid>", "shortUrl": "pho-mph-4616-triangle-ave-203", "restaurantGuid": "abe3d655-02e5-4e8a-8c1c-948c13ec1f9c", "menuApi": "DO", "visibility": "TOAST_ONLINE_ORDERING", "dateTime": "2026-11-09T18:00:00+0000"}, "nestingLevel": 10}}
```

- Upstream proxy: ApiClay proxy paid by the vendor (data cap 10 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

## Call example

```bash
curl -X POST "https://api.apiclay.com/v1/api/toastapi/menus" \
  -H "token: <YOUR_APICLAY_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"variables": {"input": {"restaurantGuid": "abe3d655-02e5-4e8a-8c1c-948c13ec1f9c", "menuApi": "DO", "visibility": "TOAST_ONLINE_ORDERING", "respectAvailability": true, "hideOutOfStockItems": false, "offset": 0, "filters": null}, "popularItemsInput": {"menusInput": {"restaurantGuid": "abe3d655-02e5-4e8a-8c1c-948c13ec1f9c", "menuApi": "DO", "visibility": "TOAST_ONLINE_ORDERING", "respectAvailability": true, "hideOutOfStockItems": false}, "restaurantGuid": "abe3d655-02e5-4e8a-8c1c-948c13ec1f9c"}}}'
```

Index of every published API: https://apiclay.com/llms.txt
