PUT /v2/locations/{location_id}
Updates a location.
Servers
- https://connect.squareup.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
location_id |
String | Yes |
The ID of the location to update. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
location |
Object | No | |
location.mcc |
String | No |
The merchant category code (MCC) of the location, as standardized by ISO 18245. The MCC describes the kind of goods or services sold at the location. |
location.description |
String | No |
The description of the location. |
location.language_code |
String | No |
The language associated with the location, in BCP 47 format. For more information, see Location language code. |
location.currency |
String | No |
The currency used for all transactions at this location, in ISO 4217 format. See Currency for possible values. |
location.logo_url |
String | No |
The URL of the logo image for the location. The Seller must choose this logo in the Seller dashboard (Receipts section) for the logo to appear on transactions (such as receipts, invoices) that Square generates on behalf of the Seller. This image should have an aspect ratio close to 1:1 and is recommended to be at least 200x200 pixels. |
location.id |
String | No |
The Square-issued ID of the location. |
location.timezone |
String | No |
The IANA Timezone identifier for the timezone of the location. |
location.business_name |
String | No |
The business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts. |
location.business_hours |
Object | No |
Represents the hours of operation for a business location. |
location.business_hours.periods[] |
Array | No |
The list of time periods during which the business is open. There may be at most 10 periods per day. |
location.business_hours.periods[].start_local_time |
String | No |
The start time of a business hours period, specified in local time using partial-time RFC 3339 format. |
location.business_hours.periods[].day_of_week |
String | No |
The day of week for this time period. |
location.business_hours.periods[].end_local_time |
String | No |
The end time of a business hours period, specified in local time using partial-time RFC 3339 format. |
location.pos_background_url |
String | No |
The URL of the Point of Sale background image for the location. |
location.type |
String | No |
The type of the location, either physical or mobile. |
location.country |
String | No |
The country of the location, in ISO 3166-1-alpha-2 format. See Country for possible values. |
location.full_format_logo_url |
String | No |
The URL of a full-format logo image for the location. The Seller must choose this logo in the Seller dashboard (Receipts section) for the logo to appear on transactions (such as receipts, invoices) that Square generates on behalf of the Seller. This image can have an aspect ratio of 2:1 or greater and is recommended to be at least 1280x648 pixels. |
location.merchant_id |
String | No |
The ID of the merchant that owns the location. |
location.coordinates |
Object | No |
Latitude and longitude coordinates. |
location.coordinates.longitude |
Number | No |
The longitude of the coordinate expressed in degrees. |
location.coordinates.latitude |
Number | No |
The latitude of the coordinate expressed in degrees. |
location.instagram_username |
String | No |
The Instagram username of the location without the '@' symbol. For example, |
location.status |
String | No |
The status of the location, either active or inactive. |
location.phone_number |
String | No |
The phone number of the location in human readable format. For example, |
location.name |
String | No |
The name of the location. This information appears in the dashboard as the nickname. A location name must be unique within a seller account. |
location.business_email |
String | No |
The email of the location.
This email is visible to the customers of the location.
For example, the email appears on customer receipts.
For example, |
location.tax_ids |
Object | No |
The tax IDs that a Location is operating under. |
location.tax_ids.fr_naf |
String | No |
The French government uses the NAF (Nomenclature des Activités Françaises) to display and track economic statistical data. This is also called the APE (Activite Principale de l’Entreprise) code. For example, 6910Z. |
location.tax_ids.eu_vat |
String | No |
The EU VAT number for this location. For example, "IE3426675K". If the EU VAT number is present, it is well-formed and has been validated with VIES, the VAT Information Exchange System. |
location.tax_ids.fr_siret |
String | No |
The SIRET (Système d'Identification du Répertoire des Entreprises et de leurs Etablissements) number is a 14 digits code issued by the French INSEE. For example, "39922799000021". |
location.created_at |
String | No |
The time when the location was created, in RFC 3339 format. For more information, see Working with Dates. |
location.facebook_url |
String | No |
The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, |
location.twitter_username |
String | No |
The Twitter username of the location without the '@' symbol. For example, |
location.address |
Object | No |
Represents a postal address in a country. The address format is based
on an open-source library from Google. For more information,
see AddressValidationMetadata.
This format has dedicated fields for four address components: postal code,
locality (city), administrative district (state, prefecture, or province), and
sublocality (town or village). These components have dedicated fields in the
For the remaining address components, the Note that, in the current implementation, all other When it comes to localization, the seller's language preferences (see Language preferences) are ignored for addresses. Even though Square products (such as Square Point of Sale and the Seller Dashboard) mostly use a seller's language preference in communication, when it comes to addresses, they will use English for a US address, Japanese for an address in Japan, and so on. |
location.address.address_line_3 |
String | No |
The third line of the address, if any. |
location.address.first_name |
String | No |
Optional first name when it's representing recipient. |
location.address.postal_code |
String | No |
The address's postal code. |
location.address.organization |
String | No |
Optional organization name when it's representing recipient. |
location.address.address_line_2 |
String | No |
The second line of the address, if any. |
location.address.address_line_1 |
String | No |
The first line of the address. Fields that start with |
location.address.administrative_district_level_3 |
String | No |
A civil entity within the address's |
location.address.sublocality_2 |
String | No |
A civil region within the address's |
location.address.administrative_district_level_2 |
String | No |
A civil entity within the address's |
location.address.locality |
String | No |
The city or town of the address. |
location.address.sublocality |
String | No |
A civil region within the address's |
location.address.last_name |
String | No |
Optional last name when it's representing recipient. |
location.address.administrative_district_level_1 |
String | No |
A civil entity within the address's country. In the US, this is the state. |
location.address.sublocality_3 |
String | No |
A civil region within the address's |
location.address.country |
String | No |
The address's country, in ISO 3166-1-alpha-2 format. |
location.capabilities[] |
Array | No |
The Square features that are enabled for the location. See LocationCapability for possible values. |
location.website_url |
String | No |
The website URL of the location. For example, |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.