API Documentation
Order
- Background
- Order Address Validation (Geocoding)
- POSTCreate Order
- POSTCreate Orders
- POSTCreate or update order by external identifier
- PATCHUpdate order
- GETGet order
- POSTCreate Quote
- GETGet Order Documents
- POSTSelect Quote
- POSTRefresh order quotes
- POSTAutodispatch Order
- POSTAdd Custom Event to Order
- DELArchive order
- Bulk Order Actions
- Delivery Windows & Capacity
Dispatch Strategies
Notifications
Store Locations & Zones
- POSTCreate store location
- PATCHUpdate Store Location
- GETGet Store Location
- GETGet Store Locations
- GETGet store location by external identifier
- DELDelete store location
- GETGet store locations that cover specified location (latitude & longitude, city_zipcode)
- POSTCreate a zone
- PATCHUpdate a zone
- GETGet zone
- GETGet zones
- GETGet zone by external identifier
- GETGet zones that cover specified location (latitude & longitude, city_zipcode)
Jobs
- Background
- Package Requirements
- POSTCreate Job
- POSTCreate or Update Job by External Identifier
- PATCHUpdate Job
- GETGet Job
- GETGet Job by External Identifier
- POSTSelect Quote
- POSTReassign a Task in a Job
- POSTRefresh Quotes
- POSTAutodispatch Job
- POSTAutodispatch Job by External Identifier
- POSTCancel Job
- POSTCancel Job by External Identifier
- POSTCreate Delivery Incident
- GETGet Refund Requests
- GETGet Refund Request
Batch Jobs
Providers
Miscellaneous
Get Store Locations
Get a list of store locations.
curl --request GET \
--url https://api.sandbox.usenash.com/v1/store_locations{
"storeLocations": [
{
"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
The size of the store locations to return.
The offset of the store locations to return.
Response
Response for list store locations.
Response for store location.
The ID of the store location.
The name of the store location.
The phone number of the person at the store location.
The location of the store location.
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.
The city of the address.
The country of the address.
The number of the address.
The secondary number of the address.
The county of the address.
The state of the address.
The postal code of the address.
The latitude of the address.
The longitude of the address.
The zone ids of the store location.
The tags of the store location.
Store location unique identifier from an external system.
[Integration Specific]: An object with keys that correspond to days of week (monday, tuesday, etc) and their corresponding operating hours / delivery windows.
[Integration Specific]: the preparation time to apply for orders, if relying on Nash to compute the delivery windows. This only applies to specific integrations.
The blackout dates of the store location.
First name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.
Last name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.
The email of the person at the store location.
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]
curl --request GET \
--url https://api.sandbox.usenash.com/v1/store_locations{
"storeLocations": [
{
"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']"
}
]
}