API reference

Release Candidate (V2.0.0-rc)

The API Specs below are V2.0.0-rc. They are published for ecosystem validation (company review and implementation pilots). They may still change based on feedback. A stable release will be published only after that phase; V1 remains active during the transition.

Status and lifecycle: Protocol evolution · Changelog.

This section is the normative implementation source for Open Delivery V2: the API Specs (REST/HTTP) — endpoints, schemas, examples, and errors.

Specification format

All API Specs are written in OpenAPI (YAML). The site presents them in a readable form; the OpenAPI file is the canonical artifact for each capability.

Contract language

API Specs are English only. Domain concepts and flows are in the Protocol tab (PT and EN).

The Protocol tab explains the domain; this tab defines the implementable contract. On conflict, the API Spec wins.

Conventions

Page	Description
General rules	Interoperability, timestamps, pagination, duplicate lifecycle ops
Error handling	Error envelope and HTTP status codes

Infrastructure

Start here for every new integration.

Spec	Description	Protocol
Discovery	Well-known endpoint and capability declaration	Rules
Authentication	OAuth 2.0, token, webhook signing	Rules

Capabilities

Spec	Description	Protocol
Orders	Lifecycle, status vs events, polling and webhooks	Rules
Indoor	Dine-in accounts (Orders extension), payments, fiscal	Rules
Merchant	Establishment, catalog, services, availability	Overview · Store data · Menus
Logistics	Delivery coordination, tracking, problems	Rules
Customer	Customer data, leads, reviews, loyalty, events	Customer · Reviews · Loyalty