Gerencie uma entrega - Onbeef Connect API

Escolha o fluxo conforme o tipo da sua integração.

Merchant
Operador de logística

Use o token OAuth do merchant nos endpoints de pedidos.

Despache o pedido

Chame POST /v1/orders/{orderId}/dispatch quando o entregador retirar o pedido.

Envie o rastreamento

Se sendTracking for true, envie atualizações para POST /v1/orders/{orderId}/tracking.O objeto deliveryTrackingInfo pode incluir evento, entregador, veículo, previsão e localização. Consulte o payload completo.

Valide o código

Quando necessário, envie o código para POST /v1/orders/{orderId}/validateCode.

Conclua a entrega

Chame POST /v1/orders/{orderId}/delivered depois da entrega.

Use os headers X-App-Id, X-App-MerchantId e X-App-Signature descritos na referência.

Envie eventos

Chame POST /v1/logistics/deliveryUpdate a cada mudança relevante da entrega.

Atualize o estado

Informe o tipo do evento, o pedido, o merchant e os dados exigidos para aquele estado.

Confirme o código

Chame POST /v1/logistics/confirmationCode antes de concluir uma entrega que exige confirmação.

Estados de logística

Evento	Momento
`PENDING`	Entrega criada.
`ASSIGNED`	Entregador atribuído.
`PICKUP_ONGOING`	Deslocamento até a loja.
`PICKUP_ARRIVED`	Chegada à loja.
`PICKED_UP`	Pedido retirado.
`DELIVERY_ONGOING`	Deslocamento até o cliente.
`DELIVERY_FINISHED`	Entrega concluída.
`REJECTED`	Entrega recusada.
`CANCELLED`	Entrega cancelada.

Valide o código quando ele for exigido antes de marcar o pedido como entregue.

​Estados de logística

Estados de logística