Help

Go-live checklist

The steps to test before you go live.

The restaurant creates the connection and hands you the base URL and API key.
GET /ping → 200 with the connection's name and the restaurant's name.
PUT /webhook with your https URL → store the webhookSecret. If the restaurant has synced its menu, menu.updated arrives at once.
Verify signatures, download the file from url, and check its SHA-256 against hash.
The restaurant changes and syncs its menu → a new menu.updated with the same url and a new hash. A sync without a change → the same hash.
Send test orders: pickup and delivery, courier store and partner, asap and scheduled, cash and online, with a discount and a quantity above 1. Each rings in the till under the connection's name.
The restaurant accepts with a time, sets the order ready and completes it → order.accepted (with pickupAt), order.ready and order.completed, with rising version. A rejection → order.rejected with a reason.
Cancel an order → 200; the till shows it cancelled, and GET /orders/{externalId} says cancelled.
With your own courier: send picked_up, then delivered → the till shows the status, and the order can be completed.
The restaurant switches an item off → menu.updated (same url, new hash, the item has available: false). An order with that item anyway → 201.
The restaurant goes offline → store.status_changed; a new order → 409 STORE_OFFLINE.
Error paths: wrong sums, the same order twice, a lost answer retried with the same body.
Your endpoint answers 500 for a while → events stay queued and arrive after you recover.
The restaurant rotates the key → the old key keeps working for 24 hours. The restaurant deletes the connection → connection.revoked, then 403 for every call.