Struct shippo::Transaction

pub struct Transaction {

    pub object_id: String,
    pub object_created: DateTime<Utc>,
    pub object_updated: Option<DateTime<Utc>>,
    pub object_owner: String,
    pub status: String,
    pub object_state: String,
    pub rate: String,
    pub metadata: String,
    pub label_file_type: String,
    pub tracking_number: String,
    pub tracking_status: String,
    pub tracking_url_provider: String,
    pub eta: Option<DateTime<Utc>>,
    pub label_url: String,
    pub commercial_invoice_url: String,
    pub messages: Vec<Message>,
    pub qr_code_url: String,
    pub test: bool,
}

The data type for a transaction. A transaction is the purchase of a shipping label from a shipping provider for a specific service. FROM: https://goshippo.com/docs/reference#transactions

Fields

object_id: String

Unique identifier of the given Transaction object.

object_created: DateTime<Utc>

Date and time of Transaction creation.

object_updated: Option<DateTime<Utc>>

Date and time of last Transaction update.

object_owner: String

Username of the user who created the Transaction object.

status: String

Indicates the status of the Transaction. “WAITING” | “QUEUED” | “SUCCESS” | “ERROR” | “REFUNDED” | “REFUNDPENDING” | “REFUNDREJECTED”

object_state: String

Indicates the validity of the Transaction object based on the given data, regardless of what the corresponding carrier returns. “VALID” | “INVALID”

rate: String

ID of the Rate object for which a Label has to be obtained. Please note that only rates that are not older than 7 days can be purchased in order to ensure up-to-date pricing.

metadata: String

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

label_file_type: String

Specify the label file format for this label. If you don’t specify this value, the API will default to your default file format that you can set on the settings page. “PNG” | “PNG_2.3x7.5” | “PDF” | “PDF_2.3x7.5” | “PDF_4x6” | “PDF_4x8” | “PDF_A4” | “PDF_A6” “ZPLII”

tracking_number: String

The carrier-specific tracking number that can be used to track the Shipment. A value will only be returned if the Rate is for a trackable Shipment and if the Transactions has been processed successfully.

tracking_status: String

Indicates the high level status of the shipment: ‘UNKNOWN’, ‘DELIVERED’, ‘TRANSIT’, ‘FAILURE’, ‘RETURNED’.

tracking_url_provider: String

A link to track this item on the carrier-provided tracking website. A value will only be returned if tracking is available and the carrier provides such a service.

eta: Option<DateTime<Utc>>

The estimated time of arrival according to the carrier.

label_url: String

A URL pointing directly to the label in the format you’ve set in your settings. A value will only be returned if the Transactions has been processed successfully.

commercial_invoice_url: String

A URL pointing to the commercial invoice as a 8.5x11 inch PDF file. A value will only be returned if the Transactions has been processed successfully and if the shipment is international.

messages: Vec<Message>

An array containing elements of the following schema:

• “code” (string): an identifier for the corresponding message (not always available“)
• “message” (string): a publishable message containing further information.

qr_code_url: String

A URL pointing directly to the QR code in PNG format. A value will only be returned if requested using qr_code_requested flag and the carrier provides such an option.

test: bool

Indicates whether the object has been created in test mode.

Trait Implementations

impl Clone for Transaction

fn clone(&self) -> Transaction

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Transaction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Transaction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Transaction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.