Conclua um pedido

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

POST

orders

{orderId}

delivered

Conclua um pedido

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

Chame este endpoint depois da entrega. Se o pedido exigir um código, valide-o antes.

Parâmetros de rota

orderId

string (uuid)

required

Identificador único do pedido que foi entregue. 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

O status de entregue foi aceito para processamento. O pedido é marcado como entregue na Onbeef e o cliente recebe uma confirmação.

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/delivered" \
  --header "Authorization: Bearer <token>"

curl --request POST \
  --url "https://api.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479/delivered" \
  --header "Authorization: Bearer <token>"

Esta ação é irreversível. Uma vez marcado como entregue, o ciclo de vida do pedido está completo e não pode ser revertido para um estado anterior. Confirme que a entrega foi bem-sucedida antes de chamar este endpoint.

A sequência padrão do ciclo de vida do pedido é: Confirmar → Pronto para retirada → Despachar → Entregue. Garanta que sua integração siga essa ordem para um rastreamento preciso na plataforma Onbeef.

Despachar pedido Validar código de entrega

⌘I

Visão geral

Autenticação

Merchant

Pedidos

Logística

Conclua 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