Vehicle

post

https://customer_id.prod.smartlane.io/api/vehicle

Body Params

int32

custom_id

string

User-defined unique identifier of a vehicle.

name

string

Vehicle name.

plate

string

Additional identifier (e.g. car license plate).

vehicle_class

string

enum

Defines speeds and restrictions on routes.

Allowed:

vehicletype

object

The Vehicletype can be referenced by a vehicle. Every empty field of the vehicle uses the corresponding type of the vehicletype.

depot_location

object

depot_location_id

int32

reference to Depot address entity. Either this or use the full depot address above. Only one can be used

end_location

object

end_location_id

int32

reference to the vehicle end location address entity. Either this or use the full end location address above. Only one can be used

capacity_1

int32

Capacity corresponding to load type 1.

capacity_2

int32

Capacity corresponding to load type 2.

capacity_3

int32

Capacity corresponding to load type 3.

daily_rate

float

Fixed cost of a vehicle which is used in a tour.

km_rate

float

Variable cost of vehicle per driven km.

waiting_hour_rate

float

Variable cost of idle time.

traveltime_factor

float

Vehicle speed correction factor.

departure_time_from

date-time

Earliest start time of tour (departure of driver), ISO 8601 time (not date-time format).

departure_time_to

date-time

Latest start time of tour (departure of driver), ISO 8601 time (not date-time format).

return_time_to

date-time

Latest end time of tour (return of driver, or last delivery), ISO 8601 time (not date-time format).

roundtrip

boolean

Should the vehicle return to the depot?

max_tour_duration

int32

Maximum tour duration in minutes (lower priority than return_time_to).

active

boolean

Defines whether the vehicle is used for the route calculations.

load_class

string

Name of the assigned LoadClass.

obeys_territory_mapping

boolean

Defines if the territory restrictions are active for this vehicle.

territory_custom_ids

array of strings

List of territory custom ids the vehicle should be assigned to. Only works when obeys_territory_mapping = true.

territory_custom_ids

secondary_territory_custom_ids

array of strings

List of secondary territory custom ids the vehicle should be assigned to. Only works when obeys_territory_mapping = true.

secondary_territory_custom_ids

max_load_height

float

Maximum load height of the vehicle.

liftgate

boolean

Defines if the vehicle has a liftgate.

trailer

boolean

Defines if the vehicle has a trailer.

variable_els_seconds_per_load

array of int32s

variable_els_seconds_per_load

fixed_els_seconds

int32

Fixed length of stay at a stop for the vehicle.

depot_els_config

object

Els values for each load dimension used for loading and unloading at the depot.

max_allowed_weight

int32

Maximum allowed weight of a vehicle in kg.

width

int32

Width of the vehicle in cm.

height

int32

Height of the vehicle in cm.

length

int32

Length of the vehicle in cm.

max_adr_points

int32

Maximum allowed ADR points on the vehicle.

max_allowed_km

int32

Maximum allowed km a vehicle is allowed to travel.

Responses

201

OK.

403An error message caused by missing authorization (403 forbidden)

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

defaultUnexpected error.