Object Index
/ Definition
You are viewing an old version of the API
Location
Object Index / Definition
Properties
| Name | Description |
|---|---|
id
|
Read only The Square-issued ID of the location. |
address
|
The physical address of the location. |
business_email
|
The email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts. |
business_hours
|
Represents the hours of operation for the location. |
business_name
|
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. |
capabilities
|
Read only The Square features that are enabled for the location. |
coordinates
|
The physical coordinates (latitude and longitude) of the location. |
country
|
Read only The country of the location, in ISO 3166-1-alpha-2 format. |
created_at
|
Read only The time when the location was created, in RFC 3339 format. |
currency
|
Read only The currency used for all transactions at this location, in ISO 4217 format. |
description
|
The description of the location. |
facebook_url
|
The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. |
instagram_username
|
The Instagram username of the location without the '@' symbol. |
language_code
|
The language associated with the location, in BCP 47 format. |
logo_url
|
Read only The URL of the logo image for the location. |
mcc
Beta
|
Read only 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. |
merchant_id
|
Read only The ID of the merchant that owns the location. |
name
|
The name of the location. This information appears in the dashboard as the nickname. |
phone_number
|
The phone number of the location in human readable format. |
pos_background_url
|
Read only The URL of the Point of Sale background image for the location. |
status
|
The status of the location, either active or inactive. |
timezone
|
The IANA Timezone identifier for the timezone of the location. |
twitter_username
|
The Twitter username of the location without the '@' symbol. |
type
|
The type of the location, either physical or mobile. |
website_url
|
The website URL of the location. |