Tracking/UPS Signature Tracking®

Web Service Developer Guide

September 13,2023
Important Information

UPS Developer Kit APIs

Your development of an application using UPS Developer Kit APIs is governed by the UPS Technology
Agreement you entered into with UPS. The following are key legal requirements from these agreements for the
UPS Developer Kit APIs. For more information on all requirements for the UPS Developer Kit APIs, please refer
to the UPS Technology Agreement.
Defined terms used but not defined in this document have the meaning set forth in the UPS Technology
Agreement.

Key Legal Requirements for UPS Developer APIs

Permitted Territories
This document can only be used in the countries of the Permitted Territory as defined in the UPS Technology
Agreement, as applicable.

Use
The application must not be designed to allow distribution of information received through the UPS Developer
Kit APIs to third parties, other than to persons having a bona fide interest in such information (e.g., the shipper,
receiver, or the third party payer, or to your service providers authorized by UPS).

Consent to Use of UPS Mark

• All screens or forms generated by your application including information received through the UPS Developer Kit
APIs must include (1) the UPS Mark positioned in reasonable proximity to the Information and of an appropriate
size to readily identify the source of the Information as UPS and (2) the following language at the bottom of
every screen that displays the UPS Mark: "UPS, the UPS brand mark, and the Color Brown are trademarks of
United Parcel Service of America, Inc. All Rights Reserved." Except as set forth in the preceding sentence, you
have no right to use the UPS Mark without the prior written approval of UPS.
• You shall not use the UPS Mark in association with any third party trademarks in a manner that might suggest
co-branding or otherwise create potential confusion as to source or sponsorship of the application, or ownership
of the UPS Mark.
• The UPS Mark shall be used only as provided by UPS electronically or in hard copy form. The UPS Mark may
not be altered in any manner, including proportions, colors, elements, etc., or animated, morphed or otherwise
distorted in perspective or dimensional appearance.
• The UPS Mark may not be combined with any other symbols, including words, logos, icons, graphics, photos,
slogans, numbers, or other design elements. A minimum amount of empty space must surround the UPS Mark
separating it from any other object, such as type, photography, borders, edges, etc. The required area of empty
space around the UPS Mark must be 1/3x, where x equals the height of the UPS Mark.

Copyright and Proprietary Notice

In your application and any POD Letters you prepare, you must include a prominent reproduction of UPS’s
copyright and proprietary notices in a form and format specified by UPS (See the Copyright section of this
document).

Display of Information
The application must not display information concerning any other provider of shipping services or such other
shipping services on any page, whether comprising one or more frames, displaying information your application
receives from the UPS Developer Kit APIs. Your application must present all data within each field received
through the UPS Developer Kit APIs without amendment, deletion, or modification of any type.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary ii
Notice
In all communications with UPS concerning this document, please refer to the document date located on the
cover.

Copyright
© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
The use, disclosure, reproduction, modification, transfer, or transmittal of this work for any purpose in any form
or by any means without the written permission of United Parcel Service is strictly prohibited.

Trademarks
Some of the UPS corporate applications use United States city, state, and postal code information obtained by
United Parcel Service of America, Inc. under a non-exclusive license from the United States Postal Service.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary iii
 Table of Contents
Chapter 1: Introduction ......................................................................................................... 1
Release Features ..................................................................................................................................... 2

Chapter 2: Understanding the Tracking API ............................................................................ 3

Business Rules ........................................................................................................................................ 3
Tracking Usage Guidelines .................................................................................................................... 3
Identifying a Package or Shipment ........................................................................................................ 4
Tracking Numbers ................................................................................................................................ 4
Shipment Identification Numbers ......................................................................................................... 4
PRO numbers and Air Waybill numbers .............................................. Error! Bookmark not defined.
Candidate Bookmarks .......................................................................................................................... 5
Reference Numbers ............................................................................................................................. 5

Chapter 3: Customer Integration Environment (CIE) ............................................................... 6

Integration Testing .................................................................................................................................. 6
Production ................................................................................................................................................ 6
Server Availability Check........................................................................................................................ 6
Shipping and Tracking Numbers for Testing ....................................................................................... 7

Chapter 4: Tracking API Elements and Details ........................................................................ 8

Element Constraints ................................................................................................................................ 8
Tracking TrackRequest Top Level Containers ..................................................................................... 9
TrackRequest XPath .............................................................................................................................. 10
Request .............................................................................................................................................. 10
InquiryNumber.................................................................................................................................... 12
TrackingOption ................................................................................................................................... 13
CandidateBookmark .......................................................................................................................... 14
ShipperAccountInfo ............................................................................................................................ 16
TrackResponse Top Level Containers ................................................................................................ 17
TrackResponse XPath ........................................................................................................................... 19
Response ........................................................................................................................................... 19
Shipment ............................................................................................................................................ 20
Disclaimer .......................................................................................................................................... 41

Chapter 5: Tracking Web Service API Examples .................................................................... 43

Tracking Request .................................................................................................................................. 43
Track Response ..................................................................................................................................... 44
Signature Tracking Request ................................................................................................................. 46
Signature Tracking Response .............................................................................................................. 47

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary iv
Chapter 6: Tracking API FAQs ............................................................................................... 50
Signature Tracking FAQs ................................................................................................................... 53

Appendices ......................................................................................................................... 54
Error Codes (WS) ................................................................................................................................... 55
Common Error Codes ........................................................................................................................ 55
Tracking Error Codes ......................................................................................................................... 56
Accessorial Codes ................................................................................................................................ 59
Country/Territory Codes ....................................................................................................................... 60
Currency Codes ..................................................................................................................................... 68
Current Status Codes............................................................................................................................ 76
Package Service Codes ........................................................................................................................ 78
Reference Number Codes..................................................................................................................... 79
Request Option Matrix .......................................................................................................................... 80
Request Option Codes .......................................................................................................................... 81
Service Codes ........................................................................................................................................ 82
United States .................................................................................................................................. 82
Canada ............................................................................................................................................. 83
European Union ............................................................................................................................. 83
Mexico .............................................................................................................................................. 83
Poland .............................................................................................................................................. 84
Puerto Rico ..................................................................................................................................... 84
Undefined Countries/Territories ............................................................................................... 84
All Countries/Territories ............................................................................................................. 85
Mail Innovations ............................................................................................................................ 85
State / Province Codes.......................................................................................................................... 86
United States...................................................................................................................................... 86
Canada ............................................................................................................................................... 87
Subversion details ................................................................................................................................. 89
Locale codes .......................................................................................................................................... 91

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary v
Tracking Web Service Developer Guide September 13,2023

Chapter 1: Introduction
In this document, you will find guidance and instructions for integrating the Tracking Web Service into your
application, service, or system.

In this guide, you will find:

• New release features
• Tracking Web Service API functionality and business rules
• Web service API request and response schema
• FAQs for the Tracking API
• Tracking error response code descriptions
• Service code references

This guide applies to the following API:

• SOAP API for the Tracking Web Service

This guide does not apply to the following APIs:

• Tracking XML API

Intended Audience
This guide is intended for developers who will be integrating the Tracking Web Service API into their application,
service, or system.

Required Knowledge & Skills

This guide assumes you have a basic understanding of the following:
• Concepts and instructions in the Introduction to the UPS Developer Kit guide
• XML syntax and structure
• Web services
• Software development

How to Use this Guide

• If this is your first time working with the UPS Developer Kit, begin with the Introduction to the UPS Developer Kit
guide. This guide serves as the foundation for all API-specific developer guides.
• If you are experienced with the UPS Developer Kit but have not yet worked with the Tracking API, continue with
Chapter 2: Understanding the Tracking API. There you will find an overview of the Tracking functionality and
business rules.
• Chapter 3: Customer Integration Environment (CIE) contains information on UPS integration environments.
• Chapter 4: Tracking API Elements and Details contains an overview of the top-level containers and elements that
comprise the Tracking request and response.
• Request and response examples are located in Chapter 5: Tracking Web Service Examples.
• Reference tables, services codes, and error codes are located in the Appendices.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 1
UPS Tracking Web Service Developer Guide September 13,2023

Release Features
August 2022

Description

Flight Indicator
Tracking will now include the flight indicator, will be used to display a plane icon and details on the status of the
UPS Premier Package so that the user will know their package is currently on a plane. The locations will update
once the package is no longer in flight.
New subversion 2207 has been added for Flight Indicator.

October 2020

Description

UPS Premier
UPS® Premier is a contract service that will provide additional visibility to critical healthcare-specific movements for
the following services:
• UPS® Premier Silver
• UPS® Premier Gold
• UPS® Premier Platinum

Tracking will now include the premier accessorial, code and description in the tracking response when requested.
New subversion 2009 has been added for UPS Premier.

January 2020
No changes

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 2
UPS Tracking Web Service Developer Guide September 13,2023

Chapter 2: Understanding the Tracking API

Business Rules
General
• UPS expects schema elements/tags as defined in the XPath and presented in the schema structure without
spelling or structural deviations. Elements/tags that are not defined in the schema or do not conform to the schema
structure will be ignored by UPS.
• Only users that plan to ship packages manifested, tendered, and delivered by UPS can use the API.
• Any customers/developers abusing or data mining the API will have their access revoked.
• To access API documentation the user must have or create a UPS profile.
• To access testing and production sites the user must have an Access Key. To get an Access Key you must have a
UPS profile and an associated shipping account. For additional information, refer to the UPS Developer Kit User
Guide.

Tracking
• The Tracking API supports Package shipments.
• UPS has a rule that header information must be established before the shipment can be displayed. Header
information is established at the billing point; this usually occurs the night of the shipment.
• Some Tracking data may not be returned in the response because the data rolled off. Database retention times:
o Manifest information, and Manifest Voided scans: 120 days
o Exceptions scans: 120 days
o In Transit scans like Origin/Arrivals/Departures/Destination scans: 120 days
o Delivery records and signature images: 120 days
• Trade Direct small package manifest uploads are kept in an advanced PLD database, and only released for
visibility after the Origin scan is applied to the label.

UPS Signature Tracking®

The Signature Tracking API gives client applications access to UPS Signature Tracking information. If UPS has
successfully delivered a shipment or package to its destination, tracking requests may return signature information for
the delivery. The response can include the name of the person who signed for the delivery, an image of that person's
signature, or a full proof of delivery letter. For more information on proof of delivery letters, please consult the
appendix.

Tracking Usage Guidelines

The following guidelines are included so all UPS customers can use UPS Tracking without delays:
• Ensure tracking requests are valid. If your request returns an error message such as "tracking number not found",
"no information available", or "invalid tracking number", you should research the cause of the error before
continuing to track the same number.
• When the results of a tracking request indicate a “delivered” status, do not continue to track the package.
• Track packages during “off hours” whenever possible. Off hours are from 5:00 pm to 8:00 am East Coast time.
• Use your UPS service level (Early, Next Day Air, etc.) to determine the best time of day to track and receive up to
the minute tracking information.
• Evenly distribute your information requests over the remaining 19-hour window.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 3
UPS Tracking Web Service Developer Guide September 13,2023

• Refrain from tracking the same numbers continually throughout the day. Unique tracking numbers should be
tracked no more than once per hour or a maximum of 24 times in a single day.
• Avoid automatic access between 10:00 am to 3:00 pm EST. However, you may track critical packages during this
time.

 If daily/weekly tracking requests exceed daily shipping volume by a large margin, UPS reserves the right to
suspend tracking for that account until the situation is rectified. If a resolution cannot be found and implemented,
tracking for that account may be terminated.

Identifying a Package or Shipment

Applications can request tracking based on a tracking number, shipment identification number, or reference number.

Tracking Numbers
UPS uses tracking numbers to identify and track packages in its system. Applications can use this tracking number to
track, locate, and verify arrival of a package. A successful query by tracking number returns information for the
specific package within a shipment. For example, if a package shipment contained four individual packages, the
query response would show a shipment containing the one package out of four with the associated tracking number.

 NOTE: Tracking numbers are available up to 120 days after delivery. UPS makes every effort to ensure that a
tracking number uniquely identifies a package for 120 days. However, it is possible that a tracking number may
be reused within a shorter time period. If this occurs, a query by tracking number returns all packages matching
the tracking number.

Shipment Identification Numbers

UPS uses shipment identification numbers to identify and track every shipment as it moves through the UPS system.
A shipment may be a single transaction with multiple packages shipment.
For package shipments, a successful query by shipment identification number returns all of the packages within a
shipment. For example, if a shipment contained four packages, the query response would show all four packages.

 NOTE: UPS makes every effort to ensure that a shipment identification number uniquely identifies a shipment for
up to 120 days. However, it is possible that a shipment identification number may be reused within a shorter time
period. If this occurs, a query by shipment identification number returns all shipments matching the shipment
identification number.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 4
UPS Tracking Web Service Developer Guide September 13,2023

Candidate Bookmarks
Client applications (or their users) can examine the list of candidates to identify the desired shipment. Once the
candidate is identified, the application can issue another tracking request. By including the candidate bookmark
information for the appropriate shipment in this second request, the application eliminates ambiguity and can receive
correct tracking results.

Reference Numbers
The ability to track any UPS package or shipment by reference number gives applications added flexibility and
convenience. Reference numbers can be a purchase order number, job number, or a group of words identifying a
shipment (such as “10 widgets” or “gift for mom”).
• Applications can assign a reference number to an individual package or to all packages in a shipment.
• A reference number can contain any combination of letters and numbers up to 35 characters.
• Applications assign a reference number when they upload electronic shipping data to UPS.
• A successful query by reference number returns all of the packages within a shipment identified by the reference
number. For example, if a shipment contained four packages, and two of the packages were tagged with the
reference number, “10 widgets,” the query response would show a shipment containing those two packages.
Since reference numbers are assigned by customers, UPS cannot guarantee the uniqueness of a reference number
across all packages shipped through the UPS system. To resolve this ambiguity, a search specification may contain
any of the following qualifiers:
• Pickup date range: A range of dates within which UPS picked up the package. The default is 30 days before
today's date.
• UPS account number: The shipper's UPS account number.
• Destination postal code: A zip code (U.S.) or postal code (international).
• Destination country or territory: The destination country or territory code.

 NOTE: Reference numbers are available up to 6 months after the shipper provided the electronic manifest, and
may roll off before the delivery record.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 5
UPS Tracking Web Service Developer Guide September 13,2023

Chapter 3: Customer Integration Environment (CIE)

The Customer Integration Environment allows customers to test their application prior to launch. This environment is
intended for integration testing of customer applications with the UPS servers.
Once your application has been thoroughly tested, you should redirect the application to the UPS Production
Environment.

No stress testing should ever be performed by customers against any UPS systems.
To access testing and production sites the user must have an Access Key. You can request an Access Key after
establishing a UPS profile and associating your shipping account.

System Availability
The Customer Integration Environment is available 24 hours a day, 7 days a week. Note, the system is occasionally
down for server maintenance.

All API URLs are case sensitive.

Integration Testing
For integration testing, direct your Tracking Web Service to: https://wwwcie.ups.com/webservices/Track

Production
Once testing is complete, direct your Tracking Web Service API to the production URL:
https://onlinetools.ups.com/webservices/Track

Server Availability Check

All of the UPS services work using HTTPS POST. If the server is available, it will reply with the service name, remote
user, server port, server name, and servlet path.
To see this in action, type the following URL in your web browser: https://wwwcie.ups.com/webservices/Track

Server Name: Track

Remote User: Null

Server Port: 443

Server Name: wwwcie.ups.com

Servlet Path: /Track

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 6
UPS Tracking Web Service Developer Guide September 13,2023

Shipping and Tracking Numbers for Testing

The following tables contain shipping and tracking numbers for use in the testing environment and describes the
results that developers should expect when attempting a TrackRequest.
When using tracking numbers other than those designated for testing in CIE, the numbers will be evaluated as
production tracking numbers.
NOTE: For Web Service only. Signature image details in CIE are returned for only the tracking numbers below.

Type Value Option Service Response

Tracking 1Z12345E0205271688 Activity (All) 2nd Day Air Delivered
(Signature Availability)

Tracking 1Z12345E6605272234 None (Last) World Wide Delivered

Express

Shipping 1Z12345E0305271640 None (Last) Ground Delivered

(Second Package:
1Z12345E0393657226)

Tracking 1Z12345E1305277940 None (Last) Next Day Air ORIGIN SCAN

Saver

Tracking 1Z12345E6205277936 Activity (All) Next Day Air 2nd Delivery attempt
Saver

Tracking 1Z12345E020527079 None (Last) Invalid Tracking Number

Tracking 1Z12345E1505270452 None (Last) No Tracking Information

Available

Tracking 3251026119 Activity (All) Delivered Origin CFS

MI Tracking 9102084383041101186729 None (Last)

Number

MI Reference cgish000116630 None (Last)

Number

Tracking 1ZWX0692YP40636269 Activity UPS SUREPOST Response for UPS

SUREPOST

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 7
UPS Tracking Web Service Developer Guide September 13,2023

Chapter 4: Tracking API Elements and Details

Element Constraints
The Request and Response XPath tables contain the full hierarchy of the API elements.

 UPS expects schema elements/tags as defined in the XPath and presented in the schema structure i.e., no
spelling or structural deviations. Elements/tags that are not defined in the schema or do not conform to the
schema structure will be ignored by UPS.

Element constraints are defined as follows:

Required
• Yes - indicates the element must be present in the request or response.
• Yes* - indicates the element must be present in the request if the parent container is present in the request.
• No - indicates the element is optional and may be used if it applies to the request.
• Cond – indicates the element is required under certain conditions.

Type
• Container - holds a group of related elements.
• String - consists of alphanumeric characters, spaces, and decimals.

Length
• The maximum number of characters that can be present in a String. Length is not applicable (N/A) to Containers.

Max Allowed
• The maximum number of elements or containers that can be present in the parent container.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 8
UPS Tracking Web Service Developer Guide September 13,2023

Tracking TrackRequest Top Level Containers

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 9
UPS Tracking Web Service Developer Guide September 13,2023

TrackRequest XPath
Name Constraint Description Validation Type
/TrackRequest
TrackRequest Required: Yes Container for the root Track All
Type: Container Request. Package, Mail
Max Allowed: 1 Innovations can be tracked
Length: N/A by invoking this request.

Users have three ways to

track, by inquiry number, by
reference number, or by
candidate bookmark.

Request
Name Constraint Description Validation Type
/TrackRequest/Request
Request Required: Yes Common Request element All
Type: Container should be provided by users
Max Allowed: 1
Length: N/A
/TrackRequest/Request/RequestOption
RequestOption Required: Cond For optional processing. For valid values, see All
Type: String Request Option Codes in the
Max Allowed: 1 Appendix.
Length: 1..15
/TrackRequest/Request/SubVersion
SubVersion Required: Yes* When UPS introduces new Supported values: 0114, All
Type: String elements in the response 1407, 1507,
Max Allowed: 1 that are not associated with 1801,1907,1909,2009
Length: 4 new request elements,
Subversion is used. This
ensures backward
compatibility.

To get such elements you

need to have the right
Subversion. The value of the
subversion is explained in
the Response element
Description.

Example: Itemized Charges

are returned only when the
Subversion element is
present and greater than or
equal to '1601'.

Format: YYMM = Year and

month of the release.
Example: 1601 = 2016
January
/TrackRequest/Request/TransactionReference
TransactionReferenc Required: Yes* TransactionReference All
e Type: Container identifies transactions
Max Allowed: 1 between client and server.
Length: N/A
/TrackRequest/Request/TransactionReference/CustomerContext

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 10
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

CustomerContext Required: Yes* The client uses All
Type: String CustomerContext to
Max Allowed: 1 synchronize
Length: 1..512 request/response pairs. The
client establishes
CustomerContext, which can
contain any information you
want, as long as it is valid
XML, it is echoed back by
the server.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 11
UPS Tracking Web Service Developer Guide September 13,2023

InquiryNumber
Name Constraint Description Validation Type
/TrackRequest/InquiryNumber
InquiryNumber Required: Cond Inquiry Number. All
Type: String
Max Allowed: 1 Package:
Length: 9..34 For package, the number will
be treated as Shipment
Identification Number or
Package Tracking Number
based on the value of the
element TrackingOption.

Tracking options:
01, the inquiry number will be
treated as shipment
identification number.
02, the inquiry number will be
treated as package Tracking
number.

Mail Innovations:
For mail innovations this
number will be the tracking
number. When tracking for
mail innovations by tracking
number the TrackingOption
also needs to be set to03.

For mail innovations different

types of tracking numbers
apply like - Sequence
number (Mail Manifest ID /
MMS), Postal service
Tracking ID.
/TrackRequest/IncludeMailInnovationIndicator
IncludeMailInnovatio Required: No The presence of this Mail Innovations only. MI
nIndicator Type: String indicator means supports
Max Allowed: 1 Mail Innovation tracking
Length: 0 without tracking option

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 12
UPS Tracking Web Service Developer Guide September 13,2023

TrackingOption
Name Constraint Description Validation Type
/TrackRequest/TrackingOption
TrackingOption Required: Cond TrackingOption applies to Package and Mail PKG, MI
Type: String Package and Mail Innovations only.
Max Allowed: 1 Innovations only.
Length: 2
Package:
01 - Single trackable entity
with more trackable entities
inside it
02 - Single trackable entity
with no more trackable
entities inside it

If value or element is not

found, then Inquiry number
will be treated as Shipment
Identification Number.

If the TrackingOption is not

present then it will return all
packages information if it is a
Multi-package shipment
(Which means Tracking
number will be treated as
Shipment Identification
number).

Mail Innovations:
For Mail Innovations track by
number, this is a mandatory
field which has to be set to
03.
For Mail Innovations a single
shipment has single
package.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 13
UPS Tracking Web Service Developer Guide September 13,2023

CandidateBookmark
Name Constraint Description Validation Type
/TrackRequest/CandidateBookmark
CandidateBookmark Required: No During InquiryNumber and FRT
Type: String Reference Number
Max Allowed: 1 searches, it is possible that
Length: 1..15 duplicate shipments will be
found. If duplicate shipments
are found, then a Candidate
Summary with a
corresponding
CandidateBookmark for each
of the Shipments will be
returned in the track
response.

This Base64 encoded

CandidateBookmark can be
passed back to the Tracking
service in a separate request
to retrieve tracking
information about the
particular shipment of
interest. It does not apply to
package tracking or Mail
Innovations.
/TrackRequest/ReferenceNumber
ReferenceNumber Required: Cond The reference number PKG, MI
Type: Container container. Required if an
Max Allowed: 1 inquiry number or candidate
Length: N/A bookmark is not present.
The reference number for
Mail Innovations needs to be
set here along with
appropriate code in
ShipmentType.
/TrackRequest/ReferenceNumber/Value
Value Required: Yes* The customer assigned PKG, MI
Type: String reference number.
Max Allowed: 1
Length: 1..35
/TrackRequest/PickupDateRange
PickupDateRange Required: Yes* The additional information of All
Type: Container pickup date range to support
Max Allowed: 1 and narrow a reference
Length: N/A number search.
For Mail Innovations this is
optional field for tracking by
reference number.
/TrackRequest/PickupDateRange/BeginDate
BeginDate Required: Yes* The beginning pickup date All
Type: String used to narrow a reference
Max Allowed: 1 number search.
Length: 8 Format: YYYYMMDD.
/TrackRequest/PickupDateRange/EndDate
EndDate Required: Yes* The end pickup date used to All
Type: String narrow a reference number
Max Allowed: 1 search.
Length: 8 Format: YYYYMMDD. MM
ranges from 01 to 12.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 14
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

/TrackRequest/ShipperNumber
ShipperNumber Required: Yes* The UPS account number PKG, FRT
Type: String used to narrow a reference
Max Allowed: 1 number search.
Length: 6 or10
/TrackRequest/ShipFrom
ShipFrom Required: Yes* Container for ship from FRT
Type: Container address used to narrow a
Max Allowed: 1 reference number search.
Length: N/A
/TrackRequest/ShipFrom/Address
Address Required: Yes* Container for the origin FRT
Type: Container country/territory code and
Max Allowed: 1 origin postal code used to
Length: N/A narrow a reference number
search.
/TrackRequest/ShipFrom/Address/PostalCode
PostalCode Required: Yes* Postal Code of the origin FRT
Type: String country/territory.
Max Allowed: 1
Length: 1..16
/TrackRequest/ShipFrom/Address/CountryCode
CountryCode Required: Yes* Country or Territory Code of FRT
Type: String the origin country or territory.
Max Allowed: 1
Length: 2
/TrackRequest/ShipTo
ShipTo Required: Yes* Container for the Destination All
Type: Container Address to narrow the
Max Allowed: 1 reference number search.
Length: N/A
/TrackRequest/ShipTo/Address
Address Required: Yes* Container for the destination All
Type: Container postal code and destination
Max Allowed: 1 country/territory Code.
Length: N/A
/TrackRequest/ShipTo/Address/PostalCode
PostalCode Required: Yes* Postal code of postal All
Type: String destination country/territory.
Max Allowed: 1
Length: 1..16
/TrackRequest/ShipTo/Address/CountryCode
CountryCode Required: Yes* Destination country or All
Type: String territory code
Max Allowed: 1
Length: 2
/TrackRequest/ShipmentType
ShipmentType Required: Cond. Container for the type of All
Type: Container Shipment when doing a
Max Allowed: 1 Reference Number search.
Length: N/A This element is required if
the Reference Number
element is specified.
/TrackRequest/ShipmentType/Code

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 15
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Code Required: Yes* This element will be used to Valid values: All
Type: String indicate the type of the 01 = Package (Default)
Max Allowed: 1 shipment being tracked 03 = Mail Innovations
Length: 2 during Reference number
tracking.
/TrackRequest/PreauthorizedReturnIndicator
PreauthorizedReturn Required: No Indicator to request Pre- This is an indicator. PKG, MI
Indicator Type: String authorized For Return (PFR) Valid value is:
Max Allowed: 1 eligibility information, URL to Y - PFR information is
Length: 1 submit pre-authorized return required.
request and other PFR
related data. For small
package and Mail Innovation
packages.
Valid value is:
Y - PFR information is
required.
/TrackRequest/Locale
Locale Required: No Locale will be used to Examples: en_US, fr_FR All
Type: String provide translated text in
Max Allowed: 1 Activity Status Description
Length: 5 and Current Status
Description.
Default Value is:
en_US

ShipperAccountInfo
Name Constraint Description Validation Type
/TrackRequest/ShipperAccountInfo
ShipperAccountInfo Required: Cond Container for Shippers Package Signature Tracking PKG SIG
Type: Container account details. only.
Max Allowed: 1
Length: N/A Used to verify the customers
signature tracking privileges
for package tracking if
shipper selects one of the
RequestOption including
signature track.
/TrackRequest/ShipperAccountInfo/PostalCode
PostalCode Required: Yes* Postal Code of the Shipper Package Signature Tracking PKG SIG
Type: String Account used to place the only.
Max Allowed: 1 shipment.
Length: 1..9
This data will be used in
verifying the rights of the
customer to view signature
results.
/TrackRequest/ShipperAccountInfo/CountryCode
CountryCode Required: Yes* Country or Territory Code of Package Signature Tracking PKG SIG
Type: String the Shipper Account used to only.
Max Allowed: 1 place the shipment.
Length: 2
This data will be used in
verifying the rights of the
customer to view signature
results.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 16
UPS Tracking Web Service Developer Guide September 13,2023

TrackResponse Top Level Containers

Continued...

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 17
UPS Tracking Web Service Developer Guide September 13,2023

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 18
UPS Tracking Web Service Developer Guide September 13,2023

TrackResponse XPath
Name Constraint Description Validation Type
/TrackResponse
TrackResponse Required: Yes Container for root Track All
Type: Container Response.
Max Allowed: 1
Length: N/A

Response
Name Constraint Description Validation Type
/TrackResponse/Response
Response Required: Yes Container for common All
Type: Container Response element.
Max Allowed: 1
Length: N/A
/TrackResponse/Response/ResponseStatus
ResponseStatus Required: Yes Response Status Container. All
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Response/ResponseStatus/Code
Code Required: Yes Identifies the success or failure All
Type: String of the transaction.
Max Allowed: 1 1 = Successful
Length: 1
/TrackResponse/Response/ResponseStatus/Description
Description Required: Yes Describes Response Status All
Type: String Code. Returns text of Success.
Max Allowed: 1
Length: 1..35
/TrackResponse/Response/Alert
Alert Required: Cond. Alert Container. There can be All
Type: Container zero to many alert containers
Max Allowed: UNB with code and description.
Length: N/A
/TrackResponse/Response/Alert/Code
Code Required: Yes* Warning code returned by the All
Type: String system.
Max Allowed: 1
Length: 1..10
/TrackResponse/Response/Alert/Description
Description Required: Yes* Warning messages returned by All
Type: String the system
Max Allowed: 1
Length: 1..150
/TrackResponse/Response/TransactionReference
TransactionReference Required: No Transaction Reference All
Type: Container Container.
Max Allowed: 1
Length: N/A
/TrackResponse/Response/TransactionReference/CustomerContext
CustomerContext Required: Yes* The CustomerContext All
Type: String Information which will be
Max Allowed: 1 echoed during response.
Length: 1..512

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 19
UPS Tracking Web Service Developer Guide September 13,2023

Shipment
Name Constraint Description Validation Type
/TrackResponse/Shipment
Shipment Required: Yes Shipment Container All
Type: Container
Max Allowed: UNB
Length: 1..240
/TrackResponse/Shipment/InquiryNumber
InquiryNumber Required: Yes Shipment Inquiry Number All
Type: Container Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/InquiryNumber/Code
Code Required: Yes Code to indicate the type of All
Type: String Inquiry Number.
Max Allowed: 1
Length: 2..6 Package:
For package this element
returns:
01 -Shipment Identification
Number

Mail Innovations:
03- Mail Innovation tracking
number

/TrackResponse/Shipment/InquiryNumber/Description
Description Required: Yes* Description of the Inquiry All
Type: String Number as indicated by code as
Max Allowed: 1 above.
Length: 1..35
/TrackResponse/Shipment/InquiryNumber/Value
Value Required: Yes* The actual value of the Inquiry All
Type: String Number.
Max Allowed: 1
Length: 1..34
/TrackResponse/Shipment/ShipmentType
ShipmentType Required: No Container for the type of All
Type: Container Shipment.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/ShipmentType/Code
Code Required: Yes* This element will be used to All
Type: String indicate the type of the
Max Allowed: 1 shipment being tracked, either
Length: 2 Package, Mail Innovations .
01 - Package
03 - Mail Innovations
/TrackResponse/Shipment/ShipmentType/Description
Description Required: Yes* Description of the code above. All
Type: String
Max Allowed: 1
Length: 1..15
/TrackResponse/Shipment/CandidateBookmark
CandidateBookmark Required: Cond During Tracking and Reference FRT
Type: String Number searches, it is possible
Max Allowed: 1 that duplicate shipments will be
Length: 1..15 found.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 20
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

If duplicate shipments are

found, then a Candidate
Summary with a corresponding
Base64 encodedCandidate
Bookmark for each of the
Shipments will be returned in
the response.

The Candidate Bookmark can

