Get one menu
The complete menu as one document: categories -> items -> modifier groups -> modifier options.
Without storeId, prices are base prices and availability flags are omitted. With storeId, prices resolve for that storefront's location (see Menu on pricing), and availability flags reflect the storefront's live stock.
Scope: a menu whose brand your organization owns, or that your organization has assigned to one of its own storefronts. A menuId that does not exist and one outside that scope are the same 404, as on every other directory and menu read on this API.
Safe to retry: this operation is read-only and idempotent.
Request
- menuIdstring
The menu to fetch. Required: an absent value is
404. A menu that does not exist and one outside your organization's scope (neither its brand is yours nor is it assigned to one of your storefronts) are the same404. - storeIdstring
Optional storefront context: when provided, prices and availability resolve for this storefront; otherwise base prices are returned and availability flags are omitted (never defaulted to
false).
{
"menuId": "00000000-0000-0000-0000-000000000000",
"storeId": "00000000-0000-0000-0000-000000000000"
}Responses
Headers
- x-mealco-tx-idstringoptional
The correlation id for this call, returned on every response that an operation produces, successful or not. Quote it when you report a problem so that we can trace the request. You may send your own x-mealco-tx-id on the request and it is used as the id. It is optional in the schema because a request with a malformed JSON body is rejected before an id is assigned, so that one response carries neither this header nor the txId field of the error body.
- menuMenu
The requested menu document. Always present on a
200; an unknown menu is a404instead.
{
"menu": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "<name>",
"brandId": "00000000-0000-0000-0000-000000000000",
"categories": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "<name>",
"items": [
{}
]
}
]
}
}About Menus
Menus: read a menu, publish it to the delivery platforms, and follow each publication's per-store, per-platform outcome.
publishMenu is the only write in this section. It changes the menu guests see on live DoorDash, Uber Eats and Grubhub storefronts, and there is no unpublish.
Every operation is scoped to the organization your API key belongs to. On fetchMenu and publishMenu, an id that does not exist and one that belongs to another organization are the same 404. On publishMenu, a menu or store outside your organization is rejected before anything is published.
Retries create a second publication. publishMenu does not replay a previous result: a retried call creates a new publication with its own publicationId and re-submits to the platforms. That changes no content, because a publication is a full replace of the same saved menu, but it doubles platform traffic. Treat a timeout as "may have succeeded" and check fetchMenuPublications before retrying.