Get Route Result

GET/routing/result/{productionId}

Retrieve the results from a routing request. Poll this endpoint after calling Create Routes until the status is completed or failed.

Path Parameters

Parameter	Type	Required	Description
`productionId`	string	Yes	The production ID returned from Create Routes

Response Status Values

Status	Description
`processing`	Routing is in progress
`completed`	Routing finished successfully
`failed`	Routing encountered an error
`cancelled`	Routing was cancelled

Example Response (Completed)

{
  "status": "completed",
  "trips": [
    {
      "id": "trip_abc123",
      "jobIds": ["job_1", "job_2"],
      "stops": [
        {
          "loc": { "lat": 40.7128, "lng": -74.0060 },
          "pickIds": ["job_1"],
          "dropIds": [],
          "date": "2024-01-15T09:00:00Z",
          "name": "123 Main St",
          "wait": 0,
          "dur": 0,
          "dis": 0
        },
        {
          "loc": { "lat": 40.7200, "lng": -74.0100 },
          "pickIds": ["job_2"],
          "dropIds": [],
          "date": "2024-01-15T09:08:00Z",
          "name": "456 Oak Ave",
          "wait": 0,
          "dur": 480,
          "dis": 1200
        },
        {
          "loc": { "lat": 40.7580, "lng": -73.9855 },
          "pickIds": [],
          "dropIds": ["job_1", "job_2"],
          "date": "2024-01-15T09:25:00Z",
          "name": "Times Square",
          "wait": 0,
          "dur": 1020,
          "dis": 4500
        }
      ],
      "duration": 1500,
      "distance": 5700,
      "seats": 3,
      "attr": ["wheelchair"],
      "areas": ["manhattan"],
      "routeTrajectory": {
        "geometry": "encoded_polyline_string",
        "distance": 5700,
        "duration": 1500,
        "legs": [
          { "distance": 1200, "duration": 480 },
          { "distance": 4500, "duration": 1020 }
        ]
      }
    }
  ],
  "unrouted": []
}

Trip

Field	Type	Description
`id`	string	Trip identifier
`jobIds`	string[]	Jobs included in this trip
`stops`	Stop[]	Ordered sequence of stops
`duration`	number	Total trip duration (seconds)
`distance`	number	Total trip distance (meters)
`seats`	number	Total seats needed
`attr`	string[]	Combined attributes from all jobs
`areas`	string[]	Areas the trip passes through
`profileName`	string[]	Service profiles
`routeTrajectory`	RouteTrajectory	Route geometry and leg details

Stop

Field	Type	Description
`loc`	Coordinates	Stop location
`pickIds`	string[]	Job IDs picking up at this stop
`dropIds`	string[]	Job IDs dropping off at this stop
`date`	ISO8601	Scheduled arrival time
`name`	string	Stop name/address
`wait`	number	Wait time at stop (seconds)
`dur`	number	Duration from previous stop (seconds)
`dis`	number	Distance from previous stop (meters)

Coordinates

Field	Type	Description
`lat`	number	Latitude
`lng`	number	Longitude

RouteTrajectory

Field	Type	Description
`geometry`	string	Encoded polyline of the route
`distance`	number	Total distance (meters)
`duration`	number	Total duration (seconds)
`legs`	RouteLeg[]	Per-segment details

RouteLeg

Field	Type	Description
`distance`	number	Segment distance (meters)
`duration`	number	Segment duration (seconds)

Unrouted Jobs

If jobs cannot be routed (conflicting constraints, unreachable locations), they appear in the unrouted array:

{
  "status": "completed",
  "trips": [...],
  "unrouted": ["job_5", "job_8"]
}

On this page