be passed back to the tracking
web service in a separate track
transaction to retrieve tracking
information about the particular
shipment of interest.
/TrackResponse/Shipment/ShipperNumber
ShipperNumber Required: No The shippers UPS account PKG, MI
Type: String number that placed this
Max Allowed: 1 shipment
Length: 6 or 10
/TrackResponse/Shipment/ShipmentAddress
ShipmentAddress Required: Yes An array of addresses All
Type: Container associated with this shipment.
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/ShipmentAddress/Type
Type Required: Yes Type of address. All
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/ShipmentAddress/Type/Code
Code Required: Yes Code of address: All
Type: String 01 = Shipper Address
Max Allowed: 1 02 = ShipTo Address
Length: 2
For Mail Innovations, shipper
address may be optionally
present.
/TrackResponse/Shipment/ShipmentAddress/Type/Description
Description Required: Yes* Description of the code above. All
Type: String
Max Allowed: 1
Length: 1..50
/TrackResponse/Shipment/ShipmentAddress/Address
Address Required: Yes Address detail. All
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/ShipmentAddress/Address/AddressLine
AddressLine Required: Yes* Street address details. Up to PKG,
Type: String three AddressLine can be FRT
Max Allowed: 3 returned.
Length: 1..70 Address lines will not be
returned for Mail Innovations.
/TrackResponse/Shipment/ShipmentAddress/Address/City
City Required: Yes* City name. This is optional for All
Type: String Mail Innovations.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 21
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/ShipmentAddress/Address/StateProvinceCode
StateProvinceCode Required: Yes* State or province code. This is optional for Mail All
Type: String Required for country/territory Innovations.
Max Allowed: 1 code US or CA.
Length: 2..5
/TrackResponse/Shipment/ShipmentAddress/Address/PostalCode
PostalCode Required: Yes* Postal code of this address. All
Type: String
Max Allowed: 1
Length: 5..16
/TrackResponse/Shipment/ShipmentAddress/Address/CountryCode
CountryCode Required: Yes* Country or Territory code. All
Type: String
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/ShipmentWeight
ShipmentWeight Required: No Shipment weight container. All
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/ShipmentWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Shipment weight unit of All
Type: Container measurement container.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/ShipmentWeight/UnitOfMeasurement/Code
Code Required: Yes* Shipment weight unit of Values: All
Type: String measurement code. OZS
Max Allowed: 1 LBS (default)
Length: 3 KGS
/TrackResponse/Shipment/ShipmentWeight/Weight
Weight Required: Yes* Shipment’s total weight. Set to 0 All
Type: String for shipment with package type
Max Allowed: 1 of letter.
Length: 8
/TrackResponse/Shipment/Service
Service Required: No Container for UPS service All
Type: Container associated with the shipment
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Service/Code
Code Required: Yes* Service Code. For valid values, All
Type: String see Service Codes in the
Max Allowed: 1 Appendix.
Length: 2..4
/TrackResponse/Shipment/Service/Description
Description Required: Yes* Description of the service. All
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/ReferenceNumber
ReferenceNumber Required: No Shipment reference number All
Type: Container container

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 22
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/ReferenceNumber/Code
Code Required: Yes* Reference number type code for For valid values, see Reference All
Type: String signifying PO #’s, Invoice #’s. Number Codes in the Appendix.
Max Allowed: 1
Length: 2..3
/TrackResponse/Shipment/ReferenceNumber/Description
Description Required: Yes* Description of the code above. All
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/ReferenceNumber/Value
Value Required: Yes* The real value of the reference All
Type: String number supplied by a customer.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/CurrentStatus
CurrentStatus Required: No Container for the current status FRT
Type: Container of the shipment.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/CurrentStatus/Code
Code Required: Yes* Code for the current status of For valid values, see Current FRT
Type: String the shipment. Status Codes in the Appendix.
Max Allowed: 1
Length: 3
/TrackResponse/Shipment/CurrentStatus/Description
Description Required: Yes* Description of the current status FRT
Type: String of the shipment.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/PickupDate
PickupDate Required: No Date the shipment was picked- All
Type: String up. Format: YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/ServiceCenter
ServiceCenter Required: No Service center container. FRT
Type: Container
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/ServiceCenter/Type/Code
Code Required: Yes* Service Center type codes: FRT
Type: String 01 - Delivery Service Center
Max Allowed: 1 02 - Estimated Delivery Service
Length: 2 Center
03 - Pickup Service Center
/TrackResponse/Shipment/ServiceCenter/Type/Description
Description Required: Yes* Description of the code above. FRT
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/ServiceCenter/Address
Address Required: Yes* Service center address. FRT
Type: Container

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 23
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/ServiceCenter/Address/City
City Required: Yes* Service center city. FRT
Type: String
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/ServiceCenter/Address/StateProvinceCode
StateProvinceCode Required: Yes* Service Center State or FRT
Type: String province code.
Max Allowed: 1
Length: 2..6
/TrackResponse/Shipment/DeliveryDateUnavailable
DeliveryDateUnavailabl Required: No DeliveryDate Unavailable All
e Type: Container container.
Max Allowed: 1 Note: This container is return if
Length: N/A SubVersion is 0114 and above.
/TrackResponse/Shipment/DeliveryDateUnavailable/Type
Type Required: Yes* Type is Scheduled Delivery. All
Type: String
Max Allowed: 1
Length: 1..19
/TrackResponse/Shipment/DeliveryDateUnavailable/Description
Description Required: Yes* A description is return to All
Type: String indicate the scheduled delivery
Max Allowed: 1 date is unavailable
Length: 1..73
/TrackResponse/Shipment/DeliveryDetail
DeliveryDetail Required: No Delivery detail information. FRT, MI
Type: Container
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/DeliveryDetail/Type
Type Required: Yes* Type of delivery detail. FRT, MI
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/DeliveryDetail/Type/Code
Code Required: Yes* Delivery Detail codes. Valid values: FRT, MI
Type: String 01 - Delivery
Max Allowed: 1 02- Estimated Delivery
Length: 2 03 - Scheduled Delivery

For Mail Innovations only 01

and02 apply.
/TrackResponse/Shipment/DeliveryDetail/Type/Description
Description Required: Yes* Description of above code. FRT, MI
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/DeliveryDetail/Date
Date Required: Yes* Date for the specific delivery FRT, MI
Type: String type. Format: YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/DeliveryDetail/Time

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 24
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Time Required: Yes* Time for the specific delivery FRT, MI
Type: String type. Format: HHMMSS.
Max Allowed: 1
Length: 6

/TrackResponse/Shipment/Volume/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Unit of measurement container. FRT
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Volume/UnitOfMeasurement/Code
Code Required: Yes* Code indicating the unit of FRT
Type: String measurement for the volume.
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Volume/UnitOfMeasurement/Description
Description Required: Yes* Description of the unit of FRT
Type: String measurement as indicated by
Max Allowed: 1 code.
Length: 1..35
/TrackResponse/Shipment/Volume/Value
Value Required: Yes* Value of the total volume of the FRT
Type: String shipment.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/BillToName
BillToName Required: No Name of the person to whom FRT
Type: String the shipment is billed to.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/NumberOfPackagingUnit
NumberOfPackagingU Required: No Number of packaging unit. FRT
nit Type: Container
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/NumberOfPackagingUnit/Type
Type Required: Yes* Type of packaging FRT
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/NumberOfPackagingUnit/Type/Code
Code Required: Yes* Packaging unit codes: FRT
Type: String 01 - Piece
Max Allowed: 1 02 – Pallet
Length: 2
/TrackResponse/Shipment/NumberOfPackagingUnit/Type/Description
Description Required: Yes* Description of the above code. FRT
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/NumberOfPackagingUnit/Value
Value Required: Yes* The actual number of unit. FRT
Type: String
Max Allowed: 1
Length: 1..15
/TrackResponse/Shipment/COD

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 25
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

COD Required: No Container for COD for the FRT
Type: Container shipment.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/COD/Amount
Amount Required: Yes* Container for COD amount FRT
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/COD/Amount/CurrencyCode
CurrencyCode Required: Yes* Currency Code for COD. FRT
Type: String Default value isUSD
Max Allowed: 1
Length: 3
/TrackResponse/Shipment/COD/Amount/MonetaryValue
MonetaryValue Required: Yes* Cash On Delivery (COD) FRT
Type: String Amount that is due.
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/COD/Status
Status Required: N/A FRT
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/SignedForByName
SignedForByName Required: No Person that received the FRT
Type: String shipment. May be the
Max Allowed: 1 addressee, or another person
Length: 1..35 that signed for the shipment
/TrackResponse/Shipment/Activity
Activity Required: No Container for shipment activity. FRT
Type: Container
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/Activity/ActivityLocation
ActivityLocation Required: Yes* Container for shipment activity FRT
Type: Container location
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Activity/ActivityLocation/City
City Required: Yes* Activity city. FRT
Type: String
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/Activity/ActivityLocation/StateProvinceCode
StateProvinceCode Required: Yes* Activity State or province code. FRT
Type: String
Max Allowed: 1
Length: 2..5
/TrackResponse/Shipment/Activity/ActivityLocation/PostalCode
PostalCode Required: Yes* Activity postal code FRT
Type: String
Max Allowed: 1
Length: 5..16
/TrackResponse/Shipment/Activity/ActivityLocation/CountryCode

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 26
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

CountryCode Required: Yes* Activity country or territory code FRT
Type: String
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Activity/Description
Description Required: Yes* Description of the Activity. FRT
Type: String
Max Allowed: 1
Length: 1..370
/TrackResponse/Shipment/Activity/Date
Date Required: Yes* Activity Date. Format: FRT
Type: String YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/Activity/Time
Time Required: Yes* Activity Time. Format: FRT
Type: String HHMMSS
Max Allowed: 1
Length: 6
/TrackResponse/Shipment/Activity/Trailer
Trailer Required: Yes* Trailer Code for the shipment FRT
Type: String
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/OriginPortDetail
OriginPortDetail Required: No Details of origin port of the FRT
Type: Container shipment.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/OriginPortDetail/OriginPort
OriginPort Required: Yes* Origin Port of the shipment. FRT
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/OriginPortDetail/EstimatedDeparture
EstimatedDeparture Required: Yes* Container for Estimated FRT
Type: Container Departure Time Stamp at the
Max Allowed: 1 origin port.
Length: N/A
/TrackResponse/Shipment/OriginPortDetail/EstimatedDeparture/Date
Date Required: Yes* Date of the Estimated Departure FRT
Type: String Time Stamp at the origin port.
Max Allowed: 1 Format: YYYYMMDD
Length: 8
/TrackResponse/Shipment/OriginPortDetail/EstimatedDeparture/Time
Time Required: Yes* Time of the Estimated FRT
Type: String Departure Time Stamp at the
Max Allowed: 1 origin port. Format: HHMMSS
Length: 6
/TrackResponse/Shipment/DestinationPortDetail
DestinationPortDetail Required: No Container for the destination FRT
Type: Container port of the shipment.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/DestinationPortDetail/DestinationPort

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 27
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

DestinationPort Required: Yes* Destination port of the FRT
Type: String shipment.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/DestinationPortDetail/EstimatedArrival
EstimatedArrival Required: Yes* Container for Estimated Arrival FRT
Type: Container Time Stamp at the Destination
Max Allowed: 1 Port
Length: N/A
/TrackResponse/Shipment/DestinationPortDetail/EstimatedArrival/Date
Date Required: Yes* Container for Estimated Arrival FRT
Type: String Time Stamp at the Destination
Max Allowed: 1 Port. Format: YYYYMMDD
Length: 8
/TrackResponse/Shipment/DestinationPortDetail/EstimatedArrival/Time
Time Required: Yes* Time of the Estimated Arrival FRT
Type: String Time Stamp at the Destination
Max Allowed: 1 Port. Format: HHMMSS
Length: 6
/TrackResponse/Shipment/DescriptionOfGoods
DescriptionOfGoods Required: No Description of Goods in the FRT
Type: String shipment.
Max Allowed: 1
Length: 1..512
/TrackResponse/Shipment/CargoReady
CargoReady Required: No Container for cargo ready date FRT
Type: Container and time.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/CargoReady/Date
Date Required: Yes* Cargo Ready date for the FRT
Type: String shipment. Format: YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/CargoReady/Time
Time Required: Yes* Cargo Ready time for the FRT
Type: String shipment. Format: HHMMSS
Max Allowed: 1
Length: 6
/TrackResponse/Shipment/Manifest
Manifest Required: No Container for Manifest date and FRT
Type: Container time.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Manifest/Date
Date Required: Yes* Manifest date for the shipment. FRT
Type: String Format: YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/Manifest/Time
Time Required: Yes* Manifest time for the shipment. FRT
Type: String Format: HHMMSS
Max Allowed: 1
Length: 6
/TrackResponse/Shipment/CarrierActivityInformation

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 28
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

CarrierActivityInformati Required: Yes* Container for carrier activity FRT
on Type: Container information for the shipment.
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/CarrierActivityInformation/CarrierId
CarrierId Required: Yes* Id number of the carrier FRT
Type: String
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/CarrierActivityInformation/Description
Description Required: Yes* Description of the carrier e.g: FRT
Type: String Flight or Vessel.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/CarrierActivityInformation/Status
Status Required: Yes* Status of the carrier FRT
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/CarrierActivityInformation/Arrival
Arrival Required: Yes* Container for arrival time stamp FRT
Type: Container information of the carrier
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/CarrierActivityInformation/Arrival/Date
Date Required: Yes* Date of the arrival time stamp. FRT
Type: String Format: YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/CarrierActivityInformation/Arrival/Time
Time Required: Yes* Time of the arrival time stamp. FRT
Type: String Format: HHMMSS
Max Allowed: 1
Length: 6
/TrackResponse/Shipment/CarrierActivityInformation/Departure
Departure Required: Yes* Container for Departure time FRT
Type: Container stamp information of the carrier
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/CarrierActivityInformation/Departure/Date
Date Required: Yes* Date of the arrival time stamp. FRT
Type: String Format: YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/CarrierActivityInformation/Departure/Time
Time Required: Yes* Time of the arrival time stamp. FRT
Type: String Format: HHMMSS
Max Allowed: 1
Length: 6
/TrackResponse/Shipment/CarrierActivityInformation/OriginPort
OriginPort Required: Yes* Origin Port of the Carrier’s leg of FRT
Type: String the journey
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/CarrierActivityInformation/DestinationPort

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 29
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

DestinationPort Required: Yes* Destination Port of the Carrier’s FRT
Type: String leg of the journey
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/Document
Document Required: Yes* Container for the various FRT SIG
Type: Container documents returned to the
Max Allowed: UNB customer.
Length: N/A
Returned if Signature Tracking
is enabled and authorized.
Returned if any of the
documents i.e., Signature, Free
Astrays, Delivery Receipt or
POD is requested using the
request option.

Refer to the Request Option

Matrix in the Appendix.
/TrackResponse/Shipment/Document/Type
Type Required: Yes* Container for the document FRT SIG
Type: Container type.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Document/Type/Code
Code Required: Yes* Code for the type of the FRT SIG
Type: String document.
Max Allowed: 1
Length: 2 01 - Signature Image
02 - Delivery Receipt
03 - Free Astray
04 - POD
/TrackResponse/Shipment/Document/Type/Description
Description Required: Yes* Description for the type of the FRT SIG
Type: String document as described by the
Max Allowed: 1 code.
Length: 1..35
/TrackResponse/Shipment/Document/Content
Content Required: Yes* Base64 Encoded Byte stream of FRT SIG
Type: String the image.
Max Allowed: 1
Length: Image
/TrackResponse/Shipment/Document/Format
Format Required: Yes* Container for the document FRT SIG
Type: Container format.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Document/Format/Code
Code Required: Yes* Code for the document format. FRT SIG
Type: String
Max Allowed: 1 Values: 01 - GIF, 02 - PDF
Length: 2
/TrackResponse/Shipment/Document/Format/Description
Description Required: Yes* Description of the document FRT SIG
Type: String format as indicated by the code.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/FileNumber

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 30
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

