curl --request GET \
--url https://api.sandbox.usenash.com/v1/routes/{id}
{
"id": "rte_JphRWDiEosGpXuxwgaYfY3",
"type": "SINGLE_PICKUP_MULTIPLE_DROPOFFS",
"stops": [
{
"stopType": "PICKUP",
"objectIds": [
"ord_Qr5bVt8WiByGh66z2g7xEu",
"ord_WJFuooSiRvFCaceGZjpbqs"
],
"arrivalTime": "2025-04-25T03:27:00",
"departTime": "2025-04-25T03:30:00",
"serviceTime": 360,
"distanceFromPrevious": 3376,
"durationFromPrevious": 420,
"location": {
"lat": 45.558214,
"lng": -122.587074
}
}
]
}
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).
Represents a planned sequence of stops for a delivery or batch.
Unique identifier for the route.
Example:"rte_JphRWDiEosGpXuxwgaYfY3"
Type of the route, indicating the pickup/dropoff structure.
Example:"SINGLE_PICKUP_MULTIPLE_DROPOFFS"
Ordered list of stops included in the route.
Represents a single stop within a planned route.
List of object IDs (e.g., order IDs, store location IDs) associated with this stop.
Example:[
"ord_Qr5bVt8WiByGh66z2g7xEu",
"ord_WJFuooSiRvFCaceGZjpbqs"
]
Geographic location of the stop. Can be null for non-location based stops like breaks.
Estimated arrival time at the stop (UTC).
Estimated departure time from the stop (UTC).
Estimated service time spent at the stop (in seconds).
stops.distanceFromPrevious
Distance traveled from the previous stop (in meters).
stops.durationFromPrevious
Travel duration from the previous stop (in seconds).
