GET
/
v1
/
store_locations
/
coverage
curl --request GET \
  --url https://api.sandbox.usenash.com/v1/store_locations/coverage
{
  "externalId": "40123",
  "operatingHours": {
    "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"
        ]
      ]
    }
  },
  "prepTimeMinutes": 123,
  "blackoutDates": [
    "2024-01-01",
    "2024-01-02"
  ],
  "firstName": "Taylor",
  "lastName": "Swift",
  "email": "taylor@swift.com",
  "pickupInstructions": "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!",
  "id": "stl_01234567890123456789",
  "name": "White House",
  "phoneNumber": "+1234567890",
  "location": {
    "number": "1600",
    "secondaryNumber": null,
    "street": "Pennsylvania Avenue NW",
    "county": "Washington",
    "city": "Washington",
    "state": "DC",
    "postalCode": "20500",
    "country": "US",
    "latitude": 38.8948949,
    "longitude": -77.0371581
  },
  "zoneIds": [
    "zone_01234567890123456789",
    "zone_01234567890123456789"
  ],
  "tags": "['service:rapid', 'franchise_location']"
}

Query Parameters

​
latitude
string | null

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

​
longitude
string | null

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

​
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.

Response

200
application/json
OK

Response for store location.

​
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
object
required

The location of the store location.

​
zoneIds
string[] | null
required

The zone ids of the store location.

​
tags
string[] | null
required

The tags of the store location.

​
externalId
string | null

Store location unique identifier from an external system.

​
operatingHours
object | null

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

​
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.

​
blackoutDates
string[] | null

The blackout dates of the store location.

​
firstName
string | null

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

​
lastName
string | null

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

​
email
string | null

The email of the person at the store location.

​
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]

Delete store locationCreate a zone