SquareConnect::Location

June 12, 2019 ยท View on GitHub

Description

Represents one of a business's locations.

Properties

NameTypeDescriptionNotes
idStringThe location's unique ID.[optional]
nameStringThe location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname[optional]
addressAddressThe location's physical address.[optional]
timezoneStringThe IANA Timezone Database identifier for the location's timezone.[optional]
capabilitiesArray<String>Indicates which Square features are enabled for the location. See LocationCapability for possible values[optional]
statusStringThe location's status See LocationStatus for possible values[optional]
created_atStringThe time when the location was created, in RFC 3339 format.[optional]
merchant_idStringThe identifier of the merchant that owns the location.[optional]
countryStringThe location's country, in ISO 3166-1-alpha-2 format. See Country for possible values[optional]
language_codeStringThe language associated with the location in BCP 47 format.[optional]
currencyStringThe 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_numberStringThe location's phone_number.[optional]
business_nameStringThe location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts.[optional]
typeStringThe 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_urlStringThe location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set.[optional]
business_hoursBusinessHoursThe hours of operation for a business location. Default: none; only exists if explicitly set.[optional]
business_emailStringThe email of the location.[optional]
descriptionStringThe business description of the location.[optional]
twitter_usernameStringThe Twitter username of the location without the '[optional]
instagram_usernameStringThe Instagram username of the location without the '[optional]
facebook_urlStringThe Facebook profile URL of the location. The URL should begin with 'facebook.com/'.[optional]
coordinatesCoordinatesThe physical coordinates (latitude and longitude) of the location.[optional]