POS Menu

Unified POS Menu for all brands.

Menu include information about items, categories, modifier sets, modifiers

Dependencies *-* *-* *-* MenuCategory MenuItem MenuModifierSet MenuModifier

Methods

Retrieve Menu

Retrieve specified location POS menu

GET /pos/v2/{locationId}/menu

Response 200

Returns all POS Menu objects within dependencies.

{
  "categories": {<MenuCategory>},
  "items": {<MenuItem>},
  "modifierSets": {<MenuModifierSet>},
  "modifiers": {<MenuModifier>},
  "taxes": {<Tax>},
  "maxModifiersLevel": number
}

Definitions

POS Menu

Unified POS Menu structure.

Name Type Description
categories* array Collection of POS Menu Categories.
Sort order is important.
items* array Collection of POS Menu Items.
Sort order is not important.
modifierSets* array Collection of Online Menu Modifier Sets.
Sort order is important.
modifiers* array Collection of POS Menu Modifiers.
Sort order is not important.
taxes* array Collection of Menu Taxes.
Sort order is not important.
maxModifiersLevel* number Determines POS supported maximum nested modifiers level.

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

Name Type Description
posRef* string POS Category reference ID. Unique per the list of Location's POS Categories.
name* string The category name displayed in POS.
description string The description displayed to the server.
items* array Collection of Items posRefs which belongs to this category.
Sort order is important.
isActive* boolean In case true this category is available in POS, otherwise this category is in active in POS.

The Menu item for sale in POS.

Name Type Description
posRef* string POS Menu Item reference ID. Unique per the list of Location's POS Items.
name* string The name shown in POS.
description string The description shown in POS.
taxes array Collection of Tax posRefs which belongs to this item.
Sort order is not important.
modifierSets* array Collection of Modifier Sets posRefs which belongs to this item.
Sort order is important.
price number The price in US cents per unit.
isActive* boolean In case true this item is available in POS, otherwise this item is in active in POS.
isSoldByWeight* boolean In case true this item is sold by weight, otherwise this item is sold by quantity.
upc string Unique product code (UPC) assigned to the item for scanning and lookup.

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

Name Type Description
posRef* string POS Modifier Set reference ID. Unique per the list of Location's POS 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.
modifiers* array Collection of Modifiers GUIDS which belongs to this size.
Sort order is important.
isActive* boolean In case true this category is available in POS, otherwise this category is in active in POS.
defaultModifierPrice object Use this default price for a referenced modifiers in case a modifier don't overwrite price by his own.

Use this default price for a referenced modifiers in case a modifier don't overwrite price by his own.

Name Type Description
type* string POS Modifier price can be defined as:
  • amount - flat modifier price
  • percent - percent modifier price
amount* number Non-null in case price type is amount, amount in US cents.
percent* number Non-null in case price type is percent, division by 10000 to get a percent value. Etc: value of 1000000 there will be 100 percent.

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

Name Type Description
posRef* string POS Modifier reference ID. Unique per the list of Location's POS Modifiers.
name* string Display name.
description string Display description.
taxes array Use this default price for a referenced modifiers in case a modifier don't overwrite price by his own.
Sort order is not important.
isActive* boolean In case true this modifier is available in POS, otherwise this modifier is in active in POS.
defaultPrice object The additional cost applied to an order if a diner selects this modifier. Use this price in case there are no specific price by ModifierSet in "prices" collection.
prices* array Collection of modifier prices.
Sort order is not important.
inheritsItemTax boolean Determine, which taxes should be taken for tax calculation.
If "true" for use the item-level taxes, otherwise by the "modifier.taxes".
modifierSets* array The various modifier types that can apply to this item, as well as the options available and the selection model. References to POS Menu Modifier Sets.

The additional cost applied to an order if a diner selects this modifier. Use this price in case there are no specific price by ModifierSet in "prices" collection.

Name Type Description
type* string POS Modifier price can be defined as:
  • amount - flat modifier price
  • percent - percent modifier price
amount* number Non-null in case price type is amount, amount in US cents.
percent* number Non-null in case price type is percent, division by 10000 to get a percent value. Etc: value of 1000000 there will be 100 percent.

The modifier price which might be applied depending by ModifierSet.

Name Type Description
modifierSetRef* string A reference to Modifier Set.
price* object The additional cost applied to an order if a diner selects this Modifier by Modifier Set.

The additional cost applied to an order if a diner selects this Modifier by Modifier Set.

Name Type Description
type* string POS Modifier price can be defined as:
  • amount - flat modifier price
  • percent - percent modifier price
amount* number Non-null in case price type is amount, amount in US cents.
percent* number Non-null in case price type is percent, division by 10000 to get a percent value. Etc: value of 1000000 there will be 100 percent.

Tax to be applied at ticket for items and modifiers, if the diner is not tax-exempt.

Name Type Description
posRef* string POS Tax reference ID. Unique per the list of Location's POS Taxes.
name* string Tax name.
isActive boolean Indicates whether this Tax is active in POS or not.
rate* object Tax rate details.

Tax rate details.

Name Type Description
type* string POS 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 ""