• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
Location

Represents one of a business' locations.

Properties

Name Description
id
string

Read only A short generated string of letters and numbers that uniquely identifies this location instance.

Max Length 32
name
string

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.

Max Length 255
address
Address

The physical address of the location.

timezone
string

The IANA time zone identifier for the time zone of the location. For example, America/Los_Angeles.

Max Length 30
capabilities
string [ ]

Read only The Square features that are enabled for the location.

status
string

The status of the location.

created_at
string

Read only The time when the location was created, in RFC 3339 format. For more information, see Working with Dates.

Min Length 20 Max Length 25
merchant_id
string

Read only The ID of the merchant that owns the location.

Max Length 32
country
string

Read only The country of the location, in the two-letter format of ISO 3166. For example, US or JP.

language_code
string

The language associated with the location, in BCP 47 format. For more information, see Language Preferences.

Min Length 2 Max Length 5
currency
string

Read only The currency used for all transactions at this location, in ISO 4217 format. For example, the currency code for US dollars is USD.

phone_number
string

The phone number of the location. For example, +1 855-700-6000.

Max Length 17
business_name
string

The name of the location's overall business. This name is present on receipts and other customer-facing branding.

Max Length 255
type
string

The type of the location.

website_url
string

The website URL of the location. For example, https://squareup.com.

Max Length 255
business_hours
BusinessHours

The hours of operation for the location.

business_email
string

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.

Max Length 255
description
string

The description of the location. For example, Main Street location.

Max Length 1024
twitter_username
string

The Twitter username of the location without the '@' symbol. For example, Square.

Min Length 1 Max Length 15
instagram_username
string

The Instagram username of the location without the '@' symbol. For example, square.

Min Length 1 Max Length 30
facebook_url
string

The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, https://www.facebook.com/square.

Max Length 255
coordinates
Coordinates

The physical coordinates (latitude and longitude) of the location.

logo_url
string

Read only 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.

Max Length 255
pos_background_url
string

Read only The URL of the Point of Sale background image for the location.

Max Length 255
mcc
string

Beta

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.

Min Length 4 Max Length 4
full_format_logo_url
string

Read only 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.

tax_ids
TaxIds

Beta

The tax IDs for this location.