Detect route location visits

  1. Detection parameter settings
  2. How visit time is recorded

Visits to route locations (orders and depots) are detected automatically. This helps log violations of the delivery sequence (if the Delivery by order statuses option is off) and to automatically detect deliveries .

Note.

Depot visits are detected only if you set up depot export to Track & Trace or if depots are added to routes as separate locations via the API (for such locations, type = depot). For more information, see Courier visits to depot.

Detection parameter settings

Detection radius, m

The detection radius is set to 500 m at the company level by default. You can specify a different value in the company settings (only when automatic delivery detection is enabled) yourself or by contacting support (if you don't want to enable automatic delivery detection). The maximum detection radius is 2000 m.

You can set individual detection radiuses:

  • For all orders on a route that start from a specific depot, in which case use the mark_delivered_radius parameter in the API method for creating the depot or editing one or multiple depots. The priority of this radius supercedes the company-level radius.
  • For a specific order, in which case use the mark_delivered_radius parameter in the API method for creating or editing one or multiple orders. The priority of this radius supercedes the company-level or depot-level radiuses.

You can set the depot visit detection radius (different from the company-level setting) via the interface in the company settings or using the API method for creating one or multiple depots in the mark_route_started_radius parameter.

Detection coefficient
The default value is 0.5. You can specify a different value in the company settings (only if automatic delivery detection is enabled) yourself or by contacting support (if you don't want to enable automatic delivery detection).
Time to spend in the radius for detection, s

A visit is detected afterwhen the courier must be within the detection radius (in the delivery area).

Note.

If you don't specify the time parameters, the visit will be detected when the courier enters the radius.

For the order, the time when the courier is in the delivery area is calculated using the formula:

, where

  • is the detection coefficient.
  • is the service_duration_s order handling time.
  • is the shared_service_duration_s address handling time.

The calculation for the depot uses the service_duration_s loading/unloading time. You can also set this value using the API method for creating one or multiple depots. You have to set this parameter if you use depot detection.

ETA calculation influence

The moment when visit detection is triggered depends on the ETA calculation method:

  • For arrival_time: in seconds after the courier enters the delivery area.
  • For delivery_time: in seconds after the start of delivery, but not before the delivery window.

How visit time is recorded

The location visit is detected using the time on the courier's device.

For example, the courier visited the order at 17:00, but the internet connection on their device was lost and only restored at 17:10. At 17:05, the routing workspace dashboard won't show that the order has been visited. The manager will only see this information at 17:10, when the courier is online again and their device can send data to the Track & Trace server. In this case, the order visit time will be recorded as 17:00.

Contact support