Calc route optimized timewindow

post https://customer_id.prod.smartlane.io/api/calcroute/optimized/timewindow

Calculates optimal routes for vehicles serving the given shipments.

This an asynchroneous process which returns a Process ID. Results can then be polled (e.g. every second) via "GET /api/process/status/<process_id>/current".

Query Params

truck

boolean

Defaults to false

Indicates if vehicles shall be treated as trucks. In this case, truck restrictions on the respective roads will be respected. The resulting tour will not lead through truck restricted road sections. Default: false

roundtrip

boolean

Defaults to false

Indicates if vehicles shall return to the depot after finishing the tour.

traffic

boolean

Defaults to true

Indicates if traffic situation prediction for the route optimization.

use_territories

boolean

Defaults to false

Indicates if pre-defined territories are respected in the planning.

vehicle_routing_type

string

Defaults to car

Vehicle type, must be one of 'car' or 'truck'. This parameter has an effect on the road types that will be used and on the average speed on each road.

drop_deliveries

boolean

Defaults to false

Indicates if deliveries shall be dropped if they do not fit into the tour's time frame or if they cannot be located on the map.

drop_deliveries_data

boolean

Defaults to false

Show full data (not just ids) of the deliveries in omitted warning.

traveltime_factor

float

Factor for increased travel time of slower vehicles.

hard_delivery_units_by_customernr

boolean

Defaults to false

Multiple deliveries which share a common unique customer number are bundled together and are treated as one single delivery object.

depot_reload

boolean

Defaults to false

Indicates if vehicles are allowed to return to the depot for multi-trip tours.

initial_loading_is_working_time

boolean

Defaults to false

Whether the depot loading time shall be considered as the drivers working hours.

final_unloading_is_working_time

boolean

Defaults to false

Whether the depot unloading time shall be considered as the drivers working hours.

depot_loading_time

int32

Defaults to 0

Depot loading time in seconds.

depot_unloading_time

int32

Defaults to 0

Depot unloading time in seconds.

stop_must_fit_in_pdt

boolean

Defines if the els has to fit within a time window.

nameprefix

string

Defaults to car

A user-defined prefix for calculated tour names/custom ids in this request. If the result contains more than one tour, this prefix wil be extended by sequential numbers.

avoid_ferries

boolean

Defaults to false

Indicates if ferries should be avoided.

Body Params

Routing Parameters

deliverydata

array of objects

List of delivery/address objects (either in the Delivery format with city, street, ... or geo positions lat and lng) which will be combined to the resulting tour(s). Time windows (pdt_from and pdt_to) are optional. It is required to provide either 'deliverydata' or 'deliveriyids'. If both are provided, only deliveryids is used.

deliverydata

deliveryids

array of int32s

List of delivery ids (if delivery objects are already defined) which will be combined to the resulting tour(s). It is required to provide either 'deliverydata' or 'deliveriyids'. If both are provided, only 'deliveryids' is used.

deliveryids

vehicles

array of objects

List of vehicle inputs.

vehicles

vehicleids

array of int32s

List of available vehicle ids.

vehicleids

start_time

date-time

Start time for an optional predefined time frame for deliveries on the route. It is only used for deliveries which don't have a specified time window (pdt_from and pdt_to) which has a higher priority.

end_time

date-time

End time for an optional predefined end time frame for deliveries on the route. It is only used for deliveries which don't have a specified time window (pdt_from and pdt_to) which has a higher priority..

tour_duration_rate

int32

Defaults to 1

Cost factor for the time/length of the route.

max_tour_duration

int32

Default maximum tour duration of all vehicles in minutes.

return_time_to

date-time

Latest possible depot return time for all vehicles.

departure_time_from

date-time

Earliest possible depot departure time for all vehicles.

departure_time_to

date-time

Latest possible departure time from depot for all vehicles.

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://customer_id.prod.smartlane.io/api/calcroute/optimized/timewindow?truck=false&roundtrip=false&traffic=true&use_territories=false&vehicle_routing_type=car&drop_deliveries=false&drop_deliveries_data=false&hard_delivery_units_by_customernr=false&depot_reload=false&initial_loading_is_working_time=false&final_unloading_is_working_time=false&depot_loading_time=0&depot_unloading_time=0&nameprefix=car&avoid_ferries=false' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "tour_duration_rate": 1
8
}
9
'

Choose an example:

application/json

202process_id for the asynchroneous process. Can be used for async status polling via "GET /api/process/status/<process_id>/current".

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

defaultUnexpected error.