Store Locations & Zones
Update a zone
API Documentation
Order
- Background
- Order Address Validation (Geocoding)
- Order Requirements
- 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
- PATCHUnarchive 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
- DELDelete a zone
- GETGet zone
- GETGet zones
- GETGet zone by external identifier
- GETGet zones that cover specified location (latitude & longitude, city_zipcode)
Jobs
- Background
- POSTCreate Job
- POSTCreate or Update Job by External Identifier
- PATCHUpdate Job
- GETGet Job
- GETGet Job by External Identifier
- POSTSelect Quote
- POSTReassign a Task
- 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
Routes
Templates
Miscellaneous
Store Locations & Zones
Update a zone
PATCH
/
v1
/
zones
/
{id}
curl --request PATCH \
--url https://api.sandbox.usenash.com/v1/zones/{id} \
--header 'Content-Type: application/json' \
--data '{
"timezoneId": "America/New_York",
"name": "Zone 1",
"coverageAreaId": "<string>",
"storeLocationIds": [
"<string>"
],
"storeLocationAssociations": [
{
"end_date": "2025-01-01",
"start_date": "2024-01-01",
"store_location_id": "stl_01234567890123456789"
}
],
"tags": "['\''service:rapid'\'', '\''service:express'\'', '\''franchise_location'\'']"
}'
{
"id": "zone_01234567890123456789",
"name": "Zone 1",
"externalId": "ext_01234567890123456789",
"portalUrl": "https://portal.usenash.com/settings/zones/zone_01234567890123456789",
"timezoneId": "America/New_York",
"coverageArea": {
"cities": [
"San Francisco"
],
"cityZipcodes": [],
"countries": [],
"id": "coa_01234567890123456789",
"states": [],
"zipCodes": [
"94114"
]
},
"storeLocations": [
{
"blackoutDates": [],
"email": "",
"externalId": "ext_01234567890123456789",
"firstName": "Steve",
"id": "stl_01234567890123456789",
"lastName": "Kerr",
"location": {
"address": "120 E 34th St, New York, NY 10016, USA",
"addressCity": "New York",
"addressCountry": "US",
"addressFirstLine": "120 E 34th St",
"addressSecondarynumber": null,
"addressState": "NY",
"addressZip": "10016",
"lat": 40.7463656,
"lng": -73.9803215
},
"name": "10392",
"operatingHours": {
"friday": {
"active": true,
"shifts": []
},
"monday": {
"active": true,
"shifts": []
},
"saturday": {
"active": true,
"shifts": []
},
"sunday": {
"active": true,
"shifts": []
},
"thursday": {
"active": true,
"shifts": []
},
"tuesday": {
"active": true,
"shifts": []
},
"wednesday": {
"active": true,
"shifts": []
}
},
"phoneNumber": "+16132525710",
"pickupInstructions": "",
"prepTimeMinutes": null,
"tags": []
}
],
"storeLocationAssociations": [
{
"endDate": "2025-01-01",
"startDate": "2024-01-01",
"storeLocationId": "stl_01234567890123456789"
}
],
"zoneRestrictions": [
{
"id": "zone_res_01234567890123456789",
"name": "Zone Restriction 1"
}
],
"tags": [
"service:rapid",
"franchise_location"
],
"zoneMetadata": {
"zone_metadata": {
"key": "value"
}
},
"isDeleted": false
}
Path Parameters
Body
application/json
Expected input payload for updating a zone.
Response
200
application/json
OK
Response for zone.
curl --request PATCH \
--url https://api.sandbox.usenash.com/v1/zones/{id} \
--header 'Content-Type: application/json' \
--data '{
"timezoneId": "America/New_York",
"name": "Zone 1",
"coverageAreaId": "<string>",
"storeLocationIds": [
"<string>"
],
"storeLocationAssociations": [
{
"end_date": "2025-01-01",
"start_date": "2024-01-01",
"store_location_id": "stl_01234567890123456789"
}
],
"tags": "['\''service:rapid'\'', '\''service:express'\'', '\''franchise_location'\'']"
}'
{
"id": "zone_01234567890123456789",
"name": "Zone 1",
"externalId": "ext_01234567890123456789",
"portalUrl": "https://portal.usenash.com/settings/zones/zone_01234567890123456789",
"timezoneId": "America/New_York",
"coverageArea": {
"cities": [
"San Francisco"
],
"cityZipcodes": [],
"countries": [],
"id": "coa_01234567890123456789",
"states": [],
"zipCodes": [
"94114"
]
},
"storeLocations": [
{
"blackoutDates": [],
"email": "",
"externalId": "ext_01234567890123456789",
"firstName": "Steve",
"id": "stl_01234567890123456789",
"lastName": "Kerr",
"location": {
"address": "120 E 34th St, New York, NY 10016, USA",
"addressCity": "New York",
"addressCountry": "US",
"addressFirstLine": "120 E 34th St",
"addressSecondarynumber": null,
"addressState": "NY",
"addressZip": "10016",
"lat": 40.7463656,
"lng": -73.9803215
},
"name": "10392",
"operatingHours": {
"friday": {
"active": true,
"shifts": []
},
"monday": {
"active": true,
"shifts": []
},
"saturday": {
"active": true,
"shifts": []
},
"sunday": {
"active": true,
"shifts": []
},
"thursday": {
"active": true,
"shifts": []
},
"tuesday": {
"active": true,
"shifts": []
},
"wednesday": {
"active": true,
"shifts": []
}
},
"phoneNumber": "+16132525710",
"pickupInstructions": "",
"prepTimeMinutes": null,
"tags": []
}
],
"storeLocationAssociations": [
{
"endDate": "2025-01-01",
"startDate": "2024-01-01",
"storeLocationId": "stl_01234567890123456789"
}
],
"zoneRestrictions": [
{
"id": "zone_res_01234567890123456789",
"name": "Zone Restriction 1"
}
],
"tags": [
"service:rapid",
"franchise_location"
],
"zoneMetadata": {
"zone_metadata": {
"key": "value"
}
},
"isDeleted": false
}