Square · Schema
Square Location
Represents one of a business's locations where transactions occur, inventory is managed, and team members work.
BookingsCatalogCheckoutCustomersDisputesEcommerceFinancial TechnologyGift CardsInventoryInvoicingLaborLocationsLoyaltyMerchantsOrdersPaymentsPoint of SaleRefundsRetailSubscriptionsTeamTerminalWebhooks
Properties
| Name | Type | Description |
|---|---|---|
| id | string | A short generated string of letters and numbers that uniquely identifies this location instance. |
| 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. |
| address | object | 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. |
| capabilities | array | The Square features that are enabled for the location. |
| status | string | The status of the location. |
| created_at | string | The time when the location was created, in RFC 3339 format. |
| merchant_id | string | The ID of the merchant that owns the location. |
| country | string | 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. |
| currency | string | The currency used for all transactions at this location, in ISO 4217 format. For example, USD. |
| phone_number | string | The phone number of the location. For example, +1 855-700-6000. |
| business_name | string | The name of the location's overall business. This name is present on receipts and other customer-facing branding. |
| type | string | The type of the location. |
| website_url | string | The website URL of the location. |
| business_hours | object | The hours of operation for the location. |
| business_email | string | The email address of the location. |
| description | string | The description of the location. For example, Main Street location. |
| twitter_username | string | The Twitter username of the location without the '@' symbol. |
| instagram_username | string | The Instagram username of the location without the '@' symbol. |
| facebook_url | string | The Facebook profile URL of the location. |
| coordinates | object | The physical coordinates (latitude and longitude) of the location. |
| logo_url | string | The URL of the logo image for the location. |
| pos_background_url | string | The URL of the Point of Sale background image for the location. |
| mcc | string | The merchant category code (MCC) of the location as standardized by ISO 18245. |
| full_format_logo_url | string | The URL of a full-format logo image for the location. |
| tax_ids | object | The tax IDs for this location. |