API reference · Orders

Get an order

GET/v1/orders/{id}

Current status, timeline, totals and delivery person of an order placed with this key.

Scope orders:read
600 / minute

Path parameters

idstringrequired: Order id from Place an order.

Request

curl https://api.billzova.com/v1/orders/0b8e… \
  -H "Authorization: Bearer $BILLZOVA_KEY"

const order = await fetch(`https://api.billzova.com/v1/orders/${id}`, {
  headers: { Authorization: `Bearer ${process.env.BILLZOVA_KEY}` },
}).then((r) => r.json());

Response

200 · application/json

{
  "id": "0b8e…", "object": "order", "test": false, "status": "OUT_FOR_DELIVERY",
  "delivery": { "address": { … }, "person": { "name": "Ramesh", "phone": "9811122233" } },
  "timeline": { "placedAt": "…", "acceptedAt": "…", "outForDeliveryAt": "…", "completedAt": null },
  "…": "…"
}

Good to know

A key only sees orders placed with that same key. Other restaurants' or other keys' orders always return 404.

Errors

Code	HTTP	Meaning
NOT_FOUND	404	Not found (or not visible to this key).
SCOPE_MISSING	403	The key is not allowed to do that.
RATE_LIMITED	429	Too many requests — wait for `Retry-After` seconds.