Introduction
Each section of the API Reference covers one domain of the API, and each page in a section covers one operation or one webhook event.
How to read a reference page
- The page title is a short description of the operation, for example Create an order.
- Under the title is the path. It ends with the operation name, for example
createOrder. That name is also theoperationIdin the OpenAPI document, so a method in a generated client has the same name. Every operation is aPOSTwith one JSON body and one JSON reply. - Request lists the fields of the body: the field name, its type and its description. For an enumerated field, Possible values lists every accepted value.
- The right-hand column shows the authorization headers that the operation requires and a code sample that you can copy, in cURL, Go, raw HTTP, Java, JavaScript and Python.
OpenAPI document
The whole API is also published as one OpenAPI 3.1 document, for generating a client or importing into your own tools: openapi.json.
Sections
- Orders: create and cancel orders, report delivery status, read an order, and the
order.*webhook events. - Stores: the stores on your channel.
- Menus: what each store sells, and the
item.availability.changedwebhook event.
A webhook event page describes a delivery that we send to the url registered for your channel. It documents a payload. It is not an endpoint that you call.