SquareConnect::Location
June 12, 2019 ยท View on GitHub
Description
Represents one of a business's locations.
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The location's unique ID. | [optional] |
| name | String | The location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname | [optional] |
| address | Address | The location's physical address. | [optional] |
| timezone | String | The IANA Timezone Database identifier for the location's timezone. | [optional] |
| capabilities | Array<String> | Indicates which Square features are enabled for the location. See LocationCapability for possible values | [optional] |
| status | String | The location's status See LocationStatus for possible values | [optional] |
| created_at | String | The time when the location was created, in RFC 3339 format. | [optional] |
| merchant_id | String | The identifier of the merchant that owns the location. | [optional] |
| country | String | The location's country, in ISO 3166-1-alpha-2 format. See Country for possible values | [optional] |
| language_code | String | The language associated with the location in BCP 47 format. | [optional] |
| currency | String | The currency used for all transactions at this location, specified in ISO 4217 format. For example, the currency for a location processing transactions in the United States is 'USD'. See Currency for possible values | [optional] |
| phone_number | String | The location's phone_number. | [optional] |
| business_name | String | The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts. | [optional] |
| type | String | The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See LocationType for possible values | [optional] |
| website_url | String | The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set. | [optional] |
| business_hours | BusinessHours | The hours of operation for a business location. Default: none; only exists if explicitly set. | [optional] |
| business_email | String | The email of the location. | [optional] |
| description | String | The business description of the location. | [optional] |
| twitter_username | String | The Twitter username of the location without the ' | [optional] |
| instagram_username | String | The Instagram username of the location without the ' | [optional] |
| facebook_url | String | The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. | [optional] |
| coordinates | Coordinates | The physical coordinates (latitude and longitude) of the location. | [optional] |