Skip to main content
GET
/
api
/
v1
/
customer
/
routing
/
preview
Preview Routing
curl --request GET \
  --url https://api.example.com/api/v1/customer/routing/preview
{
  "vehicleType": "VAN",
  "status": "PARTIAL",
  "distanceMeters": 12500,
  "durationSeconds": 1800,
  "segments": [
    {
      "type": "ROUTED",
      "fromIndex": 0,
      "toIndex": 2,
      "pointIds": [
        "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
        "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b"
      ],
      "polyline": "a~l~Fjk~uOwHJy@P",
      "distanceMeters": 12500,
      "durationSeconds": 1800
    }
  ],
  "points": [
    {
      "pointId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "name": "São Paulo",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "description": "Terminal Rodoviário Tietê",
      "lat": -23.5155,
      "lng": -46.6254
    }
  ],
  "polyline": "a~l~Fjk~uOwHJy@P"
}

Query Parameters

​
pointIds
string
required

Comma-separated point UUIDs in order

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a,0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b"

​
vehicleType
enum<string>
required

Vehicle type

Available options:
VAN
Example:

"VAN"

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Route preview

​
vehicleType
enum<string>
required

Vehicle type

Available options:
VAN
Example:

"VAN"

​
status
enum<string>
required

Route preview status

Available options:
COMPLETE,
PARTIAL,
UNROUTABLE
Example:

"PARTIAL"

​
distanceMeters
integer
required

Distance in meters

Example:

12500

​
durationSeconds
integer
required

Duration in seconds

Example:

1800

​
segments
object[]
required

Route preview segments

Route preview segment

​
points
object[]
required

Hydrated points in input order

​
polyline
string | null

Encoded polyline

Example:

"a~l~Fjk~uOwHJy@P"