The following page contains parameter tables in alphabetical order for the
following components of the Route Optimization API optimizeTours
method:
These parameter tables only list and briefly describes the top-level objects and main parameters for ease of discovery. For an exhaustive list with complete descriptions and all the nested parameters see the API reference documentation .
Request body
The request body includes the following elements, which are illustrated in the diagram to the right and listed in the table below:
-
OptimizeToursRequest: The top-level request object containing the model and solving parameters.-
ShipmentModel: The core data structure containing shipments, vehicles, and global constraints.-
Shipment: A task with pickups and deliveries.-
VisitRequest: The location and constraints for a pickup or delivery.
-
-
Vehicle: A vehicle available to perform shipments.
-
-
Parent
Parameter
Property type
Description
OptimizeToursRequest
boolean (
true
/ false
)If
true
, the request is processed even if the timeout is set to a large value (longer than 30 minutes) that risks potential server interruptions.boolean (
true
/ false
)If
true
, uses traffic data for routing. If false, uses road network speeds only.number
When
useGeodesicDistances
is true, this speed is used to calculate travel times.Routes from a previous solution to start the optimization from.
Constrains the solution to be similar to existing routes, specifying which properties must be preserved and which may be relaxed.
boolean (
true
/ false
)If
true
, matches shipments/vehicles in injected routes by their label
instead of array index.integer
Specifies the maximum number of validation errors to return. If unspecified, a default limit applies.
boolean (
true
/ false
)If
true
, returns encoded polylines for individual transitions between visits.A list of routes to be refreshed. This recalculates polylines, durations, and distances for existing routes without modifying the visit sequence.
RETURN_FAST
(quick results) or CONSUME_ALL_AVAILABLE_TIME
(best quality within timeout).DEFAULT_SOLVE
(default) or VALIDATE_ONLY
to validate the model without solving.boolean (
true
/ false
)If
true
, travel distances and times are calculated using geodesic (straight-line) distances and the geodesicMetersPerSecond
speed.Specifies custom duration and distance matrixes used for routing between locations.
array of strings
Tags defining the destinations (columns) for the custom duration and distance matrixes.
array of strings
Tags defining the sources (rows) for the custom duration and distance matrixes.
number
Cost per hour of the global time span of the route, from the earliest vehicle start to the latest vehicle end.
Rules defining ordering constraints between specific shipments.
Rules preventing shipments of certain types from being serviced by the same vehicle.
Rules requiring shipments of certain types to be serviced by the same vehicle.
Specifies extra costs, delays, and distance limits for transitions between visits with specific tags.
array of integers
Indices of vehicles allowed to perform this shipment.
map (key: integer, value: number)
Additional costs incurred if a specific vehicle services this shipment.
array of integers
Indices of vehicles to which
costsPerVehicle
values apply.The capacity required (e.g., weight, volume) to carry this shipment.
The maximum absolute detour time allowed between pickup and delivery compared to the direct path.
number
The maximum relative detour allowed for the shipment (e.g., a value of 2.0 means the total time can be at most 2x the direct travel time).
The maximum allowed duration from the start of the pickup to the start of the delivery.
The geographic arrival location as latitude/longitude coordinates.
The location where the vehicle arrives to perform the visit. Defined by coordinates or a place ID.
The geographic departure location as latitude/longitude coordinates.
The location where the vehicle departs after completing the visit. If omitted, it is assumed to be the same as the
arrivalWaypoint
.Demands specifying the load change at this visit (e.g., -1 to drop off a package).
array of strings
Tags attached to this visit request. These are used to calculate travel times between this visit and others using
transitionAttributes
.The allowed time windows for the arrival at this visit.
array of strings
Strings describing the type of visit (e.g., "delivery", "installation"). Used to apply
extraVisitDurationForVisitType
from the Vehicle model.Defines rules for breaks (e.g., mandatory lunch break).
Adds extra duration to visits based on their
visitType
.number
A fixed cost that's applied if the vehicle is used, regardless of the route's distance or duration.
A hard or soft limit on the total distance of the vehicle's route.
A hard or soft limit on the total duration of the vehicle's route.
One or several constraints like avoiding tolls, highways, or ferries.
array of strings
Tags defining the vehicle's start state, used for transition attributes.
Allowed windows for the vehicle to start its route.
Geographic start location using a Waypoint (coordinates or place ID).
A hard or soft limit on the total travel duration (excluding wait/service time) of the vehicle.
number
Multiplier applied to travel times (e.g., 1.5 makes travel 50% slower).
The travel mode (e.g.,
DRIVING
, WALKING
). Affects travel times and distances.Defines order of unloading (e.g.,
LIFO
or LAST_IN_FIRST_OUT
).boolean (
true
/ false
)If
true
, the vehicle is considered used even without shipments. It incurs fixed costs and travels between its start and end locations.Response body
The response body includes the following elements, which are illustrated in the diagram to the right and listed in the table below:
-
OptimizeToursResponse: The top-level response object that contains the optimized routes and metrics.-
Metrics: The overall cost and execution statistics for the solution. -
ShipmentRoute: The sequence of visits and travel path assigned to a single vehicle.-
Visit: A stop on a route to perform a pickup or delivery. -
Transition: The travel path and duration between two route stops. -
AggregatedMetrics: The summed totals for duration, distance, and other metrics. This element can be present both inMetricsandShipmentRoute.
-
-
Parent
Parameter
Property type
Description
Aggregated metrics for the solution, including total cost, total distance, total duration, and vehicle usage counts.
string
The label copied from the request's
label
field. Used to correlate the response with the original request.The list of routes calculated for each vehicle. Contains an entry for every vehicle, regardless of usage.
The list of shipments that were skipped (not serviced), along with the reasons they were skipped.
A list of validation errors found in the input model. This is populated if the
solvingMode
was set to VALIDATE_ONLY
, or if errors occurred during solving.Aggregated statistics across all routes, such as total travel distance, total duration, and wait times.
map (key: string, value: number)
A breakdown of costs by type (e.g., "model.vehicles.cost_per_kilometer", "model.shipments.penalty_cost").
number
The total cost of the solution, summing all route costs and skipped shipment penalties.
The total duration of breaks taken across all routes.
map (key: string, value: number)
A breakdown of costs by type (e.g., "model.vehicles.cost_per_kilometer", "model.shipments.penalty_cost").
The maximum load carried by any vehicle at any point in the solution, keyed by the load type.
number
The total cost of the solution, summing all route costs and skipped shipment penalties.
The total duration spent performing visits (loading/unloading) across all routes.
A list of breaks taken by the vehicle during the route.
boolean (
true
/ false
)Indicates if the route has any traffic-related infeasibilities.
Metrics specific to this route, such as the total distance and duration traveled.
map (key: string, value: number)
A breakdown of costs for this route. Keys are cost types (e.g., "cost_per_hour"), and values are the amounts.
The encoded polyline representing the full path of the route geographically.
An ordered list of transitions (travel legs) connecting the visits.
The ordered sequence of visits (pickups and deliveries) performed by the vehicle on this route.
The extra detour time incurred by this visit compared to the direct path between the previous and next visits.
The load demands satisfied by this visit (e.g. -1 for a delivery). This is a copy of the corresponding
VisitRequest
load demands.integer
The index of the
VisitRequest
in the shipment's pickup or delivery list that this visit corresponds to.The duration of breaks taken during this transition.
The duration of delay incurred during this transition (e.g., arriving early and waiting for a time window).
The encoded polyline representing the path of this specific transition.
string
An opaque token that can be passed to the Google Navigation SDK to reconstruct the route during navigation.
The total duration of the transition, including travel, wait, breaks, and delays.
boolean (
true
/ false
)If
true
, indicates that traffic data was not available for this transition.The load carried by the vehicle during this transition, keyed by the load type (e.g., "weight").