FileNumber Required: Yes* File Number of the shipment. FRT
Type: String
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/Appointment
Appointment Required: No Appointment Details. FRT
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Appointment/Made
Made Required: Yes* Container for Appointment FRT
Type: Container Made Date and Time.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Appointment/Made/Date
Date Required: Yes* Appointment Made Date. FRT
Type: String Format: YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/Appointment/Made/Time
Time Required: Yes* Appointment Made Time. FRT
Type: String Format: HHMMSS
Max Allowed: 1
Length: 6
/TrackResponse/Shipment/Appointment/Requested
Requested Required: Yes* Container for Appointment FRT
Type: Container Requested Date and Time
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Appointment/Requested/Date
Date Required: Yes* Appointment Requested Date. FRT
Type: String Format: YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/Appointment/Requested/Time
Time Required: Yes* Appointment Requested Time. FRT
Type: String Format: HHMMSS
Max Allowed: 1
Length: 6
/TrackResponse/Shipment/Appointment/BeginTime
BeginTime Required: Yes* Appointment Begin Time. FRT
Type: String Format: HHMMSS
Max Allowed: 1
Length: 6
/TrackResponse/Shipment/Appointment/EndTime
EndTime Required: Yes* Appointment End Time. Format: FRT
Type: String HHMMSS
Max Allowed: 1
Length: 6
/TrackResponse/Shipment/Package
Package Required: No Container for package PKG, MI
Type: Container information.
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/Package/TrackingNumber

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 31
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

TrackingNumber Required: Yes* TrackingNumber of the PKG, MI
Type: String package.
Max Allowed: 1
Length: 1..34
/TrackResponse/Shipment/Package/DeliveryIndicator
DeliveryIndicator Required: Yes* Indicates if the current package PKG, MI
Type: String is delivered. Possible Values:
Max Allowed: 1 "Y": Package is delivered
Length: 1..34 "N": Package is not delivered
/TrackResponse/Shipment/Package/DeliveryDate
TrackingNumber Required: Yes* The delivery date of the PKG, MI
Type: String package. Will be returned if
Max Allowed: 1 delivery date indicator is Y. The
Length: 1..34 format is: YYYYMMDD
/TrackResponse/Shipment/Package/SRSizeCode
SRSizeCode Required: No Simple Rate package size. PKG
Type: String Valid Values:
Max Allowed: 1 XS
Length: 1..2 S
M
L
XL
Note: This container is returned
if SubVersion is 1909 or above
/TrackResponse/Shipment/Package/Redirect
Redirect Required: Yes* Container tag for Redirect PKG
Type: Container package to UPS Access Point
Max Allowed: 1 Note: This container is return if
Length: N/A SubVersion is 0114 or above
/TrackResponse/Shipment/Package/Redirect/CompanyName
CompanyName Required: Yes* UPS Access Point Business PKG
Type: String Name.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/Redirect/LocationID
LocationID Required: Yes* UPS Access Point Location ID. PKG
Type: String
Max Allowed: 1
Length: 1..9
/TrackResponse/Shipment/Package/Redirect/PickupDate
PickupDate Required: Yes* The last date the package is PKG
Type: String held for pickup at a UPS Access
Max Allowed: 1 Point. Date of the arrival time
Length: 8 stamp.
Format: YYYYMMDD
/TrackResponse/Shipment/Package/DeliveryDetail
DeliveryDetail Required: Yes* Delivery Detail container. PKG
Type: Container
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/Package/DeliveryDetail/Type
Type Required: Yes* Type of delivery detail. PKG
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/DeliveryDetail/Type/Code

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 32
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Code Required: Yes* Delivery detail Type code: 04 – PKG
Type: String Rescheduled Delivery
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Package/DeliveryDetail/Type/Description
Description Required: Yes* Description of above code PKG
Type: String above.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/DeliveryDetail/Date
Date Required: Yes* The delivery date. Format: PKG
Type: String YYYYMMDD (military format)
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/Package/DeliveryDetail/Time
Time Required: Yes* Format: HHMMSS or HHMM PKG
Type: String (military format)
Max Allowed: 1
Length: 4 or 6
/TrackResponse/Shipment/Package/PackageAddress
PackageAddress Required: No Package address container. PKG
Type: Container
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/Package/PackageAddress/Type
Type Required: Yes* Type of the package address PKG
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/PackageAddress/Type/Code
Code Required: Yes* Package Address Type code. Valid values: PKG
Type: String 03 – ReRoute Address
Max Allowed: 1 04 – ReturnTo Address
Length: 2 05 – UPS AP Address
/TrackResponse/Shipment/Package/PackageAddress/Type/Description
Description Required: Yes* Description of the code above. PKG
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/PackageAddress/Address
Address Required: Yes* Address Container. PKG
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/PackageAddress/Address/AddressLine
AddressLine Required: Yes* Street address including name PKG
Type: String and number (when applicable)
Max Allowed: 3 and/or building floor, room,
Length: 1..50 suite, and PO Box number. Up
to three AddressLines can be
returned.
/TrackResponse/Shipment/Package/PackageAddress/Address/City
City Required: Yes* City name. PKG
Type: String
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/Package/PackageAddress/Address/StateProvinceCode

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 33
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

StateProvinceCode Required: Yes* State or Province code. PKG
Type: String
Max Allowed: 1
Length: 2..5
/TrackResponse/Shipment/Package/PackageAddress/Address/PostalCode
PostalCode Required: Yes* Postal code. PKG
Type: String
Max Allowed: 1
Length: 5..16
/TrackResponse/Shipment/Package/PackageAddress/Address/CountryCode
CountryCode Required: Yes* Country or territory code. PKG
Type: String
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Package/PackageServiceOption
PackageServiceOption Required: No Container for package service PKG
Type: Container option.
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/Package/PackageServiceOption/Type
Type Required: Yes* Type of package service option PKG
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/PackageServiceOption/Type/Code
Code Required: Yes Package Service code. For values, see Package PKG
Type: String Service Option Codes in the
Max Allowed: 1 Appendix.
Length: 2..3
/TrackResponse/Shipment/Package/PackageServiceOption/Type/Description
Description Required: Yes* Description of the code above. PKG
Type: String
Max Allowed: 1
Length: 1..100
/TrackResponse/Shipment/Package/PackageServiceOption/Value
Value Required: Yes* PackageServiceOption Type PKG
Type: String Code values:
Max Allowed: 1 04 = R – Commercial Invoice
Length: 1..100 Removal Requested or S –
Commercial Invoice Removal
Success.
06 = USPS Package
Identification number that is
returned for UPS Returns
Flexible Access Shipments.
07 = The specific product
description.
09 = R – Return Exchange
Requested or S – Exchange
Completed.
/TrackResponse/Shipment/Package/COD
COD Required: No COD container at package Package Signature Tracking PKG SIG
Type: Container level. only.
Max Allowed: 1 Refer to the Request Option
Length: N/A Matrix in the Appendix.
/TrackResponse/Shipment/Package/COD/Amount
Amount Required: Yes* Container for COD amount Package Signature Tracking PKG SIG
Type: Container information. only.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 34
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/COD/Amount/CurrencyCode
CurrencyCode Required: Yes* Currency code of COD amount. Package Signature Tracking PKG SIG
Type: String only.
Max Allowed: 1
Length: 3
/TrackResponse/Shipment/Package/COD/Amount/MonetaryValue
MonetaryValue Required: Yes* Cash On Delivery (COD) Package Signature Tracking PKG SIG
Type: String Amount that is due. only.
Max Allowed: 1
Length: 11
/TrackResponse/Shipment/Package/COD/Status
Status Required: Yes* Container for COD status. Package Signature Tracking PKG SIG
Type: Container only.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/COD/Status/Code
Code Required: Yes* Status code of whether COD Package Signature Tracking PKG SIG
Type: String was received. Values: only.
Max Allowed: 1 Collected
Length: 1 Not Collected
/TrackResponse/Shipment/Package/COD/ControlNumber
ControlNumber Required: Yes* Barcode COD Control Number Package Signature Tracking PKG SIG
Type: String or UPS imprinted Control only.
Max Allowed: 1 Number.
Length: 1..50
/TrackResponse/Shipment/Package/Activity
Activity Required: No Package activity container PKG, MI
Type: Container
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/Package/Activity/AlternateTrackingInfo
AlternateTrackingInfo Required: Yes* Alternate tracking number. Mail Innovations only. MI
Type: Container
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/Package/Activity/AlternateTrackingInfo/Type
Type Required: Yes* Package Activity Alternate Valid values: MI
Type: String Tracking info type. P – Package ID
Max Allowed: 1 M – Mail Manifest ID (type of
Length: 1 Sequence number)
S – MMS number(type of
Sequence number)
T- Postal service Tracking ID
Q – Intelligent Mail Package
Barcode shipment (IMPB)
number
/TrackResponse/Shipment/Package/Activity/AlternateTrackingInfo/Value
Value Required: Yes* This contains value of the MI
Type: String alternate tracking number.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/Activity/ActivityLocation
ActivityLocation Required: No Activity location container. PKG, MI
Type: Container

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 35
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address
Address Required: Yes* Address of Activity location. For Mail Innovations this will be PKG, MI
Type: Container consignee location.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address/AddressLine
AddressLine Required: Yes* Activity location’s street address PKG
Type: String including name and number
Max Allowed: 3 (when applicable) and/or
Length: 1..30 building floor, room, suite, and
PO Box number. Up to three
AddressLine can be returned.
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address/City
City Required: Yes* City name. This is optional for PKG, MI
Type: String Mail Innovations
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address/StateProvinceCode
StateProvinceCode Required: Yes* Activity location’s state or PKG, MI
Type: String province code. This is optional
Max Allowed: 1 for Mail Innovations.
Length: 2..5
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address/PostalCode
PostalCode Required: Yes* Activity locations postal code. PKG, MI
Type: String
Max Allowed: 1
Length: 5..16
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address/CountryCode
CountryCode Required: Yes* Activity locations country or PKG, MI
Type: String territory code.
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Package/Activity/ActivityLocation/TransportFacility
TransportFacility Required: No This container is for storing the MI
Type: Container type and code of the transport
Max Allowed: 1 facility associated with the Mail
Length: N/A Innovations activity.
/TrackResponse/Shipment/Package/Activity/ActivityLocation/TransportFacility/Type
Type Required: Yes* Type of facility for Mail Mail Innoviations valid values: MI
Type: String Innovations shipment. IC – USPS
Max Allowed: 1 VT – MI
Length: 2
/TrackResponse/Shipment/Package/Activity/ActivityLocation/TransportFacility/Code
Code Required: Yes* This code is associated with the MI
Type: String Mail Innovations facility.
Max Allowed: 1
Length: 5
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Code
Code Required: Yes* Activity location code. PKG
Type: String
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Description

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 36
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Description Required: Yes* Activity location description. PKG
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/Activity/ActivityLocation/SignedForByName
SignedForByName Required: No Name of the person who PKG
Type: String signed.
Max Allowed: 1
Length: 1..50
/TrackResponse/Shipment/Package/Activity/Status
Status Required: No Container for activity status. PKG, MI
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/Status/Type
Type Required: Yes* Type of activity status: For Mail Innovations only D, I, PKG, MI
Type: String I = In Transit M, P and X are applicable.
Max Allowed: 1 D = Delivered
Length: 1..3 X = Exception
P = Pickup
M = Manifest Pickup.
/TrackResponse/Shipment/Package/Activity/Status/Description
Description Required: Yes* Description of status code of PKG, MI
Type: String activity.
Max Allowed: 1
Length: 1..370
/TrackResponse/Shipment/Package/Activity/Status/Code
Code Required: Yes* Status code of activity. PKG, MI
Type: String
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Package/Activity/Date
Date Required: Yes* Date of activity. PKG, MI
Type: String Military format: YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/Package/Activity/Time
Time Required: Yes* Time of activity. PKG, MI
Type: String Military format: HHMMSS or
Max Allowed: 1 HHMM
Length: 4..6

/TrackResponse/Shipment/Package/Activity/GMTDate
GMTDate Required: No Date of activity. PKG, MI
Type: String Format: YYYY-MM-DD
Max Allowed: 1 Note: This container is return if
Length: 8 SubVersion is 1907 or above
/TrackResponse/Shipment/Package/Activity/GMTTime
GMTTime Required: No Time of activity. PKG, MI
Type: String Format: hh:mm:ss or hh:mm
Max Allowed: 1 Note: This container is return if
Length: 6 SubVersion is 1907 or above
/TrackResponse/Shipment/Package/Activity/GMTOffset
GMTOffset Required: No GMT Offset of activity for the PKG, MI
Type: String time zone.
Max Allowed: 1 Format: (+/-) hh:mm
Length: 6

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 37
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Note: This container is return if
SubVersion is 1907 or above
/TrackResponse/Shipment/Package/Activity/DeliveryDateFromManifestIndicator
DeliveryDateFromManif Required: No The presence of this indicator PKG, MI
estIndicator Type: String means manifest information is
Max Allowed: 1 available and used to calculate
Length: N/A the expected delivery date.
This will be available when
Track sub version >=1507
/TrackResponse/Shipment/Package/Activity/NextScheduleActivity
NextScheduleActivity Required: No Container tag to describe when PKG, MI
Type: Container the next schedule activity will
Max Allowed: 1 occur.
Length: N/A Note: This container is return if
SubVersion is 0114 and above
/TrackResponse/Shipment/Package/Activity/NextScheduleActivity/Date
Date Required: Yes* Date of activity. PKG, MI
Type: String Military format: YYYYMMDD
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/NextScheduleActivity/Time
Time Required: Yes* Time of activity. PKG, MI
Type: String Military format: HHMMSS or
Max Allowed: 1 HHMM
Length: N/A
/TrackResponse/Shipment/Package/Activity/Document
Document Required: No Documents at package activity Signature Tracking example: PKG
Type: Container level. Signature image
Max Allowed: UNB Example: PODLetter
Length: N/A
Refer to the Request Option
Matrix in the Appendix.
/TrackResponse/Shipment/Package/Activity/Document/Type
Type Required: Yes* Type of Document. PKG
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/Document/Type/Code
Code Required: Yes* Document Type code. Signature Tracking valid value: PKG
Type: String 04 – POD Letter 01 – Signature Image
Max Allowed: 1 05 – Electronic Delivery Letter
Length: 2
**Returned if customer has
authorized release of the
package with the signature.
/TrackResponse/Shipment/Package/Activity/Document/Type/Description
Description Required: Yes* Description of the code above. PKG
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/Activity/Document/Content
Content Required: Yes* Base64 Encoded PODLetter in Signature Tracking only: PKG
Type: String html format or the customer’s Base64 Encoded GIF image for
Max Allowed: 1 name for Electronic Delivery signature image.
Length: Variable Notice.
/TrackResponse/Shipment/Package/Activity/Document/Format

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 38
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Format Required: Yes* Container for document format. PKG
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/Document/Format/Code
Code Required: Yes Format code of the content. Signature Tracking valid value: PKG
Yes* 03 – HTML 01 – GIF
Type: String 04 – Plain text
Max Allowed: 1
Length: 3
/TrackResponse/Shipment/Package/Activity/Document/Format/Description
Description Required: Yes* Description of Format code PKG
Type: String above.
Max Allowed: 1 Plain text format will only apply
Length: 1..35 if the code above is 04.
/TrackResponse/Shipment/Package/Activity/SensorEventIndicator

SensorEventIndicator Required: Yes* Indicates if the activity has a PKG

Type: String sensor event associated with it.
Max Allowed: UNB Valid values:
Length: 1 Y
N
/TrackResponse/Shipment/Package/Message
Message Required: No Container for additional delivery PKG, MI
Type: Container information.
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/Package/Message/Code
Code Required: Yes* Code describing what type of Valid values: PKG, MI
Type: String message the customer can 01 – On Time
Max Allowed: 1 receive. 02 – Rescheduled
Length: 2 03 – Returned To Shipper

For Mail Innovations only01 is

