Documentation

UPS Track & Trace

Tracking information for UPS package.

Inputs

NameTypeDescription
Tracking NumberStringUPS Tracking Number

Outputs

NameTypeDescription
Was Tracking Info Found?BooleanWhether any tracking info was found for the tracking number provided
StatusStringTracking status:
Delivered, In Transit, Ready for Shipment, Ready for Pickup, Problem with Delivery, Returning to Sender
Last Event DateStringDate of the last update in ISO format
Tracking URLStringTracking URL
Shipped DateStringDate when the package was shipped
Activity HistoryListHistory of events for this package
Last EventObjectLast tracking event
Days Since Last UpdateNumberNumber of days passed since the last update in the shipment
Is Estimate Delivery Available?BooleanWhether estimate delivery time is available
Estimate Delivery DateStringScheduled delivery date in ISO format. Available only for some shipments in Transit, but not for all.
Is Handed to Post OfficeBooleanWhether the package is handed to the post office. For example UPS to USPS
Will be Handed to Post OfficeBooleanWhether the package will be handed to the post office
Alternate USPS Tracking NumberStringTracking number in case the parcel was handed to USPS
Status DescriptionStringDescription of the shipping status
Problem StatusStringStatus of the problem if shipping status is problem with delivery
POD File PresentBooleanWhether the Proof of Delivery file is present
POD FileStringThe POD HTML file in base64. pod.html
POD Location PresentBooleanWhether the delivery location is present
POD LocationStringDelivery location. Example: IN/AT MAILBOX

Statuses mapping

[
  ['M', 'Ready for Shipment'],
  ['MV', 'Ready for Shipment'],
  ['D', 'Delivered'],
  ['I', 'In Transit'],
  ['DO', 'In Transit'],
  ['DD', 'In Transit'],
  ['W', 'In Transit'],
  ['O', 'In Transit'],
  ['RS', 'Returning to Sender'],
  ['P', 'Ready for Pickup'],
  ['X', 'Problem with Delivery'],
  ['NA', null],
]