Confirme o código de entrega
Logística
Confirme o código de entrega
Valide o código de uma entrega.
POST
Confirme o código de entrega
Use este endpoint quando um operador de logística precisar validar o código informado pelo cliente.
Autenticação
Como todos os endpoints de logística, este não usa o Bearer token OAuth. É autenticado por três headers HTTP:Identificador da sua aplicação de logística (UUID v4).
Identificador do merchant no contexto da sua integração (entre 36 e 100 caracteres).
Assinatura HMAC-SHA256 (hex, 64 caracteres) do corpo cru da requisição, calculada com o
client_secret da sua integração de logística como chave.Corpo da requisição
O corpo da requisição deve ser enviado comoapplication/json.
Identificador do pedido gerado pela Onbeef, fornecido quando a entrega foi solicitada.
Código de confirmação informado pelo cliente na porta. Envie-o exatamente como o cliente apresenta.
Resposta
200: Código confirmado
O código está correto. A entrega pode prosseguir. O corpo da resposta ecoaorderId e deliveryCode.
Identificador do pedido validado.
Código de confirmação validado com sucesso.
400: Código inválido
O código não corresponde ao esperado para este pedido. Corpo:{ "title": "Invalid code provided", "status": 400 }. Não marque o pedido como entregue.
401: Não autorizado
Os headersX-App-* não foram reconhecidos, a integração não está ativa, ou a assinatura não confere.
Exemplo de requisição
Exemplo de resposta
Relação com a validação de pedido
Este endpoint é a entrada do lado da logística para a verificação do código, autenticada por headersX-App-*.
Do lado do merchant/PDV, o endpoint equivalente POST /v1/orders/{orderId}/validateCode tem o mesmo propósito, mas é autenticado com um Bearer token de merchant. Ambos verificam o mesmo código: a diferença é qual parte está fazendo a checagem e quais credenciais são usadas.