Assign or Reassign a Route
Assign a route to a provider, driver group, courier, or vehicle — before or after dispatch.
- Provider (
providerId) — an external delivery provider (e.g.uber). Selects the route’s successful quote for that provider. - Driver group (
driverGroupId) — a contract. Selects the route’s successful quote for that contract. - Courier (
courierId) — an individual driver. Must belong to the route’s driver group. - Vehicle (
vehicleId) — a vehicle. Must be assigned to the route’s driver group (contract).
driverGroupId, courierId, and vehicleId accept either an internal Nash id or your own external id. Provide at least one target; you may combine a courier and a vehicle.
Pre-dispatch vs. post-dispatch
The endpoint behaves differently depending on whether the route has already been dispatched:- Pre-dispatch — the route’s assignment is updated in place.
- Post-dispatch — the active assignment is cancelled, live deliveries are cancelled, tasks are recreated and re-quoted, a fresh route assignment is created, and the requested target is applied.
Requirements
- Provide at least one target (
providerId,driverGroupId,courierId, orvehicleId). - Assigning by provider or driver group selects that target’s successful quote on the route — a successful quote for it must already exist.
- A courier must belong to the route’s driver group.
- A vehicle must be assigned to the route’s driver group (contract).
Errors
Failed assignments return400 Bad Request with a body of shape { "error": { "code", "message", "details": { "reason" } }, "response_status", "RequestID" }. Common reasons:
422 Unprocessable Content.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Route ID
Body
Input for assigning or reassigning a route.
Provide a provider, a driver group (contract), a courier, and/or a vehicle; driver group / courier / vehicle ids may be internal or external. Pre-dispatch the assignment is updated in place; post-dispatch the route is reassigned (cancel live deliveries, recreate tasks, re-quote) and the new target applied.
Provider id to assign. Selects the route's successful quote for this provider.
"uber"
Driver group/Contract id (internal or external) to assign. Selects the route's successful quote for this contract.
"cntr_7mP3xVt9Nk8sRfWzY2hLbQ"
Courier/Driver id (internal or external) to assign to the route. The courier must belong to the route's driver group.
"cor_9dK2mNp7xVt3RfWzY8sLbQ"
Vehicle id (internal or external) to assign to the route. The vehicle must be assigned to the route's driver group (contract).
"veh_4hL8pXq2sVn6RtY3wCbD9M"
Response
OK
Represents a planned sequence of stops for a delivery or batch.
Unique identifier for the route.
"rte_JphRWDiEosGpXuxwgaYfY3"
Portal URL of the route.
"https://portal.usenash.com/routes/rte_JphRWDiEosGpXuxwgaYfY3"
Type of the route, indicating the pickup/dropoff structure.
"SINGLE_PICKUP_MULTIPLE_DROPOFFS"
Ordered list of stops included in the route.
External Route ID.
"rte_JphRWDiEosGpXuxwgaYfY3"
Name of the route.
"Route 1"
Courier ID of the driver assigned to the route.
"cor_9dK2mNp7xVt3RfWzY8sLbQ"
Vehicle ID of the vehicle assigned to the route.
"veh_4hL8pXq2sVn6RtY3wCbD9M"
Courier/driver details for the route.
Driver group assigned to the route.
Current GPS position of the assigned courier.
Vehicle details for the route.
Name of the delivery provider assigned to this route.
Shift ID of the shift assigned to the route.
"shf_1234567890abcdef12345678"
Whether the route is dispatched.
Dispatched Job ID of this route
"job_1234567890abcdef12345678"
Additional metadata for the route.
Validation errors for the route.
Encoded polyline representing the route geometry.
Current status of the route.
"CREATED"
History of status changes for the route.