applicable.
/TrackResponse/Shipment/Package/Message/Description
Description Required: Yes* Description for the code above. PKG, MI
Type: String
Max Allowed: 1
Length: 1..50
/TrackResponse/Shipment/Package/PackageWeight
PackageWeight Required: No Container for package weight. PKG, MI
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/PackageWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container for package weight PKG, MI
Type: Container unit of measurement.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/PackageWeight/UnitOfMeasurement/Code
Code Required: Yes* Package weight unit of Valid values: PKG, MI
Type: String measurement code. LBS – Pounds (default)
Max Allowed: 1 KGS – Kilograms
Length: 3 OZS – Ounces
/TrackResponse/Shipment/Package/PackageWeight/UnitOfMeasurement/Description

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 39
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Description Required: Yes* Description of the package PKG, MI
Type: String weight measurement units.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/PackageWeight/Weight
Weight Required: Yes* Packages weight. Set to 0 for PKG, MI
Type: String package type of letters.
Max Allowed: 1
Length: 7
/TrackResponse/Shipment/Package/ReferenceNumber
ReferenceNumber Required: No Container for package reference PKG, MI
Type: Container number. Up to 20 reference
Max Allowed: UNB numbers can be returned.
Length: N/A
/TrackResponse/Shipment/Package/ReferenceNumber/Code
Code Required: Yes* Package Reference number For valid values, see Reference PKG, MI
Type: String type code. The code specifies Number Codes in the Appendix.
Max Allowed: 1 the Reference name.
Length: 2
/TrackResponse/Shipment/Package/ReferenceNumber/Value
Value Required: Yes* Customer supplied reference PKG, MI
Type: String number.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/AlternateTrackingNumber
AlternateTrackingNumb Required: No Alternate tracking number PKG
er Type: String returned for this package.
Max Allowed: UNB
Length: 35..65
/TrackResponse/Shipment/Package/AlternateTrackingInfo
AlternateTrackingInfo Required: Cond Alternate tracking number Mail Innovations only. MI
Type: Container returned for this package.
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/Package/AlternateTrackingInfo/Type
Type Required: Yes* Package Alternate Tracking info Valid values: MI
Type: String type. P – Package ID
Max Allowed: 1 M -Mail Manifest ID (type of
Length: 1 Sequence number)
S- MMS number (type of
Sequence number)
T- Postal service Tracking ID
/TrackResponse/Shipment/Package/AlternateTrackingInfo/Value
Value Required: Yes* This contains value of the MI
Type: String alternate tracking number.
Max Allowed: 1
Length: 1..34
/TrackResponse/Shipment/Package/DimensionalWeightScanIndicator
DimensionalWeightSca Required: No Present if Dimensional Weight PKG
nIndicator Type: String Scan is used to recalculate
Max Allowed: 1 schedule delivery date.
Length: 0 Note: This Indicator is return if
SubVersion is 1407 and above.
/TrackResponse/Shipment/Package/PreauthorizedReturnInformation
PreauthorizedReturnInf Required: No Container for the Pre-authorized This container will be returned PKG, MI
ormation Type: Container For Return Information. If this only if the
information is requested and PreauthorizedReturnIndicator is

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 40
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Max Allowed: 1 available, then this container will present in request and Pre-
Length: N/A be populated for small authorized For Return Eligibility
packages and Mail Innovation information is available.
packages.
/TrackResponse/Shipment/Package/PreauthorizedReturnInformation/ReturnEligibilityIndicator
ReturnEligibilityIndicato Required: No Contains Eligibility of the Valid values are : PKG, MI
r Type: String original package to initiate the Y – Eligible
Max Allowed: 1 “return process” via the given N – Not Eligible
Length: 1 url.
Valid values are :
Y – Eligible
N – Not Eligible
/TrackResponse/Shipment/Package/PreauthorizedReturnInformation/ReturnExpirationDate
ReturnExpirationDate Required: No Contains the last date at which YYYYMMDD PKG, MI
Type: String the original package can
Max Allowed: 1 request a “return process” via
Length: 8 the given url.

/TrackResponse/Shipment/Package/PreauthorizedReturnInformation/ReturnRequestURL
ReturnRequestURL Required: No Contains the url that can be PKG, MI
Type: String used to initiate the “return
Max Allowed: 1 process”.
Length: UNB
/TrackResponse/Shipment/Package/PreauthorizedReturnInformation/OriginalTrackingNumber
OriginalTrackingNumbe Required: No Contains the tracking number of PKG, MI
r Type: String the original package.
Max Allowed: 1
Length: 1...21
/TrackResponse/Shipment/Package/PreauthorizedReturnInformation/ReturnTrackingNumber
ReturnTrackingNumber Required: No Contains the tracking number of PKG, MI
Type: String the return package.
Max Allowed: 1
Length: 1...21
/TrackResponse/Shipment/Package/UPSPremierAccessorial
UPSPremierAccessoria Required: No PKG
l Type: Container
Max Allowed: 1
/TrackResponse/Shipment/Package/UPSPremierAccessorial/UPSPremierCode

UPSPremierCode Required: No Valid Values: PKG

Type: String 279 (Silver)
Max Allowed: 1 278 (Gold)
Length: N/A 280 (Platinum)

/TrackResponse/Shipment/Package/UPSPremierAccessorial/UPSPremierDescription
UPSPremierDescriptio Required: No Valid Values: PKG
n Type: String UPS Premier Silver
Max Allowed: 1 UPS Premier Gold
Length: N/A UPS Premier Platinum
/TrackResponse/Shipment/Package/FlightIndicator
FlightIndicator Required: No This indicator will be used to Valid Values: PKG
Type: String display a plane icon and details true,
Max Allowed: 1 on the status of the UPS false
Length: N/A Premier Package so that the
user will know their package is
currently on a plane. The
locations will update once the
package is no longer in flight

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 41
UPS Tracking Web Service Developer Guide September 13,2023

Name Constraint Description Validation Type

Returns true if flight indicator is
available and return false if flight
indicator is not available.

Disclaimer
Name Constraint Description Validation Type
/TrackResponse/Disclaimer
Disclaimer Required: No Any necessary or special notice. All
Type: String
Max Allowed: UNB
Length: 1..300

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 42
UPS Tracking Web Service Developer Guide September 13,2023

Chapter 5: Tracking Web Service API Examples

Tracking Request
<soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:v1=”http://www.ups.com/XMLSchema/XOLTWS/UPSS/v1.0”
xmlns:v3=”http://www.ups.com/XMLSchema/XOLTWS/Track/v2.0”
xmlns:v11=”http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0”>
<soapenv:Header>
<v1:UPSSecurity>
<v1:UsernameToken>
<v1:Username>YourUserID</v1:Username>
<v1:Password>YourPassword</v1:Password>
</v1:UsernameToken>
<v1:ServiceAccessToken>
<v1:AccessLicenseNumber>YourLicenseNumber</v1:AccessLicenseNumber>
</v1:ServiceAccessToken>
</v1:UPSSecurity>
</soapenv:Header>
<soapenv:Body>
<v3:TrackRequest>
<v11:Request>
<v11:RequestOption>1</v11:RequestOption>
<v11:TransactionReference>
<v11:CustomerContext>Your Test Case Summary Description</v11:CustomerContext>
</v11:TransactionReference>
</v11:Request>
<v3:InquiryNumber>YourTrackingNumber</v3:InquiryNumber>
</v3:TrackRequest>
</soapenv:Body>
</soapenv:Envelope>

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 43
UPS Tracking Web Service Developer Guide September 13,2023

Track Response
<?xml version=”1.0” encoding=”UTF-8”?>
<soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”>
<soapenv:Header/>
<soapenv:Body>
<trk:TrackResponse xmlns:trk=”http://www.ups.com/XMLSchema/XOLTWS/Track/v2.0”>
<common:Response xmlns:common=”http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0”>
<common:ResponseStatus>
<common:Code>1</common:Code>
<common:Description>Success</common:Description>
</common:ResponseStatus>
<common:TransactionReference>
<common:CustomerContext>Your Test Case Summary
Description</common:CustomerContext>
</common:TransactionReference>
</common:Response>
<trk:Shipment>
<trk:InquiryNumber>
<trk:Code>01</trk:Code>
<trk:Description>ShipmentIdentificationNumber</trk:Description>
<trk:Value>1Z12345E1305277940</trk:Value>
</trk:InquiryNumber>
<trk:ShipmentType>
<trk:Code>01</trk:Code>
<trk:Description>Package</trk:Description>
</trk:ShipmentType>
<trk:ShipperNumber>12345E</trk:ShipperNumber>
<trk:Service>
<trk:Code>013</trk:Code>
<trk:Description>NEXT DAY AIR SAVER</trk:Description>
</trk:Service>
<trk:PickupDate>20100302</trk:PickupDate>
<trk:Package>
<trk:TrackingNumber>1Z12345E1305277940</trk:TrackingNumber>
<trk:Activity>
<trk:ActivityLocation>
<trk:Address>
<trk:City>GRAND JUNCTION AIR S</trk:City>
<trk:StateProvinceCode>CO</trk:StateProvinceCode>
<trk:CountryCode>US</trk:CountryCode>
</trk:Address>

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 44
UPS Tracking Web Service Developer Guide September 13,2023

</trk:ActivityLocation>
<trk:Status>
<trk:Type>I</trk:Type>
<trk:Description>ORIGIN SCAN</trk:Description>
<trk:Code>OR</trk:Code>
</trk:Status>
<trk:Date>20100505</trk:Date>
<trk:Time>010000</trk:Time>
</trk:Activity>
<trk:PackageWeight>
<trk:UnitOfMeasurement>
<trk:Code>LBS</trk:Code>
</trk:UnitOfMeasurement>
<trk:Weight>0.00</trk:Weight>
</trk:PackageWeight>
<trk:ReferenceNumber>
<trk:Code>01</trk:Code>
<trk:Value>FLCAPA</trk:Value>
</trk:ReferenceNumber>
<trk:ReferenceNumber>
<trk:Code>08</trk:Code>
<trk:Value>TG5432</trk:Value>
</trk:ReferenceNumber>
</trk:Package>
</trk:Shipment>
</trk:TrackResponse>
</soapenv:Body>
</soapenv:Envelope>

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 45
UPS Tracking Web Service Developer Guide September 13,2023

Signature Tracking Request

<soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:v1=”http://www.ups.com/XMLSchema/XOLTWS/UPSS/v1.0”
xmlns:v3=”http://www.ups.com/XMLSchema/XOLTWS/Track/v2.0”
xmlns:v11=”http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0”>
<soapenv:Header>
<v1:UPSSecurity>
<v1:UsernameToken>
<v1:Username>YourUserID</v1:Username>
<v1:Password>YourPassword</v1:Password>
</v1:UsernameToken>
<v1:ServiceAccessToken>
<v1:AccessLicenseNumber>YourLicenseNumber</v1:AccessLicenseNumber>
</v1:ServiceAccessToken>
</v1:UPSSecurity>
</soapenv:Header>
<soapenv:Body>
<v3:TrackRequest>
<v11:Request>
<v11:RequestOption>15</v11:RequestOption>
<v11:TransactionReference>
<v11:CustomerContext>Your Test Case Summary Description</v11:CustomerContext>
</v11:TransactionReference>
</v11:Request>
<v3:InquiryNumber>YourTrackingNumber</v3:InquiryNumber>
</v3:TrackRequest>
</soapenv:Body>
</soapenv:Envelope>

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 46
UPS Tracking Web Service Developer Guide September 13,2023

Signature Tracking Response

<soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”>
<soapenv:Header/>
<soapenv:Body>
<trk:TrackResponse xmlns:trk=”http://www.ups.com/XMLSchema/XOLTWS/Track/v2.0”>
<common:Response
xmlns:common=”http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0”>
<common:ResponseStatus>
<common:Code>1</common:Code>
<common:Description>Success</common:Description>
</common:ResponseStatus>
<common:TransactionReference>
<common:CustomerContext>Signature track test</common:CustomerContext>
</common:TransactionReference>
</common:Response>
<trk:Shipment>
<trk:InquiryNumber>
<trk:Code>01</trk:Code>
<trk:Description>ShipmentIdentificationNumber</trk:Description>
<trk:Value>YourTrackingNumber</trk:Value>
</trk:InquiryNumber>
<trk:ShipperNumber>F00100</trk:ShipperNumber>
<trk:ShipmentWeight>
<trk:UnitOfMeasurement>
<trk:Code>LBS</trk:Code>
</trk:UnitOfMeasurement>
<trk:Weight>35.00</trk:Weight>
</trk:ShipmentWeight>
<trk:Service>
<trk:Code>02</trk:Code>
<trk:Description>UPS 2ND DAY AIR</trk:Description>
</trk:Service>
<trk:Package>
<trk:TrackingNumber>YourTrackingNumber</trk:TrackingNumber>
<trk:Activity>
<trk:ActivityLocation>
<trk:Address/>
</trk:ActivityLocation>
<trk:Status>
<trk:Type>X</trk:Type>
<trk:Description>Delivered to UPS Access Point™ location and awaiting customer
pickup.</trk:Description>
<trk:Code>ZP</trk:Code>
</trk:Status>
<trk:Date>20130925</trk:Date>
<trk:Time>172800</trk:Time>
</trk:Activity>
<trk:Activity>
<trk:ActivityLocation>
<trk:Address>

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 47
UPS Tracking Web Service Developer Guide September 13,2023

<trk:City>LONDON CENTRAL</trk:City>
<trk:CountryCode>GB</trk:CountryCode>
</trk:Address>
</trk:ActivityLocation>
<trk:Status>
<trk:Type>X</trk:Type>
<trk:Description>Delivered to UPS Access Point™ location and awaiting customer
pickup.</trk:Description>
<trk:Code>ZP</trk:Code>
</trk:Status>
<trk:Date>20130925</trk:Date>
<trk:Time>172300</trk:Time>
</trk:Activity>
<trk:Activity>
<trk:ActivityLocation>
<trk:Address>
<trk:City>MAYSVILLE</trk:City>
<trk:StateProvinceCode>WV</trk:StateProvinceCode>
<trk:PostalCode>26833 9700</trk:PostalCode>
<trk:CountryCode>US</trk:CountryCode>
</trk:Address>
<trk:Code>MG</trk:Code>
<trk:Description>LEFT WITH MAN</trk:Description>
<trk:SignedForByName>Larry</trk:SignedForByName>
</trk:ActivityLocation>
<trk:Status>
<trk:Type>D</trk:Type>
<trk:Description>Delivered</trk:Description>
<trk:Code>KB</trk:Code>
</trk:Status>
<trk:Date>20030313</trk:Date>
<trk:Time>160000</trk:Time>
<trk:Document>
<trk:Type>
<trk:Code>04</trk:Code>
<trk:Description>POD Letter</trk:Description>
</trk:Type>
<trk:Content>Base64 Encoded PODLetter in html format</trk:Content>
<trk:Format>
<trk:Code>03</trk:Code>
<trk:Description>HTML</trk:Description>
</trk:Format>
</trk:Document>
</trk:Activity>
<trk:PackageWeight>
<trk:UnitOfMeasurement>
<trk:Code>LBS</trk:Code>
</trk:UnitOfMeasurement>
<trk:Weight>35.00</trk:Weight>
</trk:PackageWeight>

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 48
UPS Tracking Web Service Developer Guide September 13,2023

</trk:Package>
</trk:Shipment>
</trk:TrackResponse>
</soapenv:Body>
</soapenv:Envelope>

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 49
UPS Tracking Web Service Developer Guide September 13,2023

Chapter 6: Tracking API FAQs

Category Question Answer
Scan Types Does a scan type display when a UPS receives PSB scans at the shipment level
driver scans a Pickup Summary (when available), but we don’t display the
Barcode (PSB) in the Tracking information within our tracking systems.
API?

Scheduled Delivery Date Does the Tracking API provide a Yes. ScheduledDeliveryDate container described
(SDD) and Rescheduled Scheduled Delivery Date? within the Developer Guide. If the SDD changes
Delivery Date (RSD) then a date is returned within the
RescheduledDeliveryDate container.

Tracking What is the UPS Tracking API UPS Tracking API is an Internet-based
and Signature Tracking API? application that adds a new level of customer
service throughout your company and
functionality to your e-commerce Web site or
enterprise application. With UPS Tracking API,
your customers can track products they have
purchased online more efficiently than ever
before.
UPS Tracking API: Provide up-to-the-minute
shipment status – from origin to delivery – to your
online customers.
UPS Signature Tracking API: Obtain proof of
delivery containing a digitized signature and
delivery address.

