Skip to main content
A API de pedidos é orientada a eventos: a DeliveryVip avisa o que aconteceu com cada pedido e o seu PDV busca os detalhes e responde com ações. Todo pedido passa pelas mesmas quatro etapas.

Receba o evento

Consulte novos eventos a cada 30 segundos em GET /merchant/v3/events:polling, ou receba-os na hora por webhook.

Confirme o recebimento

Envie o acknowledgment em POST /merchant/v3/events/acknowledgment para tirar os eventos da fila.

Busque o pedido

Obtenha itens, cliente, entrega e pagamento em GET /merchant/v3/orders/{orderId}.

Atualize o status

Confirme, prepare, despache, entregue ou cancele o pedido com as ações.
Quer ver isso funcionando? O guia Receba seu primeiro pedido tem um script completo em Node.js e Python.

​
Por onde seguir

Seu primeiro pedido

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

Definições

Tipos de pedido, agendamento e o ciclo de vida de cada tipo.

Fluxo de integração

Cada etapa em detalhe: polling, eventos, acknowledgment, detalhes e ações.

Listar pedidos

Consulte o histórico de pedidos de uma loja com paginação.
A Merchant API V3 segue o modelo da especificação Open Delivery, o padrão aberto para integrar plataformas de pedidos e PDVs. Se o seu sistema já implementa Open Delivery, veja a integração Open Delivery.