Welcome to the Ordering API
The Ordering API exposes project-scoped resources for businesses, menus, products, carts, orders, users, delivery, payments, loyalty, and reporting.
Request URL
Requests use this general structure:
https://apiv4.ordering.co/{version}/{language}/{project}/{resource}
| Segment | Purpose |
|---|---|
version | Selects the API version, such as v400. |
language | Selects the response language; it does not change the operation contract. |
project | Identifies the Ordering project. |
resource | Identifies the requested API resource. |
Use project-specific values supplied through an approved environment. Never copy credentials, project identifiers, or customer data from documentation examples.
Authentication
Each operation defines its authentication requirement, which may use bearer authentication, an API key, either alternative, or no operation-level authentication.
For background and least-privilege guidance, see Users Authentication and User API Key. Keep API keys and tokens server-side and out of source control, browser bundles, screenshots, and logs.
Responses and queries
Many operations use an error and result response envelope. Response fields, HTTP status behavior, pagination, filters, and relation expansion are specified per operation.
The API summary introduces common URL and query concepts. The Pagination and Filtering guides describe these common concepts without replacing operation schemas.
