Skip to main content
A Merchant API conecta o seu sistema (PDV, ERP, KDS, gestor de entregas) às lojas que instalaram o seu app na DeliveryVip. Com ela você recebe pedidos, atualiza o status, mantém o catálogo sincronizado e opera comandas, descontos e fidelidade.
Seu PDV já implementa o padrão Open Delivery para outras plataformas? Veja o Open Delivery. Vai gerenciar lojas, assinaturas e faturas de uma rede? Esse é o papel da Partner API.

​
Para quem é

​
Base URL e autenticação

Todas as rotas exigem um token OAuth2 no header Authorization, com o scope od.all (as rotas de configuração de fidelidade pedem dv.loyalty). Veja Autenticação.

​
Comece aqui

Crie o app e instale numa loja de teste

Siga a Jornada do Developer: conta, app com a permissão Merchant API e a loja de teste, pedida no Discord.

Receba o seu primeiro pedido

O tutorial Receba seu primeiro pedido vai do token ao pedido confirmado, com um script pronto em Node.js e Python.

Prepare para produção

Escolha o canal de eventos abaixo, complete o ciclo do pedido com as ações e confira o checklist em Testes e produção.

​
Como os eventos chegam

Tudo o que muda numa loja vira um evento. Você escolhe como recebê-los, e pode usar os dois canais juntos.

Webhooks

A DeliveryVip envia cada evento para a sua URL no momento em que ele acontece. Recomendado como canal principal.

Polling de eventos

Você consulta a fila a cada 30 segundos e confirma o que processou. Ideal como reconciliação.
Os dois canais são independentes: um evento entregue por webhook continua no polling. O arranjo mais robusto é o webhook como canal principal e o polling como reconciliação. Se o seu sistema não pode receber chamadas da internet, use só o polling.

​
Módulos

Pedidos

Receba, confirme, prepare, despache e cancele pedidos de delivery, retirada e consumo no local.

Catálogo

Consulte e sincronize categorias, produtos, opções e serviços de delivery e retirada.

Indoor

Gerencie comandas e mesas do autoatendimento e responda a chamadas de garçom e pedidos de conta.

Descontos

Crie cupons e descontos automáticos e acompanhe o desempenho de cada um.

Ferramentas

Calcule a taxa de entrega para um endereço e consulte se a loja está aberta.

Fidelidade

Conecte o seu programa de cashback ao checkout: adesão, resgate e acúmulo.
Indoor e Descontos estão em beta e ainda podem mudar. Acompanhe o changelog.

​
Erros comuns

Os erros seguem o formato {"status": "422", "title": "..."}. Veja Erros.

​
Próximos passos

Receba seu primeiro pedido

Do token ao pedido confirmado, com código pronto para rodar.

Testes e produção

Loja de teste, checklist de integração e o que muda ao liberar o app.

Referência

Todos os endpoints da Merchant API V3.

Conceitos

Erros, paginação, datas, rate limiting e Postman.