Get zones that cover specified location (latitude & longitude, city_zipcode)

curl --request GET \
  --url https://api.sandbox.usenash.com/v1/zones/coverage \
  --header 'Authorization: Bearer <token>'

{
  "zones": [
    {
      "id": "zone_01234567890123456789",
      "name": "Zone 1",
      "externalId": "ext_01234567890123456789",
      "portalUrl": "https://portal.usenash.com/settings/zones/zone_01234567890123456789",
      "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": "res_01234567890123456789",
          "name": "Zone Restriction 1"
        }
      ],
      "tags": [
        "service:rapid",
        "franchise_location"
      ],
      "zoneMetadata": {
        "key": "value"
      },
      "isDeleted": false
    }
  ]
}

GET

zones

coverage

Get zones that cover specified location (latitude & longitude, city_zipcode)

curl --request GET \
  --url https://api.sandbox.usenash.com/v1/zones/coverage \
  --header 'Authorization: Bearer <token>'

{
  "zones": [
    {
      "id": "zone_01234567890123456789",
      "name": "Zone 1",
      "externalId": "ext_01234567890123456789",
      "portalUrl": "https://portal.usenash.com/settings/zones/zone_01234567890123456789",
      "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": "res_01234567890123456789",
          "name": "Zone Restriction 1"
        }
      ],
      "tags": [
        "service:rapid",
        "franchise_location"
      ],
      "zoneMetadata": {
        "key": "value"
      },
      "isDeleted": false
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

Response for list zones.

zones

ZoneResponse · object[]

required

Show child attributes

zones.id

string

required

The ID of the zone.

Example:

"zone_01234567890123456789"

zones.name

string | null

required

The name of the zone.

Example:

"Zone 1"

zones.externalId

string | null

required

The external ID of the zone.

Example:

"ext_01234567890123456789"

zones.portalUrl

string | null

required

The portal URL of the zone.

Example:

"https://portal.usenash.com/settings/zones/zone_01234567890123456789"

zones.coverageArea

Coveragearea · object

required

The coverage area of the zone.

Example:

{
  "cities": ["San Francisco"],
  "cityZipcodes": [],
  "countries": [],
  "id": "coa_01234567890123456789",
  "states": [],
  "zipCodes": ["94114"]
}

zones.storeLocations

StoreLocationResponse · object[] | null

required

The store locations of the zone.

Show child attributes

zones.storeLocations.id

string

required

The ID of the store location.

Example:

"stl_01234567890123456789"

zones.storeLocations.name

string

required

The name of the store location.

Example:

"White House"

zones.storeLocations.phoneNumber

string

required

The phone number of the person at the store location.

Example:

"+1234567890"

zones.storeLocations.location

ParsedAddressInputSerializer · object

required

The location of the store location.

Show child attributes

zones.storeLocations.location.street

string

required

The street of the address. If your geocoding service does not split numbers from street names, you can pass the street name with the number in this field. Example: 1600 Pennsylvania Avenue NW.

Example:

"Pennsylvania Avenue NW"

zones.storeLocations.location.city

string

required

The city of the address.

Example:

"Washington"

zones.storeLocations.location.country

string

required

The country of the address.

Example:

"US"

zones.storeLocations.location.number

string | null

The number of the address.

Example:

"1600"

zones.storeLocations.location.secondaryNumber

string | null

The secondary number of the address.

Example:

null

zones.storeLocations.location.county

string | null

The county of the address.

Example:

"Washington"

zones.storeLocations.location.state

string | null

The state of the address.

Example:

"DC"

zones.storeLocations.location.postalCode

string | null

The postal code of the address.

Example:

"20500"

zones.storeLocations.location.latitude

number | null

The latitude of the address.

Example:

38.8948949

zones.storeLocations.location.longitude

number | null

The longitude of the address.

Example:

-77.0371581

zones.storeLocations.zoneIds

string[] | null

required

The zone ids of the store location.

Example:

[
  "zone_01234567890123456789",
  "zone_01234567890123456789"
]

zones.storeLocations.zoneAssociations

Zoneassociations · object[] | null

required

The zone associations of the store location.

Example:

[
  {
    "end_date": "2025-01-01",
    "start_date": "2024-01-01",
    "store_location_id": "stl_01234567890123456789",
    "zone_id": "zone_01234567890123456789"
  }
]

zones.storeLocations.tags

string[] | null

required

The tags of the store location.

Example:

"['service:rapid', 'franchise_location']"

zones.storeLocations.integrationMetadata

Integrationmetadata · object

required

The integration metadata of the store location.

Example:

{ "integration_name": "ABC" }

zones.storeLocations.externalId

string | null

Store location unique identifier from an external system.

Example:

"40123"

zones.storeLocations.operatingHours

Operatinghours · object

[Integration Specific]: An object with keys that correspond to days of week (monday, tuesday, etc) and their corresponding operating hours / delivery windows.

Example:

{
  "friday": {
    "active": true,
    "shifts": [["10:00", "19:00"]]
  },
  "monday": {
    "active": true,
    "shifts": [["10:00", "19:00"]]
  },
  "saturday": {
    "active": true,
    "shifts": [["10:00", "19:00"]]
  },
  "sunday": {
    "active": true,
    "shifts": [["11:00", "18:00"]]
  },
  "thursday": {
    "active": true,
    "shifts": [["10:00", "19:00"]]
  },
  "tuesday": {
    "active": true,
    "shifts": [["10:00", "19:00"]]
  },
  "wednesday": {
    "active": true,
    "shifts": [["10:00", "19:00"]]
  }
}

zones.storeLocations.prepTimeMinutes

integer | null

[Integration Specific]: the preparation time to apply for orders, if relying on Nash to compute the delivery windows. This only applies to specific integrations.

zones.storeLocations.blackoutDates

string[] | null

The blackout dates of the store location.

Example:

["2024-01-01", "2024-01-02"]

zones.storeLocations.firstName

string | null

First name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.

Example:

"Taylor"

zones.storeLocations.lastName

string | null

Last name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.

Example:

"Swift"

zones.storeLocations.email

string | null

The email of the person at the store location.

Example:

"[email protected]"

zones.storeLocations.pickupInstructions

string | null

The pickup instructions of the store location. Limited to 280 characters. Nash Recommended Input: Order [insert order number] for [insert customer name] from [business name]

Example:

"Once you arrive at the store, please click above to let us know you are here. Then, go ahead and find a sales associate inside - they'll be happy to help you!"

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": []
  }
]

