speakeasy-playground/docs/models/components/addresscreaterequest.md

AddressCreateRequest

Address represents the address as retrieved from the database

Fields

Field	Type	Required	Description	Example
country	str	✔️	Example: US or DE. All accepted values can be found on the Official ISO Website. Sending a country is always required.	US
name	Optional[str]	➖	required for purchase First and Last Name of the addressee	Shwan Ippotle
company	Optional[str]	➖	Company Name	Shippo
street1	Optional[str]	➖	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[str]	➖	Second street line, 35 character limit.
street3	Optional[str]	➖	Third street line, 35 character limit. Only accepted for USPS international shipments, UPS domestic and UPS international shipments.
street_no	Optional[str]	➖	Street number of the addressed building. This field can be included in street1 for all carriers except for DHL Germany.
city	Optional[str]	➖	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[str]	➖	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[str]	➖	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
phone	Optional[str]	➖	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[str]	➖	E-mail address of the contact person, RFC3696/5321-compliant.	shippotle@shippo.com
is_residential	Optional[bool]	➖	N/A	true
metadata	Optional[str]	➖	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
latitude	Optional[float]	➖	Latitude of address
longitude	Optional[float]	➖	Longitude of address
validate	Optional[bool]	➖	Set to true to validate Address object.	true