HPOS 2 API
Search…⌘K

↑↓select↵openescclose

Schemas

Menu file

View as Markdown
MenuobjectMenu

The menu file at menu.updated.data.url / ping.menuUrl. Always the full menu, at most 3 MiB, served with Cache-Control: no-store. Prices are gross (tax included) in cents. A product with variants comes as one product per variant. Switched-off products and options stay in the file with available: false.

Attributes

schemaVersionstringRequiredValue: 1
publishedAtstringRequiredformat: date-time

The sync that last changed the menu

currencystringRequiredpattern: ^[A-Z]{3}$

The currency orders must use

timeZonestringRequired

IANA time zone, e.g. Europe/Berlin

priceIncludesTaxbooleanRequiredValue: true
categoriesarray of objectRequired
Show child attributesHide child attributes
idstringRequired
namestringRequired
positionintegerRequired

Display order

productsarray of objectRequired
Show child attributesHide child attributes
idstringRequired

Send as items[].productId

namestringRequired
categoryIdsarray of stringRequired
positionintegerRequired

Display order

availablebooleanRequired

false while the restaurant has it switched off

pricesobjectRequired
Show child attributesHide child attributes
pickupintegerRequired0-10000000

Minor units (cents)

deliveryintegerRequired0-10000000

Minor units (cents)

taxRatenumberRequired

Take-away rate in percent; send as items[].taxRate

modifierGroupIdsarray of stringRequired
descriptionstringOptional
imageUrlstringOptionalformat: uri

Absolute https URL only

modifierGroupsarray of objectRequired
Show child attributesHide child attributes
idstringRequired

Send as modifiers[].modifierGroupId

namestringRequired
minQuantityintegerRequired

How many options the customer must choose (not checked on orders)

maxQuantityintegerRequired

How many options the customer may choose (not checked on orders)

optionsarray of objectRequired
Show child attributesHide child attributes
idstringRequired

Send as modifiers[].modifierOptionId

namestringRequired
unitPriceintegerRequired0-10000000

Minor units (cents)

availablebooleanRequired
maxQuantityintegerRequired

How often the option can be chosen

openingHoursarray of objectRequired

For information only; may be empty

Show child attributesHide child attributes
daystringRequiredMONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY
openstringRequired

Local time HH:mm in timeZone

closestringRequired

Local time HH:mm in timeZone