Address

Specifies the full legal address of a business or person, including street, house number, zip code, city, and country for a shipment.

Property	Type	Description
AddressProperties	required
`address2`	string	Address2 address field. `\A[[:alnum:] .,&'\-]+\z` length 1...255
`business_name`	string	Name of business for address. If this name is supplied, it will indicate that the address type is business. If left empty, it indicates that the address type is a consumer. `\A[[:alnum:] .,&!'\-]+\z` length 1...255
`city`	string	City of address. required `\A[[:alnum:] .,&'\-]+\z` length 2...30
`country_code`	string	ISO country code. required `\A[A-Z]{2}\z` length 2...2
`email_address`	string	Email address compatible with RFC 5322. `\A[\w+\-\.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z` length 3...320
`eori_number`	string	Economic Operators Registration and Identification number that is required by businesses to ship internationally. length 3...17
`family_name`	string	Also known as last name. Refers to the name of the contact person to whom the address belongs. `\A[[:alnum:] -]+\z` length 1...30
`given_name`	string	Also known as first name. Refers to the personal name of the contact person to whom the address belongs. `\A[[:alnum:] -]+\z` length 1...30
`house_number`	string	House number in an address. May also contain house number extensions. `\A[[:alnum:] \-]+\z` length 1...14
`id`	string	Unique ID for an address. Can be a ID of an existing sender_address or a unique ID of a parcelshop. In all other cases this ID is empty. length 1...64
`phone_number`	string	Phone number that may consist of a country code. `\A[[:digit:] \-+()]+\z` length 2...30
`state_code`	string	State code for an address. The state code should be applicable for the country. So NY (New York) for country_code US (United States) or YT (Yukon) for country_code CA (Canada) `\A[A-Z]{2,3}\z` length 2...3
`street_name`	string	Street name is an identifying name given to a street or road. required `\A[[:alnum:] .,&'\-]+\z` length 2...55
`vat`	string	Value-added tax identification number or VAT identification number (VATIN). nullable length 3...14
`zip_code`	string	The zipcode of an address. required `\A[[:alnum:] -]+\z` length 1...10
object	required
`type`	string	one of: consumer business