<- Object

Object

All versions ->

Location

Link to section

Properties

Link to section

id

string

Read only The Square-issued ID of the location.

Link to section

name

string

The name of the location. This information appears in the dashboard as the nickname.

Link to section

address

The physical address of the location.

Link to section

timezone

string

Link to section

capabilities

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

Link to section

status

string

The status of the location, either active or inactive.

Link to section

created_at

string

Read only The time when the location was created, in RFC 3339 format.

Link to section

merchant_id

string

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

Link to section

country

string

Read only The country of the location, in ISO 3166-1-alpha-2 format.

Link to section

language_code

string

Link to section

currency

string

Read only The currency used for all transactions at this location, in ISO 4217 format.

Link to section

phone_number

string

The phone number of the location in human readable format.

Link to section

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.

Link to section

type

string

The type of the location, either physical or mobile.

Link to section

website_url

string

The website URL of the location.

Link to section

business_hours

Represents the hours of operation for the location.

Link to section

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.

Link to section

description

string

The description of the location.

Link to section

twitter_username

string

The Twitter username of the location without the '@' symbol.

Link to section

instagram_username

string

The Instagram username of the location without the '@' symbol.

Link to section

facebook_url

string

The Facebook profile URL of the location. The URL should begin with 'facebook.com/'.

Link to section

coordinates

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

Link to section

logo_url

string

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

Link to section

pos_background_url

string

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

Link to section

mcc

string

Beta

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.

Link to section

full_format_logo_url

string

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