Skip to content

Latest commit

 

History

History
58 lines (50 loc) · 4.58 KB

location.md

File metadata and controls

58 lines (50 loc) · 4.58 KB
Raw

Location

Structure

Location

Fields

Name Type Tags Description
id string Optional The Square-issued ID of the location.
name string Optional The name of the location.
This information appears in the dashboard as the nickname.
A location name must be unique within a seller account.
address Address Optional Represents a physical address.
timezone string Optional The IANA Timezone identifier for
the timezone of the location.
capabilities List of str (Location Capability) Optional The Square features that are enabled for the location.
See LocationCapability for possible values.
See LocationCapability for possible values
status str (Location Status) Optional The status of the location, whether a location is active or inactive.
created_at string Optional The time when the location was created, in RFC 3339 format.
merchant_id string Optional The ID of the merchant that owns the location.
country str (Country) Optional Indicates the country associated with another entity, such as a business.
Values are in ISO 3166-1-alpha-2 format.
language_code string Optional The language associated with the location, in
BCP 47 format.
currency str (Currency) Optional Indicates the associated currency for an amount of money. Values correspond
to ISO 4217.
phone_number string Optional The phone number of the location in human readable format.
business_name string Optional 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.
type str (Location Type) Optional A location's physical or mobile type.
website_url string Optional The website URL of the location.
business_hours Business Hours Optional Represents the hours of operation for a business location.
business_email string Optional The email of the location.
This email is visible to the customers of the location.
For example, the email appears on customer receipts.
description string Optional The description of the location.
twitter_username string Optional The Twitter username of the location without the '@' symbol.
instagram_username string Optional The Instagram username of the location without the '@' symbol.
facebook_url string Optional The Facebook profile URL of the location. The URL should begin with 'facebook.com/'.
coordinates Coordinates Optional Latitude and longitude coordinates.
logo_url string Optional 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.
pos_background_url string Optional The URL of the Point of Sale background image for the location.
mcc string Optional 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.
full_format_logo_url string Optional 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.

Example (as JSON)

{
  "id": "id0",
  "name": "name0",
  "address": {
    "address_line_1": "address_line_16",
    "address_line_2": "address_line_26",
    "address_line_3": "address_line_32",
    "locality": "locality6",
    "sublocality": "sublocality6"
  },
  "timezone": "timezone0",
  "capabilities": [
    "AUTOMATIC_TRANSFERS"
  ]
}