Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 3.26 KB

Location.md

File metadata and controls

25 lines (21 loc) · 3.26 KB

Location

Properties

Name Getter Setter Type Description Notes
id getId() setId($value) string The location's unique ID. [optional]
name getName() setName($value) 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 getAddress() setAddress($value) \SquareConnect\Model\Address The location's physical address. [optional]
timezone getTimezone() setTimezone($value) string The IANA Timezone Database identifier for the location's timezone. [optional]
capabilities getCapabilities() setCapabilities($value) string[] Indicates which Square features are enabled for the location. See LocationCapability for possible values. [optional]
status getStatus() setStatus($value) string The location's status See LocationStatus for possible values. [optional]
created_at getCreatedAt() setCreatedAt($value) string The time when the location was created, in RFC 3339 format. [optional]
merchant_id getMerchantId() setMerchantId($value) string The identifier of the merchant that owns the location. [optional]
country getCountry() setCountry($value) string The location's country, in ISO 3166-1-alpha-2 format. See Country for possible values. [optional]
language_code getLanguageCode() setLanguageCode($value) string The language associated with the location in BCP 47 format. [optional]
currency getCurrency() setCurrency($value) 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 getPhoneNumber() setPhoneNumber($value) string The location's phone_number. [optional]
business_name getBusinessName() setBusinessName($value) 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 getType() setType($value) 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 getWebsiteUrl() setWebsiteUrl($value) string The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set. [optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]