GET
/
v1
/
zones
/
coverage
curl --request GET \
  --url https://api.sandbox.usenash.com/v1/zones/coverage
{
  "zones": [
    {
      "id": "zone_01234567890123456789",
      "externalId": "ext_01234567890123456789",
      "timezoneId": "America/New_York",
      "name": "Zone 1",
      "coverageAreaId": "coa_01234567890123456789",
      "storeLocationIds": [
        "stl_01234567890123456789",
        "stl_01234567890123456789"
      ],
      "storeLocationAssociations": [
        {
          "end_date": "2025-01-01",
          "start_date": "2024-01-01",
          "store_location_id": "stl_01234567890123456789",
          "zone_id": "zone_01234567890123456789"
        }
      ],
      "deliveryWindowIds": "['dw_01234567890123456789', 'dw_01234567890123456789']",
      "tags": "['service:rapid', 'franchise_location']",
      "isDeleted": false
    }
  ]
}

Query Parameters

​
latitude
string | null

The latitude of the location to check coverage for. If used, must specify longitude

Example:

"0.00"

​
longitude
string | null

The longitude of the location to check coverage for. If used, must specify latitude

Example:

"0.00"

​
cityZipcode
string | null

The city_zipcode pair to check coverage for. The location must have coverage set up using the City & Zip Code unique field, not the separate City or Zip Code fields.

Example:

"sanfrancisco_94114"

​
zipcode
string | null

The zipcode to check coverage for.

Example:

"94114"

Response

200
application/json
OK

Response for list zones.

​
zones
object[]
required

Response for zone.