GoodBytz Order Integration Schema (1.1.0)
The endpoints a customer provides so GoodBytz can pull orders and report their status.
What you build
- Order pull endpoint (
GET): GoodBytz calls it at a fixed interval (a few seconds, set per kitchen) and cooks every new order it returns. - Order status endpoint (
POST): GoodBytz calls it each time an order changes status.
The paths below are placeholders. Send GoodBytz your base URL and the paths you chose.
Rules for both endpoints
- Every call carries the API key or any authentication credential you issue to GoodBytz, as agreed during setup.
- The order status of any order processed by GoodBytz system is sent to the order status endpoint provided, and it is expected that the order is removed from the pull endpoint.
- An order is identified by its
client_external_id. GoodBytz never creates two orders with the sameclient_external_id.
Servers
Customer-provided base URL
https://customer-api.example