Packages

shippex

0.6.2
0.18.0 0.17.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.16 0.6.15 0.6.14 0.6.13 0.6.12 0.6.11 0.6.10 0.6.9 0.6.8 0.6.7 0.6.6 0.6.5 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0 0.5.3 0.5.2 0.5.1 0.5.0 0.4.5 0.4.4 0.4.3 0.4.2 0.4.1 0.4.0 0.3.1 0.3.0 0.2.0 0.1.1 0.1.0

Shippex is an abstraction of commonly used features in shipping with various carriers. It provides a (hopefully) pleasant API to work with carrier- provided web interfaces for fetching rates and printing shipping labels.

HexDocs

Current section

Files

Jump to
Readme
43 Versions
5 Dependencies
Dependants
Files
Activity
shippex lib shippex label.ex
Raw

lib/shippex/label.ex 

defmodule Shippex.Label do

  @moduledoc """

  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 TIFF labels.

  """



  @type t :: %__MODULE__{}



  @enforce_keys [:tracking_number, :format, :image]

  defstruct [:tracking_number, :format, :image]

end