> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Documentação das APIs da DeliveryVip, em português. Regras que mais quebram integrações: (1) Merchant API: faça polling em GET /merchant/v3/events:polling no máximo a cada 30 s por token; confirme todo evento recebido com POST /merchant/v3/events/acknowledgment e corpo [{"id": "<eventId>"}] (o campo lido é id, não eventId), inclusive eventos repetidos ou que o sistema não trata; deduplique por eventId; o evento é só um aviso, busque o pedido na orderURL. (2) Tokens client_credentials valem 24 h e não têm refresh_token: peça outro ao receber 401. (3) Webhooks: valide a assinatura HMAC sobre o corpo bruto e responda 2xx rápido; o polling é a reconciliação. (4) Open Delivery: host od.deliveryvip.com.br, um client_secret por loja, datas em UTC. (5) Fidelidade: o operador implementa 5 rotas assinadas com HMAC e chama o config push; o estorno precisa ser idempotente. (6) Partner API: scope dv.partner. Não invente endpoints: use a referência gerada das specs OpenAPI.

# DeliveryVip Developers

> Integre seu sistema à DeliveryVip para receber pedidos, sincronizar o catálogo, conectar seu programa de fidelidade ou gerenciar lojas como parceiro.

## Qual integração é a sua?

Escolha o caminho que descreve o seu sistema. Cada um tem o próprio passo a passo, guias e referência.

> [card] [Merchant API](/docs/guides/merchant.md)
>
> Tenho um PDV ou ERP e quero receber pedidos, atualizar o catálogo e gerenciar comandas e descontos pela API da DeliveryVip.

> [card] [Open Delivery](/docs/guides/open-delivery.md)
>
> Meu PDV já fala o padrão aberto Open Delivery e quero integrar sem escrever código específico da DeliveryVip.

> [card] [Fidelidade](/docs/guides/merchant/loyalty.md)
>
> Tenho um programa de fidelidade ou CRM e quero oferecer adesão, resgate de cashback e acúmulo no checkout das lojas.

> [card] [Partner API](/docs/guides/partner.md)
>
> Sou parceiro ou revenda e quero cadastrar lojas e gerenciar assinaturas, recursos e faturas.

## Merchant API ou Open Delivery?

Os dois caminhos levam os pedidos da DeliveryVip até o seu PDV. A diferença está no padrão que o seu sistema fala.

| | Merchant API (V3) | Open Delivery |
| - | - | - |
| **Padrão** | API própria da DeliveryVip | Especificação aberta da Abrasel (Order `1.3.0`, Merchant `1.0.0`) |
| **Host** | `api.deliveryvip.com.br` | `od.deliveryvip.com.br` |
| **Credenciais** | `client_id` e `client_secret` do app; o mesmo token atende todas as lojas que instalaram o app | `client_id` do app e um `client_secret` por loja; cada token vale para uma loja |
| **Eventos** | Webhook ou polling | Webhook ou polling |
| **Catálogo** | Você envia pela API (update, upsert e force) | Você expõe um endpoint de catálogo no padrão OD e a DeliveryVip importa |
| **Escolha se** | Você está construindo a integração do zero | Seu PDV já implementa Open Delivery para outras plataformas |

> [!NOTE]
>
> A **Fidelidade** é uma extensão de app: o operador usa a Merchant API para ativar o programa e ler os pedidos, e implementa as rotas que a DeliveryVip chama no checkout.

## Antes de começar

Estes passos são os mesmos em qualquer integração.

> [card] [Jornada do Developer](/docs/inicio/primeiros-passos/jornada-do-developer.md)
>
> Da criação da conta até a primeira chamada à API, passo a passo.

> [card] [Autenticação](/docs/inicio/conceitos/autenticacao.md)
>
> Como obter e renovar o token OAuth2 do seu app.

> [card] [Instalando o app na loja](/docs/inicio/primeiros-passos/instalando-app-na-loja.md)
>
> Como o lojista instala e autoriza o seu app pela Delivery Store.

> [card] [Postman](/docs/inicio/conceitos/postman.md)
>
> Coleções prontas, com OAuth2 configurado, para chamar a API sem escrever código.

> [card] [Use com IA](/docs/inicio/conceitos/usando-com-ia.md)
>
> Conecte esta documentação ao Claude, ChatGPT, Cursor ou VS Code.

> [card] [Conceitos](/docs/inicio/conceitos.md)
>
> Erros, paginação, datas e horários, rate limiting e Postman.

## Acompanhe as mudanças

> [card] [Changelog](/docs/changelog.md)
>
> As principais alterações nas APIs, em ordem cronológica.

> [card] [Deprecations](/docs/deprecations.md)
>
> Endpoints em descontinuação, prazos e como migrar.

## Suporte

Em caso de dúvidas durante a integração:

* **Discord**: [canal de desenvolvedores](https://discord.gg/AJF8Yha4)
* **Reunião**: [agende com nosso time](https://calendar.app.google/EchaXk57y7xp8Hyx6)
* **Status**: [status.deliveryvip.com.br](https://status.deliveryvip.com.br), para conferir se há instabilidade antes de investigar do seu lado
* **Lojistas**: dúvidas de uso do painel ficam na [central de ajuda](https://ajuda.deliveryvip.com.br)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.