Skip to main content
POST
Remove an Order from a Route
Use this endpoint to take a single order off a route before the route is dispatched. The request has no body.
  • The order’s stop is dropped from the route and the order is detached from it.
  • The order is not cancelled. It stays available to plan onto another route.
  • Arrival and departure times of the stops after the removed one are recalculated. Nothing else on the route changes.
The updated route is returned, in the same shape as Get Route. If the timing recalculation fails, the order is still removed and the route is returned with its travel metrics marked stale; call Calculate Route Timing to refresh them.

Errors

When a request fails, nothing is changed. The response body has the shape { "error": { "code", "message" }, "response_status", "RequestID" }.
To take an order off a route that has already been dispatched, use Undispatch an order by id.

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

order_id
string
required

Order 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: