Despache um pedido
curl --request POST \
--url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId}/dispatch \
--header 'Authorization: Bearer <token>'Pedidos
Despache um pedido
Informe que a entrega começou.
POST
/
v1
/
orders
/
{orderId}
/
dispatch
Despache um pedido
curl --request POST \
--url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId}/dispatch \
--header 'Authorization: Bearer <token>'Chame este endpoint quando o entregador retirar o pedido e iniciar a entrega.
Parâmetros de rota
string (uuid)
required
Identificador único do pedido sendo despachado. Gerado pela Onbeef e retornado no evento do pedido.
Corpo da requisição
O corpo é opcional. Você pode enviardeliveryTrackingInfo (mesmo formato de Atualizar rastreamento) para registrar o rastreamento já no despacho. Sem corpo, o rastreamento enviado anteriormente é preservado.
Resposta
202: Aceito
A requisição de despacho foi aceita para processamento. O status do pedido é atualizado para refletir que está saindo para entrega.401: Não autorizado
Retornado quando a requisição não inclui credenciais de autenticação válidas.404: Não encontrado
Nenhum pedido foi encontrado com oorderId informado.
Exemplo de requisição
curl --request POST \
--url "https://api.dev.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479/dispatch" \
--header "Authorization: Bearer <token>"
curl --request POST \
--url "https://api.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479/dispatch" \
--header "Authorization: Bearer <token>"
Após despachar um pedido, você pode usar o endpoint Atualizações de entrega para enviar localização e status em tempo real à Onbeef enquanto o pedido está em trânsito, enriquecendo a experiência do cliente.
Só chame este endpoint depois que o entregador tiver retirado fisicamente o pedido.