Struct shippo::Shippo

pub struct Shippo { /* fields omitted */ }

Entrypoint for interacting with the Shippo API.

Implementations

impl Shippo

pub fn new<K>(token: K) -> Self where
    K: ToString, 

Create a new Shippo client struct. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API Token your requests will work.

pub fn new_from_env() -> Self

Create a new Shippo client struct from environment variables. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API Token and your requests will work.

pub async fn list_shipments(&self) -> Result<Vec<Shipment>, APIError>

List shipments. FROM: https://goshippo.com/docs/reference#shipments-list A maximum date range of 90 days is permitted. Provided dates should be ISO 8601 UTC dates.

pub async fn create_shipment(
    &self,
    ns: NewShipment
) -> Result<Shipment, APIError>

Create a shipment. FROM: https://goshippo.com/docs/reference#shipments-create

pub async fn list_carrier_accounts(
    &self
) -> Result<Vec<CarrierAccount>, APIError>

List the carrier accounts. FROM: https://goshippo.com/docs/reference#carrier-accounts

pub async fn get_shipment(&self, id: &str) -> Result<Shipment, APIError>

Get a shipment. FROM: https://goshippo.com/docs/reference#shipments-retrieve

pub async fn create_pickup(&self, np: &NewPickup) -> Result<Pickup, APIError>

Create a pickup. FROM: https://goshippo.com/docs/reference#pickups-create

pub async fn create_customs_item(
    &self,
    c: CustomsItem
) -> Result<CustomsItem, APIError>

Create a customs item. FROM: https://goshippo.com/docs/reference#customs-items-create

pub async fn create_shipping_label_from_rate(
    &self,
    nt: NewTransaction
) -> Result<Transaction, APIError>

Create a shipping label based on a rate. FROM: https://goshippo.com/docs/reference#transactions-create

pub async fn get_shipping_label(
    &self,
    id: &str
) -> Result<Transaction, APIError>

Get a shipping label. FROM: https://goshippo.com/docs/reference#transactions-retrieve

pub async fn list_shipping_labels(&self) -> Result<Vec<Transaction>, APIError>

List shiping labels. FROM: https://goshippo.com/docs/reference#transactions-list

pub async fn register_tracking_webhook(
    &self,
    carrier: &str,
    tracking_number: &str
) -> Result<TrackingStatus, APIError>

Register a tracking webhook. You can register your webhook(s) for a Shipment (and request the current status at the same time) by POSTing to the tracking endpoint. This way Shippo will send HTTP notifications to your track_updated webhook(s) whenever the status changes. FROM: https://goshippo.com/docs/reference#tracks-create

pub async fn get_tracking_status(
    &self,
    carrier: &str,
    tracking_number: &str
) -> Result<TrackingStatus, APIError>

Request the tracking status of a shipment by sending a GET request. FROM: https://goshippo.com/docs/reference#tracks-retrieve