Object Index
You are viewing an old version of the API
Location
Object Index
Represents one of a business' locations.
Properties
Name | Description |
---|---|
id
|
Read only A short generated string of letters and numbers that uniquely identifies this location instance. |
name
|
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. |
address
|
The physical address of the location. |
timezone
|
The IANA time zone identifier for
the time zone of the location. For example, |
capabilities
|
Read only The Square features that are enabled for the location. |
status
|
The status of the location. |
created_
|
Read only The time when the location was created, in RFC 3339 format. For more information, see Working with Dates. |
merchant_
|
Read only The ID of the merchant that owns the location. |
country
|
Read only The country of the location, in the two-letter format of ISO 3166. For example, |
language_
|
The language associated with the location, in BCP 47 format. For more information, see Location language code. |
currency
|
Read only The currency used for all transactions at this location,
in ISO 4217 format. For example, the currency code for US dollars is |
phone_
|
The phone number of the location. For example, |
business_
|
The name of the location's overall business. This name is present on receipts and other customer-facing branding. |
type
|
The type of the location. |
website_
|
The website URL of the location. For example, |
business_
|
The hours of operation for the location. |
business_
|
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. |
description
|
The description of the location. For example, |
twitter_
|
The Twitter username of the location without the '@' symbol. For example, |
instagram_
|
The Instagram username of the location without the '@' symbol. For example, |
facebook_
|
The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, |
coordinates
|
The physical coordinates (latitude and longitude) of the location. |
logo_
|
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. |
pos_
|
Read only The URL of the Point of Sale background image for the location. |
mcc
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, |
full_
|
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. |
tax_
Beta
|
The tax IDs for this location. |