Store Locations & Zones
Get zones
API Documentation
Order
- Background
- Order Address Validation (Geocoding)
- POSTCreate Order
- POSTCreate Orders
- POSTCreate or update order by external identifier
- PATCHUpdate order
- GETGet order
- POSTCreate Quote
- GETGet Order Documents
- POSTSelect Quote
- POSTRefresh order quotes
- POSTAutodispatch Order
- POSTAdd Custom Event to Order
- DELArchive order
- Bulk Order Actions
- Delivery Windows & Capacity
Dispatch Strategies
Notifications
Store Locations & Zones
- POSTCreate store location
- PATCHUpdate Store Location
- GETGet Store Location
- GETGet Store Locations
- GETGet store location by external identifier
- DELDelete store location
- GETGet store locations that cover specified location (latitude & longitude, city_zipcode)
- POSTCreate a zone
- PATCHUpdate a zone
- GETGet zone
- GETGet zones
- GETGet zone by external identifier
- GETGet zones that cover specified location (latitude & longitude, city_zipcode)
Jobs
- Background
- Package Requirements
- POSTCreate Job
- POSTCreate or Update Job by External Identifier
- PATCHUpdate Job
- GETGet Job
- GETGet Job by External Identifier
- POSTSelect Quote
- POSTReassign a Task in a Job
- POSTRefresh Quotes
- POSTAutodispatch Job
- POSTAutodispatch Job by External Identifier
- POSTCancel Job
- POSTCancel Job by External Identifier
- POSTCreate Delivery Incident
- GETGet Refund Requests
- GETGet Refund Request
Batch Jobs
Providers
Miscellaneous
Store Locations & Zones
Get zones
GET
/
v1
/
zones
curl --request GET \
--url https://api.sandbox.usenash.com/v1/zones
{
"zones": [
{
"id": "zone_01234567890123456789",
"externalId": "ext_01234567890123456789",
"name": "Zone 1",
"coverageAreaId": "coa_01234567890123456789",
"storeLocationIds": "['stl_01234567890123456789', 'stl_01234567890123456789']",
"deliveryWindowIds": "['dw_01234567890123456789', 'dw_01234567890123456789']",
"tags": "['service:rapid', 'franchise_location']",
"isDeleted": false
}
]
}
Query Parameters
The size of the zones to return.
The offset of the zones to return.
Response
200
application/json
OK
Response for list zones.
Response for zone.
The ID of the zone.
The external ID of the zone.
The name of the zone.
The ID of the coverage area.
The store location IDs of the zone.
The delivery window IDs of the zone.
The tags of the zone.
Whether the zone is deleted.
curl --request GET \
--url https://api.sandbox.usenash.com/v1/zones
{
"zones": [
{
"id": "zone_01234567890123456789",
"externalId": "ext_01234567890123456789",
"name": "Zone 1",
"coverageAreaId": "coa_01234567890123456789",
"storeLocationIds": "['stl_01234567890123456789', 'stl_01234567890123456789']",
"deliveryWindowIds": "['dw_01234567890123456789', 'dw_01234567890123456789']",
"tags": "['service:rapid', 'franchise_location']",
"isDeleted": false
}
]
}