Vehicle configuration

vehicle describes the vehicle you plan the route for, such as its weight, heading and restrictions. calculateRoute and calculateReachableRanges take the same object, with one exception.

The demo below plans London to Brussels for the vehicle you pick in its panel: a weight, a top speed and whether it carries a toll tag. Each change replans the route.

Parameters

model

• dimensions.weightKG – The only dimension routing uses. See Truck parameters.

state

• heading – The heading at the origin, in degrees clockwise from true North.

restrictions

• maxSpeedKMH – From 0 to 250. The default, 0, lets the router pick a value for the vehicle.
• tollTransponder – Whether the vehicle carries an electronic toll collection transponder: all, unknown (default) or none. With none, the route avoids tolls you can pay only by transponder. With all, it avoids tolls you can't pay by transponder.

Reachable ranges

calculateReachableRanges takes the same vehicle without state.

Truck parameters

Routing on Orbis v3 plans routes for a car. travelMode takes 'car' only, and the only vehicle dimension it uses is the weight. On September 1, 2026, each parameter below was sent on its own to both endpoints, the route and the reachable range:

• The SDK types have none of the rejected parameters, so truck dimensions fail to compile instead of returning a car's route.
• Other spellings don't help. v3 rejects any body field it doesn't know by name, such as vehicleHeight or vehicleHeightInMeters.

Example

const routes = await calculateRoute({
    locations: [[4.9041, 52.3676], [2.3522, 48.8566]],
    vehicle: {
        model: { dimensions: { weightKG: 3500 } },
        state: { heading: 90 },
        restrictions: { maxSpeedKMH: 90, tollTransponder: 'none' }
    }
});

API reference

• VehicleParameters – The calculateRoute vehicle
• ReachableRangeVehicleParameters – The reachable range vehicle

Related guides and examples

Related guides

• Route planning parameters – Every other routing option
• Reachable ranges – Time and distance budgets, with the same vehicle

Related examples

• Route avoid options playground – A vehicle, road types and areas to avoid, each replanning the route