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

# Definições de lojas

> Status e ciclo de vida da assinatura, aviso e bloqueio, status de recursos e papéis de membros.

Os conceitos abaixo aparecem nas respostas da API de lojas e decidem quais ações são aceitas em cada momento.

## Tipos de Assinaturas

O campo `subscription.status` diz em que ponto da vida comercial a loja está.

| status | Descrição |
| - | - |
| `TRIAL` | Status inicial de toda loja nova. A loja usa a plataforma sem custo até `trialExpiresAt` (10 dias após o cadastro). |
| `TRIAL_EXPIRED` | O período de teste acabou sem ativação. A loja perde o acesso à plataforma. |
| `ACTIVATED` | Assinatura ativa e faturada. |
| `CANCELLED` | Assinatura cancelada. |
| `DEMO` | Loja de demonstração. É criada automaticamente junto com cada nova revenda e não pode ser ativada. |

## Ciclo de vida da assinatura

![Estados da assinatura: TRIAL, TRIAL\_EXPIRED, ACTIVATED e CANCELLED, com as transições activate e cancel](https://mintcdn.com/deliveryvip-a4256422/ELxpcniK2_BP8zxT/images/ciclo-assinatura-loja.png?fit=max\&auto=format\&n=ELxpcniK2_BP8zxT\&q=85\&s=224700b8d7eae9ee5805a7ed1c8aef4e)

Status da assinatura de uma loja

> [!NOTE]
>
> A expiração do teste é automática. Todas as outras transições são feitas pela API de [assinatura](/docs/guides/partner/merchant/utilizando-a-api/gerenciar-assinatura-dos-merchants.md).

## Aviso e bloqueio

Enquanto a assinatura está `ACTIVATED`, ela pode ter uma de duas sinalizações. Elas são exclusivas: ativar uma desliga a outra.

| Campo | Ação | Uso |
| - | - | - |
| `warning` | `warning` / `unwarning` | Avisar a loja sobre um possível bloqueio, por exemplo por atraso de pagamento. |
| `blocked` | `block` / `unblock` | Bloquear o uso da loja. A assinatura continua `ACTIVATED` e continua sendo cobrada. |

`warning`, `blocked`, `lastWarningAt` e `lastBlockedAt` só aparecem na resposta quando o status é `ACTIVATED`.

## Status dos recursos

Cada item de `features` mostra um recurso da loja e se ele está contratado.

| status | Descrição |
| - | - |
| `AVAILABLE` | O recurso pode ser contratado. |
| `ACTIVATED` | O recurso está contratado. |
| `CANCELLED` | O recurso foi cancelado há menos de 24 horas ou no mês corrente. Depois disso volta a `AVAILABLE`. Em lojas `TRIAL` ou `DEMO`, um recurso cancelado aparece direto como `AVAILABLE`. |

Os tipos de recurso estão em [Gerenciar recursos](/docs/guides/partner/merchant/utilizando-a-api/gerenciar-recursos-dos-merchants.md#sobre-os-recursos).

## Papéis de membros

| Papel | Envio | Resposta |
| - | - | - |
| Proprietário | `owner` | `OWNER` |
| Gerente | `manager` | `MANAGER` |
| Operador | `operator` | `OPERATOR` |

O papel é enviado em minúsculas e volta em maiúsculas. Veja [Membros da loja](/docs/guides/partner/merchant/utilizando-a-api/membros-do-merchant.md).


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