location.md

Location

Represents one of a business' locations.

Structure

Location

Fields

Name	Type	Tags	Description
Id	string	Optional	A short generated string of letters and numbers that uniquely identifies this location instance. Constraints: Maximum Length: 32
Name	string	Optional	The name of the location. This information appears in the Seller Dashboard as the nickname. A location name must be unique within a seller account. Constraints: Maximum Length: 255
Address	Address	Optional	Represents a postal address in a country. For more information, see Working with Addresses.
Timezone	string	Optional	The IANA time zone identifier for the time zone of the location. For example, America/Los_Angeles. Constraints: Maximum Length: 30
Capabilities	IList<string>	Optional	The Square features that are enabled for the location. See LocationCapability for possible values. See LocationCapability for possible values
Status	string	Optional	A location's status.
CreatedAt	string	Optional	The time when the location was created, in RFC 3339 format. For more information, see Working with Dates. Constraints: Minimum Length: 20, Maximum Length: 25
MerchantId	string	Optional	The ID of the merchant that owns the location. Constraints: Maximum Length: 32
Country	string	Optional	Indicates the country associated with another entity, such as a business. Values are in ISO 3166-1-alpha-2 format.
LanguageCode	string	Optional	The language associated with the location, in BCP 47 format. For more information, see Language Preferences. Constraints: Minimum Length: 2, Maximum Length: 5
Currency	string	Optional	Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
PhoneNumber	string	Optional	The phone number of the location. For example, +1 855-700-6000. Constraints: Maximum Length: 17
BusinessName	string	Optional	The name of the location's overall business. This name is present on receipts and other customer-facing branding, and can be changed no more than three times in a twelve-month period. Constraints: Maximum Length: 255
Type	string	Optional	A location's type.
WebsiteUrl	string	Optional	The website URL of the location. For example, https://squareup.com. Constraints: Maximum Length: 255
BusinessHours	BusinessHours	Optional	The hours of operation for a location.
BusinessEmail	string	Optional	The email address of the location. This can be unique to the location and is not always the email address for the business owner or administrator. Constraints: Maximum Length: 255
Description	string	Optional	The description of the location. For example, Main Street location. Constraints: Maximum Length: 1024
TwitterUsername	string	Optional	The Twitter username of the location without the '@' symbol. For example, Square. Constraints: Minimum Length: 1, Maximum Length: 15
InstagramUsername	string	Optional	The Instagram username of the location without the '@' symbol. For example, square. Constraints: Minimum Length: 1, Maximum Length: 30
FacebookUrl	string	Optional	The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, https://www.facebook.com/square. Constraints: Maximum Length: 255
Coordinates	Coordinates	Optional	Latitude and longitude coordinates.
LogoUrl	string	Optional	The URL of the logo image for the location. When configured in the Seller Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller. This image should have a roughly square (1:1) aspect ratio and should be at least 200x200 pixels. Constraints: Maximum Length: 255
PosBackgroundUrl	string	Optional	The URL of the Point of Sale background image for the location. Constraints: Maximum Length: 255
Mcc	string	Optional	A four-digit number that describes the kind of goods or services sold at the location. The merchant category code (MCC) of the location as standardized by ISO 18245. For example, 5045, for a location that sells computer goods and software. Constraints: Minimum Length: 4, Maximum Length: 4
FullFormatLogoUrl	string	Optional	The URL of a full-format logo image for the location. When configured in the Seller Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller. This image can be wider than it is tall and should be at least 1280x648 pixels.
TaxIds	TaxIds	Optional	Identifiers for the location used by various governments for tax purposes.

Example (as JSON)

{
  "id": "id4",
  "name": "name4",
  "address": {
    "address_line_1": "address_line_16",
    "address_line_2": "address_line_26",
    "address_line_3": "address_line_32",
    "locality": "locality6",
    "sublocality": "sublocality6"
  },
  "timezone": "timezone4",
  "capabilities": [
    "CREDIT_CARD_PROCESSING"
  ]
}