shippex v0.18.0

Shippex.Label (shippex v0.18.0) View Source

Defines the struct for storing a returned Rate, along with the tracking number, base64-encoded image and its format.

%Shippex.Label{rate: %Shippex.Rate{},
               tracking_number: "ABCDEF1234",
               format: :gif,
               image: "iVBORw0K..."}

Note that :image is always a pure base64 string, and doesn't contain common prefixes like "data:image/gif;base64," and so on.

Currently, UPS returns GIF labels, and USPS returns PDF labels.

Link to this section Summary

Types

t()

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %Shippex.Label{
  format: :gif | :pdf | :tif | :png,
  image: String.t(),
  tracking_number: String.t()
}