POST
/
v1
/
zones
curl --request POST \
  --url https://api.sandbox.usenash.com/v1/zones \
  --header 'Content-Type: application/json' \
  --data '{
  "externalId": "<string>",
  "timezoneId": "America/New_York",
  "name": "Zone 1",
  "coverageAreaId": "<string>",
  "storeLocationIds": [
    "stl_01234567890123456789",
    "stl_01234567890123456789"
  ],
  "storeLocationAssociations": [
    {
      "end_date": "2025-01-01",
      "start_date": "2024-01-01",
      "store_location_id": "stl_01234567890123456789"
    }
  ],
  "tags": "['\''service:rapid'\'', '\''service:express'\'', '\''franchise_location'\'']"
}'
{
  "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
}

Body

application/json

Expected payload for creating a zone.

​
externalId
string | null

Zone unique identifier from an external system.

​
timezoneId
string | null

The timezone ID of the zone.

Example:

"America/New_York"

​
name
string | null

The name of the zone.

Example:

"Zone 1"

​
coverageAreaId
string | null

The coverage area id to associate with the zone.

​
storeLocationIds
string[] | null

The store location ids to associate with the zone.

Example:
[
  "stl_01234567890123456789",
  "stl_01234567890123456789"
]
​
storeLocationAssociations
object[] | null

The store location associations to associate with the zone.

Example:
[
  {
    "end_date": "2025-01-01",
    "start_date": "2024-01-01",
    "store_location_id": "stl_01234567890123456789"
  }
]
​
tags
string[] | null

Free form tags specific to the location.

Example:

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

Response

200
application/json
OK

Response for zone.

​
id
string
required

The ID of the zone.

Example:

"zone_01234567890123456789"

​
externalId
string | null
required

The external ID of the zone.

Example:

"ext_01234567890123456789"

​
timezoneId
string | null
required

The timezone ID of the zone.

Example:

"America/New_York"

​
name
string | null
required

The name of the zone.

Example:

"Zone 1"

​
coverageAreaId
string | null
required

The ID of the coverage area.

Example:

"coa_01234567890123456789"

​
storeLocationIds
string[] | null
required

The store location IDs of the zone.

Example:
[
  "stl_01234567890123456789",
  "stl_01234567890123456789"
]
​
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"
  }
]
​
deliveryWindowIds
string[] | null
required

The delivery window IDs of the zone.

Example:

"['dw_01234567890123456789', 'dw_01234567890123456789']"

​
tags
string[] | null
required

The tags of the zone.

Example:

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

​
isDeleted
boolean | null
required

Whether the zone is deleted.

Example:

false