Skip to main content
GET
Get menu
Proposal — not implemented in XMART_BACKOFFICE yet. See Hybrid delivery for context. This page shows the intended shape of the endpoint, not a live contract.
The fetch half of hybrid delivery: call this after receiving a menu.list_ready event to get the full menu. The response shape mirrors data.menu in menu.updated exactly — same fields, same semantics.
The notify webhook and this fetch endpoint authenticate differently. Fire pushes menu.list_ready to your server, signed with HMAC — see Request headers. Your system pulls this endpoint, so it needs an API credential instead — see below.

Authentication

This is a /v1/* endpoint — see Authentication: only x-api-key is required, no login flow.
string
required
Your Fire API key.
string
Optional Bearer <token>, accepted as a legacy alternative to x-api-key. Send one or the other.

Path parameters

string
required
The sync assignment’s identifier, received as data.syncId in the menu.list_ready event. This is the id of the row that ties a store, channel, and fulfillment type to a menu and a price list — the same three values listId summarizes as a string, but this is the one guaranteed to be unique.

Response

object
Which menu and price list this response was resolved from. Compare against your last menu.list_ready to detect a reassignment between the notify event and this fetch.
object
Menu metadata and channel/store association.
object[]
Menu categories.
object[]
Product catalog.
object[]
Modifier groups and options.

Notes

  • This endpoint returns the same shape documented field-by-field in menu.updated — refer to that page for full descriptions, edge cases, and the Menu assignment date rules.
  • A syncId that doesn’t exist, or whose assignment has been removed, should return 404.