ex_checkout v1.5.2

View Source ExCheckout.Shipment (ex_checkout v1.5.2)

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 ExCheckout.

Shipments are created by shipment/3.

Link to this section Summary

Types

t()

Functions

new(from, to, package, opts \\ [])

Builds a Shipment.

new!(from, to, package, opts \\ [])

Builds a Shipment. Raises on failure.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %ExCheckout.Shipment{
  from: ExCheckout.Address.t(),
  id: any(),
  package: ExCheckout.Package.t(),
  ship_date: any(),
  to: ExCheckout.Address.t()
}

Link to this section Functions

Link to this function

new(from, to, package, opts \\ [])

View Source 
@spec new(
  ExCheckout.Address.t(),
  ExCheckout.Address.t(),
  ExCheckout.Package.t(),
  Keyword.t()
) ::
  {:ok, t()}

Builds a Shipment.

Link to this function

new!(from, to, package, opts \\ [])

View Source 
@spec new!(
  ExCheckout.Address.t(),
  ExCheckout.Address.t(),
  ExCheckout.Package.t(),
  Keyword.t()
) ::
  t() | none()

Builds a Shipment. Raises on failure.