POST
/
v1
/
store_locations

Body

application/json

Expected payload for creating a store location.

name
string
required

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

phoneNumber
string
required

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

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
pickupInstructions
string | null

Any special instructions for store location. Limited to 280 characters. Nash Recommended Input: Order [insert order number] for [insert customer name] from [business name]

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. Can be null if using address_components.

addressComponents
object | null

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

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. Example: {monday: {active: true, shifts: [[10:00, 17:00]]}, tuesday: {active: true, shifts: [[10:00, 17:00]]}, wednesday: {active: true, shifts: [[10:00, 17:00]]}, thursday: {active: true, shifts: [[10:00, 17:00]]}, friday: {active: true, shifts: [[10:00, 17:00]]}, saturday: {active: true, shifts: []}, sunday: {active: true, shifts: []}}

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.

Response

200 - application/json

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.

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]