API TutorialAPI Reference
API Reference

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".

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
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

boolean
Defaults to false

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

boolean
Defaults to true

Indicates if traffic situation prediction for the route optimization.

boolean
Defaults to false

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

string
enum
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.

Allowed:
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.

boolean
Defaults to false

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

float

Factor for increased travel time of slower vehicles.

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to false

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

int32
Defaults to 0

Depot loading time in seconds.

int32
Defaults to 0

Depot unloading time in seconds.

boolean

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

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.

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
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.

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..

int32
Defaults to 1

Cost factor for the time/length of the route.

int32

Default maximum tour duration of all vehicles in minutes.

date-time

Latest possible depot return time for all vehicles.

date-time

Earliest possible depot departure time for all vehicles.

date-time

Latest possible departure time from depot for all vehicles.

Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 7 months ago