v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB

Store Locations

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

Find store locations whose delivery zones cover a given geographic point. Provide latitude/longitude, city_zipcode, or zipcode to find matching store locations.

get/v1/store_locations/coverage

Query parameters

latitudestring nullable

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

Example:0.00

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

longitudestring nullable

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

Example:0.00

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

cityZipcodestring nullable

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

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.

zipcodestring nullable

The zipcode to check coverage for.

Example:94114

The zipcode to check coverage for.

Response

externalIdstring nullable

Store location unique identifier from an external system.

operatingHoursobject nullable

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

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

blackoutDatesstring[] nullable

The blackout dates of the store location.

firstNamestring nullable

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

lastNamestring nullable

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

emailstring nullable

The email of the person at the store location.

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

idstring required

The ID of the store location.

namestring required

The name of the store location.

phoneNumberstring required

The phone number of the person at the store location.

zoneIdsstring[] nullable required

The zone ids of the store location.

zoneAssociationsobject[] nullable required

The zone associations of the store location.

tagsstring[] nullable required

The tags of the store location.

integrationMetadataobject nullable required

The integration metadata of the store location.

Example response

{
  "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"
        ]
      ]
    }
  },
  "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",
    "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"
  ],
  "zoneAssociations": [
    {
      "end_date": "2025-01-01",
      "start_date": "2024-01-01",
      "store_location_id": "stl_01234567890123456789",
      "zone_id": "zone_01234567890123456789"
    }
  ],
  "integrationMetadata": {
    "integration_name": "ABC"
  }
}