Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nash Route API is one of 30 APIs that Nash publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Route. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, an AsyncAPI specification, and rate-limit docs.

This API exposes 8 operations across 8 paths, and defines 23 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 4 base URLs: https://api.sandbox.usenash.com, https://api.sandbox.ap-southeast-2.usenash.com, https://api.usenash.com, https://api.ap-southeast-2.usenash.com.

8 operations 8 paths 23 schemas 1 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.usenash.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nash Route API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT, API Key) (Token).

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 1 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Route 8

Route

POST
/v1/activities/{id}/dispatch
Dispatch Optimized Orders
dispatch_optimized_orders_v1_activities__string_id__dispatch_post 1 param body → 422
POST
/v1/activities/{id}/save-routes
Save Optimization Routes
routes_v1_save_optimization_routes_activities__string_id__save_routes_post 1 param → 422
POST
/v1/routes
Create or Update Route
routes_v1_upsert_route_routes_post body → 200422
POST
/v1/routes/dispatch
Dispatch Routes
routes_v1_dispatch_routes_routes_dispatch_post body → 200422
POST
/v1/routes/external-identifier/{external_id}/assign
Assign or Reassign a Route by external id
routes_v1_assign_route_by_external_id_routes_external_identifier__external_id__assign_post 1 param body → 200422
GET
/v1/routes/{id}
Get Route
routes_v1_get_route_routes__string_id__get 1 param → 200422
POST
/v1/routes/{id}/assign
Assign or Reassign a Route
routes_v1_assign_route_routes__string_id__assign_post 1 param body → 200422
POST
/v1/routes/{id}/calculate-timing
Calculate Route Timing
routes_v1_calculate_route_timing_routes__string_id__calculate_timing_post 1 param → 200422

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are RouteSerializer (21 properties), RouteStopSerializer (16 properties), CourierPositionSerializer (12 properties), OrderItemSerializer (12 properties). Each schema is shown below with its type and property counts.

NashErrorDetails
object
3 properties 2 required
DriverGroupSerializer
object
Driver group details for a route.
2 properties
VehicleSerializer
object
Vehicle details for a route.
6 properties
UpsertRouteInputSerializer
object
Input for creating or updating a route.
8 properties
NashValidationError
object
3 properties 3 required
LatLngSerializer
object
Latitude/longitude coordinates.
2 properties 2 required
RouteStopSerializer
object
Represents a single stop within a planned route.
16 properties 3 required
DispatchOptimizationInputSerializer
object
Input for dispatching optimized orders.
2 properties
CourierSerializer
object
Courier details for a route.
4 properties
CalculateRouteTimingResponseSerializer
object
Response for route timing calculation.
2 properties 1 required
UpsertRouteResponseSerializer
object
Response for route upsert operation.
1 property 1 required
StopOrderSerializer
object
Order information associated with a route stop.
5 properties 1 required
ItemStatusHistoryEntrySerializer
object
A single status change entry in an item's status history.
2 properties 2 required
OrderItemSerializer
object
Item with status tracking for route stop webhook payloads. Combines item definition with lifecycle status from the route state machine.
12 properties
RouteStopInputSerializer
object
Input for a single route stop.
10 properties 2 required
DispatchRoutesOutputSerializer
object
Response payload for dispatching routes.
1 property 1 required
ItemStatusMetadataSerializer
object
Operational metadata tracked during item lifecycle in route delivery.
6 properties
RouteSerializer
object
Represents a planned sequence of stops for a delivery or batch.
21 properties 4 required
CourierPositionSerializer
object
Current GPS position of a courier.
12 properties 2 required
ProofOfDeliverySerializer
object
Delivery tracking details for an order at a route stop.
3 properties 1 required
AssignRouteInputSerializer
object
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 ma…
4 properties
DispatchRoutesInputSerializer
object
Input for dispatching routes to jobs.
2 properties 1 required
DispatchedJobSerializer
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nash-route-api-openapi.yml Raw ↑

Other APIs Nash publishes across the network.

Nash AI Functions API
Nash Annotate API
Nash Batch Job API
Nash Contracts API
Nash Couriers API
Nash Delivery Windows API
Nash Dispatch Strategies API
Nash Feedback API
Nash Fleet API
Nash Job API
Nash Messaging API
Nash Miscellaneous API