Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
30 lines (22 loc) · 2.27 KB

Address.md

File metadata and controls

30 lines (22 loc) · 2.27 KB

Square.Connect.Model.Address

Description

Represents a physical address.

Properties

Name Type Description Notes
AddressLine1 string The first line of the address. Fields that start with `address_line` provide the address's most specific details, like street number, street name, and building name. They do not provide less specific details like city, state/province, or country (these details are provided in other fields). [optional]
AddressLine2 string The second line of the address, if any. [optional]
AddressLine3 string The third line of the address, if any. [optional]
Locality string The city or town of the address. [optional]
Sublocality string A civil region within the address's `locality`, if any. [optional]
Sublocality2 string A civil region within the address's `sublocality`, if any. [optional]
Sublocality3 string A civil region within the address's `sublocality_2`, if any. [optional]
AdministrativeDistrictLevel1 string A civil entity within the address's country. In the US, this is the state. [optional]
AdministrativeDistrictLevel2 string A civil entity within the address's `administrative_district_level_1`. In the US, this is the county. [optional]
AdministrativeDistrictLevel3 string A civil entity within the address's `administrative_district_level_2`, if any. [optional]
PostalCode string The address's postal code. [optional]
Country string The address's country, in ISO 3166-1-alpha-2 format. See Country for possible values [optional]
FirstName string Optional first name when it's representing recipient. [optional]
LastName string Optional last name when it's representing recipient. [optional]
Organization string Optional organization name when it's representing recipient. [optional]

[Back to Model list] [Back to API list] [Back to README]