Tracking How much does the UPS UPS Tracking API is free to license. There are no
Tracking API cost? hidden fees or charges, though you may require
IT resources or 3rd party developers depending on
how complex your integration application is.

Tracking What is the difference between Basically the Tracking and Signature Tracking
Tracking API and Signature API is the same, with the exception for
Tracking API? authorization to see full Delivery address,
‘delivered to’ name, and Signature image.

Tracking Can I use Tracking information in UPS strongly discourage the use of Framed
a Frame on my own site? information. See the UPS.Com Terms and
Conditions accepted by all registered users.

Tracking Why is the Tracking Online Tools Online Tools described many different APIs. UPS
now called UPS Tracking API? Tracking API describes the Tracking API and
registering for it is now simple and easier to use.

Tracking Could my Tracking API license UPS retains the right to revoke an access key or
be revoked? block access from any user that abuse the
tracking system.

Tracking Why am I not receiving a If a shipment was created with the UPS Shipping
response on my tracking number API, UIS or UIFS, do not attempt to track it
that I just created? Information immediately because it will not be available until
unavailable. the UPS database has been populated with the
manifest details, usually 5 to 10 minutes.
If a shipper used a shipping system like
WorldShip and fails to upload manifest details by
completing EOD, UPS will not have the manifest
information, and Tracking will not be able to
return a response until a subsequent event,
example: origin scan.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 50
UPS Tracking Web Service Developer Guide September 13,2023

Category Question Answer

Transport Modes What transport modes are All modes of transport are available within the
available within the Tracking Tracking API for; package.
API?

Basic tracking Does the Tracking API support Yes, we display tracking info for BASIC on
Basic service? UPS.com and in XOLT just like for any other
package service.
However, it is important to remember that the
Delivery is made by the post office and a delivery
scan may be delayed or not available at all.
SDD/RDD is NOT displayed with Basic services
tracking statuses.
As for an In Transit status, the status is triggered
by a movement scan, just like for our other
package offerings. An origin, pickup, arrival, or
departure scan will display In Transit status.

Here is an example 1Z in production if you want

to check: 1Z2W99W3PP20791577

Reference Number If a customer processes 7 You can track a shipment through reference 1 or
Tracking packages in one shipment, will reference 2 only. When tracking a multiple-piece
reference number tracking in the shipment if you use the lead number it will show
Tracking API playback all seven you the information for the first 50 packages
packages or just the lead within that shipment however, if you track with
package or any one of the other than the lead number it will only show the
packages in some type of order? tracking information for that individual packages.

Reference number tracking Why do I see xxxxxxxxx1234 Based on the request of some shippers, some
instead of the tracking number tracking numbers in the reference number track
when I do a reference number results may be masked.
search
Scan Info Is the “Billing Information Yes
Received” scan the same as the
“Order Processed: Ready for
UPS” scan on the web?

Scan Info Why isn’t there a Scheduled Day Since these are packages that can be injected
of Delivery (SDD) returned with into the UPS Operations from any channel UPS
the Billing Information Received waits until we are certain we have taken
scan? possession of the package prior to including an
SDD.

Scan Info I see the Tracking API returning a UPS Internal Activity scan is a generic description
scan called “UPS Internal for one of several internal operations scans which
Activity”. What is this and why are filtered by the web tracking application at
don’t I see this when I track a UPS.com. These scans are not used
package on the web at externally. You may consider dropping these
UPS.com? records in your process.

POD How long can I store the POD? UPS Technology Agreement allows you to store a
POD letter (which may or may not contain digital
signature) for a maximum of 18 months.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 51
UPS Tracking Web Service Developer Guide September 13,2023

Category Question Answer

High Frequency tracking What are guidelines for high • Ensure tracking requests are valid. If your
guidelines frequency tracking? request returns an error message such as
"tracking number not found", "no information
available", or "invalid tracking number", you
should research the cause of the error before
continuing to track the same number.
• When the results of a tracking request indicate a
“delivered” status do not continue to track the
package.
• Track packages during “off hours” whenever
possible, “off hours” are from 5:00 pm till 8:00 am
East Coast time.
• Use your UPS service level (Early, Next Day Air,
etc.) to determine the best time of day to track
and receive up to the minute tracking information.
• Evenly distribute your information requests over
the remaining 19 hour window.
• If daily/weekly tracking requests exceed daily
shipping volume by a large margin, UPS will
reserve the right to suspend tracking for that
account until the situation is rectified. If a
resolution cannot be found and implemented,
tracking for that account may be terminated.
• If you are tracking with an automated tracking
robot make sure you check your system at least
once a week to insure it’s operating at peak
performance. Most HFT cases are due to
automated tracking systems becoming corrupt
and falling into a tracking loop.
• Refrain from tracking the same numbers
continually throughout the day. Unique tracking
numbers should be tracked no more than once
per hour or a maximum of 24 times in a single
day.
• Avoid automatic access between 10:00 am to
3:00 pm EST. However, you may track critical
packages during this time.

General What is Pre-Authorized Returns? A shipper has the ability to authorize a receiver to
print a Return Service Label to make retail
merchandise returns easier. A URL is included in
the Response XML for eligible packages

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 52
UPS Tracking Web Service Developer Guide September 13,2023

Signature Tracking FAQs

Storage of electronic How long is data stored for 120 days.

image Signature Tracking signature
image?

Storage of electronic Is there a watermark behind the Yes. It is part of the signature image returned by
image signature image returned by the the UPS Signature Tracking API and cannot be
UPS Signature Tracking API? modified in any way, transferred etcetera.
Electronic Signature Images and POD Letters
The information you receive through the API may
include electronic signature images.
Electronic Signature Images, other than as part of
a POD Letter, may not be stored, distributed to
any third party, copied, or modified.
Each POD Letter generated or developed as the
result of using or access to the UPS OnLine Tools
Tracking Tool may be stored in electronic format
until eighteen (18) months after the delivery of the
shipment referenced in the POD Letter.
Your application may not distribute a POD Letter
electronically to third parties, other than as a
facsimile transmission.

Transmission of electronic Can the POD Letter generated No. Only faxed or mailed. It can be stored
image through a POD image be electronically for 18 months but cannot be
emailed? emailed.

Tracking How do I add shipper accounts To add shipper account for Signature tracking the
for authorization to Signature user can access myUPS on UPS.Com by logging
Tracking API? in with the user ID and password associated with
the access key, and adding the account to the
account summary. A recent invoice will be
needed to provide the latest invoice date, amount,
and control number (if applicable)

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 53
UPS Tracking Web Service Developer Guide September 13,2023

Appendices

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 54
UPS Tracking Web Service Developer Guide September 13,2023

Error Codes (WS)

When the UPS system is unable to respond to a request, be it from a malformed request, an illegal or invalid value, or
other issues, the API generates an error response. For examples and additional information on error responses, refer
to Chapter 3: Error Responses, in the Introduction to the UPS Developer Kit guide.
Successful responses may or may not include alerts.
o Without alerts – Indicates the request has been processed as anticipated.
o With alerts – Indicates the request has been processed with potentially unanticipated results. The alert
contains information in the response that should be passed to the end user.
The severity of an error may be transient or hard.
o Transient error – Indicates an error that is temporary in nature. Such errors may be caused by response
timeouts due to high server loads or scheduled maintenance in progress. The request may be issued
successfully at a later time.
o Hard error – Indicates the request has a problem that the system is not able to resolve. These errors are
critical and prevent requests from processing.
Do not resubmit requests with Hard Errors until the problems causing the error have been
resolved.

Common Error Codes

The following error codes can apply to all Webservice and other APIs.

Code Severity Description

10001 Hard The request is not well formed.

10002 Hard The request is well formed but the request is not valid.

10003 Hard The request is either empty or null.

10006 Hard Although the document is well formed and valid, the element content contains values
which do not conform to the rules and constraints contained in this specification.

10013 Hard The message is too large to be processed by the Application.

10429 Transient Too many requests

20001 Transient General process failure.

20002 Hard The specified service name, {0}, and version number, {1}, combination is invalid.

20003 Hard Please check the server environment for the proper J2EE ws apis.

20006 Hard Invalid request action.

20007 Hard Missing Required field, {0}.

20008 Hard The field, {0}, contains invalid data, {1}.

20012 Hard The Client Information exceeds its Maximum Limit of {0}.

250000 Hard No XML declaration in the XML document.

250001 Hard Invalid Access License for the tool. Please re-license.

250002 Hard Invalid UserId/Password.

250003 Hard Invalid Access License number.

250004 Hard Incorrect UserId or Password.

250005 Hard No Access and Authentication Credentials provided.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 55
UPS Tracking Web Service Developer Guide September 13,2023

Code Severity Description

250006 Hard The maximum number of user access attempts was exceeded.

250007 Hard The UserId is currently locked out; please try again in 30 minutes.

250009 Hard License Number not found in the UPS database.

250019 Hard Invalid Field value.

250050 Transient License system not available.

Tracking Error Codes

Error Code Severity Description
20011 Hard The Integration indicator is no longer supported

150000 Transient Tracking service unavailable

150020 Hard Invalid pickup date range

150021 Hard Invalid shipment identification number

150022 Hard Invalid tracking number

150023 Hard Invalid reference number value length

150024 Hard Invalid destination postal code length

150025 Hard Invalid destination country code length

150026 Hard Invalid begin date length

150027 Hard Invalid end date length

150028 Hard Invalid shipper number length

150029 Hard Duplicate Tracking Numbers found in Package Detail

150030 Hard Invalid Request/ RequestOption

150040 Hard Invalid data found or the combination of data elements is invalid

150099 Transient Delivery Change Request System Unavailable

151018 Hard Invalid tracking number

151019 Hard No activity records found for tracking number

151036 Hard Either tracking number or reference number required

151038 Hard Shipment number required with reference number

151040 Hard Both tracking number and reference number invalid

151044 Hard No tracking information available

151045 Hard No information found

151050 Hard Too many records to display

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 56
UPS Tracking Web Service Developer Guide September 13,2023

Error Code Severity Description

151051 Hard Some Records are not returned

151062 Hard No tracking information available

151068 Hard Invalid Shipper Number

151085 Hard Multiple shipper numbers found

151086 Hard Maximum candidate exceeded for Reference number search. Use the tracking number
search

151091 Hard Multiple reference numbers found, it may be possible to narrow the search with
additional data.

151602 Hard Destination Country Code must be entered

152012 Hard Number of records selected exceeds limit of 175

152100 Hard Enter shipper number -–additional shippers used the reference

152110 Hard No information found for reference number

152315 Hard Multiple reference numbers found, it is not possible to qualify further.

154010 Hard Invalid inquiry number

154030 Hard No information for this tracking number

154040 Hard Invalid tracking type

154050 Hard Non-unique BCD number -–Candidate List returned

154070 Hard Signature Tracking Options not available without successful login

154082 Hard The supplied Candidate Bookmark fails validation

154083 HARD Specific Tracking data could not be found. It may be possible to narrow the search with
additional data.

150084 Hard Invalid origin postal code length

150085 Hard Invalid origin country code length

154086 Hard Missing origin country code when origin postal code is supplied

155001 Transient Mail Innovations Tracking Service Unavailable.

155002 Hard Mail Innovations Tracking Information not found.

155003 Hard Invalid request option for Mail Innovations.

155005 Hard Invalid country code for Mail Innovations.

155006 Hard Invalid postal code for Mail Innovations.

9150001 Hard Invalid access license number for tracking request option

9150002 Hard Invalid or missing inquiry number -–TrackingNumber, ShipmentIdentificationNumber, or

ReferenceNumber

9150003 Hard Invalid Candidate Bookmark

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 57
UPS Tracking Web Service Developer Guide September 13,2023

Error Code Severity Description

9150004 Hard Shipment Type should be specified when tracking by Reference Number

9150006 Hard CountryCode should be specified when ShipperAccountInfo container is present.

9150007 Hard Missing Recipient Email Address

9150008 Hard Missing Failure Email Address

9150009 Hard Missing Language information.

9154099 Hard Either ExceptionNotificationIndicator or DeliveryNotificationIndicator has to be supplied

with Quantum View Notification request.

9151000 Hard Invalid Tracking Request Document

Alert Codes
Code Description

154080 Could not verify Signature rights

154081 Your search returned multiple Shipments. Please select from the provided results.

155004 Max size of the candidate list is exceeded.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 58
UPS Tracking Web Service Developer Guide September 13,2023

Accessorial Codes
01 -–Signature Required
02 -–Adult Signature Required
03 -–Import Control
04 -–Commercial Invoice Removal
05 -–UPS Carbon Neutral
06 -–USPS PIC Number Of Flexible Return Shipment (The value tag is populated)
07 -–Product Type (This may have additional attributes populated for product type code and description)
08 -–Location Assured
09 – Exchange Based
10 – Packand Collect
030 – Hazardous Material Dangerous Goods
035 – Saturday Pickup
036 – Saturday Delivery
039 – Declared Value Insurance
043 – Customized Delivery Confirm.
058 -–Hold for Pickup
209 – Dry Ice
229 – Carbon Neutral Shipment
232 – UPS Returns Exchange (Forward MVMT)
233 – UPS Ret Pack and Collect
234 – UPS Returns Exchange Print Label
254 -–Lift Gate Service for Delivery
255 -–Lift Gate Service for Pickup
256 -–Drop Off At Facility
259 -–Direct to Retail
261 -–Deliver to Addressee only
262 -–Deliver to Retail COD
263 -–Retail to Retail Shipment
426 -–Direct Delivery Only
427 -–Infectious Substance Category A
428 -–Package Release Code

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 59
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Codes
Tracking API Supported Countries/Territories
UPS country/territory code abbreviations generally follow the recommendations of the International Standards
Organization (ISO), which publishes a list of country or territory abbreviations in ISO Standard 3166.
The following table lists the country or territory codes defined by ISO at the time of this publication. The latest
information is available from the ISO web site: http://www.iso.org/.

 NOTE: Not all UPS services are available in every country/territory. Refer to the UPS Rate and Service Guide at
UPS.com for more information on UPS services.

Country/Territory Name Country/Territory Code Supported Supported

Forward Origin Return Origin
Afghanistan AF

Åland Islands AX

Albania AL Yes

Algeria DZ

American Samoa AS

Andorra AD Yes

Angola AO

Anguilla AI Yes

Antarctica AQ

Antigua and Barbados AG Yes

Argentina AR Yes Yes

Armenia AM

Aruba AW

Australia AU Yes Yes

Austria AT Yes Yes

Azerbaijan AZ

Bahamas BS Yes

Bahrain BH Yes

Bangladesh BD

Barbados BB

Belarus BY

Belgium BE Yes Yes

Belize BZ

Benin BJ

Bermuda BM Yes Yes

Bhutan BT

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 60
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Name Country/Territory Code Supported Supported

Forward Origin Return Origin
Bolivia BO Yes

Bosnia and Herzegovina BA

Botswana BW

Bouvet Island BV

Brazil BR Yes Yes

British Indian Ocean Territory IO

Brunei Darussalam BN

Bulgaria BG Yes

Burkina Faso BF

Burundi BI

Cambodia KH

Cameroon CM

Canada CA Yes Yes

Cape Verde CV

Cayman Islands KY Yes

Central African Republic CF

Chad TD

Chile CL Yes Yes

China Mainland CN Yes Yes

Christmas Island CX

Cocos (Keeling) Islands CC

Colombia CO Yes Yes

Comoros KM

Congo CG

Congo, The Democratic CD

Republic of

Cook Islands CK

Costa Rica CR Yes Yes

Côte Divoire CI

Croatia HR Yes

Cuba CU

Cyprus CY Yes

Czech Republic CZ Yes Yes

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 61
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Name Country/Territory Code Supported Supported

Forward Origin Return Origin
Denmark DK Yes Yes

Djibouti DJ

Dominica DM

Dominican Republic DO Yes Yes

Ecuador EC Yes Yes

