Struct shippo::Pickup [−][src]
pub struct Pickup {}Show fields
pub object_id: String, pub object_created: DateTime<Utc>, pub object_updated: Option<DateTime<Utc>>, pub carrier_account: String, pub location: Location, pub transactions: Vec<String>, pub requested_start_time: DateTime<Utc>, pub requested_end_time: DateTime<Utc>, pub confirmed_start_time: Option<DateTime<Utc>>, pub confirmed_end_time: Option<DateTime<Utc>>, pub cancel_by_time: Option<DateTime<Utc>>, pub status: String, pub confirmation_code: String, pub timezone: String, pub messages: Option<Vec<Message>>, pub metadata: String, pub is_test: bool,
Expand description
The data type for a pickup. FROM: https://goshippo.com/docs/reference#pickups
Fields
object_id: String
Unique identifier of the given Pickup object.
object_created: DateTime<Utc>
Date and time of Pickup creation.
object_updated: Option<DateTime<Utc>>
Date and time of last Pickup update.
carrier_account: String
The object ID of your USPS or DHL Express carrier account. You can retrieve this from your Rate requests or our /carrier_accounts endpoint.
location: Location
Location where the parcel(s) will be picked up.
transactions: Vec<String>
The transaction(s) object ID(s) for the parcel(s) that need to be picked up.
requested_start_time: DateTime<Utc>
The earliest that you requested your parcels to be ready for pickup. Expressed in the timezone specified in the response.
requested_end_time: DateTime<Utc>
The latest that you requested your parcels to be available for pickup. Expressed in the timezone specified in the response.
confirmed_start_time: Option<DateTime<Utc>>
The earliest that your parcels will be ready for pickup, confirmed by the carrier. Expressed in the timezone specified in the response.
confirmed_end_time: Option<DateTime<Utc>>
The latest that your parcels will be available for pickup, confirmed by the carrier. Expressed in the timezone specified in the response.
cancel_by_time: Option<DateTime<Utc>>
The latest time to cancel a pickup. Expressed in the timezone specified in the response. To cancel a pickup, you will need to contact the carrier directly. The ability to cancel a pickup through Shippo may be released in future iterations.
status: String
Indicates the status of the pickup. “PENDING” | “CONFIRMED” | “ERROR” | “CANCELLED”
confirmation_code: String
Pickup’s confirmation code returned by the carrier. To edit or cancel a pickup, you will need to contact USPS or DHL Express directly and provide your confirmation_code.
timezone: String
The pickup time windows will be in the time zone specified here, not UTC.
messages: Option<Vec<Message>>
An array containing strings of any messages generated during validation.
metadata: String
A string of up to 100 characters that can be filled with any additional information you want to attach to the object.
is_test: bool
Indicates whether the object has been created in test mode.
Trait Implementations
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for Pickup
impl UnwindSafe for Pickup
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more