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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Nash

Nash Zones API

Zones

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

13 operations 9 paths 24 schemas 1 DELETE5 GET2 PATCH5 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 Zones API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT, API Key) (Token).

Paths & Operations 13

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

Zones 13

Zones

GET
/v1/zone-restrictions
Get zone restrictions
get_zone_restrictions_v1_zone_restrictions_get → 200422
POST
/v1/zone-restrictions
Create zone restriction
create_zone_restriction_v1_zone_restrictions_post body → 200422
POST
/v1/zone-restrictions/upsert
Upsert multiple zone restrictions
upsert_zone_restrictions_v1_zone_restrictions_upsert_post body → 200422
PATCH
/v1/zone-restrictions/{id}
Update zone restriction
update_zone_restriction_v1_zone_restrictions__string_id__patch 1 param body → 200422
GET
/v1/zones
Get zones
get_zones_list_v1_zones_get 3 params → 200422
POST
/v1/zones
Create a zone
create_zone_v1_zones_post body → 200422
GET
/v1/zones/coverage
Get zones that cover specified location (latitude & longitude, cityzipcode)
get_zones_coverage_v1_zones_coverage_get 4 params → 200422
GET
/v1/zones/external_identifier/{externalIdentifier}
Get zone by external identifier
get_zone_by_external_id_v1_zones_external_identifier__string_externalIdentifier__get 1 param → 200422
POST
/v1/zones/query
Query zones
zones_v1_query_zones_route_query_post body → 200422
POST
/v1/zones/upsert
Upsert multiple zones
upsert_zones_v1_zones_upsert_post body → 200422
GET
/v1/zones/{id}
Get zone
get_zone_v1_zones__string_id__get 1 param → 200422
DELETE
/v1/zones/{id}
Delete a zone
delete_zone_v1_zones__string_id__delete 1 param → 200422
PATCH
/v1/zones/{id}
Update a zone
update_zone_v1_zones__string_id__patch 1 param body → 200422

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are StoreLocationResponse (16 properties), ZoneStoreLocationRead (13 properties), ZoneResponse (11 properties), ParsedAddressInputSerializer (10 properties). Each schema is shown below with its type and property counts.

CreateZoneRestrictionInputSerializer
object
Expected payload for the create zone restriction endpoint.
4 properties 1 required
NashErrorDetails
object
3 properties 2 required
ListZoneRestrictionsResponse
object
Response for list zone restrictions.
1 property 1 required
ListZonesResponse
object
Response for list zones.
1 property 1 required
ParsedAddressInputSerializer
object
Parsed address input serializer for creating a job.
10 properties 3 required
StoreLocationResponse
object
Response for store location.
16 properties 8 required
ZoneCoverageAreaRead
object
7 properties 1 required
UpsertZoneInputSerializer
object
Expected input payload for upserting a zone by external id.
9 properties
UpdateZoneInputSerializer
object
Expected input payload for updating a zone.
7 properties
ZoneLocationRead
object
9 properties
NashValidationError
object
3 properties 3 required
ZoneStoreLocationRead
object
13 properties 1 required
UpsertZonesInputSerializer
object
Expected input payload for upserting multiple zones.
1 property 1 required
ZonesQueryRequest
object
Body for POST /v1/zones/query. ids and externalIds are optional and combined with OR. Omit both to page through every zone in the organization; a provided but…
5 properties
ZoneRestrictionResponse
object
Response for zone restriction.
5 properties 5 required
CreateZoneInputSerializer
object
Expected payload for creating a zone.
8 properties
ZonesQueryResponse
object
Paginated zones, in created-at order. data items match GET /v1/zones/ .
2 properties 2 required
PageMeta
object
Offset-pagination metadata for a single page of a query response.
3 properties 3 required
ZoneDetailRead
object
Full detail for a single zone. Same shape as GET /v1/zones/ .
10 properties 1 required
UpsertZoneRestrictionsInputSerializer
object
Expected input payload for upserting multiple zone restrictions.
1 property 1 required
ZoneStoreLocationAssociationRead
object
3 properties 1 required
ZonePolygonRead
object
2 properties 1 required
ZoneResponse
object
Response for zone.
11 properties 11 required
UpsertZoneRestrictionInputSerializer
object
Expected input payload for upserting a zone restriction by external id.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nash-zones-api-openapi.yml Raw ↑

Other APIs Nash publishes across the network.

Nash AI Functions API
AE Profile APIs.io
Nash Annotate API
AE Profile APIs.io
Nash Batch Job API
AE Profile APIs.io
Nash Contracts API
AE Profile APIs.io
Nash Couriers API
AE Profile APIs.io
Nash Delivery Windows API
AE Profile APIs.io
Nash Dispatch Strategies API
AE Profile APIs.io
Nash Feedback API
AE Profile APIs.io
Nash Fleet API
AE Profile APIs.io
Nash Job API
AE Profile APIs.io
Nash Messaging API
AE Profile APIs.io
Nash Miscellaneous API
AE Profile APIs.io
#Zones
← Back to N APIs
API Details
ID
nash:nash-zones-api
Base URL
https://api.usenash.com/v1
Docs
https://docs.usenash.com/api-reference/api-overview
Provider
Nash
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network