Public API

The Restro API lets other software you run — accounting, delivery aggregation, loyalty, business intelligence — read your orders, menu, customers, and stock, and write back menu and stock changes.

It is a JSON over HTTPS API. Everything is scoped to a single restaurant by the key you authenticate with, so a key can never reach data that is not yours.

#Base URL

https://api.tryrestro.com/v1

#The shape of it

curl https://api.tryrestro.com/v1/orders \
  -H "Authorization: Bearer rk_a1b2c3d4e5f60718_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

{
  "data": [
    {
      "id": "cmd8x2k9p0001abcdefghijkl",
      "number": 1042,
      "type": "delivery",
      "status": "confirmed",
      "paymentStatus": "paid",
      "currency": "EGP",
      "total": "184.00"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total": 132,
    "totalPages": 6,
    "hasMore": true
  }
}

#Where to go next

1. Authentication — creating a key and using it.
2. Conventions — pagination, errors, rate limits, and money.
3. The endpoint references: Orders, Menu, Customers, Inventory.
4. Webhooks — being told about orders instead of polling for them.

If you only need to react to orders, skip the endpoints and read the webhooks page. Polling /orders on a timer is the wrong shape for that problem.