zones.storeLocationAssociations

Storelocationassociations · object[] | null

required

The store location associations of the zone.

Example:

[
  {
    "endDate": "2025-01-01",
    "startDate": "2024-01-01",
    "storeLocationId": "stl_01234567890123456789"
  }
]

zones.zoneRestrictions

ZoneRestrictionResponse · object[] | null

required

The zone restrictions of the zone.

Show child attributes

zones.zoneRestrictions.id

string

required

The ID of the zone restriction.

Example:

"res_01234567890123456789"

zones.zoneRestrictions.externalId

string

required

The external ID of the zone restriction.

Example:

"ext_01234567890123456789"

zones.zoneRestrictions.name

string

required

The name of the zone restriction.

Example:

"Zone Restriction 1"

zones.zoneRestrictions.isActive

boolean

required

Whether the zone restriction is active.

Example:

true

zones.zoneRestrictions.restrictionMetadata

Restrictionmetadata · object

required

The metadata of the zone restriction.

Example:

{
  "restriction_metadata": { "key": "value" }
}

Example:

[
  {
    "id": "res_01234567890123456789",
    "name": "Zone Restriction 1"
  }
]

zones.tags

string[] | null

required

The tags of the zone.

Example:

["service:rapid", "franchise_location"]

zones.zoneMetadata

Zonemetadata · object

required

The metadata of the zone.

Example:

{ "key": "value" }

zones.isDeleted

boolean | null

required

Whether the zone is deleted.

Example:

false

Get zone by external identifier Background

⌘I

API Documentation

Order

Dispatch Strategies

Notifications

Store Locations & Zones

Jobs

Batch Jobs

Providers

Routes

Shifts

Templates

Store Catalog

Miscellaneous

Get zones that cover specified location (latitude & longitude, city_zipcode)

Authorizations

Query Parameters

Response