---
title: "Get zone by external identifier"
method: GET
path: "/v1/zones/external_identifier/{externalIdentifier}"
tags: ["Zones"]
---

# Get zone by external identifier

`GET /v1/zones/external_identifier/{externalIdentifier}`

Retrieve a zone using your external identifier instead of the Nash zone ID.

## Path parameters

- `externalIdentifier` string, required

## Response `200`

OK

- ZoneResponse — Response for zone.
  - `id` string, required — The ID of the zone.
  - `name` string, nullable, required — The name of the zone.
  - `externalId` string, nullable, required — The external ID of the zone.
  - `portalUrl` string, nullable, required — The portal URL of the zone.
  - `coverageArea` object, nullable, required — The coverage area of the zone.
  - `storeLocations` StoreLocationResponse[], nullable, required — The store locations of the zone.
    - `externalId` string, nullable — Store location unique identifier from an external system.
    - `operatingHours` object, nullable — [Integration Specific]: An object with keys that correspond to days of week (monday, tuesday, etc) and their corresponding operating hours / delivery windows.
    - `prepTimeMinutes` integer, nullable — [Integration Specific]: the preparation time to apply for orders, if relying on Nash to compute the delivery windows. This only applies to specific integrations.
    - `blackoutDates` string[], nullable — The blackout dates of the store location.
    - `firstName` string, nullable — First name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.
    - `lastName` string, nullable — Last name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.
    - `email` string, nullable — The email of the person at the store location.
    - `pickupInstructions` string, nullable — 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]
    - `id` string, required — The ID of the store location.
    - `name` string, required — The name of the store location.
    - `phoneNumber` string, required — The phone number of the person at the store location.
    - `location` ParsedAddressInputSerializer, required — Parsed address input serializer for creating a job.
      - `number` string, nullable — The number of the address.
      - `secondaryNumber` string, nullable — The secondary number of the address.
      - `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.
      - `county` string, nullable — The county of the address.
      - `city` string, required — The city of the address.
      - `state` string, nullable — The state of the address.
      - `postalCode` string, nullable — The postal code of the address.
      - `country` string, required — The country of the address.
      - `latitude` number, nullable — The latitude of the address.
      - `longitude` number, nullable — The longitude of the address.
    - `zoneIds` string[], nullable, required — The zone ids of the store location.
    - `zoneAssociations` object[], nullable, required — The zone associations of the store location.
    - `tags` string[], nullable, required — The tags of the store location.
    - `integrationMetadata` object, nullable, required — The integration metadata of the store location.
  - `storeLocationAssociations` object[], nullable, required — The store location associations of the zone.
  - `zoneRestrictions` ZoneRestrictionResponse[], nullable, required — The zone restrictions of the zone.
    - `id` string, required — The ID of the zone restriction.
    - `externalId` string, required — The external ID of the zone restriction.
    - `name` string, required — The name of the zone restriction.
    - `isActive` boolean, required — Whether the zone restriction is active.
    - `restrictionMetadata` object, nullable, required — The metadata of the zone restriction.
  - `tags` string[], nullable, required — The tags of the zone.
  - `zoneMetadata` object, nullable, required — The metadata of the zone.
  - `isDeleted` boolean, nullable, required — Whether the zone is deleted.

## Other responses

- `422` — Unprocessable Content

---

[API](https://skmtc.net/usenash/apis/nash-api.md) · [All operations](https://skmtc.net/usenash/apis/nash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usenash/nash-api/revisions/09a23a95889b/schema)