shippex v0.2.0 Shippex.Service

A Service represents a carrier’s offered shipping speeds. This is not initialized by the user directly. However, some convenience functions exist to display all offered carrier services to the user.

iex> Shippex.Service.services_for_carrier(:ups)
[
  %Shippex.Service{carrier: carrier, code: "01", description: "UPS Next Day Air"},
  %Shippex.Service{carrier: carrier, code: "02", description: "UPS 2nd Day Air"},
  %Shippex.Service{carrier: carrier, code: "12", description: "UPS 3 Day Select"},
  %Shippex.Service{carrier: carrier, code: "03", description: "UPS Ground"}
]

Summary

Types

t()

Functions

all()

Returns all services from all supported carriers

by_carrier_and_code(carrier, code)

Returns a service from a carrier by its code, if it exists. Otherwise, returns nil

services_for_carrier(carrier)

Returns all services for carrier

Types

t()

t() :: %Shippex.Service{carrier: term, code: term, description: term}

Functions

all()

Returns all services from all supported carriers.

by_carrier_and_code(carrier, code)

Returns a service from a carrier by its code, if it exists. Otherwise, returns nil.

iex> Shippex.Service.by_carrier_and_code(:ups, "01")
%Shippex.Service{carrier: carrier, code: "01", description: "UPS Next Day Air"},
iex> Shippex.Service.by_carrier_and_code(:ups, "999999999")
nil

services_for_carrier(carrier)

Returns all services for carrier.

Shippex.Service.services_for_carrier(:ups)