API Reference shippex v0.15.0
Modules
Represents an address that can be passed to other Shippex
functions. Do
not initialize this struct directly. Instead, use address/1
.
Defines a behaviour for implementing a new Carrier module. Includes a helper function for fetching the Carrier module.
Defines a struct for storing an Item
in a Package
.
Defines the struct for storing a returned Rate
, along with the tracking
number, base64-encoded image and its format.
Defines the struct for storing a Package
, which is then passed along with
an origin and destination address for shipping estimates. A description
is
optional, as it may or may not be used with various carriers.
A Rate
is a representation of a price estimate from a given carrier for a
Service
, which is typically selected by the end user for a desired shipping
speed.
A Service
represents a carrier's offered shipping option. This is not
initialized by the user directly. However, some convenience functions exist
to display all offered carrier services to the user.
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.
Defines a struct that represents billable transactions with carriers.