A few ideas cover the whole integration. Read this once before the quickstart; every other guide builds on these terms.
The parts
Your website never calls Nexus directly. Your backend holds the website key and makes every request. The restaurant controls its menu and decides on every order; the gateway connects the two.
Key terms
| Term | Meaning |
|---|---|
| Tenant | The restaurant business you integrate with. It can have several locations. |
| Website key | Your secret API key. It identifies the tenant and must stay on your backend. |
| Connection | One place that receives website orders: a location and its register. Every menu, order and status request names a connection ID. |
| Register | The point of sale (POS) where restaurant staff see, accept and fulfil your orders. |
| Menu revision | The version of a published menu. You send it with each order so prices are checked against what the customer saw. |
| Bani | The minor unit of the Romanian leu. All amounts are integers in bani: 3700 is 37.00 RON. |
| Variant, bundle, extra | The three kinds of product choice: a defining option such as size, an included component such as a drink, and a paid addition such as extra cheese. |
| External order ID | The ID you generate for a purchase. Reusing it makes retries safe; the same connection and ID cannot create a second order. The same ID on a different connection is a different order. |
One order, end to end
- The restaurant enables website ordering for a register and publishes its menu from Retail Admin.
- Your backend lists the tenant’s connections and picks the one for the customer’s chosen location.
- It reads that connection’s menu and shows it on your website.
- The customer builds a cart. Your backend calculates the total from the menu.
- Your backend saves the order with its own ID, then submits it.
201means the restaurant has received it, not yet accepted it. - Staff accept or reject the order in the Register.
- Your backend receives signed webhook updates and shows progress to the customer. It reads current status to reconcile missed updates; polling is a fallback without webhooks.
Register a webhook before submitting orders to receive confirmed status updates. Polling remains available for reconciliation.
What the API does not do
- Take payment. Your payment provider charges and refunds. You tell Nexus how the order is paid.
- Dispatch drivers or quote delivery. Delivery zones and couriers stay with you and the restaurant.
- Manage customers. Orders carry a name and phone only; accounts and marketing stay on your side.
Next: make your first requests in the quickstart.