Online Ordering Menu

The image below presents a high level overview of how Menu creation and update work via our API.

Online Store Menu Flow

Methods & Webhooks

Retrieve Menu

Retrieve a latest Menu for Online Ordering.

GET /online-ordering/v2/{locationId}/menu

Response 200

Returns all menu objects within dependencies for Online Ordering.

{
  "schedules": {<MenuSchedule>},
  "categories": {<MenuCategory>},
  "items": {<MenuItem>},
  "modifierSets": {<MenuModifierSet>},
  "modifiers": {<MenuModifier>},
  "taxes": {<MenuTax>}
}

Definitions

Online Menu

Online Menu structure for Online Ordering integrations.

Name Type Description
schedules* array Collection of Online Menu Schedules.
Sorted by ascending schedule creation order from oldest to newest.
categories* array Collection of Online Menu Categories.
Sorted in the same order as displayed.
items* array Collection of Online Menu Items.
Sort order is not important.
modifierSets* array Collection of Online Menu Modifier Sets.
Sorted in the same order as displayed.
modifiers* array Collection of Online Menu Modifiers.
Sort order is not important.
taxes* array Collection of Menu Taxes.
Sort order is not important.
Name Type Description
guid* string Online Schedule reference ID. Unique per the list of Location's Online Schedules.
name* string The Schedule name displayed to the diner for online ordering
available* boolean In case true this schedule is available online, otherwise this schedule is hidden from online menu.
hours* array Collection of Schedule Hours.
Sorted by day of week from Monday to Sunday.
periods array Collection of Schedule Periods (with cross day boundary support). Sorted by day of week from Monday to Sunday.
Name Type Description
dayOfWeek* string Available day of weeks:
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
  • SUNDAY
endTime* string Schedule end time in Local Timezone, etc: 23:00:00
startTime* string Schedule start time in Local Timezone, etc: 00:00:00
Name Type Description
dayOfWeek* string Available day of weeks:
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
  • SUNDAY
endTime* string Schedule end time in Local Timezone, etc: 23:00:00.
startTime* string Schedule start time in Local Timezone, etc: 00:00:00.
isOvernight* boolean If "true" the Schedule "endTime" presents a next day time, otherwise, ("false") store closes the same day.

A category of the menu - such as appetizers, breakfast, or drinks - including the menu items that these categories contain.

Name Type Description
guid* string Online Category reference ID. Unique per the list of Location's Online Categories.
name* string The category name displayed to the diner for online ordering.
description string The description displayed to the diner for online ordering.
available* boolean In case true this category is available online, otherwise this category is hidden from online menu.
items* array Collection of Items GUIDS which belongs to this category.
Sorted in the same order as displayed within category.

The Menu item for sale on Online Ordering.

Name Type Description
guid* string Online Item reference ID. Unique per the list of Location's Online Items.
name* string The name shown to the diner.
description string The description shown to the diner.
available* boolean In case true this item is available online, otherwise this item is hidden from online menu.
schedules array Collection of schedule guids which are defined for this item.
customLabels array Collection of custom, user-assigned labels for this item.
price number The price in US cents per unit.
tags array Item clasification.
Sorted in the same order as displayed.
modifierSets* array Collection of Modifier Sets GUIDS which belongs to this item.
taxes array Collection of tax guids which belong to this item.
Sort order is not important.
imageUrl800x800 string (optional) URL pointing to an image of the item.
  • Hosted on a secure connection (SSL)
  • Image format JPEG, PNG, or GIF format.
  • Both width and height is 800px.
Note: This new field becomes available once the menu is republished.
imageUrl1600x900 string (optional) URL pointing to an image of the item.
  • Hosted on a secure connection (SSL)
  • Image format JPEG, PNG, or GIF format.
  • Width 1600px and height 900px. (16:9 aspect ratio).
  • This image is a source and can’t be served to the end customer.
Note: This new field becomes available once the menu is republished.
imageUrl1600x1600 string (optional) URL pointing to an image of the item.
  • Hosted on a secure connection (SSL)
  • Image format JPEG, PNG, or GIF format.
  • Width 1600px and height 1600px. (1:1 aspect ratio).
  • This image is a source and can’t be served to the end customer.
Note: This new field becomes available once the menu is republished.

The various modifier types that can apply to this item, as well as the options available and the selection model.

Name Type Description
guid* string Online Modifier Set reference ID. Unique per the list of Location's Online Modifier Sets.
name* string Display name
description string Display description
minModifiersPerSet number Minimum number of modifiers that must be selected from this set.
Null value represents no-restriction, there are no requirement to choose any modifier;
maxModifiersPerSet number Maximum number of modifiers that can be selected from this set.
Null value represents no-restriction, choose as many modifiers as you want;
available* boolean In case true this modifier set is available online, otherwise this modifier set is hidden from online menu.
modifiers* array Collection of Modifiers GUIDS which belongs to this size.
Sorted in the same order as displayed within a modifier set.

A selection, modification, or addition to an Item, which may or may not affect the final price of the Item

Name Type Description
guid* string Online Modifier reference ID. Unique per the list of Location's Online Modifiers.
name* string Display name
description string Display description
price number The additional cost applied to an order if a diner selects this modifier.
taxes array Collection of tax guids which are assigned to this modifier.
Sort order is not important.
available* boolean In case true this item is available online, otherwise this item is hidden from online menu.
inheritsItemTax boolean Determine, which taxes should be taken for tax calculation.
If "true" for use the item-level taxes, otherwise by the "modifier.taxes"

Tax rate to be applied at order checkout, if the diner is not tax-exempt.

Name Type Description
guid* string Tax reference reference ID. Unique per the list of Location's Online Taxes.
name* string Tax name
rate* object Tax rate details

Tax rate details

Name Type Description
type* string Available tax types:
  • amount - flat amount tax rate
  • percent - percent tax rate
percent* integer Non-null in case type is percent. Tax rate (Integer, division by 10000 to get a percent. In case there is rate of 1000000 there will be 100 percent)
amount* integer Non-null in case type is amount. The amount in US cents

results matching ""

    No results matching ""