waypoint

object
id
string

The waypoint identifier

1 validation
contact_name
string

Full name of the contact at the waypoint

required
contact_phone
string

The contacts phone number (with international code)

required
notes
string

Any notes for the waypoint in the scope of the current delivery

tracking_token
string

This token can be used to authentice tracking data consumption for a single waypoint

1 validation
tracking_url
string

This URL can be used track the courier to a single waypoint

1 validation
state
string

The courier status at a given waypoint

2 validations + required
arrived_at
string

DateTime the courier arrived at the waypoint

1 validation
finished_at
string

DateTime the courier finsihed at the waypoint

1 validation
item_quantity_count
integer

What is the total quantity of orders to collect / deliver

1 validation + required
address
object