shippex v0.6.8 Shippex.Shipment

A Shipment represents everything needed to fetch rates from carriers: an origin, a destination, and a package description. An optional :id field is provided in the struct, which may be used by the end user to represent the user’s internal identifier for the shipment. The id is not used by Shippex.

Shipments are created by shipment/3.

Link to this section Summary

Link to this section Types

Link to this type t()
t() :: %Shippex.Shipment{from: term, id: term, international?: term, package: term, ship_date: term, to: term}

Link to this section Functions

Link to this function shipment(from, to, package, opts \\ [])

Builds a Shipment.