shippo v0.1.0 Shippo.Operation.Batch View Source

Shippo Batches

Link to this section Summary

Functions

Add batch shipments to an existing batch.

Creates a new batch object which allows you to purchase shipping labels for many shipments with one API call.

Retrieve an existing batch by object id.

Purchase an existing batch.

Remove batch shipments from an existing batch.

Link to this section Functions

Link to this function

add_shipments(id, params, opts \\ [])

View Source
add_shipments(id :: binary(), params :: [map()], opts :: keyword()) ::
  Shippo.Operation.t()

Add batch shipments to an existing batch.

Link to this function

create(params, opts \\ [])

View Source
create(params :: map(), opts :: keyword()) :: Shippo.Operation.t()

Creates a new batch object which allows you to purchase shipping labels for many shipments with one API call.

Link to this function

get(id, opts \\ [])

View Source
get(id :: binary(), opts :: keyword()) :: Shippo.Operation.t()

Retrieve an existing batch by object id.

Link to this function

purchase(id, opts \\ [])

View Source
purchase(id :: binary(), opts :: keyword()) :: Shippo.Operation.t()

Purchase an existing batch.

Link to this function

remove_shipments(id, params, opts \\ [])

View Source
remove_shipments(id :: binary(), params :: [binary()], opts :: keyword()) ::
  Shippo.Operation.t()

Remove batch shipments from an existing batch.