Updates a location.
Open in API Reference
The ID of the location to update.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
The Location object with only the fields to update.
Location
The physical address of the location.
The first line of the address.
Fields that start with address_line provide the address's most specific details, like street number, street name, and building name. They do not provide less specific details like city, state/province, or country (these details are provided in other fields).
address_line
A nonexistent value. In an API request this value will appear as null. Can be used to clear a field entirely.
null
The second line of the address, if any.
The third line of the address, if any.
A civil entity within the address's country. In the US, this is the state. For a full list of field meanings by country, see Working with Addresses.
A civil entity within the address's administrative_district_level_1. In the US, this is the county.
administrative_district_level_1
A civil entity within the address's administrative_district_level_2, if any.
administrative_district_level_2
The address's country, in the two-letter format of ISO 3166. For example, US or FR.
US
FR
Optional first name when it's representing recipient.
Optional last name when it's representing recipient.
The city or town of the address. For a full list of field meanings by country, see Working with Addresses.
The address's postal code. For a full list of field meanings by country, see Working with Addresses.
A civil region within the address's locality, if any.
locality
A civil region within the address's sublocality, if any.
sublocality
A civil region within the address's sublocality_2, if any.
sublocality_2
The email address of the location. This can be unique to the location and is not always the email address for the business owner or administrator.
The hours of operation for the location.
The name of the location's overall business. This name is present on receipts and other customer-facing branding, and can be changed no more than three times in a twelve-month period.
The physical coordinates (latitude and longitude) of the location.
The description of the location. For example, Main Street location.
Main Street location
The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, https://www.facebook.com/square.
https://www.facebook.com/square
The Instagram username of the location without the '@' symbol. For example, square.
square
The language associated with the location, in BCP 47 format. For more information, see Language Preferences.
A four-digit number that describes the kind of goods or services sold at the location. The merchant category code (MCC) of the location as standardized by ISO 18245. For example, 5045, for a location that sells computer goods and software.
5045
The name of the location. This information appears in the Seller Dashboard as the nickname. A location name must be unique within a seller account.
The phone number of the location. For example, +1 855-700-6000.
+1 855-700-6000
The status of the location.
The tax IDs for this location.
The IANA time zone identifier for the time zone of the location. For example, America/Los_Angeles.
America/Los_Angeles
The Twitter username of the location without the '@' symbol. For example, Square.
Square
The type of the location.
The website URL of the location. For example, https://squareup.com.
https://squareup.com
// No response received yet.