Vehicle routing profiles
Contents
A Vehicle Routing Profile is a preset collection of vehicle dimensions and other routing options that ensure the routing algorithm knows the type of vehicle being driven so it can generate a safe, efficient, and legal route. For example, if you are driving a truck, the routing algorithm will calculate a route that considers:
- Physical restrictions, such as low or weak bridges.
- Legal restrictions, such as the maximum dimensions, weight, and speed that apply to the vehicle.
- The need to avoid lower classes of roads and U-turns.
The best way to select a routing profile is by setting the profileName parameter when making a call to one of our routing APIs. The tables below can help you select the appropriate routing profile based on your worldwide region and vehicle’s dimensions.
You can also find more details below about our legacy routing profile settings.
Example format for a GET call
(North America) &profileName=Heavy%20Duty%20Doubles
(Europe) &profileName=Heavy%20Rigid
Example format for a POST call
(North America)
"Options": {
"profileName": "Heavy Duty Doubles"
},
(Europe)
"Options": {
"profileName": "Heavy Rigid"
},
Profiles by region
Select a profile based on the region where you are calculating a route and your vehicle’s dimensions.
North America
Europe
Oceania
Legacy Settings
The profileName parameter was introduced with our April 2022 release, and it is now the standard way to select a routing profile.
Prior to that release, there were multiple parameters that could be used to set a routing profile. To ensure backwards compatibility, these older parameters will continue to work, as described below. They include vehType, vehProfile (North America only), truckConfig (North America only) and individual parameters that specify vehicle dimensions.
vehType Parameter
If only the vehType is specific, a profile will automatically be assigned as outlined in the charts below. The Truck value is the default if no vehType is specified and a routing profile is not selected using any other parameter.
North America
| vehType Setting | Default Profile |
|---|---|
| 0-Truck | Heavy Duty Semitrailer (48’ x 96") |
| 1-Light Truck | Commercial Light |
| 2-Auto | Full-Sized Van |
| 3-Midsize Truck | Medium Duty Straight |
| 4-School Bus (North America only) | Conventional School Bus |
Europe
| vehType Setting | Default Profile |
|---|---|
| 0-Truck | Heavy Articulated |
| 1-Light Truck | Light |
| 2-Auto | Van |
| 3-Midsize Truck | Midsize |
Oceania
| vehType Setting | Default Profile |
|---|---|
| 0-Truck | Heavy Semitrailer |
| 1-Light Truck | Light |
| 2-Auto | Van |
| 3-Midsize Truck | Midsize |
vehProfile Parameter
(North America Only)
The vehProfile parameter includes our legacy list of Vehicle Routing Profiles in North America. If you continue to use this parameter, these older profiles will automatically be mapped to newer profiles for vehicles of the same size, which are listed above in North America Profiles.
vehProfile Enum Value
| New Profile Name |
|---|---|
| 0 | Default - Heavy Duty Semitrailer (48’ x 96’') |
| 1 | Heavy Duty Doubles |
| 2 | Heavy Duty Straight |
| 3 | Heavy Duty Semitrailer (48’ x 96’') |
| 4 | Heavy Duty Semitrailer |
| 5 | Full-size Van |
| 6 | Medium Duty Straight |
| 7 | Conventional School Bus |
| 8 | Small School Bus |
truckConfig Parameter
(North America Only)
The truckConfig parameter contains the same values as vehProfile, and its values will be mapped to newer profiles for vehicles.
If both truckConfig and vehProfile are specified, vehProfile gets preference.
Vehicle Dimensions
Vehicle dimensions are part of a Vehicle Routing Profile, but they can also be set independently using parameters such as vehHeight, vehWidth, etc.
Setting vehicle dimensions can result in errors if:
-
You only set vehicle dimensions, and they are out of range for the default Truck vehicle type.
-
You also choose a Vehicle Routing Profile via
vehProfileorprofileNameand the dimensions are out of range for that particular profile.