The delivery represents a single tracking number with one or more parcels that needs to be delivered.
The description of the model.
The latitude and longitude of the current location
Time in epoch seconds when this resource was created.
The estimated delivery for this delivery in epoch seconds.
A sudo status given to the delivery to know what is happening with the delivery.
completed- This delivery is not expected to have any more status updated. It's possible for a delivery to be completed and have an exception, like if a parcel was lost.
outstanding- Delivery is not at it's final destination yet.
exception- The delivery 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 delivery.
Unique identifier for the delivery.
The hub location to which this delivery is assigned.
The amount of lead time needed to come get the parcel from the sender. This is set up in the dashboard.
Key value pairs of data that you can set for this delivery.
Unique identifier for the organization that owns this delivery. This will always be your organization ID.
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 delivery was purchased
The shipping label PDF for this parcel if a delivery was purchased
The inventory packed inside of the parcel
The time in epoch seconds when this delivery 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.
Details about the contact receiving this delivery.
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 ID of the contact if one was used to create this recipient.
Details about the contact sending this delivery.
Parsed address for the sender.
Email 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
The ID of the contact if one was used to create this sender.
Current status for this delivery. See Statuses.
Provider-specific string used to track this delivery.
An array of waypoints this delivery 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
A unique hash for this update to make it easier to identify duplicates in webhooks.
An array of URLs to images about this update. Commonly used by on demand couriers for picture proof of delivery
The ID of the layout that this item is on, if it matches one of your locations.
The ID of the location of this update, if it is one of your locations.
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 delivery was last updated.
A special property that will be included if searching through deliveries. 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 delivery.
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.
Any custom metadata that you have added.
A number from 0 - 1 about how relevant the result was to the search query, with 1 being a perfect match.