Base address
| Environment | Address |
|---|---|
| Sandbox | https://sandbox.partners.aurmap.com/v1 (live now) |
| Live | https://partners.aurmap.com/v1 (opens for each developer once approved) |
The sandbox address works now with sandbox keys. The live address opens for each developer once their integration is reviewed and approved.
Every request is signed as in Keys and signing. Examples use the aurmap function from the quickstart.
Groups
| Group | What it does | Scope | Status |
|---|---|---|---|
| Linking | link codes, links, unlinking | none | at launch |
| Places | read the place, pause ordering | orders:write to change |
at launch |
| Catalog | publish and patch the menu, versions | catalog:write |
menus at launch; products Coming soon |
| Availability and stock | sold out, temporary prices, stock | inventory:write |
menus at launch; counted stock Coming soon |
| Orders | receive, accept, status, cancel | orders:read, orders:write |
pickup at launch; delivery Coming soon |
| Offers | publish offers on the map | offers:write |
Coming soon |
| Accounting | daily sales and payouts | accounting:read |
Coming soon |
The events we send you are in Events.
Shared conventions
Ids
Ids are strings with a prefix: mer_ merchant, plc_ place, lnk_ link, ord_ order, evt_ event. Treat them as whole strings and do not parse them.
Item, section and add-on ids are your own. We store them as they are and give them back to you in orders. They are up to 64 chars of [A-Za-z0-9_.-], with no colon :.
Scopes
Every endpoint declares its scope, listed in a table at the top of each page. On every request we check the key, then the account, then the link to the place. customer:contact is added for systems that need the customer’s full number.
Money
Every amount is an integer in minor units (halalas), with a currency. 2990 with SAR means 29.90 in riyals.
Time
Every time is UTC in ISO 8601, like 2026-10-14T12:30:05Z. Opening hours and accounting days are in the place’s time zone, found in place.timezone.
Text
Text is a language map: { "ar": "برجر دجاج", "en": "Chicken burger" }. ar or en is enough, and you may add other languages.
Lists and pages
{ "data": [ { "…": "…" } ], "next_cursor": "c_8Jk2" }Send cursor on the next request, and limit from 1 to 100 (default 50). An empty next_cursor means you reached the end.
Errors
{ "error": { "code": "SCOPE_MISSING", "message": "This link has no orders:write scope.", "request_id": "req_01JA9Z", "details": { "scope": "orders:write" } } }All codes are in Errors.
Growth
Within v1 we only add, never remove. New fields, new values and new event types may appear. Ignore what you do not know. The full policy is in the changelog.