# AddressCreateRequest

Address represents the address as retrieved from the database


## Fields

| Field                                                                                                                                                                                                                                                                                                                               | Type                                                                                                                                                                                                                                                                                                                                | Required                                                                                                                                                                                                                                                                                                                            | Description                                                                                                                                                                                                                                                                                                                         | Example                                                                                                                                                                                                                                                                                                                             |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `country`                                                                                                                                                                                                                                                                                                                           | *str*                                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                  | Example: `US` or `DE`. All accepted values can be found on the <br/><a href="http://www.iso.org/" target="blank">Official ISO Website</a>.<br/>Sending a country is always required.                                                                                                                                                | US                                                                                                                                                                                                                                                                                                                                  |
| `name`                                                                                                                                                                                                                                                                                                                              | *Optional[str]*                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | **required for purchase**<br><br/>First and Last Name of the addressee                                                                                                                                                                                                                                                              | Shwan Ippotle                                                                                                                                                                                                                                                                                                                       |
| `company`                                                                                                                                                                                                                                                                                                                           | *Optional[str]*                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | Company Name                                                                                                                                                                                                                                                                                                                        | Shippo                                                                                                                                                                                                                                                                                                                              |
| `street1`                                                                                                                                                                                                                                                                                                                           | *Optional[str]*                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | **required for purchase**<br><br/>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]*                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | Second street line, 35 character limit.                                                                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                                                                                                     |
| `street3`                                                                                                                                                                                                                                                                                                                           | *Optional[str]*                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | Third street line, 35 character limit. <br/>Only accepted for USPS international shipments, UPS domestic and UPS international shipments.                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                     |
| `street_no`                                                                                                                                                                                                                                                                                                                         | *Optional[str]*                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | Street number of the addressed building. <br/>This field can be included in street1 for all carriers except for DHL Germany.                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                                                                                     |
| `city`                                                                                                                                                                                                                                                                                                                              | *Optional[str]*                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | **required for purchase**<br><br/>Name of a city. When creating a Quote Address, sending a city is optional but will yield more accurate Rates. <br/>Please bear in mind that city names may be ambiguous (there are 34 Springfields in the US). Pass in a state <br/>or a ZIP code (see below), if known, it will yield more accurate results. | San Francisco                                                                                                                                                                                                                                                                                                                       |
| `state`                                                                                                                                                                                                                                                                                                                             | *Optional[str]*                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | **required for purchase for some countries**<br><br/>State/Province values are required for shipments from/to the US, AU, and CA. UPS requires province for some <br/>countries (i.e Ireland). To receive more accurate quotes, passing this field is recommended. Most carriers <br/>only accept two or three character state abbreviations. | CA                                                                                                                                                                                                                                                                                                                                  |
| `zip`                                                                                                                                                                                                                                                                                                                               | *Optional[str]*                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | **required for purchase**<br><br/>Postal code of an Address. When creating a Quote Addresses, sending a ZIP is optional but will yield more <br/>accurate Rates.                                                                                                                                                                    | 94117                                                                                                                                                                                                                                                                                                                               |
| `phone`                                                                                                                                                                                                                                                                                                                             | *Optional[str]*                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This <br/>increases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped.                                                                                                        | +1 555 341 9393                                                                                                                                                                                                                                                                                                                     |
| `email`                                                                                                                                                                                                                                                                                                                             | *Optional[str]*                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | E-mail address of the contact person, RFC3696/5321-compliant.                                                                                                                                                                                                                                                                       | shippotle@shippo.com                                                                                                                                                                                                                                                                                                                |
| `is_residential`                                                                                                                                                                                                                                                                                                                    | *Optional[bool]*                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                 | true                                                                                                                                                                                                                                                                                                                                |
| `metadata`                                                                                                                                                                                                                                                                                                                          | *Optional[str]*                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | A string of up to 100 characters that can be filled with any additional information you want <br/>to attach to the object.                                                                                                                                                                                                          | Customer ID 123456                                                                                                                                                                                                                                                                                                                  |
| `latitude`                                                                                                                                                                                                                                                                                                                          | *Optional[float]*                                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | Latitude of address                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                     |
| `longitude`                                                                                                                                                                                                                                                                                                                         | *Optional[float]*                                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | Longitude of address                                                                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                                                                                                                     |
| `validate`                                                                                                                                                                                                                                                                                                                          | *Optional[bool]*                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                  | Set to true to validate Address object.                                                                                                                                                                                                                                                                                             | true                                                                                                                                                                                                                                                                                                                                |