Get Store Locations

Get store locations

curl --request GET \
  --url https://api.sandbox.usenash.com/v1/store_locations \
  --header 'Authorization: Bearer <token>'

{
  "storeLocations": [
    {
      "id": "stl_01234567890123456789",
      "name": "White House",
      "phoneNumber": "+1234567890",
      "location": {
        "street": "Pennsylvania Avenue NW",
        "city": "Washington",
        "country": "US",
        "number": "1600",
        "secondaryNumber": null,
        "county": "Washington",
        "state": "DC",
        "postalCode": "20500",
        "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"
        }
      ],
      "tags": "['service:rapid', 'franchise_location']",
      "integrationMetadata": {
        "integration_name": "ABC"
      },
      "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": "[email protected]",
      "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!"
    }
  ]
}

GET

store_locations

Get store locations

curl --request GET \
  --url https://api.sandbox.usenash.com/v1/store_locations \
  --header 'Authorization: Bearer <token>'

{
  "storeLocations": [
    {
      "id": "stl_01234567890123456789",
      "name": "White House",
      "phoneNumber": "+1234567890",
      "location": {
        "street": "Pennsylvania Avenue NW",
        "city": "Washington",
        "country": "US",
        "number": "1600",
        "secondaryNumber": null,
        "county": "Washington",
        "state": "DC",
        "postalCode": "20500",
        "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"
        }
      ],
      "tags": "['service:rapid', 'franchise_location']",
      "integrationMetadata": {
        "integration_name": "ABC"
      },
      "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": "[email protected]",
      "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!"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

size

integer

default:10

The size of the store locations to return.

offset

integer

default:0

The offset of the store locations to return.

Response

Response for list store locations.

storeLocations

StoreLocationResponse · object[]

required

Show child attributes

storeLocations.id

string

required

The ID of the store location.

Example:

"stl_01234567890123456789"

storeLocations.name

string

required

The name of the store location.

Example:

"White House"

storeLocations.phoneNumber

string

required

The phone number of the person at the store location.

Example:

"+1234567890"

storeLocations.location

ParsedAddressInputSerializer · object

required

The location of the store location.

Show child attributes

storeLocations.location.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.

Example:

"Pennsylvania Avenue NW"

storeLocations.location.city

string

required

The city of the address.

Example:

"Washington"

storeLocations.location.country

string

required

The country of the address.

Example:

"US"

storeLocations.location.number

string | null

The number of the address.

Example:

"1600"

storeLocations.location.secondaryNumber

string | null

The secondary number of the address.

Example:

null

storeLocations.location.county

string | null

The county of the address.

Example:

"Washington"

storeLocations.location.state

string | null

The state of the address.

Example:

"DC"

storeLocations.location.postalCode

string | null

The postal code of the address.

Example:

"20500"

storeLocations.location.latitude

number | null

The latitude of the address.

Example:

38.8948949

storeLocations.location.longitude

number | null

The longitude of the address.

Example:

-77.0371581

storeLocations.zoneIds

string[] | null

required

The zone ids of the store location.

Example:

[
  "zone_01234567890123456789",
  "zone_01234567890123456789"
]

storeLocations.zoneAssociations

Zoneassociations · object[] | null

required

The zone associations of the store location.

Example:

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

storeLocations.tags

string[] | null

required

The tags of the store location.

Example:

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

storeLocations.integrationMetadata

Integrationmetadata · object

required

The integration metadata of the store location.

Example:

{ "integration_name": "ABC" }

storeLocations.externalId

string | null

Store location unique identifier from an external system.

Example:

"40123"

storeLocations.operatingHours

Operatinghours · object

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

Example:

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

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

storeLocations.blackoutDates

string[] | null

The blackout dates of the store location.

Example:

["2024-01-01", "2024-01-02"]

storeLocations.firstName

string | null

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

Example:

"Taylor"

storeLocations.lastName

string | null

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

Example:

"Swift"

storeLocations.email

string | null

The email of the person at the store location.

Example:

"[email protected]"

storeLocations.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]

Example:

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

Get Store Location Get store location by external identifier

⌘I

API Documentation

Order

Dispatch Strategies

Notifications

Store Locations & Zones

Jobs

Batch Jobs

Providers

Routes

Shifts

Templates

Store Catalog

Miscellaneous

Get Store Locations

Authorizations

Query Parameters

Response