Route (id)

patch

https://customer_id.prod.smartlane.io/api/route/{route_id}

Edits the route information. Currently used for updating the status. Soon to be replaced by dedicated endpoints.

Path Params

route_id

int32

required

Route ID

Body Params

int32

creationtime

date-time

ast

date-time

Actual start time

tst_from

date-time

Target start time span (beginning).

tst_to

date-time

Target start time span (end).

distance

int32

Complete length of route in metersm.

gross_duration

int32

Duration of the whole route in seconds, including stop times at each location.

net_duration

int32

Duration of the whole route in seconds, not including stop times and waiting times. Depecated.

total_driving_time

int32

Driving time of the whole route in seconds.

status

int32

deliveries

array of objects

deliveries

custom_id

string

previous_deliveries

array of int32s

When deliveries are removed or changed, their IDs are saved here.

previous_deliveries

pst

date-time

Deprecated. Planned start time.

replaces

int32

Reference IDs to previous versions, when the route is updated.

routebase_address_id

int32

Reference to address.

finished_deliveries

int32

Deliveries which are already finished (i.e. delivered or cancelled).

fixed_cost

double

Fixed vehicle usage cost of this route.

initial_creationtime

date-time

Time of first creation of this route.

locked

boolean

Defaults to false

Has this route been locked by the user to avoid automatic updates?

performed_breaks

object

A list of rest break items.

remaining_time

int32

If the route was updated while being on the way, this is the remaining time to be performed.

return_time

date-time

Return time to the depot or (if no round trip, end time of the last stop).

roundtrip

boolean

Defaults to false

Does this route return to the depot?

total_cost

double

Sum of all costs.

total_deliveries

int32

Total number of deliveries on this route.

total_driving_time_seconds

int32

Total driving time of this route in seconds.

total_load

int32

Total load volume on this vehicle (first load dimension).

total_load_2

int32

Total load volume on this vehicle (second load dimension).

total_load_3

int32

Total load volume on this vehicle (third load dimension).

total_loads

array of int32s

Total load volume on this vehicle (list of all load dimensions).

total_loads

total_stop_time

int32

Sum of all stop times at each delivery location (in minutes).

total_waiting_time

int32

Sum of all waiting times before each delivery location (in minutes).

total_waiting_time_seconds

int32

Sum of all waiting times before each delivery location (in seconds).

tour_delay

int32

Total delay on this route in minutes.

variable_cost

double

Variable cost per km of this route.

vehicle

string

Vehicle type which performs this route.

vehicle_id

int32

ID of the vehicle that performs this route.

vehicle_territory_names

array of strings

Names of territories that are assigned to the route's vehicle.

vehicle_territory_names

waiting_cost

double

Waiting cost on this route.

end_location_id

int32

ID of the vehicle end location that performs this route.

Responses

200Detailed route data

422An error message caused by unprocessable input (e.g. no data found for input parameters)

defaultUnexpected error.