Track parts and equipment shipping to/from job sites.
If you are shipping parts to the site (or expecting a return), use the Shipments object to track deliveries.
Why use Shipments? Adding tracking numbers here allows the provider to see shipment status directly in their mobile app. This significantly reduces "Where is the part?" phone calls.
GET /workorders/{id}/shipments
{
"results": [
{
"id": 201,
"description": "Router Box",
"carrier": "FedEx",
"tracking_number": "123456789",
"direction": "to_site",
"status": "delivered",
"created": { "utc": "2024-01-10 10:00:00" }
}
]
}POST /workorders/{id}/shipments
{
"description": "Router Box",
"carrier": {
"name": "FedEx",
"tracking": "123456789"
},
"direction": "to_site"
}PUT /workorders/{id}/shipments/{shipment_id}
{
"status": "delivered",
"tracking_number": "123456789-updated"
}DELETE /workorders/{id}/shipments/{shipment_id}
| Direction | Description |
|---|---|
to site | Parts shipping TO the work location |
from site | Returns shipping FROM the site |
to provider | Parts shipping directly to the provider |
to other location | Shipping to a third-party location |
Supported carrier values (case-insensitive name):
upsfedexuspsother| Status | Description |
|---|---|
pending | Shipment created, not yet sent |
in_transit | Package is on the way |
delivered | Package arrived |
delayed | Shipping issues |
Link tracking numbers so providers can check delivery status before traveling to the site.
Last updated on