README.md

Shippex

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.

As of now, only UPS and USPS are supported. More carrier support will come in the future. Units of measurement are mostly hardcoded to inches and miles.

Installation

Add shippex to your list of dependencies in mix.exs:

def deps do
  [{:shippex, "~> 0.18"}]
end

Ensure shippex is started before your application:

def application do
  [applications: [:shippex]]
end

Configuration

config :shippex,
  env: :dev,
  distance_unit: :in, # either :in or :cm
  weight_unit: :lbs, # either :lbs or :kg
  currency: :usd, # :usd, :can, :mxn, :eur
  carriers: [
    ups: [
      username: "MyUsername",
      password: "MyPassword",
      secret_key: "123123",
      shipper: %{
        account_number: "AB1234",
        name: "My Company",
        phone: "123-456-7890",
        address: "1234 Foo St",
        city: "Foo",
        state: "TX",
        postal_code: "78999"
      }
    ],
    usps: [
      username: "MyUsername",
      password: "MyPassword"
    ]
  ]

Usage

# Create origin/destination addresses.
origin = Shippex.Address.new(%{
  name: "Earl G",
  phone: "123-123-1234",
  address: "9999 Hobby Lane",
  address_line_2: nil,
  city: "Austin",
  state: "TX",
  postal_code: "78703"
})

destination = Shippex.Address.new(%{
  name: "Bar Baz",
  phone: "123-123-1234",
  address: "1234 Foo Blvd",
  address_line_2: nil,
  city: "Plano",
  state: "TX",
  postal_code: "75074",
  country: "US" # optional
})

# Create a package. Currently only inches and pounds (lbs) supported.
package = Shippex.Package.new(%{
  length: 8,
  width: 8,
  height: 4,
  weight: 5,
  description: "Headphones",
  monetary_value: 20 # optional
})

# Link the origin, destination, and package with a shipment.
shipment = Shippex.Shipment.new(origin, destination, package)

# Fetch rates to present to the user.
rates = Shippex.fetch_rates(shipment, carriers: :usps)

# Accept one of the services and print the label
{:ok, rate} = Enum.shuffle(rates) |> hd

# Fetch the label. Includes the tracking number and a gif image of the label.
{:ok, transaction} = Shippex.create_transaction(shipment, rate.service)

rate = transaction.rate
label = transaction.label

# Print the price.
IO.puts(rate.price)

# Write the label to disk.
File.write!("#{label.tracking_number}.#{label.format}", Base.decode64!(label.image))

TODO:

Carrier support:

• UPS
• USPS
• FedEx