Confirm Delivery

Time	Status	User Agent
Retrieving recent requests…

delivery_id

string

required

The delivery identification that should be updated

event_at

string

required

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

external_id

string

The identification on your system so both companies can reference the same delivery

support_id

string

In case you have a different id for support team

observation

string

Any additional information that you want to provide. Max length 400 chars

mail_label

object

Flexible options to customize the label that the store will print

driver_name

string

The name of the driver who is handling the delivery

driver_phone

string

The phone of the driver who is handling the delivery

driver_document

string

The document number of the driver who is handling the delivery

driver_vehicle_type

string

enum

Defaults to MOTORCYCLE

The type of vehicle that is being used to deliver the order and to be displayed on tracking page

Allowed:

driver_vehicle_color

string

Defaults to black

The color to be applied to the vehicle on the tracking page. It must be a known CSS color or a hex code

driver_vehicle_plate

string

The vehicle identification to help final customer identify on time of delivery

driver_image_url

string

The profile picture of the driver to be displayed on the tracking page

event_latitude

float

Shipper latitude on time of checkpoint (separator: dot)

event_longitude

float

Shipper longitude on time of checkpoint (separator: dot)

collect_eta

string

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

collect_verification_code

string

Alphanumeric code the shipper must input in app (informed by seller) to unlock and start the delivery for safety measures

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_verification_code

string

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

200200

400400