Pular para o conteúdo principal
O Open Delivery é uma especificação aberta brasileira que padroniza a integração entre plataformas de pedidos e sistemas de PDV/gestão. Se o seu sistema já fala Open Delivery, você integra com a DeliveryVip sem escrever código específico da nossa API proprietária.

​
Papéis

Na terminologia do Open Delivery:

​
Quem chama quem

As chamadas acontecem nos dois sentidos. Você chama a API OD da DeliveryVip com um token OAuth por loja; a DeliveryVip chama o seu webhook e o seu endpoint de catálogo.
O cliente HTTP do PDV chama a API Open Delivery; a DeliveryVip envia eventos ao ordersWebhookURL e importa o catálogo da getMerchantURLO cliente HTTP do PDV chama a API Open Delivery; a DeliveryVip envia eventos ao ordersWebhookURL e importa o catálogo da getMerchantURL

Quem chama quem no Open Delivery

​
Versões suportadas

Os métodos de entrega de eventos disponíveis são WEBHOOK e POLLING. Recomendamos webhook como canal principal e polling como reconciliação; veja Recebendo eventos. Você pode consultar as versões em tempo de execução pelos endpoints de versão; veja Primeiros passos.

​
Um app, várias lojas

Você cadastra um único app com a extensão Open Delivery e ele atende todas as lojas que o instalarem. Cada loja instalada recebe:
  • um client_secret próprio (o client_id é o do app): o token emitido com ele vale só para aquela loja, e é com ele que os webhooks da loja são assinados;
  • a própria configuração: merchantId, URL de webhook e endpoint de catálogo, definidos no onboarding;
  • o próprio circuito de webhooks: uma loja com endpoint fora do ar não interrompe as entregas das demais.

​
Host da API

A API Open Delivery da DeliveryVip roda em um host dedicado:
Os endpoints da spec ficam sob o prefixo /v1. O endpoint de token OAuth fica na raiz desse host (POST /oauth/token), fora do /v1, porque a spec OD pede uma baseURL de autenticação separada.
Se o seu sistema monta as rotas direto na URL base, sem o /v1 (padrão das primeiras versões do Open Delivery), configure a URL base da API como https://od.deliveryvip.com.br/v1 e mantenha a URL de login em https://od.deliveryvip.com.br. Um 404 em todas as chamadas costuma ser esse caso.

​
Datas em UTC

As datas da API Open Delivery são em UTC (RFC 3339, sufixo Z, ex.: 2026-08-10T17:39:28Z), conforme exigido pela spec OD. Note a diferença para a API Merchant V3, que usa UTC-3; veja Datas e horários. Isso vale também para o createdAt dos eventos entregues por webhook.

​
Open Delivery ou API Merchant V3?

Open Delivery

Para quando o seu sistema já implementa (ou vai implementar) o padrão para integrar com múltiplas plataformas. Você reaproveita a mesma integração.

API Merchant V3

Para acessar os recursos proprietários da plataforma que vão além da spec, como Indoor (comandas e places), descontos e a API de catálogo própria.
Os dois caminhos são independentes: o formato dos objetos (pedido, catálogo) no Open Delivery segue a spec oficial, e esta seção documenta apenas o que é específico da DeliveryVip.

​
Comece por aqui

Primeiros passos

Crie o app, receba a credencial da loja e obtenha o token.

Onboarding de lojas

Registre merchantId, webhook e endpoint de catálogo de cada loja.

Recebendo eventos

Webhook assinado como canal principal e polling como reconciliação.

Ciclo de vida do pedido

Detalhes do pedido e as transições de status.

Seu primeiro pedido

Um programa completo: webhook assinado, confirmação do pedido e reconciliação pelo polling.