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

# Lojas

> Endpoints para listar, cadastrar e gerenciar lojas, assinaturas, recursos, membros e apps autorizados.

Endpoints de lojas (merchants). Todos exigem [autenticação](/docs/reference/partner/v2/authentication.md) com o scope `dv.partner`. Para o fluxo completo, veja o guia de [Lojas](/docs/guides/partner/merchant.md).

| Etapa | Endpoint | Guia |
| - | - | - |
| 1. Cadastrar | `POST /{partnerId}/merchants`: a loja nasce em `TRIAL` por 10 dias. | [Cadastrar uma loja](/docs/guides/partner/merchant/utilizando-a-api/adicionar-um-merchant.md) |
| 2. Dar acesso | `POST /merchants/{merchantId}/members` e o magic link. | [Membros](/docs/guides/partner/merchant/utilizando-a-api/membros-do-merchant.md) |
| 3. Ativar | `POST /merchants/{merchantId}/activate`, com contrato e plano. | [Assinatura](/docs/guides/partner/merchant/utilizando-a-api/gerenciar-assinatura-dos-merchants.md) |
| 4. Acompanhar | `GET /merchants`, `GET /merchants/sales`, recursos e apps autorizados. | [Listar lojas](/docs/guides/partner/merchant/utilizando-a-api/listar-merchants.md) |

Os status da assinatura e os papéis de membro estão em [Definições](/docs/guides/partner/merchant/definicoes.md).

> [!NOTE]
>
> **Formato do corpo.** Membros usam `member.role` em minúsculas (`owner`, `manager`, `operator`); recursos usam `feature.featureTypes`; assinatura usa `subscription.agreementCode` e `subscription.planId`. Campos opcionais vazios não são enviados nas respostas.

> [!WARNING]
>
> Descontinuados, mas ainda respondendo com os headers `Deprecation` e `Sunset` (data anunciada: 01/07/2025):
>
> * `GET /partner/v2/merchants/invoices` → use `GET /partner/v2/{partnerId}/merchants/invoices`.
> * `PUT /partner/v2/merchants/{merchantId}/agreementCode` → use `PUT /partner/v2/merchants/{merchantId}/subscription`.


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