Struct shippo::Shippo [−][src]
pub struct Shippo { /* fields omitted */ }
Entrypoint for interacting with the Shippo API.
Implementations
impl Shippo
[src]
impl Shippo
[src]pub fn new<K>(token: K) -> Self where
K: ToString,
[src]
pub fn new<K>(token: K) -> Self where
K: ToString,
[src]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
[src]
pub fn new_from_env() -> Self
[src]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>
[src]
pub async fn list_shipments(&self) -> Result<Vec<Shipment>, APIError>
[src]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>
[src]
pub async fn create_shipment(
&self,
ns: NewShipment
) -> Result<Shipment, APIError>
[src]Create a shipment. FROM: https://goshippo.com/docs/reference#shipments-create
pub async fn get_shipment(&self, id: &str) -> Result<Shipment, APIError>
[src]
pub async fn get_shipment(&self, id: &str) -> Result<Shipment, APIError>
[src]Get a shipment. FROM: https://goshippo.com/docs/reference#shipments-retrieve
pub async fn create_pickup(&self, np: NewPickup) -> Result<Pickup, APIError>
[src]
pub async fn create_pickup(&self, np: NewPickup) -> Result<Pickup, APIError>
[src]Create a pickup. FROM: https://goshippo.com/docs/reference#pickups-create
pub async fn create_customs_item(
&self,
c: CustomsItem
) -> Result<CustomsItem, APIError>
[src]
pub async fn create_customs_item(
&self,
c: CustomsItem
) -> Result<CustomsItem, APIError>
[src]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>
[src]
pub async fn create_shipping_label_from_rate(
&self,
nt: NewTransaction
) -> Result<Transaction, APIError>
[src]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>
[src]
pub async fn get_shipping_label(
&self,
id: &str
) -> Result<Transaction, APIError>
[src]Get a shipping label. FROM: https://goshippo.com/docs/reference#transactions-retrieve
pub async fn list_shipping_labels(&self) -> Result<Vec<Transaction>, APIError>
[src]
pub async fn list_shipping_labels(&self) -> Result<Vec<Transaction>, APIError>
[src]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>
[src]
pub async fn register_tracking_webhook(
&self,
carrier: &str,
tracking_number: &str
) -> Result<TrackingStatus, APIError>
[src]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>
[src]
pub async fn get_tracking_status(
&self,
carrier: &str,
tracking_number: &str
) -> Result<TrackingStatus, APIError>
[src]Request the tracking status of a shipment by sending a GET request. FROM: https://goshippo.com/docs/reference#tracks-retrieve
Auto Trait Implementations
impl !RefUnwindSafe for Shippo
impl Send for Shippo
impl Sync for Shippo
impl Unpin for Shippo
impl !UnwindSafe for Shippo
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,