API Reference usps_ex v2023.1.27

modules

Modules

Documentation for UspsEx.

Represents an address that can be passed to other UspsEx functions. Do not initialize this struct directly. Instead, use address/1.

This is a module that holds insurance related functions

Defines a struct for storing an UspsEx in a Package.

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 for a Service, which is typically selected by the end user for a desired shipping speed.

A Service represents a shipping option.

A Shipment represents everything needed to fetch rates from carriers: an origin, a destination, and a list of packages. 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 UspsEx.

Defines a struct that represents billable transactions with carriers.

Utils for UspsEx.