The shipments APIs make it easy to check shipping rates and purchase shipping labels.
Creating a new shipment is a two-step process. First, you'll get rates from every applicable provider for your shipment. These rates are based on the filters you provide via the API Request or filters that were set on your PackageX Dashboard. The second step selects one of those rates and purchases the shipment.
After the shipment is created, it will transition between multiple statuses as the shipping provider updates the shipment details and location. You can enable notifications to be automatically sent to customers in the PackageX Dashboard or use webhooks to listen for updates yourself.
To make the development experience a little easier, all shipment object
ids will be prefixed with
ship_ to make them easy to distinguish.
Rate objects will also be prefixed with
rate_ to make sure they are easy to tell apart.