Object Index

You are viewing an old version of the API

2021-05-13

Version 2021-05-13

• All Versions

Location

Read only The Square-issued ID of the location.

The name of the location. This information appears in the dashboard as the nickname. A location name must be unique within a seller account.

The physical address of the location.

The IANA Timezone identifier for the timezone of the location.

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

The status of the location, either active or inactive.

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

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

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

The language associated with the location, in BCP 47 format.

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

The phone number of the location in human readable format.

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.

The type of the location, either physical or mobile.

The website URL of the location.

Represents the hours of operation for the location.

The email of the location. This email is visible to the customers of the location. For example, the email appears on customer receipts.

The description of the location.

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

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

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

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

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.

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

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.

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.