Skip to main content
GET
/
v1
/
routes
/
{id}
Get Route
curl --request GET \
  --url https://api.sandbox.usenash.com/v1/routes/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "rte_JphRWDiEosGpXuxwgaYfY3",
  "type": "SINGLE_PICKUP_MULTIPLE_DROPOFFS",
  "stops": [
    {
      "stopType": "PICKUP",
      "objectIds": [
        "ord_Qr5bVt8WiByGh66z2g7xEu",
        "ord_WJFuooSiRvFCaceGZjpbqs"
      ],
      "location": {
        "lat": 45.558214,
        "lng": -122.587074
      },
      "arrivalTime": "2025-04-25T03:27:00",
      "departTime": "2025-04-25T03:30:00",
      "serviceTime": 360,
      "distanceFromPrevious": 3376,
      "durationFromPrevious": 420
    }
  ],
  "jobId": "job_1234567890abcdef12345678",
  "externalId": "rte_JphRWDiEosGpXuxwgaYfY3",
  "routeMetadata": {
    "priority": "high",
    "source": "optimization_engine"
  }
}
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).

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"

​
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.

​
jobId
string | null
required

Dispatched Job ID of this route

Example:

"job_1234567890abcdef12345678"

​
externalId
string | null

External Route ID.

Example:

"rte_JphRWDiEosGpXuxwgaYfY3"

​
routeMetadata
Routemetadata · object

Additional metadata for the route.

Example:
{
  "priority": "high",
  "source": "optimization_engine"
}