Path Parameters
Response
OK
Response for zone.
The ID of the zone.
Example:
"zone_01234567890123456789"
The name of the zone.
Example:
"Zone 1"
The external ID of the zone.
Example:
"ext_01234567890123456789"
The portal URL of the zone.
Example:
"https://portal.usenash.com/settings/zones/zone_01234567890123456789"
The coverage area of the zone.
Example:
{
"cities": ["San Francisco"],
"cityZipcodes": [],
"countries": [],
"id": "coa_01234567890123456789",
"states": [],
"zipCodes": ["94114"]
}
The store locations of the zone.
Example:
[
{
"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": []
}
]
The store location associations of the zone.
Example:
[
{
"endDate": "2025-01-01",
"startDate": "2024-01-01",
"storeLocationId": "stl_01234567890123456789"
}
]
The zone restrictions of the zone.
Example:
[
{
"id": "res_01234567890123456789",
"name": "Zone Restriction 1"
}
]
The tags of the zone.
Example:
["service:rapid", "franchise_location"]
The metadata of the zone.
Example:
{ "key": "value" }
Whether the zone is deleted.
Example:
false