<- Object

Object

Location

Link to section

Properties

Link to section

id

string

Read only A short generated string of letters and numbers that uniquely identifies this location instance.

Link to section

name

string

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.

Link to section

address

The physical address of the location.

Link to section

timezone

string

The IANA time zone identifier for the time zone of the location. For example, America/Los_Angeles.

Link to section

capabilities

string [ ]

Read only The Square features that are enabled for the location.

Link to section

status

string

The status of the location.

Link to section

created_at

string

Read only The time when the location was created, in RFC 3339 format. For more information, see Working with Dates.

Link to section

merchant_id

string

Read only The ID of the merchant that owns the location.

Link to section

country

string

Read only The country of the location, in the two-letter format of ISO 3166. For example, US or JP.

Link to section

language_code

string

Link to section

currency

string

Read only The currency used for all transactions at this location, in ISO 4217 format. For example, the currency code for US dollars is USD.

Link to section

phone_number

string

The phone number of the location. For example, +1 855-700-6000.

Link to section

business_name

string

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.

Link to section

type

string

The type of the location.

Link to section

website_url

string

The website URL of the location. For example, https://squareup.com.

Link to section

business_hours

The hours of operation for the location.

Link to section

business_email

string

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.

Link to section

description

string

The description of the location. For example, Main Street location.

Link to section

twitter_username

string

The Twitter username of the location without the '@' symbol. For example, Square.

Link to section

instagram_username

string

The Instagram username of the location without the '@' symbol. For example, square.

Link to section

facebook_url

string

The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, https://www.facebook.com/square.

Link to section

coordinates

The physical coordinates (latitude and longitude) of the location.

Link to section

logo_url

string

Read only The URL of the logo image for the location. When configured in the Seller Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller. This image should have a roughly square (1:1) aspect ratio and should be at least 200x200 pixels.

Link to section

pos_background_url

string

Read only The URL of the Point of Sale background image for the location.

Link to section

mcc

string

Beta

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.

Link to section

full_format_logo_url

string

Read only The URL of a full-format logo image for the location. When configured in the Seller Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller. This image can be wider than it is tall and should be at least 1280x648 pixels.

Link to section

tax_ids

Beta

Read only The tax IDs for this location.