Menu

API suite

Build on Munim

Munim's core is headless: every screen — the counter, the kitchen display, the owner's console and each business's storefront — talks to the same HTTP API. This portal documents it for people building storefronts and other frontends.

The reference below is generated from the contracts the server itself validates against (269 operations, 13 of them for storefronts). All data you see through it is synthetic.

Base URLs

Mock API · available nowhttps://<this-site>/mockServed by this website. Contract-shaped responses over synthetic data for two demo storefronts. No sign-up; the two mock storefront keys are on the Mock API page.
Real API · laterto be announcedThe real base URL and storefront keys come later. Paths and bodies are the same, so switching is a base-URL change.

Every path in the reference starts with /v1 (or /platform/v1 for operator routes), so a storefront call on the mock is <base>/v1/storefront/outlets.

Getting startedInstall the SDK and make your first call against the mock API.Mock APIKeys, routes and the errors you can trigger on purpose.GuidesBuild the Spice Route and Laneway Cafe storefronts step by step.API referenceEvery operation, its auth, parameters, bodies and errors. Searchable.AuthenticationStorefront keys, customer and guest tokens, member tokens.AI contractHow AI answers arrive: references, “Cannot verify”, and drafts.DownloadsThe TypeScript SDK package.

Ground rules for every frontend

  • Prices and totals come from the server. Send items and options; read the total back. A total your client computes is ignored.
  • Payments are recorded, never processed. Storefront checkout is pay-at-the-counter; there is no card flow.
  • Show AI numbers only through their references. See the AI contract.
  • Label what is simulated. Suppliers and Munim Cares recipients are simulated in the demo; say so wherever they appear.
  • Writes are idempotent. Every command carries a command_id and an idempotency_key; retry with the same values.