Skip to content

Latest commit

 

History

History
34 lines (31 loc) · 4.57 KB

Location.md

File metadata and controls

34 lines (31 loc) · 4.57 KB
Raw

Location

Properties

Name Type Description Notes
Id string The Square-issued ID of the location. [optional] [default to null]
Name string The name of the location. This information appears in the dashboard as the nickname. [optional] [default to null]
Address *Address [optional] [default to null]
Timezone string The IANA Timezone identifier for the timezone of the location. [optional] [default to null]
Capabilities []string The Square features that are enabled for the location. See `LocationCapability` for possible values. See LocationCapability for possible values [optional] [default to null]
Status string The status of the location, either active or inactive. See LocationStatus for possible values [optional] [default to null]
CreatedAt string The time when the location was created, in RFC 3339 format. [optional] [default to null]
MerchantId string The ID of the merchant that owns the location. [optional] [default to null]
Country string The country of the location, in ISO 3166-1-alpha-2 format. See `Country` for possible values. See Country for possible values [optional] [default to null]
LanguageCode string The language associated with the location, in BCP 47 format. [optional] [default to null]
Currency string The currency used for all transactions at this location, in ISO 4217 format. See `Currency` for possible values. See Currency for possible values [optional] [default to null]
PhoneNumber string The phone number of the location in human readable format. [optional] [default to null]
BusinessName string 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. [optional] [default to null]
Type_ string The type of the location, either physical or mobile. See LocationType for possible values [optional] [default to null]
WebsiteUrl string The website URL of the location. [optional] [default to null]
BusinessHours *BusinessHours [optional] [default to null]
BusinessEmail string The email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts. [optional] [default to null]
Description string The description of the location. [optional] [default to null]
TwitterUsername string The Twitter username of the location without the '@' symbol. [optional] [default to null]
InstagramUsername string The Instagram username of the location without the '@' symbol. [optional] [default to null]
FacebookUrl string The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. [optional] [default to null]
Coordinates *Coordinates [optional] [default to null]
LogoUrl string The URL of the logo image for the location. The Seller must choose this logo in the Seller dashboard (Receipts section) for the logo to appear on transactions (such as receipts, invoices) that Square generates on behalf of the Seller. This image should have an aspect ratio close to 1:1 and is recommended to be at least 200x200 pixels. [optional] [default to null]
PosBackgroundUrl string The URL of the Point of Sale background image for the location. [optional] [default to null]
Mcc string 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. [optional] [default to null]
FullFormatLogoUrl string The URL of a full-format logo image for the location. The Seller must choose this logo in the Seller dashboard (Receipts section) for the logo to appear on transactions (such as receipts, invoices) that Square generates on behalf of the Seller. This image can have an aspect ratio of 2:1 or greater and is recommended to be at least 1280x648 pixels. [optional] [default to null]

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