API Reference | ReDoc

Tracking

The Track API helps retrieves current status of shipments such as Small Package 1Z, Infonotice, Mail Innovations, FGV, or UPS Freight shipments using the package number or the reference number. The tracking response data typically includes package movements/activities, destination UPS access point information, expected delivery dates/times, etc. Required parameters are the inquiryNumber, transaction ID, and transaction source.
The response returns an array of shipment objects containing detailed tracking information and status for the package(s) associated with the inquiryNumber, including current status, activity history, delivery details, package details, and more. For more information on the Track API, please visit the Product Overview page.

Note: Data is rolled off after the 120 day retention period and may not be returned in the response after the retention period.

Key Business Values:

Near real-time tracking information: Get up-to-date information on the status and location of your shipments, so you can keep your customers informed.
Proof of Delivery: Automated proof of delivery updates with signature verification to help prevent fraud and theft.
Improved cash flow: Reduce the time it takes to collect payments by tracking shipments and invoices electronically.

Reference

Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.

Tracking

SecurityOAuth2

Request

path Parameters

inquiryNumber

required

string

The tracking number for which tracking information is requested. Each inquiry number must be between 7 and 34 characters in length.

query Parameters

locale	string Default: "en_US" Language and country code of the user, separated by an underscore. Default value is 'en_US'
returnSignature	string Default: "false" Indicator requesting that the delivery signature image be included as part of the response (by default the image will not be returned). Returns image bytecodes of the signature.
returnMilestones	string Default: "false" returnMilestones
returnPOD	string Default: "false" Return Proof of Delivery

header Parameters

transId required	string An identifier unique to the request.
transactionSrc required	string Default: testing Identifies the client/source application that is calling

Responses

200

Tracking Information found

400

Invalid request

403

Blocked Merchant

404

Tracking number information not found

500

Internal server error

503

Resource is not available

get/track/v1/details/{inquiryNumber}

Request samples

Response samples

application/json

{"trackResponse": {"shipment": [{"inquiryNumber": "1Z023E2X0214323462",
"package": [{"accessPointInformation": {"pickupByDate": "string"
},
"activity": [{"date": null,
"gmtDate": null,
"gmtOffset": null,
"gmtTime": null,
"location": null,
"status": null,
"time": null
}
],
"additionalAttributes": ["SENSOR_EVENT"
],
"additionalServices": ["ADULT_SIGNATURE_REQUIRED",
"SIGNATURE_REQUIRED",
"ADDITIONAL_HANDLING",
"CARBON_NEUTRAL",
"UPS_PREMIER_SILVER",
"UPS_PREMIER_GOLD",
"UPS_PREMIER_PLATINUM"
],
"alternateTrackingNumber": [{"number": null,
"type": null
}
],
"currentStatus": {"code": "SR",
"description": "Your package was released by the customs agency.",
"simplifiedTextDescription": "Delivered",
"statusCode": "003",
"type": "X"
},
"deliveryDate": [{"date": null,
"type": null
}
],
"deliveryInformation": {"deliveryPhoto": {"isNonPostalCodeCountry": null,
"photo": null,
"photoCaptureInd": null,
"photoDispositionCode": null
},
"location": "Front Door",
"receivedBy": "",
"signature": {"image": null
},
"pod": {"content": null
}
},
"deliveryTime": {"endTime": "string",
"startTime": "string",
"type": "string"
},
"dimension": {"height": "string",
"length": "string",
"unitOfDimension": "string",
"width": "string"
},
"isSmartPackage": true,
"milestones": [{"category": null,
"code": null,
"current": null,
"description": null,
"linkedActivity": null,
"state": null,
"subMilestone": null
}
],
"packageAddress": [{"address": null,
"attentionName": null,
"name": null,
"type": null
}
],
"packageCount": 2,
"paymentInformation": [{"amount": null,
"currency": null,
"id": null,
"paid": null,
"paymentMethod": null,
"type": null
}
],
"referenceNumber": [{"number": null,
"type": null
}
],
"service": {"code": "518",
"description": "UPS Ground",
"levelCode": "011"
},
"statusCode": "string",
"statusDescription": "string",
"suppressionIndicators": "DETAIL",
"trackingNumber": "string",
"ucixStatus": "string",
"weight": {"unitOfMeasurement": "string",
"weight": "string"
}
}
],
"userRelation": "MYCHOICE_HOME",
"warnings": [{"code": "string",
"message": "string"
}
]
}
]
}
}

Track by Reference Number