> ## 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": ""}] (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. # Listar planos > Lista os planos do parceiro, em qualquer status. Quando `partnerId` é uma revenda, retorna apenas os planos com visibilidade `PUBLIC` e `RESALE`; quando é um parceiro, retorna também os `DIRECT_MERCHANT`. Planos `PRIVATE` nunca são retornados. ## OpenAPI ````yaml https://app.deliveryvip.com.br/swaggers/partner.yaml get /partner/v2/{partnerId}/plans openapi: 3.0.3 info: version: v2 title: API de Parceiros DeliveryVip description: >- A API de Parceiros da DeliveryVip permite que parceiros e revendas gerenciem as lojas (merchants) e as revendas da sua carteira: cadastro, consulta, membros, assinaturas, recursos contratados, aplicações autorizadas, planos e faturas. Todas as rotas exigem um access token OAuth 2.0 com o escopo `dv.partner`, enviado no cabeçalho `Authorization: Bearer `. O token dá acesso aos parceiros autorizados para a aplicação. O cabeçalho opcional `x-partners` (lista de UUIDs separados por vírgula) restringe a requisição a um subconjunto desses parceiros; um UUID fora da autorização do token resulta em `403`. Erros seguem o formato `{"status": "", "title": }`, em que `title` é um texto ou, em erros de validação, um objeto com as mensagens por campo. servers: - url: https://api.deliveryvip.com.br description: Produção security: - bearerAuth: [] tags: - name: Signup description: >- Cadastro público de loja, consumido por uma landing page e não pelo backend do parceiro. - name: Plans description: Planos disponíveis para as lojas do parceiro. - name: Invoices description: Faturas das lojas do parceiro. - name: Merchants description: Cadastro, listagem e consulta de lojas, vendas e faturas. - name: Merchants/Subscriptions description: >- Ativação, cancelamento, aviso, bloqueio e atualização da assinatura da loja. - name: Merchants/Members description: Adição, alteração e remoção de membros da loja. - name: Merchants/Applications description: Autorização e revogação de aplicações na loja. - name: Merchants/Features description: Contratação e cancelamento de recursos adicionais da loja. - name: Resales description: Cadastro, listagem e consulta de revendas e suas faturas. - name: Resales/Subscriptions description: >- Ativação, cancelamento, aviso, bloqueio e atualização da assinatura da revenda. - name: Resales/Members description: Adição, alteração e remoção de membros da revenda. - name: Resales/Applications description: Autorização e revogação de aplicações na revenda. paths: /partner/v2/{partnerId}/plans: get: tags: - Plans summary: Listar planos description: >- Lista os planos do parceiro, em qualquer status. Quando `partnerId` é uma revenda, retorna apenas os planos com visibilidade `PUBLIC` e `RESALE`; quando é um parceiro, retorna também os `DIRECT_MERCHANT`. Planos `PRIVATE` nunca são retornados. parameters: - $ref: '#/components/parameters/partnerId' responses: '200': description: Lista de planos. content: application/json: schema: type: array items: $ref: '#/components/schemas/plan' '204': description: Nenhum plano encontrado. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' components: parameters: partnerId: in: path name: partnerId description: UUID do parceiro ou da revenda. required: true schema: type: string format: uuid schemas: plan: type: object required: - id - name - standard - code - status - visibility - features properties: id: type: string format: uuid description: UUID do plano. name: type: string description: Nome do plano. standard: type: boolean description: Indica se é o plano padrão do parceiro. code: type: string description: Código do plano. status: type: string description: Status do plano. enum: - DRAFT - AVAILABLE - UNAVAILABLE visibility: type: string description: Para quem o plano pode ser oferecido. enum: - PUBLIC - PRIVATE - RESALE - DIRECT_MERCHANT features: type: array description: Recursos do plano. items: type: object required: - featureType - inclusionType properties: featureType: $ref: '#/components/schemas/itemType' inclusionType: type: string description: >- `INCLUDED` quando o recurso está incluído no plano; `ADDITIONAL` quando é contratado à parte. enum: - INCLUDED - ADDITIONAL itemType: type: string description: Recurso cobrado. enum: - DELIVERY_TAKEOUT - DELIVERYBOT_NOTIFICATION - DELIVERYBOT_ASSISTANT - INDOOR_VIEWER - INDOOR_QRCODE - INDOOR_TABLET - DOMAIN_CUSTOM - GROWTH_DISCOUNT - INTEGRATION_MARKETING - INTEGRATION_LOGISTIC - SALES_REVENUE - ORDERS_COUNT - MULTI_STORE error: type: object properties: status: type: string description: Código HTTP, como texto. example: '422' title: description: >- Mensagem de erro. Em erros de validação, é um objeto com a lista de mensagens de cada campo. oneOf: - type: string - type: object additionalProperties: type: array items: type: string responses: Unauthorized: description: Token ausente, inválido ou expirado. content: application/json: schema: type: object properties: title: type: string example: Unauthorized status: type: integer example: 401 Forbidden: description: >- Proibido. Retornado quando o token não tem o escopo `dv.partner`, quando o cabeçalho `x-partners` é inválido ou quando o `partnerId` não é autorizado para o token. content: application/json: schema: $ref: '#/components/schemas/error' securitySchemes: bearerAuth: type: http scheme: bearer description: >- Access token OAuth 2.0 (opaco) com o escopo `dv.partner`, obtido em `POST /authentication/v1/oauth/token`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.