> ## 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.

# Use esta documentação com IA

> Conecte a documentação da DeliveryVip ao Claude, ChatGPT, Cursor ou VS Code para tirar dúvidas e gerar código de integração com base no conteúdo oficial.

Assistentes de IA escrevem integrações melhores quando leem a documentação atual em vez de depender do que aprenderam no treinamento. Esta documentação foi preparada para isso: cada página pode ser lida em Markdown, há um índice para modelos de linguagem e um servidor MCP para o seu editor consultar.

## Pelo menu da página

No topo de cada página há um menu com atalhos:

| Opção | O que faz |
| - | - |
| **Copiar página** | Copia a página em Markdown para colar no assistente. |
| **Ver como Markdown** | Abre a versão em Markdown da página. |
| **Abrir no ChatGPT** / **Abrir no Claude** | Abre uma conversa já com a página como contexto. |
| **Conectar ao Cursor** / **Conectar ao VS Code** | Instala o servidor MCP da documentação no editor. |
| **Copiar MCP Server** | Copia o endereço do servidor MCP para configurar em outro cliente. |

## Servidor MCP

Com o servidor MCP instalado, o assistente do editor pesquisa esta documentação sozinho enquanto escreve o código. Use **Conectar ao Cursor**, **Conectar ao VS Code** ou **Copiar MCP Server** no menu de qualquer página. O endereço é o desta documentação seguido de `/mcp`.

> [!TIP]
>
> Peça ao assistente para consultar a documentação antes de responder, por exemplo: "Usando o MCP da DeliveryVip, escreva o polling de eventos com confirmação em Node.js."

## llms.txt

Para ferramentas que leem arquivos de contexto, acrescente ao endereço desta documentação:

* `/llms.txt`: índice de todas as páginas, com título e descrição.
* `/llms-full.txt`: a documentação inteira em um só arquivo.

## Especificações OpenAPI

Para gerar clientes ou dar ao assistente o contrato exato de cada rota, use as specs da [página do Postman](/docs/inicio/conceitos/postman.md#specs-disponíveis).

> [!WARNING]
>
> Confira o código gerado antes de usar em produção, principalmente a validação da assinatura dos webhooks e o tratamento de erros. E nunca cole `client_secret` ou tokens no chat de um assistente.


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