# DeliveryVip Developers > Documentação das APIs da DeliveryVip: Merchant API, Open Delivery, Fidelidade e Partner API, com guias, tutoriais e referência. > ## 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. - [DeliveryVip Developers](https://deliveryvip-a4256422.mintlify.dev/docs/index.md): Integre seu sistema à DeliveryVip para receber pedidos, sincronizar o catálogo, conectar seu programa de fidelidade ou gerenciar lojas como parceiro. - [Primeiros passos](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/primeiros-passos/index.md): Crie sua conta, a conta de desenvolvedor e o primeiro app para consumir as APIs da DeliveryVip. - [Jornada do Developer](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/primeiros-passos/jornada-do-developer.md): Da criação da conta até a primeira chamada à API, com o caminho certo para o seu tipo de integração. - [Distribuição direta](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/primeiros-passos/distribuicao-direta.md): Crie um app de distribuição direta, envie o token de autorização para a loja e obtenha o token de acesso via client credentials. - [Distribuição interativa](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/primeiros-passos/distribuicao-interativa.md): Crie um app com tela própria, que abre dentro ou fora do painel da loja e recebe a autorização pela Redirect URI. - [Instalando o app na loja](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/primeiros-passos/instalando-app-na-loja.md): O passo a passo que o lojista segue na Delivery Store para instalar e autorizar o seu app. - [Conceitos](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/conceitos/index.md): As regras que valem para todas as APIs da DeliveryVip, de autenticação a paginação e limites. - [Autenticação](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/conceitos/autenticacao.md): Obtenha, use, renove e revogue o token OAuth2 que autentica o seu app nas APIs da DeliveryVip. - [Erros](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/conceitos/erros.md): O formato do corpo de erro das APIs da DeliveryVip e o que fazer com cada status HTTP. - [Paginação](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/conceitos/paginacao.md): Navegue pelas listagens paginadas com os cursores next e previous, o header Link e o parâmetro per_page. - [Datas e horários](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/conceitos/datas-e-horarios.md): O formato das datas nas APIs da DeliveryVip, o fuso de cada API e como interpretar os valores sem errar por 3 horas. - [Rate limiting](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/conceitos/rate-limiting.md): O limite de requisições das APIs da DeliveryVip e como a sua integração deve reagir ao 429. - [Postman](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/conceitos/postman.md): Baixe as coleções prontas da DeliveryVip, ou importe as specs OpenAPI, e chame a API pelo Postman sem escrever código. - [Use esta documentação com IA](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/conceitos/usando-com-ia.md): 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. - [Testes e ir para produção](https://deliveryvip-a4256422.mintlify.dev/docs/inicio/testes-e-producao.md): Como testar a integração numa loja de teste, o checklist de cada produto antes de liberar e o que muda quando as lojas reais instalam o seu app. - [Autenticação](https://deliveryvip-a4256422.mintlify.dev/docs/reference/merchant/v3/authentication.md): Como autenticar as chamadas da Merchant API V3 e quais scopes cada grupo de endpoints exige. - [Obter access token](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/oauth/obter-access-token.md): Emite um access token com `grant_type=client_credentials`. As credenciais podem ser enviadas no corpo (`client_id`/`client_secret`) ou via HTTP Basic. Quando o `client_secret` é a credencial de uma loja específica (aplicativos com a extensão OpenDelivery), o token fica vinculado apenas àquela loja;… - [Revogar token](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/oauth/revogar-token.md): Revoga um access token ou refresh token antes da expiração (RFC 7009). O token precisa pertencer ao cliente autenticado. Responde 200 também quando o token é desconhecido ou já estava inválido. - [Inspecionar token](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/oauth/inspecionar-token.md): Retorna os metadados de um token, incluindo se ele está ativo (RFC 7662). A requisição deve ser autenticada com as credenciais do cliente (HTTP Basic ou `client_id`/`client_secret` no corpo) ou com um access token válido no header `Authorization: Bearer`. Para tokens inativos, a resposta é apenas `{… - [Consultar token atual](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/oauth/consultar-token-atual.md): Retorna informações sobre o access token enviado no header `Authorization`, como validade restante, escopos e o aplicativo ao qual pertence. - [Merchant API](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/index.md): Conheça os módulos da Merchant API e escolha por onde começar a integrar o seu PDV ou ERP. - [Eventos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/events.md): Entenda o polling de eventos, a fila de 100 eventos por chamada e quando combinar polling com webhook. - [Webhooks](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/webhooks.md): Receba eventos de pedido e de indoor em tempo real na sua URL, valide a assinatura e trate reenvios e suspensões. - [Pedidos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/order/index.md): Receba, confirme e acompanhe os pedidos das lojas que instalaram o seu app. - [Definições](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/order/definicoes.md): Os tipos de pedido, o momento de preparo e o ciclo de vida de cada tipo. - [Listar pedidos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/order/listar-pedidos.md): Consulte o histórico de pedidos de uma loja com filtros por período e tipo, paginação por cursor e agrupamento de opções. - [Fluxo de integração](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/order/fluxo-de-integracao/index.md): As etapas para receber e gerenciar um pedido, da consulta de eventos às ações. - [Receba seu primeiro pedido](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/order/fluxo-de-integracao/recepcao-de-pedidos.md): Um script completo que obtém o token, consulta eventos, confirma o recebimento e aceita o pedido. Pronto para copiar e rodar. - [Consultar novos pedidos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/order/fluxo-de-integracao/consultar-novos-pedidos.md): Como fazer o polling de eventos, drenar a fila e filtrar por tipo de evento, tipo de pedido e loja. - [Eventos de pedidos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/order/fluxo-de-integracao/eventos-de-pedidos.md): A estrutura de um evento e todos os tipos que um pedido pode gerar. - [Acknowledgment de eventos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/order/fluxo-de-integracao/acknowledgment-de-eventos.md): Confirme o recebimento dos eventos para tirá-los da fila do polling. - [Ações de pedidos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/order/fluxo-de-integracao/acoes-de-pedidos.md): Atualize o status do pedido do preparo à entrega, cancele e envie dados de rastreio. - [Obter detalhes do pedido](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/order/fluxo-de-integracao/obter-detalhes-do-pedido.md): Busque itens, cliente, entrega, pagamento e totais de um pedido e entenda cada campo da resposta. - [Catálogo](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/catalog-and-services/index.md): Consulte e sincronize o catálogo, os serviços e as formas de pagamento das lojas que instalaram o seu app. - [Detalhes da loja](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/catalog-and-services/details.md): Leia em uma chamada os dados da loja, os serviços, as formas de pagamento e o catálogo completo. - [Ações do catálogo](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/catalog-and-services/actions/index.md): Escolha entre update, upsert e force e conheça as regras que valem para as três rotas. - [Atualizar objetos (update)](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/catalog-and-services/actions/update.md): Altere campos de objetos que já existem, abra ou feche a loja e mude os tempos de entrega e retirada. - [Criar ou atualizar objetos (upsert)](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/catalog-and-services/actions/upsert.md): Cadastre objetos novos e altere os existentes no catálogo, sem mexer no que você não enviou. - [Reescrever o catálogo (force)](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/catalog-and-services/actions/force.md): Envie o catálogo completo em uma chamada e remova da DeliveryVip tudo o que não estiver nele. - [Indoor](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/index.md): Integre o autoatendimento no salão, com mesas, comandas, chamadas de garçom e pedidos de fechamento de conta. - [Fluxo de integração](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/fluxo-de-integracao/index.md): Como o seu PDV recebe e confirma os chamados do salão, como chamar garçom e pedir a conta. - [Consultar novos eventos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/fluxo-de-integracao/consultar-novos-eventos.md): Faça o polling dos eventos de chamar garçom e fechar conta, drene a fila e filtre por tipo e loja. - [Eventos de indoor](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/fluxo-de-integracao/eventos-de-indoor.md): A estrutura dos eventos de chamar garçom e fechar conta, e quais campos vêm conforme a origem do chamado. - [Acknowledgment de eventos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/fluxo-de-integracao/acknowledgment-de-eventos.md): Confirme o recebimento dos eventos de indoor para tirá-los da fila do polling. - [Comandas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/comanda-api/index.md): Cadastre e controle as comandas da loja, e entenda a diferença entre status e situação. - [Listar comandas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/comanda-api/listar-comandas.md): Busque todas as comandas cadastradas numa loja, com status, situação e QR Code. - [Obter detalhes da comanda](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/comanda-api/obter-detalhes-da-comanda.md): Busque uma comanda pelo id para conferir a situação ou recuperar o QR Code. - [Adicionar uma comanda](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/comanda-api/adicionar-uma-comanda.md): Cadastre uma nova comanda com nome e código, pronta para uso. - [Atualizar uma comanda](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/comanda-api/atualizar-uma-comanda.md): Altere o nome ou o código de uma comanda existente. - [Remover uma comanda](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/comanda-api/remover-uma-comanda.md): Tire uma comanda de uso e libere o código dela para outra comanda. - [Ações das comandas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/comanda-api/acoes-das-comandas/index.md): Abra e feche comandas para consumo e migre das rotas descontinuadas. - [Ativar uma comanda](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/comanda-api/acoes-das-comandas/ativar-uma-comanda.md): Rota em deprecação que marca a comanda como disponível e aberta. Migre para opened. - [Desativar uma comanda](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/comanda-api/acoes-das-comandas/desativar-uma-comanda.md): Rota em deprecação que marca a comanda como indisponível e fechada. Migre para closed. - [Abrir uma comanda para consumo](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/comanda-api/acoes-das-comandas/abrir-para-consumo-uma-comanda.md): Libere uma comanda fechada para voltar a receber pedidos. - [Fechar uma comanda para consumo](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/comanda-api/acoes-das-comandas/fechar-para-consumo-uma-comanda.md): Bloqueie novos pedidos numa comanda, por exemplo depois que a conta foi paga. - [Places](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/places-api/index.md): Liste as mesas com QR Code e tablet da loja e controle quais aceitam consumo. - [Listar places](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/places-api/listar-places.md): Busque as mesas com QR Code e tablet da loja e veja quais estão livres, ocupadas ou fechadas. - [Ações de places](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/places-api/acoes-de-places/index.md): Abra e feche mesas com QR Code ou tablet para consumo. - [Abrir um place para consumo](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/places-api/acoes-de-places/abrir-para-consumo-um-place.md): Libere uma mesa com QR Code ou tablet para voltar a receber pedidos. - [Fechar um place para consumo](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/indoor/places-api/acoes-de-places/fechar-para-consumo-um-place.md): Bloqueie novos pedidos numa mesa com QR Code ou tablet, por exemplo depois que a conta foi paga. - [Descontos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/discount/index.md): Crie e gerencie descontos automáticos e cupons de uma loja e acompanhe o resultado de cada um. - [Listar descontos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/discount/listar-descontos.md): Busque os descontos de uma loja, do mais recente para o mais antigo, com paginação. - [Obter detalhes do desconto](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/discount/obter-detalhes-do-desconto.md): Busque um desconto pelo id para ver regras, período e status atual. - [Obter estatística do desconto](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/discount/obter-estatistica-do-desconto.md): Veja quanto um desconto custou, quanto vendeu e quantos clientes trouxe ou reativou. - [Adicionar um desconto](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/discount/adicionar-um-desconto.md): Cadastre um desconto automático ou um cupom, com valor, período e regras de uso. - [Atualizar um desconto](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/discount/atualizar-um-desconto.md): Altere o valor, o período ou as regras de um desconto existente. - [Remover um desconto](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/discount/remover-um-desconto.md): Tire um desconto da loja de vez, liberando o código do cupom. - [Ações dos descontos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/discount/acoes-dos-descontos/index.md): Ligue ou desligue um desconto na hora, sem editar as datas manualmente. - [Ativar um desconto](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/discount/acoes-dos-descontos/ativar-um-desconto.md): Coloque um desconto para valer agora, sem data de fim. - [Desativar um desconto](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/discount/acoes-dos-descontos/desativar-um-desconto.md): Encerre um desconto agora, mantendo o cadastro e as estatísticas. - [Ferramentas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/tools/index.md): Endpoints auxiliares para calcular a taxa de entrega de um endereço e consultar se a loja está aberta. - [Obter taxa de entrega](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/tools/obter-taxa-de-entrega.md): Calcule se a loja entrega numa coordenada, a distância e o valor da taxa de entrega. - [Obter status do merchant](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/tools/obter-status-do-merchant.md): Consulte se a loja está aberta ou fechada e os horários de funcionamento de cada dia da semana. - [Merchant API V3](https://deliveryvip-a4256422.mintlify.dev/docs/reference/merchant/v3/index.md): Referência completa dos endpoints da Merchant API V3, com base URL, autenticação e convenções. - [Pedidos](https://deliveryvip-a4256422.mintlify.dev/docs/reference/merchant/v3/orders.md): Endpoints para receber eventos, listar, consultar e atualizar pedidos. - [Listar eventos](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/events/listar-eventos.md): Retorna os eventos ainda não confirmados pelo aplicativo, das lojas vinculadas ao token, criados nas últimas 24 horas. Os eventos vêm em ordem cronológica, no máximo 100 por chamada. Cada evento recebido deve ser confirmado em `/v1/events/acknowledgment`; caso contrário, continuará sendo retornado n… - [Confirmar eventos](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/events/confirmar-eventos.md): Confirma (acknowledgment) um conjunto de eventos, removendo-os das próximas chamadas de polling deste aplicativo. Apenas o `id` de cada item é utilizado; ids desconhecidos ou de lojas não autorizadas são ignorados. Confirmar o mesmo evento mais de uma vez não tem efeito adicional. - [Listar pedidos](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/listar-pedidos.md): Lista os pedidos da loja, do mais recente para o mais antigo, com paginação por cursor. Quando há mais páginas, a resposta traz os cabeçalhos `X-Next-Cursor`/`X-Previous-Cursor` e `Link` (`rel="next"` e `rel="prev"`). - [Consultar pedido](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/consultar-pedido.md): Retorna os detalhes de um pedido de uma loja vinculada ao token. Pedidos aguardando pagamento ou não pagos não são retornados. - [Confirmar pedido](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/confirmar-pedido.md): Confirma (aceita) o pedido. Consulte os detalhes do pedido antes de confirmá-lo. Um corpo, se enviado, é ignorado. - [Iniciar preparo do pedido](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/iniciar-preparo-do-pedido.md): Sinaliza que a loja começou a preparar o pedido. - [Marcar pedido como pronto](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/marcar-pedido-como-pronto.md): Sinaliza que o pedido está pronto para ser retirado ou entregue. - [Despachar pedido](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/despachar-pedido.md): Sinaliza que o pedido saiu para entrega. - [Marcar pedido como retirado](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/marcar-pedido-como-retirado.md): Sinaliza que o pedido foi retirado pelo cliente (pedidos para retirada). - [Marcar pedido como entregue](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/marcar-pedido-como-entregue.md): Sinaliza que o pedido foi entregue ao cliente. - [Cancelar pedido](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/cancelar-pedido.md): Cancela o pedido imediatamente. Um corpo (motivo, código, itens indisponíveis), se enviado, é ignorado. - [Aceitar cancelamento](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/aceitar-cancelamento.md): Aceita uma solicitação de cancelamento. Apenas confirma o recebimento: o estado do pedido não é alterado. - [Recusar cancelamento](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/recusar-cancelamento.md): Recusa uma solicitação de cancelamento. Apenas confirma o recebimento: o estado do pedido não é alterado. - [Atualizar rastreamento da entrega](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/atualizar-rastreamento-da-entrega.md): Envia uma atualização de rastreamento da entrega do pedido. O corpo deve conter `event` (andamento da entrega) ou `problem` (ocorrência), além dos blocos opcionais de veículo, previsão, entregador e geolocalização. Propriedades fora do schema são rejeitadas com `422`. - [Catálogo](https://deliveryvip-a4256422.mintlify.dev/docs/reference/merchant/v3/catalog-and-services.md): Endpoints para consultar a loja, sincronizar o catálogo e ver o status de funcionamento. - [Consultar loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/consultar-loja.md): Retorna uma loja do parceiro ou de uma de suas revendas. - [Atualizar loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/atualizar-loja.md): Atualiza status e entidades **já existentes** da loja. Entidades inexistentes não são criadas. O corpo pode ser enviado diretamente ou envolvido em `{"merchant": {...}}`. - [Criar ou atualizar entidades da loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/criar-ou-atualizar-entidades-da-loja.md): Cria ou atualiza (upsert) status e entidades da loja. O corpo pode ser enviado diretamente ou envolvido em `{"merchant": {...}}`. - [Sincronizar loja completa](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/sincronizar-loja-completa.md): Envia a loja completa (mesmo formato de `GET /merchant/v3/{merchantId}`) e processa todas as entidades presentes: serviços, complementos, grupos de complementos, categorias, itens e formas de pagamento. O campo `status` abre ou fecha a loja. Os campos `id`, `lastUpdate`, `ttl` e `status` são obrigat… - [Consultar status e horários da loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/consultar-status-e-horários-da-loja.md): Retorna o status da loja (`AVAILABLE`/`UNAVAILABLE`), os horários de funcionamento e o id da loja. - [Indoor](https://deliveryvip-a4256422.mintlify.dev/docs/reference/merchant/v3/indoor.md): Endpoints de eventos de autoatendimento, comandas e places. - [Listar eventos](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/events/listar-eventos.md): Retorna os eventos ainda não confirmados pelo aplicativo, das lojas vinculadas ao token, criados nas últimas 24 horas. Os eventos vêm em ordem cronológica, no máximo 100 por chamada. Cada evento recebido deve ser confirmado em `/v1/events/acknowledgment`; caso contrário, continuará sendo retornado n… - [Confirmar eventos](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/events/confirmar-eventos.md): Confirma (acknowledgment) um conjunto de eventos, removendo-os das próximas chamadas de polling deste aplicativo. Apenas o `id` de cada item é utilizado; ids desconhecidos ou de lojas não autorizadas são ignorados. Confirmar o mesmo evento mais de uma vez não tem efeito adicional. - [Listar comandas](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/tabs/listar-comandas.md): Lista as comandas da loja. - [Listar mesas](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/places/listar-mesas.md): Lista as mesas da loja (QR Codes e tablets de salão) e a situação de cada uma. - [Consultar comanda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/tabs/consultar-comanda.md): Retorna os detalhes de uma comanda a partir do seu id. - [Criar comanda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/tabs/criar-comanda.md): Cria uma comanda na loja. O corpo pode ser enviado diretamente ou envolvido em `{"tab": {...}}`. - [Atualizar comanda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/tabs/atualizar-comanda.md): Atualiza o nome ou o código de uma comanda. O corpo pode ser enviado diretamente ou envolvido em `{"tab": {...}}`. - [Excluir comanda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/tabs/excluir-comanda.md): Exclui uma comanda da loja e retorna a comanda excluída. - [Disponibilizar comanda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/tabs/disponibilizar-comanda.md): Torna a comanda disponível. **Descontinuado:** as respostas trazem os cabeçalhos `Deprecation` e `Sunset` (01/12/2025). - [Indisponibilizar comanda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/tabs/indisponibilizar-comanda.md): Torna a comanda indisponível. **Descontinuado:** as respostas trazem os cabeçalhos `Deprecation` e `Sunset` (01/12/2025). - [Abrir comanda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/tabs/abrir-comanda.md): Abre uma comanda que estava fechada. - [Fechar comanda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/tabs/fechar-comanda.md): Fecha uma comanda que está aberta. - [Abrir mesa](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/places/abrir-mesa.md): Abre uma mesa que estava fechada. - [Fechar mesa](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/places/fechar-mesa.md): Fecha uma mesa que está aberta. - [Descontos](https://deliveryvip-a4256422.mintlify.dev/docs/reference/merchant/v3/discounts.md): Endpoints para listar, criar, atualizar, ativar e remover descontos e consultar estatísticas. - [Listar descontos](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/discounts/listar-descontos.md): Lista os descontos (cupons e descontos inteligentes) da loja, com paginação por cursor. - [Consultar desconto](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/discounts/consultar-desconto.md): Retorna os detalhes de um desconto a partir do seu id. - [Consultar estatísticas do desconto](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/discounts/consultar-estatísticas-do-desconto.md): Retorna as estatísticas de uso de um desconto: valores totais, quantidade de pedidos e clientes novos ou reativados. - [Criar desconto](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/discounts/criar-desconto.md): Cria um cupom (`COUPON`, identificado por `code`) ou um desconto inteligente (`SMART`, identificado por `name`). O corpo pode ser enviado diretamente ou envolvido em `{"discount": {...}}`. Os valores de enum são aceitos em maiúsculas ou minúsculas. - [Atualizar desconto](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/discounts/atualizar-desconto.md): Atualiza um desconto da loja. Envie apenas os campos que deseja alterar; o corpo pode ser enviado diretamente ou envolvido em `{"discount": {...}}`. - [Excluir desconto](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/discounts/excluir-desconto.md): Exclui um desconto da loja e retorna o desconto excluído. - [Ativar desconto](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/discounts/ativar-desconto.md): Torna o desconto disponível para uso. - [Desativar desconto](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/discounts/desativar-desconto.md): Torna o desconto indisponível para uso. - [Ferramentas](https://deliveryvip-a4256422.mintlify.dev/docs/reference/merchant/v3/tools.md): Endpoint utilitário para calcular a taxa de entrega de uma coordenada. - [Calcular taxa de entrega](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/utils/calcular-taxa-de-entrega.md): Calcula a taxa de entrega da loja para uma coordenada, conforme as áreas ou raios de entrega configurados. Fora da área atendida, `status` é `UNAVAILABLE` e `fee` não é retornado. - [Open Delivery](https://deliveryvip-a4256422.mintlify.dev/docs/guides/open-delivery/index.md): Integre seu PDV/ERP com a DeliveryVip usando o padrão aberto Open Delivery, sem precisar da API proprietária. - [Primeiros passos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/open-delivery/primeiros-passos.md): Crie o app com a extensão Open Delivery, receba a credencial de cada loja e obtenha o token OAuth que opera aquela loja. - [Receba seu primeiro pedido via Open Delivery](https://deliveryvip-a4256422.mintlify.dev/docs/guides/open-delivery/primeiro-pedido.md): Um programa completo que recebe o webhook assinado, busca o pedido, confirma e reconcilia pelo polling. Pronto para copiar e rodar. - [Onboarding de lojas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/open-delivery/onboarding-de-lojas.md): Registre por loja o merchantId do seu sistema, a URL de webhook e o endpoint de catálogo no padrão Open Delivery. - [Catálogo](https://deliveryvip-a4256422.mintlify.dev/docs/guides/open-delivery/catalogo.md): Exponha os dados da loja no padrão OD Merchant, avise as mudanças com merchantUpdate e acompanhe a importação com merchantStatus. - [Recebendo eventos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/open-delivery/recebendo-eventos.md): Receba os eventos de pedido por webhook assinado, valide a assinatura e use o polling com acknowledgment como reconciliação. - [Ciclo de vida do pedido](https://deliveryvip-a4256422.mintlify.dev/docs/guides/open-delivery/ciclo-de-vida-do-pedido.md): Busque os detalhes do pedido pela orderURL e transicione o status do preparo à entrega, ou cancele. - [Referência rápida](https://deliveryvip-a4256422.mintlify.dev/docs/guides/open-delivery/referencia-rapida.md): Endpoints, credenciais, limites e códigos de resposta da integração Open Delivery em uma página. - [Obter access token](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/oauth/obter-access-token.md): Emite um access token com `grant_type=client_credentials`. As credenciais podem ser enviadas no corpo (`client_id`/`client_secret`) ou via HTTP Basic. Quando o `client_secret` é a credencial de uma loja específica (aplicativos com a extensão OpenDelivery), o token fica vinculado apenas àquela loja;… - [Consultar versão da Ordering Application](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/versions/consultar-versão-da-ordering-application.md): Retorna as versões dos endpoints hospedados pela DeliveryVip como Ordering Application e os métodos de entrega de eventos suportados. - [Consultar versão da API de merchant](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/versions/consultar-versão-da-api-de-merchant.md): Retorna a versão dos endpoints de merchant que a Ordering Application espera do Software Service. - [Listar eventos](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/events/listar-eventos.md): Retorna os eventos ainda não confirmados pelo aplicativo, das lojas vinculadas ao token, criados nas últimas 24 horas. Os eventos vêm em ordem cronológica, no máximo 100 por chamada. Cada evento recebido deve ser confirmado em `/v1/events/acknowledgment`; caso contrário, continuará sendo retornado n… - [Confirmar recebimento de eventos](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/events/confirmar-recebimento-de-eventos.md): Confirma o recebimento de eventos. Eventos confirmados deixam de ser retornados no polling. Identificadores desconhecidos ou de lojas não vinculadas ao token são ignorados e não entram no total. - [Consultar pedido](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/consultar-pedido.md): Retorna os detalhes de um pedido de uma loja vinculada ao token. Pedidos aguardando pagamento ou não pagos não são retornados. - [Confirmar pedido](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/confirmar-pedido.md): Confirma (aceita) o pedido. Consulte os detalhes do pedido antes de confirmá-lo. Um corpo, se enviado, é ignorado. - [Iniciar preparo](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/iniciar-preparo.md): Sinaliza que a loja começou a preparar o pedido. - [Marcar pedido como pronto](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/marcar-pedido-como-pronto.md): Sinaliza que o pedido está pronto para ser retirado ou entregue. - [Marcar pedido como retirado](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/marcar-pedido-como-retirado.md): Sinaliza que o pedido foi retirado pelo cliente (pedidos para retirada). - [Despachar pedido](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/despachar-pedido.md): Sinaliza que o pedido saiu para entrega. - [Marcar pedido como entregue](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/marcar-pedido-como-entregue.md): Sinaliza que o pedido foi entregue ao cliente. - [Cancelar pedido](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/cancelar-pedido.md): Cancela o pedido imediatamente. Um corpo (motivo, código, itens indisponíveis), se enviado, é ignorado. - [Aceitar cancelamento](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/aceitar-cancelamento.md): Aceita uma solicitação de cancelamento. Apenas confirma o recebimento: o estado do pedido não é alterado. - [Recusar cancelamento](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/recusar-cancelamento.md): Recusa uma solicitação de cancelamento. Apenas confirma o recebimento: o estado do pedido não é alterado. - [Enviar rastreamento da entrega](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/orders/enviar-rastreamento-da-entrega.md): Atualiza o rastreamento da entrega do pedido: um evento de entrega (`event`) ou uma ocorrência (`problem`), com dados opcionais de entregador, veículo, previsões e localização. - [Fazer onboarding da loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/fazer-onboarding-da-loja.md): Registra (ou atualiza) os dados do Software Service para a loja do token: o seu identificador da loja (`merchantId`), a URL e a chave para consulta do merchant (getMerchant) e a URL do webhook de pedidos. Responde 201 no primeiro registro e 204 nas atualizações. - [Consultar processamento do merchant](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/consultar-processamento-do-merchant.md): Retorna o resultado do último processamento de atualização da loja disparado por `/v1/merchantUpdate` (nova leitura do merchant e do catálogo via getMerchant). - [Atualizar merchant](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/atualizar-merchant.md): Notifica a DeliveryVip de mudanças na loja do token. Modos: - [Fidelidade](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/loyalty/index.md): Conecte seu programa de fidelidade ao checkout da DeliveryVip: o cliente adere, resgata cashback e acumula, com o saldo sempre sob o seu controle. - [Primeiros passos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/loyalty/primeiros-passos.md): Crie o app com o scope dv.loyalty, declare a extensão de fidelidade e obtenha o token com os dois scopes necessários. - [Monte um operador de fidelidade mínimo](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/loyalty/operador-minimo.md): Um operador completo, em memória, com as cinco rotas do contrato e a assinatura validada. Ative o programa em uma loja de teste e veja adesão, saldo, resgate e estorno no checkout. - [Ativando o programa](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/loyalty/ativando-o-programa.md): Ative o programa por loja com o config push: um PUT com a configuração, verificado na hora por um ping assinado no seu endpoint. - [Acúmulo](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/loyalty/acumulo.md): Acumule sobre pedidos concluídos: receba o evento, busque o pedido com od.all e leia o bloco loyalty. A base de cálculo é sua. - [Contrato do operador](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/loyalty/contrato-do-operador/index.md): As cinco rotas HTTP que o seu sistema implementa e a DeliveryVip chama, todas assinadas com HMAC-SHA256 do corpo bruto. - [Vínculo e PIN](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/loyalty/contrato-do-operador/vinculo-e-pin.md): Localize ou cadastre o cliente com consentimento no accounts:link, com desafio de PIN opcional, e sirva o saldo da conta para o checkout. - [Resgate e estorno](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/loyalty/contrato-do-operador/resgate-e-estorno.md): O débito síncrono do resgate, última etapa da criação do pedido, e o estorno idempotente disparado quando o pedido termina sem ser pago. - [Referência rápida](https://deliveryvip-a4256422.mintlify.dev/docs/guides/merchant/loyalty/referencia-rapida.md): Endpoints, rotas do contrato, headers, limites e regras da extensão de fidelidade em uma página. - [Fidelidade](https://deliveryvip-a4256422.mintlify.dev/docs/reference/merchant/v3/loyalty.md): Endpoints de configuração do programa de fidelidade, para apps com a extensão loyalty. - [Enviar configuração de fidelidade](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/loyalty/enviar-configuração-de-fidelidade.md): Cria ou substitui a configuração do programa de fidelidade do aplicativo autenticado para a loja (a última escrita prevalece). Antes de gravar qualquer coisa, a plataforma faz uma verificação síncrona: um GET /loyalty/ping assinado contra o `api_base_url` da extensão. Se o operador estiver inacessív… - [Remover configuração de fidelidade](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/loyalty/remover-configuração-de-fidelidade.md): Desativa o programa na loja removendo a configuração gravada. Idempotente: sempre responde `204`, exista ou não uma configuração. Os vínculos de clientes e o histórico de resgates não são alterados. - [Signed reachability check](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/handshake/signed-reachability-check.md): Called synchronously while the operator pushes a merchant configuration. Verify the signature (HMAC of an empty string) and answer 2xx. Any non-2xx, timeout or invalid signature makes DeliveryVip reject the configuration push with 422 — nothing is stored. - [Locate-or-enroll the customer (opt-in)](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/accounts/locate-or-enroll-the-customer-opt-in.md): Sent when the customer opts into the program at checkout. The click IS the consent (consent.grantedAt is the moment of the click; timestamps carry the platform's UTC offset). The customer profile is attested by DeliveryVip (non-guest, complete profile). The operator may answer with a PIN challenge i… - [Account balance](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/accounts/account-balance.md): Balance read for the checkout surface. DeliveryVip caches the answer for 60 seconds per account. The request carries only the opaque account id — never the CPF. Unknown fields in the response are ignored (emitting extras such as expiresAt or metadata is safe). The optional redemptionLimits object pi… - [Synchronous balance debit](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/redemptions/synchronous-balance-debit.md): The authoritative debit, called as the LAST step inside DeliveryVip's order-creation transaction. A non-201 answer (or timeout) rolls the whole order back — the order is never born and the customer keeps shopping. Idempotency key is relatedOrderId (the order UUID): replaying the same relatedOrderId… - [Explicit idempotent reversal](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/redemptions/explicit-idempotent-reversal.md): Undoes a debit after order cancellation, rejection, payment expiry or payment failure. Fire-and-forget from DeliveryVip's perspective (asynchronous with retries). Must be idempotent: reversing an already-reversed redemption answers 2xx again. 404 means the redemption is unknown — DeliveryVip stops r… - [Partner API](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/index.md): Gerencie lojas, revendas, assinaturas, planos e faturas da sua rede na DeliveryVip. - [Lojas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/merchant/index.md): Cadastre e administre as lojas (merchants) da sua rede, da assinatura aos membros do painel. - [Definições de lojas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/merchant/definicoes.md): Status e ciclo de vida da assinatura, aviso e bloqueio, status de recursos e papéis de membros. - [Utilizando a API de lojas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/merchant/utilizando-a-api/index.md): Mapa de todos os endpoints de lojas da Partner API V2. - [Listar lojas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/merchant/utilizando-a-api/listar-merchants.md): Liste as lojas que o token alcança, com filtros por status da assinatura, contrato, CNPJ/CPF e parceiro. - [Listar vendas das lojas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/merchant/utilizando-a-api/listar-vendas-dos-merchants.md): Consulte a quantidade de pedidos e o valor vendido por loja em um mês. - [Listar faturas das lojas (descontinuado)](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/merchant/utilizando-a-api/listar-faturas-dos-merchants.md): Formato antigo das faturas das lojas, mantido por compatibilidade. Migre para as rotas com partnerId. - [Obter detalhes da loja](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/merchant/utilizando-a-api/obter-detalhes-do-merchant.md): Consulte cadastro, responsável, endereço, assinatura e recursos de uma loja. - [Cadastrar uma loja](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/merchant/utilizando-a-api/adicionar-um-merchant.md): Crie uma loja vinculada ao seu parceiro ou a uma das suas revendas. - [Membros da loja](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/merchant/utilizando-a-api/membros-do-merchant.md): Liste, adicione, atualize e remova quem acessa o painel da loja, e gere magic links de acesso. - [Gerenciar assinatura das lojas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/merchant/utilizando-a-api/gerenciar-assinatura-dos-merchants.md): Ative, cancele, avise, bloqueie e atualize contrato e plano da assinatura de uma loja. - [Gerenciar recursos das lojas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/merchant/utilizando-a-api/gerenciar-recursos-dos-merchants.md): Contrate e cancele recursos adicionais, como DeliveryBot, cardápio por QR Code e domínio próprio. - [Gerenciar apps autorizados nas lojas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/merchant/utilizando-a-api/gerenciar-permissao-de-aplicativos-dos-merchants.md): Autorize ou revogue o acesso de um app (PDV, integrador) à Merchant API de uma loja, sem passar pelo lojista. - [Revendas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/resale/index.md): Cadastre e administre as revendas que vendem a DeliveryVip abaixo do seu parceiro. - [Definições de revendas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/resale/definicoes.md): Status e ciclo de vida da assinatura de uma revenda e o efeito dela sobre as lojas. - [Utilizando a API de revendas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/resale/utilizando-a-api/index.md): Mapa de todos os endpoints de revendas da Partner API V2. - [Listar revendas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/resale/utilizando-a-api/listar-resales.md): Liste as revendas do parceiro com filtros por status da assinatura, contrato, CNPJ/CPF e parceiro. - [Listar faturas das revendas (descontinuado)](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/resale/utilizando-a-api/listar-faturas-das-revendas.md): Formato antigo das faturas das lojas de revenda, mantido por compatibilidade. Migre para o resumo por revenda. - [Obter detalhes da revenda](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/resale/utilizando-a-api/obter-detalhes-da-resale.md): Consulte cadastro, responsável, endereço e assinatura de uma revenda. - [Cadastrar uma revenda](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/resale/utilizando-a-api/adicionar-um-resale.md): Crie uma revenda abaixo do seu parceiro, com teste de 10 dias e loja de demonstração. - [Membros da revenda](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/resale/utilizando-a-api/membros-da-revenda.md): Liste, adicione, atualize e remova quem acessa o painel da revenda, e gere magic links de acesso. - [Gerenciar assinatura das revendas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/resale/utilizando-a-api/gerenciar-assinatura-das-revendas.md): Ative, cancele, avise, bloqueie e atualize o código do contrato da assinatura de uma revenda. - [Gerenciar apps autorizados nas revendas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/resale/utilizando-a-api/gerenciar-permissao-de-aplicativos-das-revendas.md): Autorize ou revogue o acesso de um app à Partner API em nome de uma revenda. - [Planos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/plans/index.md): Consulte os planos de cobrança do parceiro para usar nas assinaturas das lojas. - [Definições de planos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/plans/definicoes.md): Campos do plano de cobrança, plano padrão, visibilidade, status e tipos de recurso. - [Utilizando a API de planos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/plans/utilizando-a-api/index.md): Endpoints de consulta de planos de cobrança da Partner API V2. - [Listar planos](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/plans/utilizando-a-api/listar-planos.md): Liste os planos de cobrança visíveis para o parceiro ou para a revenda. - [Obter detalhes do plano](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/plans/utilizando-a-api/obter-detalhes-do-plano.md): Consulte um plano de cobrança pelo ID. - [Faturas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/invoices/index.md): Consulte o fechamento mensal de cada loja e o resumo por revenda para gerar as suas cobranças. - [Definições de faturas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/invoices/definicoes.md): Campos da fatura da loja, blocos de preço PAYABLE e RECEIVABLE, valor do mês cheio e valor proporcional. - [Utilizando a API de faturas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/invoices/utilizando-a-api/index.md): Os três endpoints de faturas da Partner API V2 e quando usar cada um. - [Listando faturas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/invoices/utilizando-a-api/listando-invoices.md): Liste a fatura do mês de cada loja, diretas e de revendas, com os blocos de preço a pagar e a receber. - [Listando faturas das lojas diretas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/invoices/utilizando-a-api/listando-merchants-invoices.md): Liste a fatura do mês só das lojas atendidas diretamente pelo parceiro ou pela revenda. - [Listando faturas das revendas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/invoices/utilizando-a-api/listando-resales-invoices.md): Resumo mensal das faturas por revenda, com totais da revenda, de cada plano e de cada tipo de item. - [Cadastro de lojas](https://deliveryvip-a4256422.mintlify.dev/docs/guides/partner/signup/index.md): Cadastre loja e conta do proprietário a partir de uma landing page pública, sem expor quais e-mails têm conta. - [Partner API V2](https://deliveryvip-a4256422.mintlify.dev/docs/reference/partner/v2/index.md): Referência completa da Partner API V2, organizada por recurso. - [Autenticação](https://deliveryvip-a4256422.mintlify.dev/docs/reference/partner/v2/authentication.md): Como autenticar as chamadas da Partner API V2, o alcance do token e o header x-partners. - [Lojas](https://deliveryvip-a4256422.mintlify.dev/docs/reference/partner/v2/merchant.md): Endpoints para listar, cadastrar e gerenciar lojas, assinaturas, recursos, membros e apps autorizados. - [Listar lojas](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/listar-lojas.md): Lista as lojas dos parceiros e revendas autorizados para o token. - [Listar vendas das lojas](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/listar-vendas-das-lojas.md): Retorna, por loja, a quantidade e o total de pedidos do mês. - [Listar faturas das lojas (obsoleto)](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/listar-faturas-das-lojas-obsoleto.md): Obsoleto: use `GET /partner/v2/{partnerId}/invoices` ou `GET /partner/v2/{partnerId}/merchants/invoices`. A rota continua respondendo e envia os cabeçalhos `Deprecation: true` e `Sunset` (01/07/2025). - [Listar membros da loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantsmembers/listar-membros-da-loja.md): Lista os membros da loja com conta vinculada. Convites pendentes (`INVITED`) não aparecem. - [Consultar loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/consultar-loja.md): Retorna uma loja do parceiro ou de uma de suas revendas. - [Criar loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchants/criar-loja.md): Cria uma loja vinculada ao parceiro ou à revenda informada em `partnerId`. Os campos podem ser enviados na raiz do corpo ou dentro de um objeto `merchant`. - [Adicionar membro à loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantsmembers/adicionar-membro-à-loja.md): Adiciona um membro à loja. - [Alterar membro da loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantsmembers/alterar-membro-da-loja.md): Altera o papel de um membro da loja. A rota também aceita `PUT`. - [Remover membro da loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantsmembers/remover-membro-da-loja.md): Remove o membro da loja ou revoga o convite pendente. - [Gerar magic link do membro da loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantsmembers/gerar-magic-link-do-membro-da-loja.md): Gera um link para o membro entrar no painel sem senha. O link usa o domínio de painel do parceiro e expira em 6 horas. - [Ativar assinatura da loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantssubscriptions/ativar-assinatura-da-loja.md): Ativa a assinatura da loja. O parceiro (e a revenda, quando houver) precisa estar com a assinatura ativa. Assinaturas de demonstração não podem ser ativadas. - [Cancelar assinatura da loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantssubscriptions/cancelar-assinatura-da-loja.md): Cancela a assinatura da loja. A assinatura precisa estar ativa. - [Avisar loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantssubscriptions/avisar-loja.md): Marca a assinatura da loja com aviso, sinalizando um possível bloqueio. A assinatura precisa estar ativa. - [Remover aviso da loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantssubscriptions/remover-aviso-da-loja.md): Remove o aviso da assinatura da loja. A assinatura precisa estar ativa. - [Bloquear loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantssubscriptions/bloquear-loja.md): Bloqueia a assinatura da loja. A assinatura precisa estar ativa. - [Desbloquear loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantssubscriptions/desbloquear-loja.md): Desbloqueia a assinatura da loja. A assinatura precisa estar ativa. - [Atualizar assinatura da loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantssubscriptions/atualizar-assinatura-da-loja.md): Atualiza o código de contrato e/ou o plano da assinatura da loja, sem mudar o status. - [Contratar recursos](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantsfeatures/contratar-recursos.md): Contrata recursos adicionais para a loja. Cada recurso precisa existir no plano da assinatura; recursos já contratados são ignorados. - [Cancelar recursos](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantsfeatures/cancelar-recursos.md): Cancela recursos adicionais da loja. Recursos incluídos no plano não podem ser cancelados. - [Autorizar aplicação na loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantsapplications/autorizar-aplicação-na-loja.md): Autoriza uma aplicação na loja. Apenas aplicações do tipo manual podem ser autorizadas por esta rota. - [Revogar aplicação da loja](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/merchantsapplications/revogar-aplicação-da-loja.md): Revoga a autorização da aplicação na loja. - [Revendas](https://deliveryvip-a4256422.mintlify.dev/docs/reference/partner/v2/resale.md): Endpoints para listar, cadastrar e gerenciar revendas, assinaturas, membros e apps autorizados. - [Listar revendas](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resales/listar-revendas.md): Lista as revendas dos parceiros autorizados para o token. - [Listar membros da revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalesmembers/listar-membros-da-revenda.md): Lista os membros da revenda com conta vinculada. Convites pendentes (`INVITED`) não aparecem. - [Listar faturas das revendas (obsoleto)](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resales/listar-faturas-das-revendas-obsoleto.md): Obsoleto: use `GET /partner/v2/{partnerId}/resales/invoices`. A rota continua respondendo e envia os cabeçalhos `Deprecation: true` e `Sunset` (01/07/2025). - [Consultar revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resales/consultar-revenda.md): Retorna uma revenda do parceiro. - [Criar revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resales/criar-revenda.md): Cria uma revenda vinculada ao parceiro. Disponível apenas quando `partnerId` é um parceiro; uma revenda não pode criar outra revenda. - [Adicionar membro à revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalesmembers/adicionar-membro-à-revenda.md): Adiciona um membro à revenda. - [Alterar membro da revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalesmembers/alterar-membro-da-revenda.md): Altera o papel de um membro da revenda. A rota também aceita `PUT`. - [Remover membro da revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalesmembers/remover-membro-da-revenda.md): Remove o membro da revenda ou revoga o convite pendente. - [Gerar magic link do membro da revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalesmembers/gerar-magic-link-do-membro-da-revenda.md): Gera um link para o membro entrar no painel sem senha. O link usa o domínio de painel do parceiro e expira em 6 horas. - [Ativar assinatura da revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalessubscriptions/ativar-assinatura-da-revenda.md): Ativa a assinatura da revenda. Assinaturas de demonstração não podem ser ativadas. - [Cancelar assinatura da revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalessubscriptions/cancelar-assinatura-da-revenda.md): Cancela a assinatura da revenda. A assinatura precisa estar ativa. - [Avisar revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalessubscriptions/avisar-revenda.md): Marca a assinatura da revenda com aviso, sinalizando um possível bloqueio. A assinatura precisa estar ativa. - [Remover aviso da revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalessubscriptions/remover-aviso-da-revenda.md): Remove o aviso da assinatura da revenda. A assinatura precisa estar ativa. - [Bloquear revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalessubscriptions/bloquear-revenda.md): Bloqueia a assinatura da revenda. A assinatura precisa estar ativa. - [Desbloquear revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalessubscriptions/desbloquear-revenda.md): Desbloqueia a assinatura da revenda. A assinatura precisa estar ativa. - [Atualizar assinatura da revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalessubscriptions/atualizar-assinatura-da-revenda.md): Atualiza o código de contrato da assinatura da revenda, sem mudar o status. - [Autorizar aplicação na revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalesapplications/autorizar-aplicação-na-revenda.md): Autoriza uma aplicação na revenda. Apenas aplicações do tipo manual podem ser autorizadas por esta rota. - [Revogar aplicação da revenda](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/resalesapplications/revogar-aplicação-da-revenda.md): Revoga a autorização da aplicação na revenda. - [Planos](https://deliveryvip-a4256422.mintlify.dev/docs/reference/partner/v2/plans.md): Endpoints para consultar os planos de cobrança usados nas assinaturas das lojas. - [Listar planos](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/plans/listar-planos.md): 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. - [Consultar plano](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/plans/consultar-plano.md): Retorna um plano do parceiro. Segue as mesmas regras de visibilidade da listagem. - [Faturas](https://deliveryvip-a4256422.mintlify.dev/docs/reference/partner/v2/invoices.md): Endpoints para consultar as faturas mensais das lojas e o resumo por revenda. - [Listar faturas](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/invoices/listar-faturas.md): Lista as faturas do mês de todas as lojas do parceiro (diretas e de revendas) ou, quando `partnerId` é uma revenda, das lojas da revenda. Para revendas, `totalPrice` só vem quando a revenda tem tabela de preços própria. - [Listar faturas das lojas diretas](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/invoices/listar-faturas-das-lojas-diretas.md): Lista as faturas do mês das lojas. Quando `partnerId` é um parceiro, retorna apenas as lojas vendidas diretamente por ele (sem revenda); quando é uma revenda, retorna as lojas da revenda. Os blocos de preço `RECEIVABLE` só aparecem quando o parceiro tem tabela de preços própria. - [Listar faturas das revendas](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/invoices/listar-faturas-das-revendas.md): Resume, por revenda, as faturas do mês das revendas do parceiro. Faturas de lojas vendidas diretamente pelo parceiro não entram. Os blocos de preço `RECEIVABLE` só aparecem quando o parceiro tem tabela de preços própria. - [Cadastro](https://deliveryvip-a4256422.mintlify.dev/docs/reference/partner/v2/signup.md): Endpoint para cadastrar loja e proprietário a partir de uma landing page pública. - [Cadastrar loja por página pública](https://deliveryvip-a4256422.mintlify.dev/docs/api-reference/signup/cadastrar-loja-por-página-pública.md): Cria uma loja e a conta do seu dono a partir de uma landing page pública, em que quem preenche o formulário é um visitante anônimo e não o backend do parceiro. - [Changelog](https://deliveryvip-a4256422.mintlify.dev/docs/changelog.md): As principais alterações nas APIs da DeliveryVip, da mais recente para a mais antiga. - [Deprecations](https://deliveryvip-a4256422.mintlify.dev/docs/deprecations.md): Rotas em descontinuação, os prazos de cada uma e como migrar para as substitutas. ## OpenAPI Specs - [authentication](https://app.deliveryvip.com.br/swaggers/authentication.yaml) - [loyalty_operator](https://app.deliveryvip.com.br/swaggers/loyalty_operator.yaml) - [merchant](https://app.deliveryvip.com.br/swaggers/merchant.yaml) - [opendelivery](https://app.deliveryvip.com.br/swaggers/opendelivery.yaml) - [partner](https://app.deliveryvip.com.br/swaggers/partner.yaml) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.