ZIONARO Developers

API reference

REST, JSON, HTTPS. Base URL:

https://zionaro.com/api/dev/v1

  1. Apply and wait for approval (we email you).
  2. Create an API key in your dashboard. Copy it — it is shown only once.
  3. Give your Developer ID to the restaurant owner. They open Settings → API & developers, enter it and choose what you may see.
  4. Call GET /restaurants to 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.

curl https://zionaro.com/api/dev/v1/me \ -H "Authorization: Bearer dq_live_your_key_here" \ -H "Accept: application/json"
  • 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:readBranches. Read branch names, addresses and online-ordering status.
menu:readMenu. Read categories, dishes, prices, options and availability.
menu:availabilityMenu availability. Mark a dish as available or sold out (nothing else can change).
tables:readTables. Read table numbers, seats and status (no QR codes).
orders:readOrders. Read approved orders with dishes and totals. Guest phone numbers are never shared.
online-orders:readOnline orders. Read pickup / delivery orders and their status (address shown only to the restaurant).
kitchen:readKitchen tickets. Read kitchen tickets and their status.
reports:readSales 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

{ "error": { "code": "missing_scope", "message": "This API key does not have the “orders:read” permission.", "request_id": "…" } }
HTTPcodeMeaning
401invalid_keyMissing, wrong, revoked or expired key.
403missing_scopeThe key, your account or the restaurant does not allow this permission.
403ip_not_allowedThe key has an IP allow-list and your server is not on it.
403developer_not_approvedYour account is waiting for approval or was suspended.
403restaurant_planThe restaurant's plan does not include API access right now.
403https_requiredPlain http:// was used.
404not_foundNot found — or the restaurant / branch is not connected to your app.
422validationA field is missing or wrong (details in "errors").
429rate_limitedToo 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.

curl "https://zionaro.com/api/dev/v1/me" \ -H "Authorization: Bearer $DINEQR_KEY"

Example answer

{ "data": { "developer": { "id": "dev_01jd…", "name": "Anil Kumar", "company": "PosLink" }, "key": { "name": "Production", "prefix": "dq_live_7Kp2X", "scopes": [ "menu:read", "orders:read" ], "expires_at": null }, "rate_limit_per_minute": 60 } }

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.

curl "https://zionaro.com/api/dev/v1/restaurants" \ -H "Authorization: Bearer $DINEQR_KEY"

Example answer

{ "data": [ { "id": "01jd2k8m3x9v…", "name": "Spice Garden", "handle": "spicegarden", "currency": "INR", "timezone": "Asia/Kolkata", "scopes": [ "menu:read", "orders:read" ], "branch_ids": null } ] }

Restaurant

Branches

GET/restaurants/{restaurant}/branches

Permission: branches:read

Branches you may see, with address and whether online pickup / delivery is open right now.

curl "https://zionaro.com/api/dev/v1/restaurants/01jd2k8m3x9v…/branches" \ -H "Authorization: Bearer $DINEQR_KEY"

Example answer

{ "data": [ { "id": 12, "name": "RS Puram", "handle": "rspuram", "status": "active", "city": "Coimbatore", "online_ordering": { "pickup": { "enabled": true, "open_now": true }, "delivery": { "enabled": true, "open_now": false } } } ] }

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.

curl "https://zionaro.com/api/dev/v1/restaurants/01jd2k8m3x9v…/branches/12/menu" \ -H "Authorization: Bearer $DINEQR_KEY"

Example answer

{ "data": [ { "id": 3, "name": "Biryani", "items": [ { "id": 41, "name": "Chicken Biryani", "price_minor": 25000, "food_type": "non_veg", "available": true, "tax_rate_bps": 500, "option_groups": [ { "name": "Portion", "required": true, "options": [ { "name": "Full", "price_delta_minor": 0 } ] } ] } ] } ] }

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.

ParameterTypeRequiredNotes
availablebooleanrequiredtrue = available, false = sold out
curl -X PATCH "https://zionaro.com/api/dev/v1/restaurants/01jd2k8m3x9v…/branches/12/menu-items/41/availability" \ -H "Authorization: Bearer $DINEQR_KEY" \ -H "Content-Type: application/json" \ -d '{"available": false}'

Example answer

{ "data": { "id": 41, "name": "Chicken Biryani", "available": false } }

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.

curl "https://zionaro.com/api/dev/v1/restaurants/01jd2k8m3x9v…/branches/12/tables" \ -H "Authorization: Bearer $DINEQR_KEY"

Example answer

{ "data": [ { "id": 7, "number": "05", "seats": 4, "status": "occupied", "section": "Hall" } ] }

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.

ParameterTypeRequiredNotes
fromdate / date-timeoptionalDefault: 7 days ago. Longest range: 31 days.
todate / date-timeoptionalDefault: now.
statuslistoptionalapproved, preparing, ready, served, completed, cancelled (comma separated)
channeltextoptionaldine_in, pickup or delivery
page / per_pagenumberoptionalper_page up to 100
curl "https://zionaro.com/api/dev/v1/restaurants/01jd2k8m3x9v…/branches/12/orders" \ -H "Authorization: Bearer $DINEQR_KEY"

Example answer

{ "data": [ { "id": 9812, "number": "O251115-00042", "status": "completed", "channel": "dine_in", "table": "05", "total_minor": 54600, "items": [ { "name": "Chicken Biryani", "quantity": 2, "line_total_minor": 50000 } ] } ], "meta": { "page": 1, "per_page": 50, "total": 1, "last_page": 1 } }

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).

curl "https://zionaro.com/api/dev/v1/restaurants/01jd2k8m3x9v…/branches/12/orders/9812" \ -H "Authorization: Bearer $DINEQR_KEY"

Example answer

{ "data": { "id": 9812, "number": "O251115-00042", "status": "completed" } }

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.

ParameterTypeRequiredNotes
from / todateoptionalSame as orders
statuslistoptionalpending, accepted, ready, out_for_delivery, completed, rejected, cancelled, not_collected
curl "https://zionaro.com/api/dev/v1/restaurants/01jd2k8m3x9v…/branches/12/online-orders" \ -H "Authorization: Bearer $DINEQR_KEY"

Example answer

{ "data": [ { "id": "01jd…", "number": "D-014", "type": "delivery", "status": "accepted", "guest_first_name": "Priya", "ready_by": "2026-11-15T20:10:00+05:30", "total_minor": 58440 } ] }

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.

ParameterTypeRequiredNotes
statuslistoptionalnew, preparing, ready, completed
curl "https://zionaro.com/api/dev/v1/restaurants/01jd2k8m3x9v…/branches/12/kitchen-tickets" \ -H "Authorization: Bearer $DINEQR_KEY"

Example answer

{ "data": [ { "id": 512, "number": "K0042", "status": "preparing", "channel": "pickup", "items": [ { "name": "Masala Dosa", "quantity": 2 } ] } ] }

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).

ParameterTypeRequiredNotes
from / todateoptionalDefault: last 7 days
branchnumberoptionalOnly one branch
curl "https://zionaro.com/api/dev/v1/restaurants/01jd2k8m3x9v…/reports/sales" \ -H "Authorization: Bearer $DINEQR_KEY"

Example answer

{ "data": { "currency": "INR", "summary": { "sales_minor": 1845000, "orders": 312, "avg_order_minor": 59134 }, "by_channel": [ { "key": "dine_in", "orders": 260, "total": 1500000 } ] } }