UPS Track & Trace
Returns detailed UPS tracking for a parcel, including proof of delivery when available. Use it in UPS tracking flows.
What it does
- Fetches tracking details from the UPS Track API.
- Maps the shipment to a standard delivery status with rich extra fields (EDD, POD, post office handoff, and so on).
- Returns the tracking URL, activity history and normalized events.
Notes
- Requires a valid UPS tracking number.
Inputs
| Name | Type | Description |
|---|---|---|
| Tracking Number | String | tracking reference for the package |
Outputs
| Name | Type | Description |
|---|---|---|
| Was Tracking Info Found? | Boolean | whether any tracking info was found for the tracking number provided |
| Status | String | status of the package delivery Possible values: Delivered, In Transit, Ready for Shipment, Ready for Pickup, Problem with Delivery, Returning to Sender. |
| Last Event Date | String | date of the last update in ISO format |
| Tracking URL | String | tracking url for user to open in the browser |
| Shipped Date | String | date when the package was shipped |
| Activity History | List | history of events for this package |
| Last Event | Object | last event for the package |
| Days Since Last Update | Number | number of days passed since the last update in the shipment |
| Is Estimate Delivery Available? | Boolean | whether estimate delivery time is available. |
| Estimate Delivery Date | String | scheduled delivery date in ISO format. Available only for some shipments in Transit, but not for all. |
| Is Handed to Post Office? | Boolean | whether was handed to post office |
| Will be Handed to Post Office? | Boolean | whether will be handed to post office |
| Alternate USPS Tracking Number | String | Tracking number if parcel was handed to USPS |
| Status Description | String | Description of the shipping status |
| Problem Status | String | Status of the problem if shipping status is problem with delivery |
| POD File Present? | Boolean | Whether the Proof of Delivery file is present |
| POD File | String | The POD HTML file in base64. pod.html |
| POD Location Present? | Boolean | Whether the delivery location is present |
| POD Location | String | Delivery location. Example: IN/AT MAILBOX |
| Normalized Tracking Events | List | DG normalized tracking events |
| Tracking Data | Object | Tracking data |