Valide o código de entrega

curl --request POST \
  --url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId}/validateCode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deliveryCode": "<string>"
}
'

{
  "orderId": {},
  "deliveryCode": "<string>"
}

POST

orders

{orderId}

validateCode

Valide o código de entrega

curl --request POST \
  --url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId}/validateCode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deliveryCode": "<string>"
}
'

{
  "orderId": {},
  "deliveryCode": "<string>"
}

Valide o código informado pelo cliente antes de chamar o endpoint Marcar como entregue.

Parâmetros de rota

orderId

string (uuid)

required

Identificador único do pedido cujo código de entrega você quer validar. Gerado pela Onbeef e retornado no evento do pedido.

Corpo da requisição

deliveryCode

string

required

Código de confirmação de entrega informado pelo cliente no momento da entrega.

Resposta

200: Sucesso

O código é válido. A entrega está confirmada como sendo feita ao cliente correto.

orderId

string (uuid)

Identificador único do pedido validado.

deliveryCode

string

Código de confirmação de entrega que foi validado.

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.

400: Requisição inválida

O código de entrega informado é inválido ou não corresponde ao código registrado para este pedido. Corpo: { "title": "Invalid code provided", "status": 400 }.

Exemplo de requisição

curl --request POST \
  --url "https://api.dev.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479/validateCode" \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{
    "deliveryCode": "4829"
  }'

curl --request POST \
  --url "https://api.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479/validateCode" \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{
    "deliveryCode": "4829"
  }'

Exemplo de corpo da requisição

{
  "deliveryCode": "4829"
}

Exemplo de resposta (200)

{
  "orderId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "deliveryCode": "4829"
}

Uma resposta 400 significa que o código está incorreto. Não entregue o pedido se a validação falhar: entre em contato com o cliente pelo canal apropriado para resolver a divergência antes de concluir a entrega.

Este é o endpoint do lado do merchant (autenticado por Bearer token). O provedor de logística usa o endpoint equivalente POST /v1/logistics/confirmationCode, autenticado por headers X-App-*.

Marcar como entregue Solicitar cancelamento

⌘I

Visão geral

Autenticação

Merchant

Pedidos

Logística

Valide o código de entrega

Parâmetros de rota

Corpo da requisição

Resposta

200: Sucesso

401: Não autorizado

404: Não encontrado

400: Requisição inválida

Exemplo de requisição

Exemplo de corpo da requisição

Exemplo de resposta (200)

​Parâmetros de rota

​Corpo da requisição

​Resposta

​200: Sucesso

​401: Não autorizado

​404: Não encontrado

​400: Requisição inválida

​Exemplo de requisição

​Exemplo de corpo da requisição

​Exemplo de resposta (200)

Parâmetros de rota

Corpo da requisição

Resposta

200: Sucesso

401: Não autorizado

404: Não encontrado

400: Requisição inválida

Exemplo de requisição

Exemplo de corpo da requisição

Exemplo de resposta (200)