Menu V2
The Menu V2 API provides access to complete menu structures for online ordering integration.
Overview
The image below presents a high level overview of how Menu creation and update work via our API.
The Menu V2 endpoint returns a comprehensive menu object containing schedules, categories, items, modifier sets, modifiers, and taxes in a single response.
API Endpoint
GET /online-ordering/v2/{locationId}/menu
Response: 200 OK
Returns complete menu structure with all dependencies for online ordering integration.
Response Structure
The API returns six main collections in a single response:
{
"schedules": [<MenuSchedule>],
"categories": [<MenuCategory>],
"items": [<MenuItem>],
"modifierSets": [<MenuModifierSet>],
"modifiers": [<MenuModifier>],
"taxes": [<MenuTax>]
}
Data Models
Menu Schedule
Represents operating hours for online ordering availability.
| Field | Type | Description |
|---|---|---|
guid | string | Unique schedule identifier |
name | string | Display name for diners |
available | boolean | Availability flag |
hours[] | array | Daily operating hours |
periods[] | array | Schedule periods supporting cross-day boundaries |
Menu Category
Groups related menu items.
| Field | Type | Description |
|---|---|---|
guid | string | Unique category identifier |
name | string | Display name |
description | string | Optional category description |
available | boolean | Availability flag |
items[] | array | GUIDs of contained items (displayed order maintained) |
Menu Item
Represents purchasable offerings.
| Field | Type | Description |
|---|---|---|
guid | string | Unique item identifier |
name | string | Customer-facing name |
description | string | Optional item description |
available | boolean | Availability flag |
price | integer | Amount in US cents |
schedules[] | array | Associated schedule GUIDs |
customLabels[] | array | User-assigned classifications |
tags[] | array | Item classifications |
modifierSets[] | array | Associated modifier set GUIDs |
taxes[] | array | Associated tax GUIDs |
imageUrl800x800 | string | Square image (SSL, JPEG/PNG/GIF) |
imageUrl1600x900 | string | Landscape image (SSL, 16:9 ratio, source only) |
imageUrl1600x1600 | string | Square high-res image (SSL, 1:1 ratio, source only) |
Menu Modifier Set
Defines modification options for items.
| Field | Type | Description |
|---|---|---|
guid | string | Unique set identifier |
name | string | Display name |
description | string | Optional description |
minModifiersPerSet | integer/null | Minimum selection requirement (null = unrestricted) |
maxModifiersPerSet | integer/null | Maximum selection limit (null = unrestricted) |
available | boolean | Availability flag |
modifiers[] | array | Contained modifier GUIDs (displayed order maintained) |
Menu Modifier
Individual selectable modifications.
| Field | Type | Description |
|---|---|---|
guid | string | Unique modifier identifier |
name | string | Display name |
description | string | Optional description |
price | integer | Additional cost in US cents |
taxes[] | array | Associated tax GUIDs |
available | boolean | Availability flag |
inheritsItemTax | boolean | Tax calculation source indicator |
Menu Tax
Tax configuration for checkout.
| Field | Type | Description |
|---|---|---|
guid | string | Unique tax identifier |
name | string | Tax name |
rate | object | Tax rate object |
Tax Rate:
| Field | Type | Description |
|---|---|---|
type | string | "amount" (flat rate) or "percent" (percentage-based) |
percent | integer | Divide by 10,000 to obtain percentage |
amount | integer | Flat rate in US cents |