Failed to Deliver

post

https://api.abbiamo.io/v1/delivery/failed-to-deliver

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Header required
The Header x-abbiamo-carrier-key is required to use this endpoint. Please fill out this field on the upper right corner of this page.
If you don't have one, please don't hesitate to contact us to claim it.

📘
Abbiamo Failure Codes
Please, keep in mind that the field failure_code must be filled by a code that can be found in this failure codes table.
If your failed reason is not in this table, please send the failure_code 17 (other) and put the failure message in the observation field.

Update order to Failed with sub_status Failed to Deliver

❗️
Event block

Sequential events cannot have the same event_at attribute. If you send a payload with se same event_at as a previous event it won't be processed.

Body Params

delivery_id

string

required

The delivery identification that should be updated

failure_code

int32

required

The failure code. It must be one of the provided in the failure code table.

event_at

string

required

The event time in format of ISO string with timezone. Example: 2022-12-15T12:15:08.060-03:00

observation

string

Any additional information about the failure. Max length 400 chars

attachments

array of objects

Any image attached to this orders like proof of delivery failed

attachments

failure_driver_message

string

Any additional information about the deliver provided by the driver

event_latitude

float

Shipper latitude on time of checkpoint (separator: dot)

event_longitude

float

Shipper longitude on time of checkpoint (separator: dot)

delivery_eta

string

The event estimated time of arrival at destination address in format of ISO string with timezone. Example: 2022-12-19T13:02:28.012-03:00

preview_delivery_price

int32

Preview price charged to seller regarding this delivery

return_eta

string

The event estimated time of arrival at pickup point to return packages in format of ISO string with timezone. Example: 2022-12-19T13:02:28.012-03:00

return_verification_code

string

Alphanumeric code the shipper must input in app (informed by seller) to finish the return process for safety measures

Responses

Header required

Abbiamo Failure Codes

Event block

200200

400400