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.

Online Store Menu Flow

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.

FieldTypeDescription
guidstringUnique schedule identifier
namestringDisplay name for diners
availablebooleanAvailability flag
hours[]arrayDaily operating hours
periods[]arraySchedule periods supporting cross-day boundaries

Menu Category

Groups related menu items.

FieldTypeDescription
guidstringUnique category identifier
namestringDisplay name
descriptionstringOptional category description
availablebooleanAvailability flag
items[]arrayGUIDs of contained items (displayed order maintained)

Menu Item

Represents purchasable offerings.

FieldTypeDescription
guidstringUnique item identifier
namestringCustomer-facing name
descriptionstringOptional item description
availablebooleanAvailability flag
priceintegerAmount in US cents
schedules[]arrayAssociated schedule GUIDs
customLabels[]arrayUser-assigned classifications
tags[]arrayItem classifications
modifierSets[]arrayAssociated modifier set GUIDs
taxes[]arrayAssociated tax GUIDs
imageUrl800x800stringSquare image (SSL, JPEG/PNG/GIF)
imageUrl1600x900stringLandscape image (SSL, 16:9 ratio, source only)
imageUrl1600x1600stringSquare high-res image (SSL, 1:1 ratio, source only)

Menu Modifier Set

Defines modification options for items.

FieldTypeDescription
guidstringUnique set identifier
namestringDisplay name
descriptionstringOptional description
minModifiersPerSetinteger/nullMinimum selection requirement (null = unrestricted)
maxModifiersPerSetinteger/nullMaximum selection limit (null = unrestricted)
availablebooleanAvailability flag
modifiers[]arrayContained modifier GUIDs (displayed order maintained)

Menu Modifier

Individual selectable modifications.

FieldTypeDescription
guidstringUnique modifier identifier
namestringDisplay name
descriptionstringOptional description
priceintegerAdditional cost in US cents
taxes[]arrayAssociated tax GUIDs
availablebooleanAvailability flag
inheritsItemTaxbooleanTax calculation source indicator

Menu Tax

Tax configuration for checkout.

FieldTypeDescription
guidstringUnique tax identifier
namestringTax name
rateobjectTax rate object

Tax Rate:

FieldTypeDescription
typestring"amount" (flat rate) or "percent" (percentage-based)
percentintegerDivide by 10,000 to obtain percentage
amountintegerFlat rate in US cents

Was this page helpful?