Struct shippo::Address [−][src]
pub struct Address {}Show fields
pub object_id: String, pub is_complete: bool, pub name: String, pub company: String, pub street1: String, pub street2: String, pub city: String, pub state: String, pub zip: String, pub country: String, pub phone: String, pub email: String, pub test: bool, pub validation_results: Option<ValidationResults>,
Expand description
The data type for an address. FROM: https://goshippo.com/docs/reference#addresses
Fields
object_id: String
Unique identifier of the given Address object. This ID is required to create a Shipment object.
is_complete: bool
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.
name: String
First and Last Name of the addressee
company: String
Company Name
street1: String
First street line, 35 character limit. Usually street number and street name (except for DHL Germany, see street_no).
street2: String
Second street line, 35 character limit.
city: String
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.
state: String
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.
zip: String
Postal code of an Address. When creating a Quote Addresses, sending a ZIP is optional but will yield more accurate Rates.
country: String
Example: ‘US’ or ‘DE’. All accepted values can be found on the Official ISO Website. Sending a country is always required.
phone: 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.
email: String
E-mail address of the contact person, RFC3696/5321-compliant.
test: bool
Indicates whether the object has been created in test mode.
validation_results: Option<ValidationResults>
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).
Implementations
Trait Implementations
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for Address
impl UnwindSafe for Address
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more