usps v0.1.0 Usps.Shipment View Source

Get tracking information about a shipment

Link to this section Summary

Types

event()

shipment()

Functions

track(number)

Passing a list of tracking numbers to track/1 to track multiple shipments.

Link to this section Types

event()

event() :: %{
  name: nil | binary(),
  time: nil | binary(),
  date: nil | binary(),
  city: nil | binary(),
  state: nil | binary(),
  zip: nil | binary()
}

shipment()

shipment() :: %{
  number: nil | binary(),
  status: nil | binary(),
  category: nil | binary(),
  class: nil | binary(),
  destination_city: nil | binary(),
  origin_city: nil | binary(),
  origin_state: nil | binary(),
  origin_zip: nil | binary(),
  destination_state: nil | binary(),
  destination_zip: nil | binary(),
  on_time: nil | binary(),
  estimated_delivery_date: nil | binary(),
  summary: nil | binary(),
  events: [event()]
}

Link to this section Functions

track(number)

track(number :: binary()) :: Usps.Operation.t()

track(numbers :: [binary()]) :: Usps.Operation.t()

Passing a list of tracking numbers to track/1 to track multiple shipments.