Shipments
Providers & Service
The PackageX platform supports fetching shipping rates from standard shipping providers and private rates that you set only for yourself.
Providers
Public providers are the ones that can be toggled on and off on your dashboard. All rates returned from these providers will be of type: provider_delivery
. Below is the current public list:
Special Cases
There are two reserved IDs that also act as providers.
self
You yourself can be a shipping provider in a few ways:
- You are an approved shipping provider on the PackageX marketplace
- You have set up private rates via the API or the Deliver App.
The self
keyword only targets your private rates as it relates to filtering shipping rates after creating a shipment or fulfillment.
marketplace
There are hundreds of thousands of independent operated shipping provers across the US and even more internationally. The PackageX shipment API gives access to these providers using the ID marketplace
.
Names & IDs
Service Levels
Every provider with which we work can return multiple rates for a shipment, as long as each rate has a unique service level. When creating a shipment or a fulfillment, you can indicate how you would like these service levels to be pre-filtered.
Self
When targeting self
there can be any number or rates returned depending on how many private rates you have set up. These rates will have dynamic IDs which can be queried like this:
const response = await fetch("https://api.packagex.io/v1/org", {
method: "GET",
headers: {
"PX-API-KEY": process.env.PX_API_KEY,
"Content-Type": "application/json",
},
}).then(res.json());
const deliveries_settings = response.data.settings.deliveries;
const private_rate_ids = deliveries_settings.private_rates.map((rate) => rate.id);