Get zones

GET

zones

curl --request GET \
  --url https://api.sandbox.usenash.com/v1/zones

{
  "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

size

integer

default:10

The size of the zones to return.

offset

integer

default:0

The offset of the zones to return.

Response

200

application/json

Response for list zones.

zones

object[]

required

Response for zone.

zones.id

string

required

The ID of the zone.

Example:

"zone_01234567890123456789"

zones.externalId

string | null

required

The external ID of the zone.

Example:

"ext_01234567890123456789"

zones.timezoneId

string | null

required

The timezone ID of the zone.

Example:

"America/New_York"

zones.name

string | null

required

The name of the zone.

Example:

"Zone 1"

zones.coverageAreaId

string | null

required

The ID of the coverage area.

Example:

"coa_01234567890123456789"

zones.storeLocationIds

string[] | null

required

The store location IDs of the zone.

Example:

[
  "stl_01234567890123456789",
  "stl_01234567890123456789"
]

zones.storeLocationAssociations

object[] | null

required

The store location associations of the zone.

Example:

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

zones.deliveryWindowIds

string[] | null

required

The delivery window IDs of the zone.

Example:

"['dw_01234567890123456789', 'dw_01234567890123456789']"

zones.tags

string[] | null

required

The tags of the zone.

Example:

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

zones.isDeleted

boolean | null

required

Whether the zone is deleted.

Example:

false

Get zone Get zone by external identifier

curl --request GET \
  --url https://api.sandbox.usenash.com/v1/zones

{
  "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
    }
  ]
}

API Documentation

Order

Dispatch Strategies

Notifications

Store Locations & Zones

Jobs

Batch Jobs

Providers

Miscellaneous

Query Parameters

Response