Route details

Migrate before: Q1 2027

Migrate from the legacy Route service to the latest version. The new service delivers a reorganized schema, per-country operator preferences, faster route computation, and greater maintainability.

Operations

General schema changes

• Explicit typing: previously flexible JSON fields are now explicitly typed in the schema to improve structure and validation.
• Naming conventions: fields now use snake_case instead of camelCase.
• Unit support: numeric inputs now support different unit types, expressed as an object with value, type, and an optional source (manual, telemetry, or default).

Query and subscription changes

Field naming and grouping have been revised, and redundant fields have been removed. The response now includes the original input enriched with defaults, so it can be reused for future route recalculations.

Top level

At the top level, most fields move under recommended, and the ev, telemetry, and routeRequest inputs are folded into a single request_input object.

Route

At the route level, most fields move under recommended, keeping their own names, alongside a few explicit renames.

Legs

At the leg level, ranges follow the same renaming as the route, and occupant and cargo details move onto each leg’s origin and via location properties.

Legs also gain a new range_after_charge field.

Highlighted changes

The response also introduces a new, more structured shape for route sections. It’s covered in more detail below.

Sections

Steps have been replaced with sections, which provide more granular information, including origin and destination details for each section.

sections {  type  tags  polyline(decimals: five)  distance(unit: meter)  duration  consumption  origin {    id    type    properties {      occupants      total_occupant_weight      total_cargo_weight    }    geometry {      type      coordinates    }  }  destination {    id    type    properties {      occupants      total_occupant_weight      total_cargo_weight    }    geometry {      coordinates      type    }  }}