Whether you are fetching shipping rates, purchasing a label, or tracking a shipment, we will always have the same model for you. We standardize the data from every carrier to make responses as predictable as possible.
The description of the model.
The amount collected for this shipment from the customer as an Integer. $13.78 is saved as 1378.
The amount billed to you for this shipment.
Time in epoch seconds when this shipment was created.
The lowercase three-character code for the currency used for this transaction.
The estimated delivery for this shipment in epoch seconds.
A sudo status given to the delivery to know what is happening with the delivery.
completed- This shipment is not expected to have any more status updated. It's possible for a shipment to be completed and have an exception, like if a parcel was lost.
outstanding- Shipment is not at it's final destination yet.
exception- The shipment is not going according to plan. This does not mean it will not be delivered, just that there is presently as issue.
The ID of the fulfillment that created this shipment.
Unique identifier for the shipment.
Unique identifier for the invoice of this shipment.
This kiosk that was used to generate this shipment.
URL for the shipping label in the size and format specified in the dashboard.
Details about the current live whereabouts of the package.
The latitude and longitude of the current location
The time in epoch seconds when this was last updated
The URL of the embeddable map for the tracking of this shipment
The amount of lead time needed to prepare the shipment for an on-demand courier. This is set up in the dashboard.
Key value pairs of data that you can set for this shipment.
Options that were passed in when generated shipping rates.
The amount of time in milliseconds to wait for a shipping provider before discarding it's results.
If all addresses for the shipment should be verified
The total price in USD cents for the cart total during an e-commerce purchase.
If the shipping provider should pick up this package.
The list of shipping provider IDs that you want returned.
The list of service level IDs that you want returned.
The maximum number of delivery days for this shipment.
The type of rate that should be returned for the shipment.
Unique identifier for the organization that owns this shipment. This will always be your organization ID.
If this shipment was paid for successfully.
All parcels in the fulfillment and the inventory packed within them
The enum for this object
Indicates certain aspects of the item that will impact shipping and handling
The unique ID assigned to the parcel beginning with prcl_
The length of the parcel in inches
The width of the parcel in inches
The height of the parcel in inches
The weight of the parcel in pounds (lbs)
The type of package if selecting from carrier specific packaging. See Predefined Packages
Special handing instructions for the parcel.
The tracking number for this parcel if a shipment was purchased
The shipping label PDF for this parcel if a shipment was purchased
The inventory packed inside of the parcel
A reference for the payment of this shipment. This will be visible on the invoice.
The time in epoch seconds when this shipment will be picked up.
Details about the shipping carrier.
Unique ID for the provider.
Logo of the provider.
If this shipping provider came from the PackageX marketplace.
Name of the provider.
Email to contact support for this provider, available for on demand couriers.
Phone to contact support for this provider, available for on demand couriers.
URL to contact support for this provider, available for on demand couriers.
A support reference code that some providers use to help customers.
Rate class being used for this shipment. See Rate.
All rates returned for this shipment. See Rate.
Details about the contact receiving this shipment.
The parsed address for this recipient
Email for the recipient. Recipient will receive tracking notifications here
Phone number of the recipient. On demand couriers may contact this number for issues
Name of the recipient, printed on the shipping label
The status of the refund on this shipment if one was requested. Funds will be returned back when the status is
refunded, which varies with time based on the shipping provider.
Details about the contact sending this shipment.
Parsed address for the sender.
Email for the sender.
The organization ID of the sender.
The logo for the sender.
Phone number of the sender. On demand couriers may contact this number for issues.
Name of the sender, printed on the shipping label
Current status for this shipment. See Statuses.
Provider-specific string used to track this shipment. See Rate.
An array of waypoints this shipment had in order from oldest to newest.
The address of the package at this waypoint. Address details are often limited to use the city and state when in transit.
A comment left by the provider about this update
Time in epoch seconds when this update occurred
The latest event that occurred at this waypoint. See Shipment Events
An array of URLs to images about this update. Commonly used by on demand couriers for picture proof of delivery
User-friendly message generated by PackageX to let a customer know about their shipment status
The status code for this update See Statuses
The time in epoch seconds when this status was last updated
URL where a user can go to track their packages.
Time in epoch seconds when this shipment was last updated.
A special property that will be included if searching through shipments. This is a flat object which will include
<mark> tags around characters that have matched the search. You can use this to more easily highlight text for a user interface.
The ID of the shipment.
The tracking number.
The sender's name. It will also match common nicknames.
The sender's email.
The sender's phone.
The sender's full address string.
The recipient's name. It will also match common nicknames.
The recipient's email.
The recipient's phone.
The recipient's full address string.
The shipping provider's name.
The shipping provider's ID
Any custom metadata that you have added
This is how all rates are returned on the platform. Initially when you are creating rates, you'll typically have many options here. When it's time to purchase the rate, you'll pass the
id of the rate you want to buy.
The description of the model.
The amount that will be displayed for this rate.
The amount you will be charged for this rate if purchased. Can be higher or lower than
amount if you are discounting or upcharging your shipment.
The carrier account used for this rate, if provided.
Seconds from epoch when this rate was created.
Unique identifier for this rate. This ID is passed to purchase a rate.
The time in epoch seconds when this shipment will be picked up for this rate. If this shipment does not include a pickup, it will be null.
The details of the carrier or courier for this shipment.
Unique ID for the provider
Logo of the provider
If this provider came from the PackageX marketplace
Name of the provider
Email to contact support for this provider, available for on demand couriers
Phone to contact support for this provider, available for on demand couriers
URL to contact support for this provider, available for on demand couriers
The data about the service level for this delivery.
The expected days that this delivery will take
Time in epoch seconds when the delivery is estimated to take place
The ID of the service level
The name of the service label for customers to understand, e.g: Same Day or Next Day Air
The time in epoch seconds when this shipment will be picked up for this rate
The user-friendly string about the service, such as "1 day delivery" or "Today by 9pm"