Get started
Conventions
JSON, amounts in cents, timestamps, ids, optional fields.
| Topic | Rule |
|---|---|
| Format | JSON, UTF-8. Every answer carries Cache-Control: no-store. |
| Schema version | Every order carries "schemaVersion": "1". |
| Amounts | Non-negative integers in minor units (cents), at most 10 000 000 each. |
| Quantities | Integers from 1 to 999. |
| Currency | ISO 4217. It must be the restaurant's currency (the menu file's currency). |
| Timestamps | ISO 8601 with Z or an offset, e.g. 2026-10-15T12:30:00+02:00. We answer in UTC (…Z). |
| Time zone | IANA name, e.g. Europe/Berlin (the menu file's timeZone). |
| Ids | Opaque and case-sensitive. Send our ids back unchanged. |
externalId | Your order id: 1–64 characters of [A-Za-z0-9._~-]. It appears in URLs. |
| Tax rates | Percent from 0 to 100; fractions are allowed (7, 19, 7.7). |
| Optional fields | Leave them out. null in place of an optional field is invalid (422). |
| Unknown fields | Ignored. |
Idempotency-Key | Not needed and ignored. Retries are safe through the order's externalId (§11). |