PATCH
/
v1
/
store_locations
/
{id}
curl --request PATCH \
  --url https://api.sandbox.usenash.com/v1/store_locations/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "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!",
  "name": "<string>",
  "phoneNumber": "<string>",
  "address": "<string>",
  "addressComponents": {
    "number": "1600",
    "secondaryNumber": null,
    "street": "Pennsylvania Avenue NW",
    "county": "Washington",
    "city": "Washington",
    "state": "DC",
    "postalCode": "20500",
    "country": "US",
    "latitude": 38.8948949,
    "longitude": -77.0371581
  },
  "tags": "['\''service:rapid'\'', '\''service:express'\'', '\''franchise_location'\'']",
  "zoneIds": [
    "zone_01234567890123456789",
    "zone_01234567890123456789"
  ],
  "zoneAssociations": [
    {
      "end_date": "2025-01-01",
      "start_date": "2024-01-01",
      "zone_id": "zone_01234567890123456789"
    }
  ]
}'
{
  "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"
  ],
  "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']"
}

Path Parameters

​
id
string
required

Body

application/json

Expected input payload for updating a store location.

​
externalId
string | null

Store location unique identifier from an external system.

Example:

"40123"

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

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"]]
  }
}
​
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.

Example:
["2024-01-01", "2024-01-02"]
​
firstName
string | null

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

Example:

"Taylor"

​
lastName
string | null

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

Example:

"Swift"

​
email
string | null

The email of the person at the store location.

Example:

"taylor@swift.com"

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

​
name
string | null

Store business name at the origin. Limited to 80 characters.

​
phoneNumber
string | null

The phone number to contact at the store location: '+15555555555'

​
address
string | null

The full address in one line for the store location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state] [zip code]. All address fields are required except 'second line'. Second line should include Apt/Suite/Unit/# appended to the number of the unit.

​
addressComponents
object | null

A geocoded and componentized version of the pickup address. NOTE: THIS WILL BYPASS OUR ADDRESS GEOCODING SERVICE!

​
tags
string[] | null

Free form tags specific to the location.

Example:

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

​
zoneIds
string[] | null

The zone ids to associate with the store location.

Example:
[
  "zone_01234567890123456789",
  "zone_01234567890123456789"
]
​
zoneAssociations
object[] | null

The zone associations to associate with the store location.

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

Response

200
application/json
OK

Response for store location.

​
id
string
required

The ID of the store location.

Example:

"stl_01234567890123456789"

​
name
string
required

The name of the store location.

Example:

"White House"

​
phoneNumber
string
required

The phone number of the person at the store location.

Example:

"+1234567890"

​
location
object
required

The location of the store location.

​
zoneIds
string[] | null
required

The zone ids of the store location.

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

The tags of the store location.

Example:

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

​
externalId
string | null

Store location unique identifier from an external system.

Example:

"40123"

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

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"]]
  }
}
​
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.

Example:
["2024-01-01", "2024-01-02"]
​
firstName
string | null

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

Example:

"Taylor"

​
lastName
string | null

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

Example:

"Swift"

​
email
string | null

The email of the person at the store location.

Example:

"taylor@swift.com"

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