Despache um pedido

curl --request POST \
  --url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId}/dispatch \
  --header 'Authorization: Bearer <token>'

POST

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

orderId

string (uuid)

required

Identificador único do pedido sendo despachado. Gerado pela Onbeef e retornado no evento do pedido.

Corpo da requisição

Este endpoint não exige corpo de requisição.

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 o orderId 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. Chamá-lo cedo demais: enquanto o entregador ainda está a caminho da sua loja: dará ao cliente informações imprecisas sobre o status da entrega.

Pronto para retirada Marcar como entregue

⌘I

Visão geral

Autenticação

Merchant

Pedidos

Logística

Despache um pedido

Parâmetros de rota

Corpo da requisição

Resposta

202: Aceito

401: Não autorizado

404: Não encontrado

Exemplo de requisição

​Parâmetros de rota

​Corpo da requisição

​Resposta

​202: Aceito

​401: Não autorizado

​404: Não encontrado

​Exemplo de requisição

Parâmetros de rota

Corpo da requisição

Resposta

202: Aceito

401: Não autorizado

404: Não encontrado

Exemplo de requisição