Name | Description | Type | Additional information |
---|---|---|---|
PersonName |
(Optional) Mandatory if the CompanyName is not present |
string |
None. |
CompanyName |
(Optional) Mandatory if the PersonName is not present |
string |
None. |
Country |
(Mandatory) The country Code (ex: US, CA, GB etc) |
string |
None. |
State |
(Mandatory) Country Province/State (for Canada(CA) - ON, AB... for United States(US) - NY... for other countries can use more letters!) |
string |
None. |
City |
(Optional) mandatory for some carriers |
string |
None. |
PostalCode |
(Mandatory) Postal/Zip |
string |
None. |
Address1 |
(Mandatory) The Address line 1 |
string |
None. |
Address2 |
(Optional) The Address line 2 |
string |
None. |
Telephone |
(Mandatory) The Telephone |
string |
None. |
(Optional) The Email |
string |
None. |
|
IsResidential |
(Optional) if the address Is Residential |
boolean |
None. |
StreetNumber |
(Mandatory if the shipping carrier is Purolator (9 or 11) Street Number (Numeric value) |
string |
None. |
StreetType |
(Mandatory if the shipping carrier is Purolator (9 or 11) Street Type(Valid values are: Abbey, End, Montéé, Village, Acres, Esplanade, Mount, Villas, Allée, Estates, Mountain, Vista, Alley, Expressway, Parade, Voie, Autoroute, Extension, Parc, Walk, avenue, Field, Park, Way, Avenue, Forest, Parkway, Wharf, Bay, Freeway, Passage, Wood, Beach, Front, Path, Wynd, Bend, Gardens, Pathway, Boulevard, Gate, Pines, Branch, Glade, Place, By-pass, Glen, Plateau, Campus, Green, Plaza, Cape, Grounds, Point, Carré, Grove, Pointe, Carrefour, Harbour, Port, Centre, Heath, Private, Cercle, Height, Promenade, Chase, Heights, Quai, Chemin, Highlands, Quay, Circle, Highway, Ramp, Circuit, Hill, Rang, Close, Hollow, Ridge, Common, Île, Rise, Concession, Impasse, Road, Corners, Inlet, Route, Côte, Island, Row, Cour, Key, Rue, Cours, Knoll, Ruelle, Court, Landing, Run, Cove, Lane, Sentier, Crest, Limits, Square, Crescent, Line, Street, Croissant, Link, Subdivision, Crossing, Lookout, Terrace, Cul-de-sac, Loop, Terrasse, Dale, Mall, Townline, Dell, Manor, Trail, Diversion, Maze, Turnabout, Downs, Meadow, Vale, Drive, Mews, View |
string |
None. |