Location.md

SquareConnect.Location

Description

Properties

Name	Type	Description	Notes
id	String	The Square-issued ID of the location.	[optional]
name	String	The name of the location. This information appears in the dashboard as the nickname.	[optional]
address	Address	The physical address of the location.	[optional]
timezone	String	The IANA Timezone identifier for the timezone of the location.	[optional]
capabilities	[String]	The Square features that are enabled for the location. See `LocationCapability` for possible values. See LocationCapability for possible values	[optional]
status	String	The status of the location, either active or inactive. 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 ID of the merchant that owns the location.	[optional]
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]
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, in ISO 4217 format. See `Currency` for possible values. See Currency for possible values	[optional]
phone_number	String	The phone number of the location in human readable format.	[optional]
business_name	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]
type	String	The type of the location, either physical or mobile. See LocationType for possible values	[optional]
website_url	String	The website URL of the location.	[optional]
business_hours	BusinessHours	Represents the hours of operation for the location.	[optional]
business_email	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]
description	String	The description of the location.	[optional]
twitter_username	String	The Twitter username of the location without the '@' symbol.	[optional]
instagram_username	String	The Instagram username of the location without the '@' symbol.	[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]
logo_url	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]
pos_background_url	String	The URL of the Point of Sale background image for the location.	[optional]
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] [beta]
full_format_logo_url	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]