Route tracking

The route is tracked between the route_start and route_finish parameters. You can see the tracking results and the time of passing route checkpoints in the interface (for more information, see Courier's location at a specific time and Courier route information).

Tracking parameters

route_start

Route start time relative to the date value, in [d.]HH:MM:SS format.

This parameter's value is also linked to the shift_start notification and SMS at the start of the route.

Example of parameter calculation

You plan the route for 12.01.2021 and set the following route_start value:

• 5:00:00 — Tracking will start at 5:00 on 12.01.2021.
• 1.5:00:00 — Tracking will start at 5:00 on 12.02.2021.

route_finish

Route finish time relative to the date value, in [d.]HH:MM:SS format.

Example of parameter calculation

You plan the route for 12.01.2021 and set the following route_finish value:

• 18:00:00 — Tracking will end at 18:00 on 12.01.2021.
• 1.18:00:00 — Tracking will end at 18:00 on 12.02.2021.

When calculating the parameters, the depot's time zone is taken into account. For example, if route_start = 5:00:00, and the depot's time zone time_zone is Europe/London, tracking starts at 05:00 London time, or at 07:00 Helsinki time.

The route_start and route_finish parameters are optional. They're described in API Resources.

Tip

We recommend clearly setting the route_start and route_finish times.

Tracking start

When working via the API, the start of tracking depends on whether the route_start parameter is set.

route_start is set

Note

If there are no orders on the route and route_finish is not set, then the route is considered inactive and tracking will not start. Add orders in advance or set route_finish.

Tracking starts immediately or some time before the route_start start time. The tracking offset from the route start time is specified in the tracking_start_h parameter, which is set in hours:

• For the route.

• For the company (used if the value for the route isn't set).

  The default tracking_start_h tracking offset for the company is 1. If you need to change this value, contact support.

For more information about tracking_start_h, see API resources.

route_start is not set

Tracking starts 5 hours before the earliest order time window.

When working with the interface, the route_start (start of tracking) depends on the way the task is uploaded to Track & Trace.

Planning in the interface and export to Track & Trace

The route_start time is the time of the vehicle's departure from the depot.

Example

The task's conditions are manually entered into Routing workspace where the route is built. The route is then exported to Track & Trace.

• Sample task conditions

The route page in Routing workspace shows that the Set start time is 9:26, which is when the vehicle left the depot.

Importing routes from Excel to Track & Trace

The route_start time is the start time of the shift.

Example

An Excel file with routes prepared in advance (the Routessheet) is uploaded to Track & Trace. In the Start and end time of the shift column on the Vehicles sheet, the shifts.0.time_window parameter has the shift start value set to 02:00.

• Sample file with a prepared route

The route page in Routing workspace shows that the Set start time is 02:00.

End of tracking

The tracking end time depends on the route_finish parameter.

route_finish is set

Tracking ends at the time specified in the route_finish parameter.

route_finish is not set

Tracking ends 5 hours after the end of the latest order time window.

Route availability in the app

route_finish is set

At the route_finish time, the open route closes and the courier is unable to enter the route.

route_finish is not set

The route will no longer be available in the app if one of the following conditions is met:

• More than 5 hours have passed since the latest order time window.
• The automatic tracking extension time has ended.

Automatic tracking extension

In some cases, it may be necessary to continue tracking a route after the route_finish time or if more than 5 hours have passed since the latest order time window.

Tracking is extended automatically if:

1. max_route_finish_prolongation_h > 0.

2. At least one of the following conditions is met:

   • The route contains an undelivered order.
   • The courier is within the radius of the order on the route.
   • There's an unvisited depot or an order with the garage type at the end of the route.

The max_route_finish_prolongation_h parameter limits the time which the route can be automatically extended for. The extension time can be set between 0 and 168 hours (7 days). By default, max_route_finish_prolongation_h is set to 0. If you need to change this value, contact support.

Contact support