Location

November 20, 2019 ยท View on GitHub

Description

Properties

NameGetterSetterTypeDescriptionNotes
idgetId()setId($value)stringThe Square-issued ID of the location.[optional]
namegetName()setName($value)stringThe name of the location. This information appears in the dashboard as the nickname.[optional]
addressgetAddress()setAddress($value)\SquareConnect\Model\AddressThe physical address of the location.[optional]
timezonegetTimezone()setTimezone($value)stringThe IANA Timezone identifier for the timezone of the location.[optional]
capabilitiesgetCapabilities()setCapabilities($value)string[]The Square features that are enabled for the location. See `LocationCapability` for possible values. See LocationCapability for possible values[optional]
statusgetStatus()setStatus($value)stringThe status of the location, either active or inactive. See LocationStatus for possible values[optional]
created_atgetCreatedAt()setCreatedAt($value)stringThe time when the location was created, in RFC 3339 format.[optional]
merchant_idgetMerchantId()setMerchantId($value)stringThe ID of the merchant that owns the location.[optional]
countrygetCountry()setCountry($value)stringThe country of the location, in ISO 3166-1-alpha-2 format. See `Country` for possible values. See Country for possible values[optional]
language_codegetLanguageCode()setLanguageCode($value)stringThe language associated with the location, in BCP 47 format.[optional]
currencygetCurrency()setCurrency($value)stringThe currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See Currency for possible values[optional]
phone_numbergetPhoneNumber()setPhoneNumber($value)stringThe phone number of the location in human readable format.[optional]
business_namegetBusinessName()setBusinessName($value)stringThe business name of the location This is the name visible to the customers of the location. For example, this name appears on customer receipts.[optional]
typegetType()setType($value)stringThe type of the location, either physical or mobile. See LocationType for possible values[optional]
website_urlgetWebsiteUrl()setWebsiteUrl($value)stringThe website URL of the location.[optional]
business_hoursgetBusinessHours()setBusinessHours($value)\SquareConnect\Model\BusinessHoursRepresents the hours of operation for the location.[optional]
business_emailgetBusinessEmail()setBusinessEmail($value)stringThe email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts.[optional]
descriptiongetDescription()setDescription($value)stringThe description of the location.[optional]
twitter_usernamegetTwitterUsername()setTwitterUsername($value)stringThe Twitter username of the location without the '@' symbol.[optional]
instagram_usernamegetInstagramUsername()setInstagramUsername($value)stringThe Instagram username of the location without the '@' symbol.[optional]
facebook_urlgetFacebookUrl()setFacebookUrl($value)stringThe Facebook profile URL of the location. The URL should begin with 'facebook.com/'.[optional]
coordinatesgetCoordinates()setCoordinates($value)\SquareConnect\Model\CoordinatesThe physical coordinates (latitude and longitude) of the location.[optional]
logo_urlgetLogoUrl()setLogoUrl($value)stringThe URL of the logo image for the location.[optional]
pos_background_urlgetPosBackgroundUrl()setPosBackgroundUrl($value)stringThe URL of the Point of Sale background image for the location.[optional]
mccgetMcc()setMcc($value)stringThe 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.[optional] [beta]

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

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