Pular para o conteúdo principal
O fluxo típico: você recebe um evento CREATED (via webhook ou polling), busca os detalhes do pedido pela orderURL do evento e vai transicionando o status conforme o pedido avança no seu PDV. Cada transição gera um evento, que chega pelo mesmo canal.
Evento CREATED, busca do pedido, confirmação e as demais ações, cada uma respondida com 202 e o evento correspondenteEvento CREATED, busca do pedido, confirmação e as demais ações, cada uma respondida com 202 e o evento correspondente

O pedido do evento CREATED à entrega

Obter detalhes do pedido

O formato do objeto de pedido segue a spec Order 1.3.0 do Open Delivery; consulte a spec oficial para o schema completo. As datas vêm em UTC.
Prefira usar a orderURL que chega no evento em vez de montar a URL manualmente. Pedidos ainda aguardando pagamento online (ou que expiraram sem pagamento) não são expostos: a API responde 404 para eles.

Transicionar o status

As transições são feitas via POST /v1/orders/{orderId}/{ação}, sem corpo (exceto o rastreio):
As respostas de sucesso trazem o id do pedido: {"id": "64939842-..."}. Uma ação que o estado atual do pedido não aceita (por exemplo, despachar um pedido já cancelado) responde 422.

Fluxo de cancelamento

  • Você quer cancelar: envie requestCancellation. O pedido é cancelado na hora, a resposta é 200 e o evento CANCELLED é emitido. Não há etapa de aprovação.
  • Cancelamento do lado da plataforma: quando a loja ou a plataforma cancela, você recebe direto o evento CANCELLED.
acceptCancellation e denyCancellation existem por compatibilidade com a spec e respondem 200 sem alterar o pedido. Hoje a DeliveryVip não emite ORDER_CANCELLATION_REQUEST, então você não precisa chamá-los.

Rastreio da entrega

O tracking recebe os dados de rastreio no formato da spec: último evento da entrega, problemas, veículo, previsão de chegada, entregador e localização. É o mesmo formato da API Merchant V3; veja os campos em Tracking. Um corpo fora do schema responde 422.

Eventos emitidos pela plataforma

Além dos eventos que refletem as suas ações, a plataforma emite eventos originados do lado dela, como CREATED (novo pedido), CONCLUDED e CANCELLED. A lista completa de tipos está em Recebendo eventos. Confirme cada um com o acknowledgment se você também usa o polling.