Falha no retorno

Houve falha na devolução do pacote à filial — inclui `failure_code` da tabela de [códigos de falha](/docs/api/conceitos/tables/failure-codes).

Header obrigatório. Toda chamada exige o header x-abbiamo-seller-group-key. Preencha-o no canto superior direito desta página ou veja como obter a sua chave.

Update order to Failed with sub_status Failed to Return

Eventos sequenciais não podem ter o mesmo event_at. Se você enviar um payload com o mesmo event_at de um evento anterior, ele não será processado.

Authorization

sec0

x-abbiamo-carrier-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

delivery_id*string

Identificador da entrega a ser atualizado

event_at*string

Data/hora do evento no formato ISO 8601 com timezone. Ex.: 2022-12-15T12:15:08.060-03:00

observation?string

Informações adicionais sobre a falha. Máx. 400 caracteres

failure_driver_message?string

Informações adicionais sobre a falha, se enviadas pelo motorista

event_latitude?number

Latitude do motorista no momento do checkpoint (separador: ponto)

Formatfloat

event_longitude?number

Longitude do motorista no momento do checkpoint (separador: ponto)

Formatfloat

return_verification_code?string

Código alfanumérico que o motorista deve digitar no app (informado pelo lojista) para finalizar o processo de devolução, por segurança

Response Body

`application/json`

curl -X POST "https://example.com/v1/delivery/failed-to-return" \  -H "Content-Type: application/json" \  -d '{    "delivery_id": "string",    "event_at": "string"  }'

"{\n  \"success\": true\n}"

"{}"

Authorization

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`