API reference
REST, JSON, HTTPS. Base URL:
https://zionaro.com/api/dev/v1
- Apply and wait for approval (we email you).
- Create an API key in your dashboard. Copy it — it is shown only once.
- Give your Developer ID to the restaurant owner. They open Settings → API & developers, enter it and choose what you may see.
- Call
GET /restaurantsto get the restaurant ids, then the other endpoints.
Money is always in paise (minor units): 25000 = ₹250.00. Times are ISO-8601 in the restaurant's time zone.
API keys
Send your key in the Authorization header on every call. Never put keys in apps, websites or URLs that others can see — call the API from your server.
- Keys start with
dq_live_and are 48 characters long. - Each key has its own permissions, optional IP allow-list and optional expiry (30–365 days).
- Revoke a key any time in your dashboard; it stops working immediately.
Permissions (scopes)
A call works only if the permission is allowed for your account by us, is on the key, and was granted by the restaurant.
| branches:read | Branches. Read branch names, addresses and online-ordering status. |
| menu:read | Menu. Read categories, dishes, prices, options and availability. |
| menu:availability | Menu availability. Mark a dish as available or sold out (nothing else can change). |
| tables:read | Tables. Read table numbers, seats and status (no QR codes). |
| orders:read | Orders. Read approved orders with dishes and totals. Guest phone numbers are never shared. |
| online-orders:read | Online orders. Read pickup / delivery orders and their status (address shown only to the restaurant). |
| kitchen:read | Kitchen tickets. Read kitchen tickets and their status. |
| reports:read | Sales reports. Read sales totals by day, branch and channel. |
Rate limits
Default 60 requests per minute per key (we can raise it for approved apps), plus 600 per minute per IP address. Every answer has X-RateLimit-Limit and X-RateLimit-Remaining. When you go over, you get 429 with Retry-After (seconds). Changing dish availability is limited to 30 per minute.
Errors
| HTTP | code | Meaning |
|---|---|---|
| 401 | invalid_key | Missing, wrong, revoked or expired key. |
| 403 | missing_scope | The key, your account or the restaurant does not allow this permission. |
| 403 | ip_not_allowed | The key has an IP allow-list and your server is not on it. |
| 403 | developer_not_approved | Your account is waiting for approval or was suspended. |
| 403 | restaurant_plan | The restaurant's plan does not include API access right now. |
| 403 | https_required | Plain http:// was used. |
| 404 | not_found | Not found — or the restaurant / branch is not connected to your app. |
| 422 | validation | A field is missing or wrong (details in "errors"). |
| 429 | rate_limited | Too many requests. Wait for the Retry-After seconds. |
Security rules for your app
- Keep keys on your server only. Rotate them (create a new one, then revoke the old one) at least once a year.
- Use an IP allow-list when your server has a fixed IP.
- Ask only for the permissions you need. Use restaurant data only for the purpose you applied for.
- When a restaurant disconnects your app, delete their data from your systems.
- Report a leaked key or security issue to us at once — we can suspend it in seconds.
Account
Who am I
GET/me
Permission: any valid key
Shows your developer account, this key's name, permissions, expiry and your rate limit. Use it to test a new key.
Example answer
Account
Connected restaurants
GET/restaurants
Permission: any valid key
Restaurants whose owner connected your app, with the permissions and branches each one allowed. Use the "id" in all other calls.
Example answer
Restaurant
Branches
GET/restaurants/{restaurant}/branches
Permission: branches:read
Branches you may see, with address and whether online pickup / delivery is open right now.
Example answer
Menu
Menu
GET/restaurants/{restaurant}/branches/{branch}/menu
Permission: menu:read
Categories with their dishes: price (in paise), veg / non-veg, availability, picture, tax rate and option groups.
Example answer
Menu
Mark a dish available / sold out
PATCH/restaurants/{restaurant}/branches/{branch}/menu-items/{item}/availability
Permission: menu:availability
The only change the API can make. Body: {"available": false}. Limited to 30 calls per minute. Every change is recorded in the restaurant's audit log.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| available | boolean | required | true = available, false = sold out |
Example answer
Tables
Tables
GET/restaurants/{restaurant}/branches/{branch}/tables
Permission: tables:read
Table numbers, seats, section and status (available, occupied, billing, cleaning, disabled). QR codes are never shared.
Example answer
Orders
Orders
GET/restaurants/{restaurant}/branches/{branch}/orders
Permission: orders:read
Approved orders (newest first, 50 per page) with dishes and totals. Only orders staff approved are shown. Guest names and phone numbers are never included.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| from | date / date-time | optional | Default: 7 days ago. Longest range: 31 days. |
| to | date / date-time | optional | Default: now. |
| status | list | optional | approved, preparing, ready, served, completed, cancelled (comma separated) |
| channel | text | optional | dine_in, pickup or delivery |
| page / per_page | number | optional | per_page up to 100 |
Example answer
Orders
One order
GET/restaurants/{restaurant}/branches/{branch}/orders/{order}
Permission: orders:read
A single order with all its lines (including packing / delivery charges, marked is_charge).
Example answer
Orders
Online pickup & delivery orders
GET/restaurants/{restaurant}/branches/{branch}/online-orders
Permission: online-orders:read
Online orders with type, status, promised time and total. Only the guest's first name is shared — never the phone number, address or handover code.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| from / to | date | optional | Same as orders |
| status | list | optional | pending, accepted, ready, out_for_delivery, completed, rejected, cancelled, not_collected |
Example answer
Kitchen
Kitchen tickets (last 24 hours)
GET/restaurants/{restaurant}/branches/{branch}/kitchen-tickets
Permission: kitchen:read
Kitchen tickets with their dishes and status (new, preparing, ready, completed). Useful for kitchen display or buzzer integrations.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| status | list | optional | new, preparing, ready, completed |
Example answer
Reports
Sales report
GET/restaurants/{restaurant}/reports/sales
Permission: reports:read
Sales totals for a period (up to 31 days): per day, per branch and per channel (dine-in, pickup, delivery).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| from / to | date | optional | Default: last 7 days |
| branch | number | optional | Only one branch |
Example answer