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

# Deprecations

> Rotas em descontinuação, os prazos de cada uma e como migrar para as substitutas.

Esta página lista as rotas que estão sendo descontinuadas, o que usar no lugar e como migrar. Rotas em deprecação continuam respondendo, mas podem ser removidas: migre o quanto antes.

## Situação atual

| Rota | Substituta | Status | Prazo |
| - | - | - | - |
| Partner API **v1** (todas as rotas) | [Partner API V2](/docs/guides/partner.md) | Removida | Encerrado |
| Merchant API **v1/v2** (todas as rotas) | [Merchant API V3](/docs/guides/merchant.md) | Prazo encerrado | 01/08/2026 |
| Tabs `available` / `unavailable` | Tabs `opened` / `closed` | Prazo encerrado | 01/08/2026 |
| Invoices sem `{partnerId}` (Partner V2) | Invoices com `{partnerId}` | Prazo encerrado | 01/08/2026 |
| `agreementCode` (Partner V2) | `subscription` | Prazo encerrado | 01/08/2026 |

> [!CAUTION]
>
> O prazo de 01/08/2026 já passou. As rotas marcadas como **Prazo encerrado** ainda respondem, mas não há garantia de que continuem: integrações que dependem delas podem parar a qualquer momento. Migre agora.

## Linha do tempo

![Linha do tempo: 22/04/2025 início da deprecação da Partner v1, Merchant v1/v2, invoices e agreementCode; 17/06/2025 Tabs; 30/06/2026 prazo adiado; 01/08/2026 fim do prazo](https://mintcdn.com/deliveryvip-a4256422/ELxpcniK2_BP8zxT/images/deprecations-linha-do-tempo.png?fit=max\&auto=format\&n=ELxpcniK2_BP8zxT\&q=85\&s=0953144f661fc1dc7d8684625ccc16fd)

Linha do tempo das deprecações

## Como identificar uma rota em deprecação

Rotas em deprecação respondem normalmente, com dois headers a mais:

```http theme={null}
HTTP/1.1 200 OK
Deprecation: true
Sunset: Mon, 01 Dec 2025 00:00:00 GMT
Content-Type: application/json
```

> [!TIP]
>
> Registre um alerta no seu cliente HTTP sempre que uma resposta vier com `Deprecation: true`. Assim você descobre rotas antigas esquecidas antes que elas parem.

> [!WARNING]
>
> O valor do `Sunset` enviado hoje não reflete o adiamento para 01/08/2026: as rotas de Merchant v1/v2 e Tabs enviam `Mon, 01 Dec 2025 00:00:00 GMT`, e as de invoices e `agreementCode` da Partner V2 enviam `Tue, 01 Jul 2025 00:00:00 GMT`. Use o header como sinal de deprecação e esta página como referência de prazo.

Depois da remoção, a rota responde `410 Gone` (ou deixa de existir) e a integração que não migrou deixa de funcionar.

```http theme={null}
HTTP/1.1 410 Gone
```

## Migrando

> [accordion] Tabs: available / unavailable → opened / closed
>
> Anunciado em 16/06/2025. As ações de abrir e fechar comanda ganharam nomes que dizem o que fazem.
>
> | Deprecada | Substituta |
> | - | - |
> | `POST /merchant/v3/{merchantId}/tabs/{tabId}/available` | `POST /merchant/v3/{merchantId}/tabs/{tabId}/opened` |
> | `POST /merchant/v3/{merchantId}/tabs/{tabId}/unavailable` | `POST /merchant/v3/{merchantId}/tabs/{tabId}/closed` |
>
> **1. Troque o caminho**
>
> Substitua `/available` por `/opened` (abrir a comanda para consumo) e `/unavailable` por `/closed` (fechar a comanda).
>
> **2. Confira o header**
>
> Depois da troca, as respostas não devem mais trazer `Deprecation: true`.
>
> Veja [Indoor](/docs/guides/merchant/indoor.md).

> [accordion] Partner V2: invoices sem partnerId
>
> Anunciado em 22/04/2025, com o novo sistema de cobrança.
>
> | Deprecada | Substituta |
> | - | - |
> | `GET /partner/v2/merchants/invoices` | `GET /partner/v2/{partnerId}/merchants/invoices` |
> | `GET /partner/v2/resales/invoices` | `GET /partner/v2/{partnerId}/resales/invoices` |
>
> **1. Inclua o partnerId no caminho**
>
> Use o ID do parceiro dono das faturas. Um token com vários parceiros faz uma chamada por parceiro.
>
> **2. Revise o parse da resposta**
>
> As rotas novas seguem o modelo de faturas por plano. Veja [Invoices](/docs/guides/partner/invoices.md).

> [accordion] Partner V2: agreementCode → subscription
>
> Anunciado em 22/04/2025.
>
> | Deprecada | Substituta |
> | - | - |
> | `PUT /partner/v2/merchants/{merchantId}/agreementCode` | `PUT /partner/v2/merchants/{merchantId}/subscription` |
> | `PUT /partner/v2/resales/{resaleId}/agreementCode` | `PUT /partner/v2/resales/{resaleId}/subscription` |
>
> **1. Troque a rota**
>
> Envie o mesmo código de contrato pela rota `subscription`, que atualiza a assinatura inteira.
>
> **2. Revise o corpo**
>
> Veja os campos aceitos em [Gerenciar assinatura dos merchants](/docs/guides/partner/merchant/utilizando-a-api/gerenciar-assinatura-dos-merchants.md) e [das revendas](/docs/guides/partner/resale/utilizando-a-api/gerenciar-assinatura-das-revendas.md).

> [accordion] Merchant API v1/v2 → V3
>
> Anunciado em 22/04/2025. Todas as rotas v1 e v2 da Merchant API foram substituídas pela V3, que segue o modelo Open Delivery.
>
> **1. Gere o token com o scope od.all**
>
> A V3 usa o mesmo [OAuth2](/docs/inicio/conceitos/autenticacao.md) com o scope `od.all`.
>
> **2. Reimplemente o fluxo de pedidos**
>
> Siga [Receba seu primeiro pedido](/docs/guides/merchant/order/fluxo-de-integracao/recepcao-de-pedidos.md): eventos, acknowledgment, detalhes e ações.
>
> **3. Migre o catálogo**
>
> Use `merchantUpdate`, `merchantUpsert` e `merchantForce`. Veja [Catálogo](/docs/guides/merchant/catalog-and-services.md).

> [accordion] Partner API v1 → V2
>
> Anunciado em 22/04/2025 e **já removida**: as rotas v1 não são mais atendidas. Use a [Partner API V2](/docs/guides/partner.md) com o scope `dv.partner`.

## Histórico de avisos

> [accordion] 16/06/2025: Tabs API
>
> Início da deprecação em 17/06/2025 das rotas `available` e `unavailable` das comandas, substituídas por `opened` e `closed`. Prazo original de descontinuação: 01/08/2026.

> [accordion] 22/04/2025: Partner API e Merchant API v1/v2
>
> A Partner API consolidou operações redundantes e introduziu assinaturas com governança unificada. Entraram em deprecação as invoices sem `partnerId`, as rotas `agreementCode`, todas as rotas v1/v2 da Merchant API e todas as rotas v1 da Partner API. O prazo foi adiado para 01/08/2026 em 30/06/2026, quando a Partner v1 foi removida.


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