Skip to main content
O Routing calcula um preview de rota sobre uma sequência de Points: polyline, distância e duração. O resultado serve para visualizar o traçado e estimar distância/tempo antes de cadastrar rotas ou planejar paradas.
Routing não grava distanceKm/estimatedDuration em uma Route. Esses valores continuam sendo informados pela empresa no cadastro da rota; o preview é apenas uma ferramenta de apoio.

Entrada

CampoDescrição
pointIds2 a 25 Points, na ordem desejada
vehicleTypeTipo de veículo usado no preview

Validações

RegraErro
Menos de 2 waypointstoo_few_waypoints
Mais de 25 waypointstoo_many_waypoints
pointIds com duplicatasinvalid_point_ids
Algum pointId inexistentenot_found (Point)
Os Points são carregados e reordenados conforme a ordem de entrada.

Segmentos e status

O preview percorre pares consecutivos de Points e monta segmentos:
  • ROUTED — para um trecho contínuo de Points com coordenadas, devolve polyline, distanceMeters e durationSeconds.
  • GAP — quando um par consecutivo tem algum Point sem coordenadas, registra um buraco com missingPointIds e reason: MISSING_COORDINATES.
O status geral é derivado dos segmentos:
StatusCondição
COMPLETENenhum gap
PARTIALHá gaps e há pelo menos um trecho roteado
UNROUTABLEHá gaps e nenhum trecho roteado

Saída (RoutePreview)

CampoTipoDescrição
vehicleType'VAN'Tipo de veículo
statusRoutePreviewStatusCOMPLETE, PARTIAL ou UNROUTABLE
polylinestring?Polyline geral (apenas quando COMPLETE; senão null)
distanceMetersintegerSoma das distâncias dos trechos roteados
durationSecondsintegerSoma das durações dos trechos roteados
pointsPoint[]Points hidratados, na ordem de entrada
segmentsRoutePreviewSegment[]Segmentos ROUTED e GAP

Capacidades

SuperfícieAcesso
OPSread:route, escopado por organização
CustomerDisponível para preview público de rota
Ambas recebem pointIds e vehicleType.
O preview usa roteamento com tráfego e polyline codificada. O mesmo fluxo de mapas atende a busca de Places.