Skip to main content
GET
Get Route
A Route object represents a planned sequence of stops for a vehicle or delivery agent. The core of the Route is the stops array, which lists the specific locations to visit in order. Each stop within this array details:
  • The actions to be performed (like stopType).
  • Associated items (objectIds).
  • Timing estimates (arrivalTime, departTime, serviceTime).
  • Travel details from the prior stop (distanceFromPrevious, durationFromPrevious).
  • The physical coordinates (location).
Planned times, not live telemetry. arrivalTime, departTime, serviceTime, distanceFromPrevious, and durationFromPrevious are the values stored with the route. Nash fills them in when it plans the route for you or when you call Calculate Route Timing; a route you build by hand carries whatever you supplied at creation. This endpoint reads them back and doesn’t recompute them. To follow what the driver actually did, read each stop’s status and statusHistory, which record every transition (ENROUTE, ARRIVED, IN_PROGRESS, COMPLETED, and the failure states) with a timestamp.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Route ID

Response

OK

Represents a planned sequence of stops for a delivery or batch.

id
string
required

Unique identifier for the route.

Example:

"rte_JphRWDiEosGpXuxwgaYfY3"

portalUrl
string
required

Portal URL of the route.

Example:

"https://portal.usenash.com/routes/rte_JphRWDiEosGpXuxwgaYfY3"

type
string
required

Type of the route, indicating the pickup/dropoff structure.

Example:

"SINGLE_PICKUP_MULTIPLE_DROPOFFS"

stops
RouteStopSerializer · object[]
required

Ordered list of stops included in the route.

externalId
string | null

External Route ID.

Example:

"rte_JphRWDiEosGpXuxwgaYfY3"

name
string | null

Name of the route.

Example:

"Route 1"

courierId
string | null

Courier ID of the driver assigned to the route.

Example:

"cor_9dK2mNp7xVt3RfWzY8sLbQ"

vehicleId
string | null

Vehicle ID of the vehicle assigned to the route.

Example:

"veh_4hL8pXq2sVn6RtY3wCbD9M"

courier
CourierSerializer · object | null

Courier/driver details for the route.

driverGroup
DriverGroupSerializer · object | null

Driver group assigned to the route.

courierPosition
CourierPositionSerializer · object | null

Current GPS position of the assigned courier.

vehicle
VehicleSerializer · object | null

Vehicle details for the route.

providerName
string | null

Name of the delivery provider assigned to this route.

shiftId
string | null

Shift ID of the shift assigned to the route.

Example:

"shf_1234567890abcdef12345678"

isDispatched
boolean
default:false

Whether the route is dispatched.

jobId
string | null

Dispatched Job ID of this route

Example:

"job_1234567890abcdef12345678"

routeMetadata
Routemetadata · object | null

Additional metadata for the route.

Example:
validationErrors
Validationerrors · object | null

Validation errors for the route.

Example:
encodedPolyline
string | null

Encoded polyline representing the route geometry.

status
string | null

Current status of the route.

Example:

"CREATED"

statusHistory
Statushistory · object[] | null

History of status changes for the route.

Example: