Shipping

How shipping works

A shipment sends one or more mail items to an address of your choice, domestically or internationally. Both Registered Agent mail and CMRA mail is eligible for shipping.

The general steps are:

1. Gather the available shipping options for the given items and the destination address.
2. Create a shipment with one of the options.
3. Track the shipment.

Creating a bulk shipment may result in more than one physical shipment being created. This is because items may not be in the same physical location, or because bundling the items was not possible.

Naming

In code, you will see the name "forward." The Mail Items field is named forwardDetails and the events are under the mailItem.forward.* namespace, but these are interchangeable with "shipment."

Shipping costs

Shipping costs are billed to the Stable account once label(s) are created for shipment. Estimates are not provided prior to shipping due to weight differences in mail items.

Shipping costs can be found on mailItem.forwardDetails.cost as whole integer cents, and also on mailItem.forward.completed.

{
  "id": "mi_456",
  "forwardDetails": {
    "id": "shp_789",
    "status": "completed",
    "cost": 1250,
    "trackingNumber": "9400100000000000000000"
  }
}

When reconciling shipping costs, it's important to deduplicate cost on forwardDetails.id. Otherwise, you may process the same bulk shipment across n multiple mail items, resulting in accidentally summing cost x n charges.

You can learn about available shipping methods and their approximate pricing in the support center.