Waypoints Sequence Extension API Developer's Guide

Pickup Waypoints

The waypoint sequence resource (findpickups allows you to optimize the cost of your journey by picking up and dropping passengers and goods along the route. Use the parameters driver_cost (cost per hour) and vehicle_cost (cost per kilometer) to set the detour time/distance in relation to the revenue made by picking up and dropping off things.

The Waypoints Sequence Extension API does not include route details in its responses. To request a route, use the HERE Routing API passing the route start/end points and the pickup/drop-off waypoints in the order as suggested in the findpickups response.

Requests to the Routing API must include the route travel mode and two consecutive waypoint coordinates from the response from the Waypoints Sequence Extension API. The response from the Waypoints Sequence Extension API provides this information in the element estimatedDeparture.

Time window constraints define opening hours or deadlines for product delivery points or appointments specific to each waypoint. Succcesful responses contain an optimized waypoint sequence that observes all the time constraints specified in the request in the parameter waypointN. Where this is not possible, the service generates a response without a way point sequence, but hints at conflicting or problematic constraints or waypoints. You must then resubmit the request with relaxed or modified constraints or waypoints. For an example, see Time Constraints Waypoint Sequence.

Pickup and dropoff names define an implicite partial order between pairs of waypoints which is strictly obeyed.

Service time is specific to each waypoint and defines the amount of time to be spent at the waypoint. In other words, it indicates the length of time between arrival at the waypoint and departure from it, for example to complete a goods delivery. Service times are taken into account in the optimized waypoint sequence.

The Waypoints Sequence Extension API may take several minutes to calculate a response depending on the parameters specified. Specifically, this calculation time depends on the following:

  • whether traffic mode (mode=...;traffic:enabled) is enabled
  • the number of waypoints
  • the distances between the individual waypoints
  • whether car or truck mode is used (mode=car;… or mode=truck;...)

The timeout after which the network connection is closed is set to 600 seconds on the HERE Waypoints Sequence Extension API systems.