Skip to content

Latest commit

 

History

History
68 lines (59 loc) · 6.73 KB

location.md

File metadata and controls

68 lines (59 loc) · 6.73 KB
Raw

Location

Represents one of a business' locations.

Structure

Location

Fields

Name Type Tags Description
id string | undefined Optional A short generated string of letters and numbers that uniquely identifies this location instance.
Constraints: Maximum Length: 32
name string | undefined 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 | undefined Optional Represents a postal address in a country.
For more information, see Working with Addresses.
timezone string | undefined Optional The IANA time zone identifier for
the time zone of the location. For example, America/Los_Angeles.
Constraints: Maximum Length: 30
capabilities string[] | undefined Optional The Square features that are enabled for the location.
See LocationCapability for possible values.
See LocationCapability for possible values
status string | undefined Optional A location's status.
createdAt string | undefined 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 | undefined Optional The ID of the merchant that owns the location.
Constraints: Maximum Length: 32
country string | undefined Optional Indicates the country associated with another entity, such as a business.
Values are in ISO 3166-1-alpha-2 format.
languageCode string | undefined 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 | undefined Optional Indicates the associated currency for an amount of money. Values correspond
to ISO 4217.
phoneNumber string | undefined Optional The phone number of the location. For example, +1 855-700-6000.
Constraints: Maximum Length: 17
businessName string | undefined Optional The name of the location's overall business. This name is present on receipts and other customer-facing branding.
Constraints: Maximum Length: 255
type string | undefined Optional A location's type.
websiteUrl string | undefined Optional The website URL of the location. For example, https://squareup.com.
Constraints: Maximum Length: 255
businessHours BusinessHours | undefined Optional The hours of operation for a location.
businessEmail string | undefined 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 | undefined Optional The description of the location. For example, Main Street location.
Constraints: Maximum Length: 1024
twitterUsername string | undefined Optional The Twitter username of the location without the '@' symbol. For example, Square.
Constraints: Minimum Length: 1, Maximum Length: 15
instagramUsername string | undefined Optional The Instagram username of the location without the '@' symbol. For example, square.
Constraints: Minimum Length: 1, Maximum Length: 30
facebookUrl string | undefined 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 | undefined Optional Latitude and longitude coordinates.
logoUrl string | undefined 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 | undefined Optional The URL of the Point of Sale background image for the location.
Constraints: Maximum Length: 255
mcc string | undefined 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 | undefined 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 | undefined Optional Identifiers for the location used by various governments for tax purposes.

Example (as JSON)

{
  "name": null,
  "address": null,
  "timezone": null,
  "status": null,
  "country": null,
  "language_code": null,
  "currency": null,
  "phone_number": null,
  "business_name": null,
  "type": null,
  "website_url": null,
  "business_hours": null,
  "business_email": null,
  "description": null,
  "twitter_username": null,
  "instagram_username": null,
  "facebook_url": null,
  "coordinates": null,
  "mcc": null,
  "tax_ids": null
}