Address.md

Address

Address represents the address as retrieved from the database

Fields

Field	Type	Required	Description	Example
name	Optional<String>	➖	required for purchase First and Last Name of the addressee	Shwan Ippotle
company	Optional<String>	➖	Company Name	Shippo
street1	Optional<String>	➖	required for purchase First street line, 35 character limit. Usually street number and street name (except for DHL Germany, see street_no).	215 Clayton St.
street2	Optional<String>	➖	Second street line, 35 character limit.
street3	Optional<String>	➖	Third street line, 35 character limit. Only accepted for USPS international shipments, UPS domestic and UPS international shipments.
streetNo	Optional<String>	➖	Street number of the addressed building. This field can be included in street1 for all carriers except for DHL Germany.
city	Optional<String>	➖	required for purchase Name of a city. When creating a Quote Address, sending a city is optional but will yield more accurate Rates. Please bear in mind that city names may be ambiguous (there are 34 Springfields in the US). Pass in a state or a ZIP code (see below), if known, it will yield more accurate results.	San Francisco
state	Optional<String>	➖	required for purchase for some countries State/Province values are required for shipments from/to the US, AU, and CA. UPS requires province for some countries (i.e Ireland). To receive more accurate quotes, passing this field is recommended. Most carriers only accept two or three character state abbreviations.	CA
zip	Optional<String>	➖	required for purchase Postal code of an Address. When creating a Quote Addresses, sending a ZIP is optional but will yield more accurate Rates.	94117
country	String	✔️	ISO 3166-1 alpha-2 country codes and country names can be used. For most consistent results, we reccomend using country codes like US or DE. If using country names, please ensure they are spelled correctly and in English. Country names are converted to country codes. Refer to this guide for a list of country codes. Sending a country is always required.	US
phone	Optional<String>	➖	Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This increases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped.	+1 555 341 9393
email	Optional<String>	➖	E-mail address of the contact person, RFC3696/5321-compliant.	[email protected]
isResidential	Optional<Boolean>	➖	N/A	true
metadata	Optional<String>	➖	A string of up to 100 characters that can be filled with any additional information you want to attach to the object.	Customer ID 123456
isComplete	Optional<Boolean>	➖	Complete addresses contain all required values. Incomplete addresses have failed one or multiple validations. Incomplete Addresses are eligible for requesting rates but lack at least one required value for purchasing labels.	true
latitude	Optional<Latitude>	➖	Latitude of address
longitude	Optional<Longitude>	➖	Longitude of address
objectCreated	OffsetDateTime	➖	Date and time of Address creation.	2014-07-09T02:19:13.174Z
objectId	Optional<String>	➖	Unique identifier of the given Address object. This ID is required to create a Shipment object.	d799c2679e644279b59fe661ac8fa488
objectOwner	Optional<String>	➖	Username of the user who created the Address object.	[email protected]
objectUpdated	OffsetDateTime	➖	Date and time of last Address update. Since you cannot update Addresses after they were created, this time stamp reflects the time when the Address was changed by Shippo's systems for the last time, e.g., during the approximation of one or more values.	2014-07-09T02:19:13.174Z
validationResults	Optional<AddressValidationResults>	➖	Object that contains information regarding if an address had been validated or not. Also contains any messages generated during validation. Children keys are is_valid(boolean) and messages(array).
test	Optional<Boolean>	➖	Indicates whether the object has been created in test mode.	false