Set a stop along a route

  • Use the vehicleStopover property to designate a waypoint as a stopover for pickups or drop-offs, ensuring the route avoids unsuitable roads like highways or tunnels.

  • Requests utilizing the vehicleStopover property incur higher billing rates compared to standard route requests.

  • Setting vehicleStopover to true guarantees the route starts or ends on a road suitable for pickups and drop-offs, avoiding issues with waypoints located near tunnels or highways.

  • The vehicleStopover property is crucial for optimizing routes for vehicles that require specific pickup and drop-off locations.
European Economic Area (EEA) developers

To set a stop along a route, for example, for a pickup or dropoff, you designate a waypoint as a stopover waypoint. To do this, use the vehicleStopover property of a waypoint, Waypoint (REST) or Waypoint (gRPC). This setting ensures that the calculated route doesn't begin or end on a road that is unsuitable for pickup and drop-off, such as a highway or tunnel.

Consider the situation where a surface road crosses over a road inside a tunnel. If you were to specify a waypoint located where the two roads intersect (as seen on a map), then the resulting route would begin or end on either the surface road or the tunnel. This result presents a problem because you can't stop in tunnels to make pickups or drop-offs.

If you want to use the waypoint for a pickup or drop-off, then you set the vehicleStopover field to true to ensure that the resulting route begins or ends on a road that allows pickups and drop-offs.

The following example demonstrates how to set the vehicleStopover property:

{
  "origin":{
    "location":{
      "latLng":{
        "latitude": 37.419734,
        "longitude": -122.0827784
      }
    },
    "vehicleStopover": true
  },
  ...
}