Parcels
Statuses and Events
You can update the status of a parcel using any of the statuses from the list. This will also create an event which you can listen to via our webhooks.
# Parcel Statuses
| Status | Description |
|---|---|
inbound_transit | The parcel is currently on its way to the fulfillment center or warehouse. |
outbound_transit | The parcel has been dispatched from the fulfillment center and is on its way to the recipient. |
in_processing | The parcel is being prepared for shipment; the provider is waiting for the package to be ready (on demand only). |
in_storage | The parcel is stored at a facility and is not currently in transit; it may be awaiting further processing. |
unpacked | The parcel has been delivered to the recipient and has been opened. |
destroyed | The parcel has been damaged beyond repair. |
overdue | The parcel has not been delivered by the expected delivery date and is considered late. |
# Special Handling Tags
| Tag | Description |
|---|---|
ftl | The parcel is being shipped via Full Truck Load, indicating a dedicated truck for transport. |
ltl | The parcel is being shipped via Less Than Truck Load, indicating it shares space with other shipments. |
chemicals | The parcel contains chemicals that require special handling and compliance with safety regulations. |
hazmat | The parcel contains hazardous materials that require special handling and must comply with safety regulations. |
perishable | The parcel contains items that may spoil or degrade over time, requiring timely delivery. |
frozen | The parcel contains items that must be kept frozen during transport to maintain their integrity. |
oversize | The parcel exceeds standard dimensions and may require special transportation arrangements. |
fragile | The parcel contains delicate items that require careful handling to prevent damage during transit. |
dry_cleaning | The parcel contains items that require dry cleaning and must be handled accordingly. |
lithium | The parcel contains lithium batteries, which require special handling due to safety concerns. |
alcohol | The parcel contains alcoholic beverages and must comply with legal regulations for transport. |
cannabis | The parcel contains cannabis products and must comply with legal regulations for transport. |
confidential | The parcel contains sensitive information or items that require discreet handling and delivery. |
marijuana | The parcel contains marijuana products and must comply with legal regulations for transport. |
pharma | The parcel contains pharmaceutical products that require special handling and temperature control. |
dry_ice | The parcel contains dry ice for temperature-sensitive items and requires special handling. |
express_priority | The parcel is marked for express delivery and should be prioritized in the shipping process. |
security_concern | The parcel is flagged for security reasons and may require additional handling or scrutiny. |
cold_storage | The parcel contains items that must be kept in cold storage during transport to maintain their integrity. |
high_value | The parcel contains high-value items that require special handling and insurance during transport. |
requires_equipment | The parcel requires special equipment for handling or transport, such as forklifts or cranes. |
# Parcel Events
| Event | Description |
|---|---|
parcel.parcel__created | A new parcel has been created and is ready for processing. |
parcel.parcel__updated | An existing parcel has been updated with new information. |