CanadaPostAddressDetail Type

Represents the address details of a sender or recipient.

Remarks

This type contains descriptive data of physical location of a sender or recipient.

Example: Setting the fields of a sender

SenderAddress addr = new SenderAddress 
addr.Address1 = "1425 James St"
addr.Address2 = "PO Box 4001 Stn A"
addr.City = "Victoria"
addr.Province = "BC"
addr.PostalCode = "V8X3X4"
addr.CountryCode = "CA"

The fields contained by this type are listed below.

Fields

Address1
String

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address.

Maximum Length: 44 characters

Address2
String

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional.

Maximum Length: 44 characters

City
String

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

CountryCode
String

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered.


Country Name	Country Code
Afghanistan	AF
Albania	AL
American Samoa	AS
Andorra	AD
Angola	AO
Anguilla	AI
Antigua	AG
Argentina	AR
Armenia	AM
Aruba	AW
Australia	AU
Austria	AT
Azerbaijan	AZ
Bahamas	BS
Bahrain	BH
Bangladesh	BD
Barbados	BB
Barbuda	AG
Belarus	BY
Belgium	BE
Belize	BZ
Benin	BJ
Bermuda	BM
Bhutan	BT
Bolivia	BO
Bonaire	AN
Bosnia-Herzegovina	BA
Botswana	BW
Brazil	BR
British Virgin Islands	VG
Brunei	BN
Bulgaria	BG
Burkina Faso	BF
Burundi	BI
Cambodia	KH
Cameroon	CM
Canada	CA
Canary Islands	ES
Cape Verde	CV
Cayman Islands	KY
Chad	TD
Channel Islands	GB
Chile	CL
China	CN
Colombia	CO
Congo	CG
Congo Dem. Rep. Of	CD
Cook Islands	CK
Costa Rica	CR
Croatia	HR
Curacao	AN
Cyprus	CY
Czech Republic	CZ
Denmark	DK
Djibouti	DJ
Dominica	DM
Dominican Republic	DO
East Timor	TL
Ecuador	EC
Egypt	EG
El Salvador	SV
England	GB
Equatorial Guinea	GQ
Eritrea	ER
Estonia	EE
Ethiopia	ET
Faeroe Islands	FO
Fiji	FJ
Finland	FI
France	FR
French Guiana	GF
French Polynesia	PF
Gabon	GA
Gambia	GM
Georgia	GE
Germany	DE
Ghana	GH
Gibraltar	GI
Grand Cayman	KY
Great Britain	GB
Great Thatch Island	VG
Great Tobago Islands	VG
Greece	GR
Greenland	GL
Grenada	GD
Guadeloupe	GP
Guam	GU
Guatemala	GT
Guinea	GN
Guyana	GY
Haiti	HT
Holland	NL
Honduras	HN
Hong Kong	HK
Hungary	HU
Iceland	IS
India	IN
Indonesia	ID
Iraq	IQ
Ireland	IE
Israel	IL
Italy	IT
Ivory Coast	CI
Jamaica	JM
Japan	JP
Jordan	JO
Jost Van Dyke Islands	VG
Kazakhstan	KZ
Kenya	KE
Kuwait	KW
Kyrgyzstan	KG
Laos	LA
Latvia	LV
Lebanon	LB
Lesotho	LS
Liberia	LR
Liechtenstein	LI
Lithuania	LT
Luxembourg	LU
Macau	MO
Macedonia	MK
Madagascar	MG
Malawi	MW
Malaysia	MY
Maldives	MV
Mali	ML
Malta	MT
Marshall Islands	MH
Martinique	MQ
Mauritania	MR
Mauritius	MU
Mexico	MX
Micronesia	FM
Moldova	MD
Monaco	MC
Mongolia	MN
Montserrat	MS
Morocco	MA
Mozambique	MZ
Namibia	NA
Nepal	NP
Netherlands	NL
Netherlands Antilles	AN
New Caledonia	NC
New Zealand	NZ
Nicaragua	NI
Niger	NE
Nigeria	NG
Norman Island	VG
Northern Ireland	GB
Northern Mariana Islands	MP
Norway	NO
Oman	OM
Pakistan	PK
Palau	PW
Palestine	PS
Panama	PA
Papua New Guinea	PG
Paraguay	PY
Peru	PE
Philippines	PH
Poland	PL
Portugal	PT
Puerto Rico	PR
Qatar	QA
Reunion	RE
Romania	RO
Rota	MP
Russia	RU
Rwanda	RW
Saba	AN
Saipan	MP
Samoa	WS
San Marino	IT
Saudi Arabia	SA
Scotland	GB
Senegal	SN
Serbia & Montenegro	CS
Seychelles	SC
Singapore	SG
Slovak Republic	SK
Slovenia	SI
South Africa	ZA
South Korea	KR
Spain	ES
Sri Lanka	LK
St. Barthelemy	GP
St. Christopher	KN
St. Croix Island	VI
St. Eustatius	AN
St. John	VI
St. Kitts and Nevis	KN
St. Lucia	LC
St. Maarten	AN
St. Thomas	VI
St. Vincent	VC
Suriname	SR
Swaziland	SZ
Sweden	SE
Switzerland	CH
Tahiti	PF
Taiwan	TW
Tanzania	TZ
Thailand	TH
Tinian	MP
Togo	TG
Tonga	TO
Tortola Island	VG
Trinidad & Tobago	TT
Tunisia	TN
Turkey	TR
Turkmenistan	TM
Turks & Caicos Islands	TC
U.S. Virgin Islands	VI
Uganda	UG
Ukraine	UA
Union Island	VC
United Arab Emirates	AE
United Kingdom	GB
United States	US
Uruguay	UY
Uzbekistan	UZ
Vanuatu	VU
Vatican City	IT
Venezuela	VE
Vietnam	VN
Wales	GB
Wallis & Futuna Islands	WF
Yemen	YE
Zambia	ZM
Zimbabwe	ZW

PostalCode
String

This is identifies of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country. The format for Canadian postal codes is A9A9A9.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both City and Province are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 14.

Province
String

Province or state code. This is the identifying abbreviation for Canada province, US state, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

This is required when CountryCode is either CA or US.

Constructors

public CanadaPostAddressDetail();