Egypt EG Yes

El Salvador SV Yes Yes

Equatorial Guinea GQ

Eritrea ER

Estonia EE Yes

Ethiopia ET

Falkland Islands (Malvinas) FK

Faroe Islands FO

Fiji FJ

Finland FI Yes Yes

France FR Yes Yes

French Guiana GF

French Polynesia PF

French Southern Territories TF

Gabon GA

Gambia GM

Georgia GE

Germany DE Yes Yes

Ghana GH

Gibraltar GI

Greece GR Yes Yes

Greenland GL

Grenada GD Yes

Guadeloupe GP

Guam GU

Guatemala GT Yes Yes

Guernsey GG Yes Yes

Guinea GN

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 62
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Name Country/Territory Code Supported Supported

Forward Origin Return Origin
Guinea-Bissau GW

Guyana GY

Haiti HT Yes

Heard Island and HM

McDonald Islands

Holy See (Vatican City VA

State)

Honduras HN Yes Yes

Hong Kong SAR, China HK Yes Yes

Hungary HU Yes Yes

Iceland IS Yes

India IN Yes Yes

Indonesia ID Yes Yes

Iran, Islamic Republic of IR

Iraq IQ

Ireland IE Yes Yes

Isle of Man IM

Israel IL Yes Yes

Italy IT Yes Yes

Jamaica JM Yes

Japan JP Yes Yes

Jersey JE Yes Yes

Jordan JO

Kazakhstan KZ

Kenya KE

Kiribati KI

Korea, Democratic People’s KP

Republic of

Korea, Republic of KR Yes Yes

Kuwait KW Yes

Kyrgyzstan KG

Lao Peoples Democratic LA

Republic

Latvia LV Yes

Lebanon LB Yes

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 63
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Name Country/Territory Code Supported Supported

Forward Origin Return Origin
Lesotho LS

Liberia LR

Libyan Arab Jamahiriya LY

Liechtenstein LI Yes

Lithuania LT Yes

Luxembourg LU Yes

Macau (Macao) SAR, China MO Yes Yes

Macedonia, The Former MK

Yugoslav Republic of

Madagascar MG

Malawi MW

Malaysia MY Yes Yes

Maldives MV

Mali ML

Malta MT Yes

Marshall Islands MH

Martinique MQ Yes

Mauritania MR

Mauritius MU

Mayotte YT

Mexico MX Yes Yes

Micronesia, Federated FM
States of

Moldova, Republic of MD

Monaco MC Yes

Mongolia MN

Montenegro ME Yes

Montserrat MS Yes

Morocco MA

Mozambique MZ

Myanmar MM

Namibia NA

Nauru NR

Nepal NP

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 64
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Name Country/Territory Code Supported Supported

Forward Origin Return Origin
Netherlands NL Yes Yes

Netherlands Antilles AN

New Caledonia NC

New Zealand NZ Yes Yes

Nicaragua NI Yes Yes

Niger NE

Nigeria NG Yes

Nigeria NG

Niue NU

Norfolk Island NF

Northern Mariana Islands MP

Norway NO Yes Yes

Oman OM Yes

Pakistan PK Yes

Palau PW Yes

Palestinian Territory, PS
Occupied

Panama PA Yes Yes

Papua New Guinea PG

Paraguay PY Yes Yes

Peru PE Yes Yes

Philippines PH Yes Yes

Pitcairn PN

Poland PL Yes Yes

Portugal PT Yes Yes

Puerto Rico PR Yes Yes

Qatar QA Yes

Réunion RE

Romania RO Yes Yes

Russian Federation RU Yes Yes

Rwanda RW

Saint Helena SH

Saint Kitts and Nevis KN Yes

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 65
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Name Country/Territory Code Supported Supported

Forward Origin Return Origin
Saint Lucia LC Yes

Saint Pierre and Miquelon PM

Saint Vincent and The VC Yes

Grenadines

Samoa WS

San Marino SM Yes

Sao Tome and Principe ST

Saudi Arabia SA Yes

Senegal SN

Serbia RS Yes

Seychelles SC

Sierra Leone SL

Singapore SG Yes Yes

Slovakia SK Yes

Slovenia SI Yes

Solomon Islands SB

Somalia SO

South Africa ZA Yes

South Georgia and GS

The South Sandwich Islands

Spain ES Yes Yes

Sri Lanka LK Yes

Sudan SD

Suriname SR Yes

Svalbard and Jan Mayen SJ

Swaziland SZ

Sweden SE Yes Yes

Switzerland CH Yes Yes

Syrian Arab Republic SY

Taiwan, China TW Yes Yes

Tajikistan TJ

Tanzania, United Republic of TZ

Thailand TH Yes Yes

Timor-Leste TL

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 66
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Name Country/Territory Code Supported Supported

Forward Origin Return Origin
Togo TG

Tokelau TK

Tonga TO

Trinidad and Tobago TT

Tunisia TN Yes

Turkey TR Yes Yes

Turkmenistan TM

Turks and Caicos Islands TC Yes

Tuvalu TV

Uganda UG

Ukraine UA Yes

United Arab Emirates AE Yes

United Kingdom GB Yes Yes

United States US Yes Yes

United States Minor UM

Outlying Islands

Uruguay UY Yes Yes

Uzbekistan UZ

Vanuatu VU

Venezuela VE Yes Yes

Viet Nam VN Yes

Virgin Islands, British VG

Virgin Islands, U.S. VI Yes Yes

Wallis and Futuna WF

Western Sahara EH

Yemen YE

Zambia ZM

Zimbabwe ZW

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 67
UPS Tracking Web Service Developer Guide September 13,2023

Currency Codes
UPS currency code abbreviations generally follow the recommendations of the International Standards Organization
(ISO), which publishes a list of currency abbreviations in ISO Standard 4217. The following table lists the currency
codes defined by ISO at the time of this publication. The latest information is available from the ISO web site:
http://www.iso.org/.
Countries/Territories may sometimes change their official currency. UPS does require time after the introduction of a
new currency before it can fully support that currency. In addition, UPS may continue to support the older currency for
an interim period in order to provide backwards compatibility.
UPS may also require the use of currencies other than the official currency for some countries/Territories.

Country/Territory Currency Name Currency Code

Afghanistan Afghani AFN

Albania Lek ALL

Algeria Algerian Dinar DZD

American Samoa US Dollar USD

Andorra Euro EUR

Angola Kwanza AOA

Anguilla East Caribbean Dollar XCD

Antigua And Barbuda East Caribbean Dollar XCD

Argentina Argentine Peso ARS

Armenia Armenian Dram AMD

Aruba Aruban Guilder AWG

Australia Australian Dollar AUD

Austria Euro EUR

Azerbaijan Azerbaijanian Manat AZN

Bahamas Bahamian Dollar BSD

Bahrain Bahraini Dinar BHD

Bangladesh Taka BDT

Barbados Barbados Dollar BBD

Belarus Belarussian Ruble BYR

Belgium Euro EUR

Belize Belize Dollar BZD

Benin CFA Franc BCEAO XOF

Bermuda Bermudian Dollar BMD

Bhutan Indian Rupee INR

Bhutan Ngultrum BTN

Bolivia Boliviano BOB

Bolivia Mvdol BOV

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 68
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Currency Name Currency Code

Bosnia and Herzegovina Convertible Marks BAM

Botswana Pula BWP

Bouvet Island Norwegian Krone NOK

Brazil Brazilian Real BRL

British Indian Ocean Territory US Dollar USD

Brunei Darussalam Brunei Dollar BND

Bulgaria Bulgarian Lev BGN

Burkina Faso CFA Franc BCEAO XOF

Burundi Burundi Franc BIF

Cambodia Riel KHR

Cameroon US Dollar USD

Canada Canadian Dollar CAD

Cape Verde Cape Verde Escudo CVE

Cayman Islands Cayman Islands Dollar KYD

Central African Republic CFA Franc BEAC XAF

Chad CFA Franc BEAC XAF

Chile Chilean Peso CLP

Chile Unidades de formento CLF

China Mainland Yuan Renminbi RMB

Christmas Island Australian Dollar AUD

Cocos (Keeling) Islands Australian Dollar AUD

Colombia Colombian Peso COP

Colombia Unidad de Valor Real COU

Comoros Comoro Franc KMF

Congo CFA Franc BEAC XAF

Congo, The Democratic Republic of Franc Congolais CDF

Cook Islands New Zealand Dollar NZD

Costa Rica Costa Rican Colon CRC

Côte Divoire CFA Franc BCEAO XOF

Croatia Croatian Kuna HRK

Cuba Cuban Peso CUP

Cyprus Euro EUR

Czech Republic Czech Koruna CZK

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 69
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Currency Name Currency Code

Denmark Danish Krone DKK

Djibouti Djibouti Franc DJF

Dominica East Caribbean Dollar XCD

Dominican Republic Dominican Peso DOP

Ecuador US Dollar USD

Egypt Egyptian Pound EGP

El Salvador El Salvador Colon SVC

El Salvador US Dollar USD

Equatorial Guinea CFA Franc BEAC XAF

Eritrea Nakfa ERN

Estonia Euro EUR

Ethiopia Ethiopian Birr ETB

Falkland Islands (Malvinas) Falkland Islands Pound FKP

Faroe Islands Danish Krone DKK

Fiji Fiji Dollar FJD

Finland Euro EUR

France Euro EUR

French Guiana Euro EUR

French Polynesia CFP Franc XPF

French Southern Territories Euro EUR

Gabon CFA Franc BEAC XAF

Gambia Dalasi GMD

Georgia Lari GEL

Germany Euro EUR

Ghana Cedi GHS

Gibraltar Gibraltar Pound GIP

Greece Euro EUR

Greenland Danish Krone DKK

Grenada East Caribbean Dollar XCD

Guadeloupe Euro EUR

Guam US Dollar USD

Guatemala Quetzal GTQ

Guernsey Pound Sterling GBP

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 70
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Currency Name Currency Code

Guinea Guinea Franc GNF

Guinea-Bissau Guinea-Bissau Peso GWP

Guinea-Bissau CFA Franc BCEAO XOF

Guyana Guyana Dollar GYD

Haiti Gourde HTG

Haiti US Dollar USD

Heard Island ond McDonald Islands Australian Dollar AUD

Holy See (Vatican City State) Euro EUR

Honduras Lempira HNL

Hong Kong SAR, China Hong Kong Dollar HKD

Hungary Forint HUF

Iceland Iceland Krona ISK

India Indian Rupee INR

Indonesia Rupiah IDR

Iran (Islamic Republic of) Iranian Rial IRR

Iraq Iraqi Dinar IQD

Ireland Euro EUR

Israel New Israeli Sheqel ILS

Italy Euro EUR

Jamaica Jamaican Dollar JMD

Japan Yen JPY

Jersey Pound Sterling GBP

Jordan Jordanian Dinar JOD

Kazakhstan Tenge KZT

Kenya Kenyan Shilling KES

Kiribati Australian Dollar AUD

Korea, Democratic Peoples Republic of North Korean Won KPW

Korea, Republic of Won KRW

Kuwait Kuwaiti Dinar KWD

Kyrgyzstan Som KGS

Lao Peoples Democratic Republic Kip LAK

Latvia Euro EUR

Lebanon Lebanese Pound LBP

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 71
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Currency Name Currency Code

Lesotho Rand ZAR

Lesotho Loti LSL

Liberia Liberian Dollar LRD

Libyan Arab Jamahiriya Libyan Dinar LYD

Liechtenstein Swiss Franc CHF

Lithuania Euro EUR

Luxembourg Euro EUR

Macau (Macao) SAR, China Pataca MOP

Macedonia, The Former Yugoslav Republic Denar MKD

of

Madagascar Malagascy Ariary MGA

Malawi Kwacha MWK

Malaysia Malaysian Ringgit MYR

Maldives Rufiyaa MVR

Mali CFA Franc BCEAO XOF

Malta Euro EUR

Marshall Islands US Dollar USD

Martinique Euro EUR

Mauritania Ouguiya MRO

Mauritius Mauritius Rupee MUR

Mayotte Euro EUR

Mexico Mexican Peso MXN

Mexico Mexican Unidad de Inversion (UID) MXV

Micronesia (Federated States of) US Dollar USD

Moldova, Republic of Moldovan Leu MDL

Monaco Euro EUR

Mongolia Tugrik MNT

Montenegro Euro EUR

Montserrat East Caribbean Dollar XCD

Morocco Moroccan Dirham MAD

Mozambique Metical MZN

Myanmar Kyat MMK

Namibia Rand ZAR

Namibia Namibian Dollar NAD

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 72
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Currency Name Currency Code

Nauru Australian Dollar AUD

Nepal Nepalese Rupee NPR

Netherlands Euro EUR

Netherlands Antilles Netherlands Antillian Guilder ANG

New Caledonia CFP Franc XPF

New Zealand New Zealand Dollar NZD

Nicaragua Cordoba Oro NIO

Niger CFA Franc BCEAO XOF

Nigeria Naira NGN

Niue New Zealand Dollar NZD

Norfolk Island Australian Dollar AUD

Northern Mariana Islands US Dollar USD

Norway Norwegian Krone NOK

Oman Rial Omani OMR

Pakistan Pakistan Rupee PKR

Palau US Dollar USD

Panama Balboa PAB

Panama US Dollar USD

Papua New Guinea Kina PGK

Paraguay Guarani PYG

Peru Nuevo Sol PEN

Philippines Philippine Peso PHP

Pitcairn New Zealand Dollar NZD

Poland Zloty PLN

Portugal Euro EUR

Puerto Rico US Dollar USD

Qatar Qatari Rial QAR

Réunion Euro EUR

Romania New Leu RON

Russian Federation Russian Ruble RUB

Rwanda Rwanda Franc RWF

Saint Helena Saint Helena Pound SHP

Saint Kitts and Nevis East Caribbean Dollar XCD

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 73
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Currency Name Currency Code

Saint Lucia East Caribbean Dollar XCD

Saint Pierre and Miquelon Euro EUR

Saint Vincent and The Grenadines East Caribbean Dollar XCD

Samoa Tala WST

San Marino Euro EUR

São Tome and Principe Dobra STD

Saudi Arabia Saudi Riyal SAR

Senegal CFA Franc BCEAO XOF

Serbia Serbian Dinar RSD

Seychelles Seychelles Rupee SCR

Sierra Leone Leone SLL

Singapore Singapore Dollar SGD

Slovakia Euro EUR

Slovenia Euro EUR

Solomon Islands Solomon Islands Dollar SBD

Somalia Somali Shilling SOS

South Africa Rand ZAR

Spain Euro EUR

Sri Lanka Sri Lanka Rupee LKR

Sudan Sudanese Dinar SDD

Suriname Surinam Dollar SRD

Svalbard and Jan Mayen Norwegian Krone NOK

Swaziland Lilangeni SZL

Sweden Swedish Krona SEK

Switzerland Swiss Franc CHF

Switzerland WIR Franc CHW

Switzerland WIR Euro CHE

Syrian Arab Republic Syrian Pound SYP

Taiwan, China New Taiwan Dollar TWD

Tajikistan Somoni TJS

Tanzania, United Republic of Tanzanian Shilling TZS

Thailand Baht THB

Timor-Leste US Dollar USD

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 74
UPS Tracking Web Service Developer Guide September 13,2023

Country/Territory Currency Name Currency Code

Togo CFA Franc BCEAO XOF

Tokelau New Zealand Dollar NZD

Tonga Paanga TOP

Trinidad And Tobago Trinidad and Tobago Dollar TTD

Tunisia Tunisian Dinar TND

Turkey New Turkish Lira TRY

Turkmenistan Manat TMM

Turks And Caicos Islands US Dollar USD

Tuvalu Australian Dollar AUD

Uganda Uganda Shilling UGX

Ukraine Hryvnia UAH

United Arab Emirates UAE Dirham AED

United Kingdom Pound Sterling GBP

United States US Dollar USD

United States Minor Outlying Islands US Dollar USD

Uruguay Peso Uruguayo UYU

