Referência da API

Release Candidate (V2.0.0-rc)

As especificações da API abaixo são da V2.0.0-rc. Estão publicadas para validação com o ecossistema (revisão por empresas e pilotos de implementação). Podem ainda receber ajustes com base no feedback. A release estável será publicada somente após essa fase; a V1 permanece ativa na transição.

Status e ciclo de vida: Evolução do protocolo · Changelog.

Esta seção é a fonte normativa de implementação do Open Delivery V2: as especificações da API (REST/HTTP) — endpoints, schemas, exemplos e erros.

Formato das especificações

Todas as especificações da API são escritas em OpenAPI (YAML). O site as apresenta de forma legível; o arquivo OpenAPI é o artefato canônico de cada capability.

Idioma do contrato

As especificações da API estão somente em inglês. Conceitos e fluxos de domínio ficam na tab Protocolo (PT e EN).

A tab Protocolo explica o domínio; esta tab define o contrato implementável. Em divergência, prevalece a especificação da API.

Convenções

Página	Descrição
Regras gerais	Interoperabilidade, timestamps, paginação, duplicidade de ciclo de vida
Tratamento de Erros	Envelope de erro e códigos HTTP

Infraestrutura

Comece por aqui em toda integração nova.

Spec	Descrição	Protocolo
Discovery	Endpoint well-known e declaração de capabilities	Regras
Autenticação	OAuth 2.0, token, assinatura de webhooks	Regras

Capabilities

Spec	Descrição	Protocolo
Pedidos	Ciclo de vida, status × eventos, polling e webhooks	Regras
Indoor	Contas em salão (extensão de Orders), pagamentos e fiscal	Regras
Merchant	Estabelecimento, catálogo, serviços e disponibilidade	Visão geral · Dados da Loja · Menus
Logística	Coordenação de entrega, rastreamento e problemas	Regras
Customer	Dados do cliente, leads, reviews, loyalty e eventos	Customer · Reviews · Loyalty