Skip to content

Files

Latest commit

6513ad5 · Feb 10, 2017

History

History
281 lines (273 loc) · 5.65 KB

Address.md

File metadata and controls

281 lines (273 loc) · 5.65 KB

Square.Connect.Model.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 CountryEnum The address's country, in ISO 3166-1-alpha-2 format. [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]

CountryEnum

Name Value
ZZ "ZZ"
AD "AD"
AE "AE"
AF "AF"
AG "AG"
AI "AI"
AL "AL"
AM "AM"
AO "AO"
AQ "AQ"
AR "AR"
AS "AS"
AT "AT"
AU "AU"
AW "AW"
AX "AX"
AZ "AZ"
BA "BA"
BB "BB"
BD "BD"
BE "BE"
BF "BF"
BG "BG"
BH "BH"
BI "BI"
BJ "BJ"
BL "BL"
BM "BM"
BN "BN"
BO "BO"
BQ "BQ"
BR "BR"
BS "BS"
BT "BT"
BV "BV"
BW "BW"
BY "BY"
BZ "BZ"
CA "CA"
CC "CC"
CD "CD"
CF "CF"
CG "CG"
CH "CH"
CI "CI"
CK "CK"
CL "CL"
CM "CM"
CN "CN"
CO "CO"
CR "CR"
CU "CU"
CV "CV"
CW "CW"
CX "CX"
CY "CY"
CZ "CZ"
DE "DE"
DJ "DJ"
DK "DK"
DM "DM"
DO "DO"
DZ "DZ"
EC "EC"
EE "EE"
EG "EG"
EH "EH"
ER "ER"
ES "ES"
ET "ET"
FI "FI"
FJ "FJ"
FK "FK"
FM "FM"
FO "FO"
FR "FR"
GA "GA"
GB "GB"
GD "GD"
GE "GE"
GF "GF"
GG "GG"
GH "GH"
GI "GI"
GL "GL"
GM "GM"
GN "GN"
GP "GP"
GQ "GQ"
GR "GR"
GS "GS"
GT "GT"
GU "GU"
GW "GW"
GY "GY"
HK "HK"
HM "HM"
HN "HN"
HR "HR"
HT "HT"
HU "HU"
ID "ID"
IE "IE"
IL "IL"
IM "IM"
IN "IN"
IO "IO"
IQ "IQ"
IR "IR"
IS "IS"
IT "IT"
JE "JE"
JM "JM"
JO "JO"
JP "JP"
KE "KE"
KG "KG"
KH "KH"
KI "KI"
KM "KM"
KN "KN"
KP "KP"
KR "KR"
KW "KW"
KY "KY"
KZ "KZ"
LA "LA"
LB "LB"
LC "LC"
LI "LI"
LK "LK"
LR "LR"
LS "LS"
LT "LT"
LU "LU"
LV "LV"
LY "LY"
MA "MA"
MC "MC"
MD "MD"
ME "ME"
MF "MF"
MG "MG"
MH "MH"
MK "MK"
ML "ML"
MM "MM"
MN "MN"
MO "MO"
MP "MP"
MQ "MQ"
MR "MR"
MS "MS"
MT "MT"
MU "MU"
MV "MV"
MW "MW"
MX "MX"
MY "MY"
MZ "MZ"
NA "NA"
NC "NC"
NE "NE"
NF "NF"
NG "NG"
NI "NI"
NL "NL"
NO "NO"
NP "NP"
NR "NR"
NU "NU"
NZ "NZ"
OM "OM"
PA "PA"
PE "PE"
PF "PF"
PG "PG"
PH "PH"
PK "PK"
PL "PL"
PM "PM"
PN "PN"
PR "PR"
PS "PS"
PT "PT"
PW "PW"
PY "PY"
QA "QA"
RE "RE"
RO "RO"
RS "RS"
RU "RU"
RW "RW"
SA "SA"
SB "SB"
SC "SC"
SD "SD"
SE "SE"
SG "SG"
SH "SH"
SI "SI"
SJ "SJ"
SK "SK"
SL "SL"
SM "SM"
SN "SN"
SO "SO"
SR "SR"
SS "SS"
ST "ST"
SV "SV"
SX "SX"
SY "SY"
SZ "SZ"
TC "TC"
TD "TD"
TF "TF"
TG "TG"
TH "TH"
TJ "TJ"
TK "TK"
TL "TL"
TM "TM"
TN "TN"
TO "TO"
TR "TR"
TT "TT"
TV "TV"
TW "TW"
TZ "TZ"
UA "UA"
UG "UG"
UM "UM"
US "US"
UY "UY"
UZ "UZ"
VA "VA"
VC "VC"
VE "VE"
VG "VG"
VI "VI"
VN "VN"
VU "VU"
WF "WF"
WS "WS"
YE "YE"
YT "YT"
ZA "ZA"
ZM "ZM"
ZW "ZW"

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