toast_get_menu
Retrieve a Toast restaurant's menu as groups and items with names, descriptions, prices, and out-of-stock flags; choose online, POS, or merged sources and filter by query.
Instructions
Get a Toast restaurant's menu: menus → groups → items with name, description, price, per-size prices and out-of-stock flag. restaurant is a GUID or any link that contains one (use toast_resolve_restaurant for a bare shortUrl). source: "online" (default) is what the restaurant sells through online ordering; "pos" is the register's full menu (often far larger); "both" merges them: an item on both menus is listed from the online menu with sources ["online","pos"]. An item filed under several groups ("Popular" plus its own category, say) appears under each, so total_items counts listings, not distinct items; dedupe by guid for a count. query searches item names, descriptions and group names. Prices are in dollars (12.5 = $12.50, checked against the ordering page). Modifier/option prices are not included.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view | No | Response shape: "compact" (default) drops fields the response already carries elsewhere; "full" returns every field this server understands. compact (default) returns the shaped result; "full" returns the Toast gateway's raw `data` object untouched. | |
| limit | No | Max items to return (default 200). | |
| query | No | Only items whose name/description/group contains this (case-insensitive). | |
| source | No | online | |
| restaurant | Yes | Restaurant GUID, or a Toast link containing one. | |
| include_out_of_stock | No | Keep 86'd items (flagged out_of_stock). Default true. |