Uruguay Uruguay Peso en Unidades Indexadas UYI

Uzbekistan Uzbekistan Sum UZS

Vanuatu Vatu VUV

Venezuela Bolivar VEB

Viet Nam Dong VND

Virgin Islands (British) US Dollar USD

Virgin Islands (US) US Dollar USD

Wallis And Futuna CFP Franc XPF

Western Sahara Moroccan Dirham MAD

Yemen Yemeni Rial YER

Zambia Kwacha ZMK

Zimbabwe Zimbabwe Dollar ZWD

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 75
UPS Tracking Web Service Developer Guide September 13,2023

Current Status Codes

Code Description
000 Status Not Available

003 Order Processed: Ready for UPS

005 In Transit

006 On Vehicle for Delivery

007 Shipment Information Voided

010 In Transit: On Time

011 Delivered

012 Clearance in Progress

013 Exception

014 Clearance Completed

016 Held in Warehouse

017 Held for Customer Pickup

018 Delivery Change Requested: Hold for Pickup

019 Held for Future Delivery

020 Held for Future Delivery Requested

021 On Vehicle for Delivery Today

022 First Attempt Made

023 Second Attempt Made

024 Final Attempt Made

025 Transferred to Local Post Office for Delivery

026 Delivered by Local Post Office

027 Delivery Address Change Requested

028 Delivery Address Changed

029 Exception: Action Required

030 Local Post Office Exception

032 Adverse Weather May Cause Delay

033 Return to Sender Requested

034 Returned to Sender

035 Returning to Sender

036 Returning to Sender: In Transit

037 Returning to Sender: On Vehicle for Delivery

038 Picked Up

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 76
UPS Tracking Web Service Developer Guide September 13,2023

Code Description
039 In Transit by Post Office

040 Delivered to UPS Access Point Awaiting Customer Pickup

041 Service Upgrade Requested

042 Service Upgraded

043 Voided Pickup

044 In Transit to UPS

045 Order Processed: In Transit to UPS

046 Delay

047 Delay

048 Delay

049 Delay: Action Required

050 Address Information Required

051 Delay: Emergency Situation or Severe Weather

052 Delay: Severe Weather

053 Delay: Severe Weather, Recovery in Progress

054 Delivery Change Requested

055 Rescheduled Delivery

056 Service Upgrade Requested

057 In Transit to a UPS Access Point

058 Clearance Information Required

059 Damage Reported

060 Delivery Attempted

061 Delivery Attempted: Adult Signature Required

062 Delivery Attempted: Funds Required

063 Delivery Change Completed

064 Delivery Refused

065 Pickup Attempted

066 Post Office Delivery Attempted

067 Returned to Sender by Post Office

068 Sent to Lost and Found

069 Package Not Claimed

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 77
UPS Tracking Web Service Developer Guide September 13,2023

Package Service Codes

01 -–Signature Required
02 -–Adult Signature Required
03 -–Import Control
04 -–Commercial Invoice Removal
05 -–UPS Carbon Neutral
06 -–USPS PIC Number Of Flexible Return Shipment (The value tag is populated)
07 -–Product Type (This may have additional attributes populated for product type code and description)
08 -–Location Assured
09 – Exchange Based
10 – Pack and Collect
058 -–Hold for Pickup
254 -–Lift Gate Service for Delivery
255 -–Lift Gate Service for Pickup
256 -–Drop Off At Facility
259 -–Direct to Retail
261 -–Deliver to Addressee only
262 -–Deliver to Retail COD
263 -–Retail to Retail Shipment
426 -–Direct Delivery Only
428 -–Package Release Code

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 78
UPS Tracking Web Service Developer Guide September 13,2023

Reference Number Codes

Package
13 -–UPS Waybill Number
16 -–Reference Number
17 -–Reference Number
19 – Reference Number
28 -–Purchase Order No.
33 -–Model Number
34 -–Part Number
35 -–Serial Number
50 -–Department Number
51 -–Store Number
54 -–FDA Product Code
55 -–Acct. Rec. Customer Acct.
56 -–Appropriation Number
57 -–Bill of Lading Number
58 -–Employer'’ ID Number
59 -–Invoice Number
60 -–Manifest Key Number
61 -–Dealer Order Number
62 -–Production Code
63 -–Purchase Req. Number
64 -–Salesperson Number
65 -–Social Security Number
67 -–Transaction Ref. No.
RZ -–RMA
9V -–COD Number

Mail Innovations
91 -–USPS PIC
93 -–USPS (30 char, truncated barcode number)
94 – Mail Manifest System Number (MMS)
95 -–Mail Manifest ID (MMI)
96 -–Mail Innovations (reference number, customer package id (PID))

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 79
UPS Tracking Web Service Developer Guide September 13,2023

Request Option Matrix

When requesting tracking information, applications may use the RequestOption field to indicate the specific types of
information they wish to receive.

Request Option Proof of Delivery COD Info Receiver Address All Activity Last Activity
0 X

1 X

2 X X X

3 X X X

4 X X X

5 X X X

6 X X X X

7 X X X X

activity X

none X

blank or empty X

Signature Tracking only

Request Option Proof of Delivery COD Info Receiver Address All Activity Last Activity Sig Image
8 X X X
9 X X X
10 X X X X
11 X X X X
12 X X X X
13 X X X X
14 X X X X X
15 X X X X X

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 80
UPS Tracking Web Service Developer Guide September 13,2023

Request Option Codes

• Mail Innovations will only return: none, 0, or 1.
• none, "“"“ 0=Last Activity (default)
• 1= All activity
• 2= POD, Receiver Address and Last Activity
• 3= POD, Receiver Address, All Activity
• 4=POD,COD, Last Activity
• 5=POD, COD, All Activity
• 6=POD, COD, Receiver Address, Last Activity
• 7=POD,COD, Receiver Address, All Activity

Signature Tracking only

The Signature Tracking interface recognizes a Signature track by RequestOption.
If the user submits a request with a request option of '‘'’-–'‘5'’then Signature Tracking must validate the user’s rights to
use signature track.
• 8=POD, Signature Image, Last Activity
• 9=POD, Signature Image, All Activity
• 10=POD, Signature Image, Receiver Address, Last Activity
• 11=POD, Signature Image, Receiver Address, All Activity
• 12=POD, Signature Image, COD, Last Activity
• 13=POD, Signature Image, COD, All Activity
• 14=POD, Signature Image, COD, Receiver Address, Last Activity
• 15=POD, Signature Image, COD, Receiver Address, All Activity

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 81
UPS Tracking Web Service Developer Guide September 13,2023

Service Codes

United States
Shipments originating in United States

Description Code
UPS 3 Day Select 012

UPS Ground 003

UPS Next Day Air 001

UPS Next Day Air Early 014

UPS Saver 065

UPS 2nd Day Air 002

UPS 2nd Day Air A.M. 059

numUPS Standard 011

UPS Worldwide Expedited 008

UPS Worldwide Express 007

UPS Worldwide Express Plus 054

United States Domestic Shipments

Description Code
UPS 2nd Day Air 002

UPS 2nd Day Air A.M. 059

UPS 3 Day Select 012

UPS Ground 003

UPS Next Day Air 001

UPS Next Day Air Early 104

UPS Next Day Air Saver 013

UPS Saver 065

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 82
UPS Tracking Web Service Developer Guide September 13,2023

Canada
Description Category Code
UPS 3 Day Select Shipments originating in Canada 012

UPS Express Shipments originating in Canada going to the United 001

States

UPS Express Shipments originating in Canada 001

UPS Express Early Shipments originating in Canada 014

UPS Saver Shipments originating in Canada 065

UPS Standard Shipments originating in Canada 011

UPS Worldwide Expedited Shipments originating in Canada to US and Mexico 008

UPS Worldwide Expedited Shipments originating in Canada to Canada 002

European Union
Shipments originating in the European Union

Description Code
UPS Expedited 008

UPS Express 007

UPS Saver 065

UPS Standard 011

UPS Worldwide Express Plus 054

Mexico
Shipments originating in Mexico

Description Code
UPS Expedited 008

UPS Express 007

UPS Express Plus 054

UPS Saver 065

UPS Standard 011

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 83
UPS Tracking Web Service Developer Guide September 13,2023

Poland
Description Code
UPS Expedited 008

UPS Express 007

UPS Saver 065

UPS Standard 011

UPS Today Dedicated Courrier 083

UPS Today Express 085

UPS Today Express Saver 086

UPS Today Standard 082

UPS Worldwide Express Plus 054

Puerto Rico
Shipments originating in Puerto Rico

Description Code
UPS 2nd Day Air 002

UPS Ground 003

UPS Next Day Air 001

UPS Next Day Air Early 014

UPS Saver 065

UPS Worldwide Expedited 008

UPS Worldwide Express 007

UPS Worldwide Express Plus 054

Undefined Countries/Territories
Use for all countries other than United States, Canada, European Union, Mexico, Poland, and Puerto Rico

Description Code
UPS Express 007

UPS Saver 065

UPS Standard 011

UPS Worldwide Expedited 008

UPS Worldwide Express Plus 054

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 84
UPS Tracking Web Service Developer Guide September 13,2023

All Countries/Territories
Shipments originating in all countries

Description Code
UPS® Worldwide Economy DDU 017

UPS® Worldwide Economy DDP 072

Mail Innovations
Description Code
UPS Mail Innovations 701

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 85
UPS Tracking Web Service Developer Guide September 13,2023

State / Province Codes

United States
State Code
Alaska AK

Alabama AL

Arkansas AR

Arizona AZ

California CA

Colorado CO

Connecticut CT

District of Columbia DC

Delaware DE

Florida FL

Georgia GA

Hawaii HI

Iowa IA

Idaho ID

Illinois IL

Indiana IN

Kansas KS

Kentucky KY

Louisiana LA

Massachusetts MA

Maryland MD

Maine ME

Michigan MI

Minnesota MN

Missouri MO

Mississippi MS

Montana MT

North Carolina NC

North Dakota ND

Nebraska NE

New Hampshire NH

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 86
UPS Tracking Web Service Developer Guide September 13,2023

State Code
New Jersey NJ

New Mexico NM

Nevada NV

New York NY

Ohio OH

Oklahoma OK

Oregon OR

Pennsylvania PA

Rhode Island RI

South Carolina SC

South Dakota SD

Tennessee TN

Texas TX

Utah UT

Virginia VA

Vermont VT

Washington WA

Wisconsin WI

West Virginia WV

Wyoming WY

Canada
Province Code
Alberta AB

British Columbia BC

Manitoba MB

New Brunswick NB

Newfoundland and Labrador NL

Nova Scotia NS

Northwest Territories NT

Nunavut NU

Ontario ON

Prince Edward Island PE

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 87
UPS Tracking Web Service Developer Guide September 13,2023

Province Code
Quebec QC

Saskatchewan SK

Yukon Territory YT

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 88
UPS Tracking Web Service Developer Guide September 13,2023

Subversion details
UPS uses sub version strategy to give back new elements in the SOAP Webservice response when there is no
functionality change in the request. In order to ensure that we do not break the SOAP Webservice client’s application,
we give back the new elements only when the subversion is specified in the request.

SubVersion New Elements/Error Descriptions Error Code

Values
0114 /TrackRequest/Request/SubVersion
1407
1507

0114 and /TrackResponse/Shipment/DeliveryDateUnavailable

greater /TrackResponse/Shipment/DeliveryDateUnavailable/Type
/TrackResponse/Shipment/DeliveryDateUnavailable/Description

0114 and /TrackResponse/Shipment/Package/Redirect

greater /TrackResponse/Shipment/Package/Redirect/CompanyName
/TrackResponse/Shipment/Package/Redirect/LocationID
/TrackResponse/Shipment/Package/Redirect/PickupDate

0114 and /TrackResponse/Shipment/Package/Activity/NextScheduleActivity

greater /TrackResponse/Shipment/Package/Activity/NextScheduleActivity/Date
/TrackResponse/Shipment/Package/Activity/NextScheduleActivity/Time

1407 and /TrackResponse/Shipment/Package/DimensionalWeightScanIndicator

greater

1507 and /TrackResponse/Shipment/Package/Activity/DeliveryDateFromManifestIndicator

greater

1907and greater /TrackResponse/Shipment/Package/Activity/GMTDate

/TrackResponse/Shipment/Package/Activity/GMTTime
/TrackResponse/Shipment/Package/Activity/GMTOffset

1909 and /TrackResponse/Shipment/Package/SRSizeCode

greater

2009 and /TrackResponse/Shipment/Package/UPSPremierAccessorial

greater
/TrackResponse/Shipment/Package/UPSPremierAccessorial/UPSPremierCode
/TrackResponse/Shipment/Package/UPSPremierAccessorial/UPSPremierDescription
/TrackResponse/Shipment/Package/Activity/SensorEventIndicator

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 89
UPS Tracking Web Service Developer Guide September 13,2023

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 90
UPS Tracking Web Service Developer Guide September 13,2023

Locale codes
The following table lists all supported locale codes (country/territory and language combination). Refer to the
Country/Territory Codes Appendix section for Country/Territory details.
Locale is accepted in below format Example: - Locale - en_US means ‘LanguageCode_CountryCode’

Locale Code

bg_BG

cs_CZ

da_DK

de_AT

de_CH

de_DE

el_CY

el_GR

en_AE

en_AG

en_AI

en_AL

en_AR

en_AT

en_AU

en_AW

en_AZ

en_BA

en_BB

en_BD

en_BE

en_BG

en_BH

en_BL

en_BM

en_BO

en_BQ

en_BR

en_BS

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 91
UPS Tracking Web Service Developer Guide September 13,2023

Locale Code

en_CA

en_CB

en_CH

en_CI

en_CL

en_CN

en_CO

en_CR

en_CW

en_CY

en_CZ

en_DE

en_DK

en_DM

en_DO

en_DZ

en_EC

en_EE

en_EG

en_ES

en_EU

en_FI

en_FR

en_GB

en_GD

en_GH

en_GI

en_GP

en_GR

en_GT

en_GY

en_HK

en_HN

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 92
UPS Tracking Web Service Developer Guide September 13,2023

Locale Code

en_HR

en_HT

en_HU

en_ID

en_IE

en_IL

en_IN

en_IT

en_JM

en_JO

en_JP

en_KE

en_KN

en_KR

en_KW

en_KY

en_KZ

en_LB

en_LC

en_LT

en_LU

en_LV

en_MA

en_MD

en_MO

en_MS

en_MT

en_MU

en_MX

en_MY

en_NG

en_NI

en_NL

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 93
UPS Tracking Web Service Developer Guide September 13,2023

Locale Code

en_NO

en_NZ

en_OM

en_PA

en_PE

en_PH

en_PK

en_PL

en_PR

en_PT

en_PY

en_QA

en_RE

en_RO

en_RS

en_RU

en_SA

en_SE

en_SG

en_SI

en_SK

en_SR

en_ST

en_SV

en_SX

en_TH

en_TN

en_TR

en_TT

en_TW

en_UA

en_US

en_UY

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 94
UPS Tracking Web Service Developer Guide September 13,2023

Locale Code

en_VC

en_VE

en_VG

en_VI

en_VN

en_ZA

en_ZW

es_AR

es_BO

es_CL

es_CO

es_CR

es_DO

es_EC

es_ES

es_GT

es_HN

es_MX

es_NI

es_PA

es_PE

es_PR

es_PY

es_SV

es_US

es_UY

es_VE

et_EE

fi_FI

fr_BE

fr_CA

fr_CH

fr_DZ

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 95
UPS Tracking Web Service Developer Guide September 13,2023

Locale Code

fr_FR

fr_LU

fr_MA

fr_TN

he_IL

hu_HU

it_IT

ja_JP

ko_KR

lt_LT

lv_LV

nl_BE

nl_NL

no_NO

pl_PL

pt_BR

pt_PT

ro_RO

ru_RU

sk_SK

sv_SE

tr_TR

vi_VN

zh_CN

zh_HK

zh_MO

zh_TW

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 96