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 Restrictions API

Org-scoped geographic areas the route optimizer must avoid traversing.

Nash Route Restrictions 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 Restrictions. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, an AsyncAPI specification, and rate-limit docs.

This API exposes 6 operations across 3 paths, and defines 9 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.

6 operations 3 paths 9 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

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 Restrictions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT, API Key) (Token).

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Route Restrictions 6

Org-scoped geographic areas the route optimizer must avoid traversing.

PUT
/v1/optimization-strategies/{id}/route-restrictions
Set Strategy Route Restrictions
route_restrictions_strategy_attach_v1_set_strategy_restrictions_route__id__route_restrictions_put 1 param body → 200422
GET
/v1/route-restrictions
List Route Restrictions
route_restrictions_v1_list_route_restrictions_route_get → 200422
POST
/v1/route-restrictions
Create Route Restriction
route_restrictions_v1_create_route_restriction_route_post body → 200422
GET
/v1/route-restrictions/{id}
Get Route Restriction
route_restrictions_v1_get_route_restriction_route__id__get 1 param → 200422
DELETE
/v1/route-restrictions/{id}
Delete Route Restriction
route_restrictions_v1_delete_route_restriction_route__id__delete 1 param → 200422
PATCH
/v1/route-restrictions/{id}
Update Route Restriction
route_restrictions_v1_update_route_restriction_route__id__patch 1 param body → 200422

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are RouteRestrictionRead (8 properties), RouteRestrictionUpdate (4 properties), RouteRestrictionCreate (4 properties), NashErrorDetails (3 properties). Each schema is shown below with its type and property counts.

DeleteRouteRestrictionResponse
object
1 property
NashErrorDetails
object
3 properties 2 required
SetStrategyRestrictionsRequest
object
1 property 1 required
RouteRestrictionUpdate
object
4 properties
SetStrategyRestrictionsResponse
object
1 property 1 required
NashValidationError
object
3 properties 3 required
RouteRestrictionCreate
object
4 properties 2 required
RouteRestrictionsListResponse
object
1 property 1 required
RouteRestrictionRead
object
8 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nash-route-restrictions-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