Tracking/UPS Signature Tracking®

XML 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 ......................................................................................................... 6
Release Features ..................................................................................................................................... 7

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

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

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

Integration Testing ................................................................................................................................ 11
Production .............................................................................................................................................. 11
Server Availability Check...................................................................................................................... 11
Shipping and Tracking Numbers for Testing ..................................................................................... 12

Chapter 4: Signature Tracking API Elements and Details ....................................................... 13

Element Constraints .............................................................................................................................. 13
TrackRequest XML Top Level Containers .......................................................................................... 14
TrackRequest Elements ........................................................................................................................ 15
TrackResponse XML Top Level Containers ....................................................................................... 20
TrackResponse Elements ..................................................................................................................... 22
Response ........................................................................................................................................... 22
Shipment ............................................................................................................................................ 24

Chapter 5: Tracking API XML Examples ................................................................................ 55

Tracking Request .................................................................................................................................. 55
Tracking Response ............................................................................................................................... 55
Signature Tracking Request ................................................................................................................. 57
Signature Tracking Response .............................................................................................................. 57

Tracking API FAQs ............................................................................................................... 63

Signature Tracking FAQs ..................................................................................................................... 67

Appendices ......................................................................................................................... 68
Error Codes (XML) ................................................................................................................................. 69
Common Error Codes ........................................................................................................................ 69
Tracking Error Codes ......................................................................................................................... 70
Accessorial Codes ................................................................................................................................ 73

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 4
Tracking XML Developer Guide August 08, 2022

Country/Territory Codes ....................................................................................................................... 74

Currency Codes ..................................................................................................................................... 82
Current Status Codes............................................................................................................................ 91
Package Accessorial Codes ................................................................................................................. 92
Reference Number Codes..................................................................................................................... 93
Request Option Matrix .......................................................................................................................... 94
Request Option Codes .......................................................................................................................... 95
Service Codes ........................................................................................................................................ 96
United States .................................................................................................................................. 96
Canada ............................................................................................................................................. 97
European Union ............................................................................................................................. 97
Mexico .............................................................................................................................................. 97
Poland .............................................................................................................................................. 98
Puerto Rico ..................................................................................................................................... 98
Undefined Countries/Territories ............................................................................................... 98
All Countries/Territories ............................................................................................................. 99
Mail Innovations ............................................................................................................................ 99
State / Province Codes........................................................................................................................ 100
United States.................................................................................................................................... 100
Canada ............................................................................................................................................. 101
Subversion details ............................................................................................................................... 105

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 5
Tracking XML Developer Guide August 08, 2022

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

In this guide, you will find:

• New release features
• Tracking XML API functionality and business rules
• XML 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:

• Tracking XML API

This guide does not apply to the following APIs:

• Tracking Web Service API

Intended Audience
This guide is intended for developers who will be integrating the Tracking XML 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
• 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 XML API 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 6
Tracking XML Developer Guide August 08, 2022

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 7
Tracking XML Developer Guide August 08, 2022

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 8
Tracking XML Developer Guide August 08, 2022

• 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.
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 9
Tracking XML Developer Guide August 08, 2022

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 10
Tracking XML Developer Guide August 08, 2022

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 test Tracking XML to: https://wwwcie.ups.com/ups.app/xml/Track

Production
Once testing is complete, direct your Tracking XML to the production URL:
https://onlinetools.ups.com/ups.app/xml/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/ups.app/xml/Track

Service 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 11
Tracking XML Developer Guide August 08, 2022

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 XML only. Signature image details in CIE are returned for only the tracking numbers below.

Type Value Option Service Response

Tracking 1Z12345E0291980793 Activity (All) 2nd Day Air Delivered

Tracking 1Z12345E6692804405 None (Last) World Wide Delivered

Express

Shipping 1Z12345E0390515214 None (Last) Ground Delivered

(Second Package:
1Z12345E0393657226)

Tracking 1Z12345E1392654435 None (Last) Next Day Air Saver ORIGIN SCAN

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

Tracking 1Z12345E029198079 None (Last) Invalid Tracking Number

Tracking 1Z12345E1591910450 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

Tracking 1Z12345E5991872040 Activity (All) Next Day Air Delivered, COD, Signature,
Package Receiver Address
Tracking 1Z12345E0390105056 Activity (All) Ground Delivered. No COD, No
Signature, Receiver Address
Tracking 1Z12345E0290424025 Activity(Last) 2nd Day Air Delivered, No COD Signature,
No Receiver Address
Tracking 1Z12345E0194845039 Activity(Last) Next Day Air Letter Delivered, No COD, Signature,
Receiver Address

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 12
Tracking XML Developer Guide August 08, 2022

Chapter 4: Signature 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 13
Tracking XML Developer Guide August 08, 2022

TrackRequest XML Top Level Containers

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 14
Tracking XML Developer Guide August 08, 2022

TrackRequest Elements
Name Constraint Description Validation Type
/TrackRequest
TrackRequest Required: Yes Container for the root Track All
Type: Container Request.
Max Allowed: 1
Length: N/A
/TrackRequest/Request
Request Required: Yes* Container for the Track All
Type: Container Request.
Max Allowed: 1
Length: N/A
/TrackRequest/Request/TransactionReference
TransactionReferenc Required: No TransactionReference All
e Type: Container identifies transactions
Max Allowed: 1 between client and server.
Length: N/A
/TrackRequest/Request/TransactionReference/CustomerContext
CustomerContext Required: No The client uses All
Type: String CustomerContext to
Max Allowed: 1 synchronize request/response
Length: 1..512 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.
/TrackRequest/Request/TransactionReference/TransactionIdentifier
TransactionIdentifier Required: No The Unique All
Type: String TransactionIdentifier for a
Max Allowed: 1 given transaction.
Length: 1..20
/TrackRequest/Request/TransactionReference/ToolVersion
ToolVersion Required: Yes* Current Tracking Tool All
Type: String Version.
Max Allowed: 1
Length: 3
/TrackRequest/Request/RequestAction
RequestAction Required: Yes* Indicates the action to be All
Type: String taken by the XML service.
Max Allowed: 1 The only valid action for
Length: 1..15 tracking is Track.
/TrackRequest/Request/RequestOption
RequestOption Required: No For optional processing. For All
Type: String valid values, see Request
Max Allowed: 1 Option Codes in the
Length: 1..15 Appendix.
/TrackRequest/Request/SubVersion
SubVersion Required: Yes* When UPS introduces new Supported values: 1909, All
Type: String elements in the response that 2009,2203,2207
Max Allowed: 1 are not associated with new
Length: 4 request elements, Subversion
is used. This ensures
backward compatibility.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 15
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

To get such elements you
need to have the right
Subversion. The value of the
subversion is explained in the
Response element
Description.

Example: SRSizeCode for

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

Format: YYMM = Year and

month of the release.
Example: 1909 = 2019
September
/TrackRequest/TrackingNumber
TrackingNumber Required: Cond The packages tracking All
Type: String number.
Max Allowed: 1
Length: 1..34 - For package when the
Tracking Number element is
supplied, details of the
package corresponding to the
Tracking Number will be
returned.

- For Mail Innovations this is

treated as Mail Innovations
tracking number. For Mail
Innovations TrackingOption
also has to be set.
/TrackRequest/ShipmentIdentificationNumber
ShipmentIdentificatio Required: Cond The shipments tracking PKG,
nNumber Type: String number. FRT
Max Allowed: 1
Length: 11..21
/TrackRequest/CandidateBookmark
CandidateBookmark Required: No During Tracking and FRT
Type: String Reference Number searches,
Max Allowed: 1 it is possible that duplicate
Length: 0..15 shipments will be found.
If duplicate shipments are
found, then a Candidate
Summary with a
corresponding Candidate
Bookmark for each of the
Shipments will be returned in
the response.
The Candidate Bookmark can
be passed back to the
Tracking Tool in a separate
transaction to retrieve
tracking information about the
particular Shipment of
interest.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 16
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackRequest/ReferenceNumber
ReferenceNumber Required: No The reference number PKG, MI
Type: Container container tag.
Max Allowed: 1 Required if a Shipment
Length: N/A Identification Number or
Tracking Number is not
present.
For tracking a reference
number of Mail Innovations
type this has to be set along
with ShipmentType.
/TrackRequest/ReferenceNumber/Value
Value Required: Yes* The customer assigned PKG, MI
Type: String reference number. Required if
Max Allowed: 1 a Shipment Identification
Length: 1..35 Number or Tracking Number
is not present.
/TrackRequest/PickupDateRange
PickupDateRange Required: No Container for pickup date All
Type: Container range.
Max Allowed: 1 Optional for Mail Innovations.
Length: N/A
/TrackRequest/PickupDateRange/BeginDate
BeginDate Required: Yes* The begin pickup date used All
Type: String to narrow a reference number
Max Allowed: 1 search.
Length: 8 Format: YYYYMMDD
Optional for Mail Innovations.
/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.
Required if Begin Date is
present.
Optional for Mail Innovations.
/TrackRequest/ShipperNumber
ShipperNumber Required: No The UPS account number PKG,
Type: String used to narrow a reference FRT
Max Allowed: 1 number search.
Length: 6 or 10
/TrackRequest/DestinationPostalCode
DestinationPostalCo Required: No A ZIP Code (United States) or All
de Type: String postal code (international
Max Allowed: 1 destination) also narrows the
Length: 1..16 search.
The destination country or
territory code is required if the
destination postal code is
present.
/TrackRequest/DestinationCountryCode
DestinationCountryC Required: No A country or territory code All
ode Type: String used to narrow a reference
Max Allowed: 1 number search.
Length: 2

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 17
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackRequest/OriginPostalCode
OriginPostalCode Required: No Postal Code of the origin FRT
Type: String country or territory used to
Max Allowed: 1 narrow the reference number
Length: 1..16 search.
/TrackRequest/OriginCountryCode
OriginCountryCode Required: No Country or territory code of FRT
Type: String the origin country or territory
Max Allowed: 1 used to narrow the reference
Length: 2 number search.
/TrackRequest/ShipmentType
ShipmentType Required: Cond Container for the type of All
Type: Container Shipment when doing a
Max Allowed: 1 Reference Number search. If
Length: N/A this container is not present,
tracking defaults to package.
Required if the Reference
Number element is specified.
/TrackRequest/ShipmentType/Code
Code Required: Yes* Indicates the type of the Valid values: All
Type: String shipment being tracked 01 = Package (Default)
Max Allowed: 1 during Reference number 03 = Mail Innovations
Length: 2 tracking.
/TrackRequest/ShipmentType/Description
Description Required: No Description of the type of the All
Type: String shipment being tracked
Max Allowed: 1 during Reference tracking,
Length: 0..15 see above.
/TrackRequest/IncludeMailInnovationIndicator
IncludeMailInnovatio Required: No The presence of this indicator MI
nIndicator Type: String means supports Mail
Max Allowed: 1 Innovation tracking without
Length: 0 tracking option.
/TrackRequest/TrackingOption
TrackingOption Required: Cond TrackingOption applies to TrackingOption applies to Mail MI
Type: String Mail Innovations only. Innovations only.
Max Allowed: 1 For Mail Innovations track by
Length: 2 number, this is a mandatory
field which has to be set to
'03'.
For Mail Innovations a single
shipment has single package.
If only tracking number is
provided without
trackingoption then it will be
treated as package tracking.
/TrackRequest/ShipperAccountInfo
ShipperAccountInfo Required: No Container for Shipper's Package Signature Tracking PKG
Type: Container account details. only.
Max Allowed: 1 Package Signature Tracking
Length: N/A only.
Used to verify the customers
signature tracking privileges
for package tracking if shipper
selects one of the

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 18
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

RequestOption including
signature track.
/TrackRequest/ShipperAccountInfo/PostalCode
PostalCode Required: Yes* Postal Code of the Shipper Package Signature Tracking PKG
Type: String Account used to place the only.
Max Allowed: 1 shipment.
Length: 1…9 Package Signature Tracking
only.
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
Type: String the Shipper Account used to only.
Max Allowed: 1 place the shipment.
Length: 2..3 Package Signature Tracking
only.
This data will be used in
verifying the rights of the
customer to view signature
results.
/TrackRequest/PreauthorizedReturnIndicator
PreauthorizedReturnI Required: No Indicator to request Pre- This is an indicator. PKG, MI
ndicator 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.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 19
Tracking XML Developer Guide August 08, 2022

TrackResponse XML Top Level Containers

Continued...

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 20
Tracking XML Developer Guide August 08, 2022

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 21
Tracking XML Developer Guide August 08, 2022

TrackResponse Elements
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 Track Response. All
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Response/TransactionReference
TransactionReferenc Required: No TransactionReference identifies All
e Type: Container transactions between client and
Max Allowed: 1 server.
Length: N/A
/TrackResponse/Response/TransactionReference/CustomerContext
CustomerContext Required: Yes* The client uses CustomerContext All
Type: String to synchronize request/response
Max Allowed: 1 pairs.
Length: 1...512 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.
/TrackResponse/Response/TransactionReference/XpciVersion
XpciVersion Required: Yes* Message version. Defaults to
Type: String 1.0001.
Max Allowed: 1
Length: 4
/TrackResponse/Response/ResponseStatusCode
ResponseStatusCod Required: Yes* Identifies the success or failure of All
e Type: String the transaction.
Max Allowed: 1 1 = Successful
Length: 1 0 = Failure
/TrackResponse/Response/ResponseStatusDescription
ResponseStatusDes Required: Yes* Describes the Response Status All
cription Type: String Code above.
Max Allowed: 1
Length: 1..35
/TrackResponse/Response/Error
Error Required: Cond If an error is encountered during All
Type: Container the interchange, the Response
Max Allowed: 1 contains
Length: N/A an error. If the error is present,
then the ErrorSeverity and
ErrorCode are required.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 22
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Response/Error/ErrorSeverity
ErrorSeverity Required: Yes* Describes the severity of the All
Type: String error. TransientError - Customers
Max Allowed: 1 data has not been processed due
Length: 1...15 to system unavailability. The
customer has to wait and try
again.
HardError - The error was
encountered processing the
customer's data
and that the data needs
correction.
Warning - The customer's data
was successfully processed;
however, there were warnings
encountered during processing.
/TrackResponse/Response/Error/ErrorCode
ErrorCode Required: Yes* A numeric value that describes All
Type: String the error. Each tool defines a
Max Allowed: 1 range of error codes.
Length: 1...15
/TrackResponse/Response/Error/ErrorDescription
ErrorDescription Required: Yes* Describes the error code above. All
Type: String
Max Allowed: 1
Length: 1...50
/TrackResponse/Response/Error/MinimumRetrySeconds
MinimumRetrySecon Required: Yes* Number of seconds to wait until All
ds Type: String retry.
Max Allowed: 1 This field is populated on special
Length: 1...5 conditions of the Transient Error
only, as defined by the service. A
number between 1 and 86400 (24
hours)
/TrackResponse/Response/Error/ErrorLocation
ErrorLocation Required: Yes* Identifies the element in error. All
Type: Container
Max Allowed: UNB
Length: N/A
/TrackResponse/Response/Error/ErrorLocation/ErrorLocationElementName
ErrorLocationElemen Required: Yes* The XPATH name of the element All
tName Type: String in error.
Max Allowed: 1 This is a valid XPATH pointing to
Length: 1...512 an element in the request
document.
/TrackResponse/Response/Error/ErrorLocation/ErrorLocationAttributeName
ErrorLocationAttribut Required: Yes* The name of the attribute in error. All
eName Type: String This is the name of the attribute
Max Allowed: 1 contained by the Error Location
Length: 1...50 Element.
/TrackResponse/Response/Error/ErrorDigest
ErrorDigest Required: Yes* The contents of the element in All
Type: String error.
Max Allowed: UNB
Length: Bound by the

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 23
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

size of the Request
data.

Shipment
Name Constraint Description Validation Type
/TrackResponse/Shipment
Shipment Required: Yes* Shipment Container tag. All
Type: Container
Max Allowed: UNB
Length: N/A

/TrackResponse/Shipment/InquiryNumber
InquiryNumber Required: Yes* Shipment Inquiry Number FRT, MI
Type: Container Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/InquiryNumber/Code
Code Required: Yes* Code to indicate the type of Valid values: FRT, MI
Type: String Inquiry Number.
Max Allowed: 1 Mail Innovations
Length: 2 03 - Mail Innovation
tracking number.
/TrackResponse/Shipment/InquiryNumber/Description
Description Required: Yes* Description of the Inquiry Number FRT, MI
Type: String as indicated by code above.
Max Allowed: 1
Length: 1...35
/TrackResponse/Shipment/InquiryNumber/Value
Value Required: Yes* Value of the Inquiry Number FRT, MI
Type: String
Max Allowed: 1
Length: 1…34
/TrackResponse/Shipment/ShipmentIdentificationNumber
ShipmentIdentification Required: No Shipment number to which the PKG
Number Type: String package belongs. This element is
Max Allowed: 1 not returned for track requests by
Length: 1...21 Reference Number.
/TrackResponse/Shipment/ShipmentType
ShipmentType Required: Cond Container for the type of Shipment All
Type: Container when doing a Reference Number
Max Allowed: 1 search.
Length: N/A
/TrackResponse/Shipment/ShipmentType/Code
Code Required: Yes* This element will be used to Valid values: All
Type: String indicate the type of the shipment 01 - Package
Max Allowed: 1 being tracked, either Package, 03 - Mail
Length: 2 Mail Innovations. Innovations
/TrackResponse/Shipment/ShipmentType/Description
Description Required: Yes* Description of the code above. All
Type: String
Max Allowed: 1
Length: 1..15

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 24
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/CandidateBookmark
CandidateBookmark Required: No During Tracking and Reference FRT
Type: String Number searches, it is possible
Max Allowed: 1 that duplicate shipments will be
Length: 1..15 found. If duplicate shipments are
found, then a Candidate Summary
with a corresponding Candidate
Bookmark for each of the
Shipments will be returned in the
response.
The Candidate Bookmark can be
passed back to the Tracking in a
separate transaction to retrieve
tracking information about the
particular Shipment of interest.
/TrackResponse/Shipment/Shipper
Shipper Required: No Shipper Container Tag All
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Shipper/ShipperNumber
ShipperNumber Required: No Shippers six or ten digit account All
Type: String number.
Max Allowed: 1
Length: 6...10
/TrackResponse/Shipment/Shipper/Address
Address Required: No Shippers address Container tag. All
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Shipper/Address/AddressLine1
AddressLine1 Required: Yes* Shippers address line 1 PKG,
Type: String FRT
Max Allowed: 1
Length: 1...70
/TrackResponse/Shipment/Shipper/Address/AddressLine2
AddressLine2 Required: Yes* Shippers address line 2 PKG,
Type: String FRT
Max Allowed: 1
Length: 1...70
/TrackResponse/Shipment/Shipper/Address/AddressLine3
AddressLine3 Required: Yes* Shippers address line 3 PKG,
Type: String FRT
Max Allowed: 1
Length: 1…70
/TrackResponse/Shipment/Shipper/Address/City
City Required: Yes* Shipper's city. All
Type: String
Max Allowed: 1
Length: 1...30
/TrackResponse/Shipment/Shipper/Address/StateProvinceCode
StateProvinceCode Required: Yes* Shipper's state or province code. All
Type: String Required for US or Canada.
Max Allowed: 1
Length: 2...5

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 25
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Shipper/Address/PostalCode
PostalCode Required: Yes* Shipper's postal code All
Type: String
Max Allowed: 1
Length: 5..16
/TrackResponse/Shipment/Shipper/Address/CountryCode
CountryCode Required: Yes* Shipper's country or territory code. All
Type: String
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/ShipTo
ShipTo Required: No Consignees ship to Container tag. All
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/ShipTo/Address
Address Required: Yes* Consignees address Container All
Type: Container tag.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/ShipTo/Address/AddressLine1
AddressLine1 Required: Yes* Consignees address line 1 PKG,
Type: String FRT
Max Allowed: 1
Length: 1...70
/TrackResponse/Shipment/ShipTo/Address/AddressLine2
AddressLine2 Required: Yes* Consignees address line 2 PKG,
Type: String FRT
Max Allowed: 1
Length: 1...70
/TrackResponse/Shipment/ShipTo/Address/AddressLine3
AddressLine3 Required: Yes* Consignees address line 3 PKG,
Type: String FRT
Max Allowed: 1
Length: 1...70
/TrackResponse/Shipment/ShipTo/Address/City
City Required: Yes* Consignee's city. All
Type: String
Max Allowed: 1
Length: 1...30
/TrackResponse/Shipment/ShipTo/Address/StateProvinceCode
StateProvinceCode Required: Yes* Consignee's state or province All
Type: String code. Required for US or Canada.
Max Allowed: 1
Length: 2...5
/TrackResponse/Shipment/ShipTo/Address/PostalCode
PostalCode Required: Yes* Consignee's postal code All
Type: String
Max Allowed: 1
Length: 5..16

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 26
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/ShipTo/Address/CountryCode
CountryCode Required: Yes* Consignee's country or territory All
Type: String code.
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/ShipmentWeight
ShipmentWeight Required: No Shipment weight Container tag 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 tag.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/ShipmentWeight/UnitOfMeasurement/Code
Code Required: Yes* Shipment weight unit of Valid values: All
Type: String measurement code. LBS (default)
Max Allowed: 1 KGS
Length: 3 OZS
/TrackResponse/Shipment/ShipmentWeight/UnitOfMeasurement/Description
Description Required: Yes* Textual indication of Shipment All
Type: String weight unit of Measurement.
Max Allowed: 1
Length: 1…35
/TrackResponse/Shipment/ShipmentWeight/Weight
Weight Required: No Shipments total weight. Set to 0 All
Type: String for shipment with package type of
Max Allowed: 1 letter.
Length: 8
/TrackResponse/Shipment/Service
Service Required: Yes* Container tag 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
/TrackResponse/Shipment/Service/Description
Description Required: Yes* Description of the service code All
Type: String above.
Max Allowed: 1
Length: 1...35
/TrackResponse/Shipment/ReferenceNumber
ReferenceNumber Required: No Shipment reference number All
Type: Container Container tag.
Max Allowed: UNB
Length: N/A

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 27
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/ReferenceNumber/Code
Code Required: Yes* Reference number type code for For valid values, All
Type: String signifying PO #’s, Invoice #’s, etc, see
Max Allowed: 1 for the entire shipment. ReferenceNumber
Length: 2 Codes in the
Appendix.
/TrackResponse/Shipment/ReferenceNumber/Description
Description Required: Yes* Description of the All
Type: String ReferenceNumber Code above.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/ReferenceNumber/Value
Value Required: Yes* Customer supplied reference All
Type: String number.
Max Allowed: 1
Length: 1...35
/TrackResponse/Shipment/CurrentStatus
CurrentStatus Required: Cond Container for the current status of FRT
Type: Container the shipment.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/CurrentStatus/Code
Code Required: Yes* For valid values, see FRT
Type: String CurrentStatus Codes in the
Max Allowed: 1 Appendix.
Length: 3
/TrackResponse/Shipment/CurrentStatus/Description
Description Required: Yes* Description for the current status FRT
Type: String of the shipment, see above.
Max Allowed: 1
Length: 1...35
/TrackResponse/Shipment/PickupDate
PickupDate Required: No Date shipment was picked-up. All
Type: String Format: YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/DeliveryDetails
DeliveryDetails Required: No Container for Delivery Details FRT
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/DeliveryDetails/DeliveryDate
DeliveryDate Required: Yes* Container for Delivery Date and FRT
Type: Container Time
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/DeliveryDetails/DeliveryDate/Date
Date Required: Yes* Date shipment was delivered. FRT
Type: String Format: YYYYMMDD
Max Allowed: 1
Length: 8

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 28
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/DeliveryDetails/DeliveryDate/Time
Time Required: Yes* Time shipment was delivered. FRT
Type: String Format: HHMMSS
Max Allowed: 1
Length: 6
/TrackResponse/Shipment/DeliveryDetails/ServiceCenter
ServiceCenter Required: No Container for the Delivery Service FRT
Type: Container Center
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/DeliveryDetails/ServiceCenter/City
City Required: Yes* Delivery Service center city FRT
Type: String
Max Allowed: 1
Length: 1...30
/TrackResponse/Shipment/DeliveryDetails/ServiceCenter/StateProvinceCode
StateProvinceCode Required: Yes* Delivery Service Center State FRT
Type: String
Max Allowed: 1
Length: 2...6
/TrackResponse/Shipment/DeliveryDateTime
DeliveryDateTime Required: Cond Delivery detail info for Mail MI
Type: Container Innovations shipment only
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/DeliveryDateTime/Type
Type Required: Yes* Type of delivery detail. MI
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/DeliveryDateTime/Type/Code
Code Required: Yes* Code of delivery detail. Valid values: MI
Type: String 01 - Delivery
Max Allowed: 1 02 - Estimated
Length: 2 Delivery
/TrackResponse/Shipment/DeliveryDateTime/Type/Description
Description Required: Yes* Description of code, see above. MI
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/DeliveryDateTime/Date
Date Required: Yes* Date for the specific delivery type. MI
Type: String Format: YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/Volume
Volume Required: Yes* Container for the volume of the FRT
Type: Container Shipment
Max Allowed: 1
Length: N/A

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 29
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Volume/Code
Code Required: Yes* Code indicating the unit of FRT
Type: String measurement for the volume
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Volume/Description
Description Required: Yes* Textual indication of Unit of FRT
Type: String Measurement: Litres, gallons,
Max Allowed: 1 square feet, etc
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 the FRT
Type: String shipment is billed to.
Max Allowed: 1
Length: 1...35
/TrackResponse/Shipment/PickUpServiceCenter
PickUpServiceCenter Required: No Container for the pickup service FRT
Type: Container center.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/PickUpServiceCenter/City
City Required: Yes* City of the pickup service center. FRT
Type: String
Max Allowed: 1
Length: 1...30
/TrackResponse/Shipment/PickUpServiceCenter/StateProvinceCode
StateProvinceCode Required: Yes* State of the pickup service center. FRT
Type: String
Max Allowed: 1
Length: 2...5
/TrackResponse/Shipment/NumberOfPieces
NumberOfPieces Required: No Number of pieces in the shipment FRT
Type: String
Max Allowed: 1
Length: 1...15
/TrackResponse/Shipment/NumberOfPallets
NumberOfPallets Required: No Number of pallets in the shipment FRT
Type: String
Max Allowed: 1
Length: 1...15
/TrackResponse/Shipment/ShipmentServiceOptions
ShipmentServiceOpti Required: No Container for Shipment Service FRT
ons Type: Container Options. Currently contains COD
Max Allowed: 1 only
Length: N/A

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 30
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/ShipmentServiceOptions/COD
COD Required: Yes* Container for COD for the FRT
Type: Container shipment
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/ShipmentServiceOptions/COD/CODAmount
CODAmount Required: Yes* Container for COD amount FRT
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/ShipmentServiceOptions/COD/CODAmount/CurrencyCode
CurrencyCode Required: Yes* Currency Code for COD. Default FRT
Type: String value is USD
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/ShipmentServiceOptions/COD/CODAmount/MonetaryValue
MonetaryValue Required: Yes* Currency Value for COD FRT
Type: String
Max Allowed: 1
Length: 1...30
/TrackResponse/Shipment/EstimatedDeliveryDetails
EstimatedDeliveryDet Required: No Container for estimated delivery FRT
ails Type: Container details
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/EstimatedDeliveryDetails/Date
Date Required: Yes* Estimated delivery date of the FRT
Type: String shipment
Max Allowed: 1 Format: YYYYMMDD
Length: 8
/TrackResponse/Shipment/EstimatedDeliveryDetails/Time
Time Required: Yes* Estimated Time shipment was FRT
Type: String delivered.
Max Allowed: 1 Format: HHMMSS
Length: 6
/TrackResponse/Shipment/EstimatedDeliveryDetails/ServiceCenter
ServiceCenter Required: Yes* Container for estimated delivery FRT
Type: Container service center
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/EstimatedDeliveryDetails/ServiceCenter/City
City Required: Yes* Estimated delivery service center FRT
Type: String city
Max Allowed: 1
Length: 1...30
/TrackResponse/Shipment/EstimatedDeliveryDetails/ServiceCenter/StateProvinceCode
StateProvinceCode Required: Yes* Estimated delivery service center FRT
Type: String state
Max Allowed: 1
Length: 2...8

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 31
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/SignedForByName
SignedForByName Required: No Person that received the FRT
Type: String shipment. May be the addressee,
Max Allowed: 1 or another person that signed for
Length: 1...35 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: UNB
Length: N/A
/TrackResponse/Shipment/Activity/ActivityLocation/Address
Address Required: Yes* Container for the address of the FRT
Type: Container shipment activity location
Max Allowed: UNB
Length: N/A
/TrackResponse/Shipment/Activity/ActivityLocation/Address/City
City Required: Yes* Activity city. FRT
Type: String
Max Allowed: 1
Length: 1...30
/TrackResponse/Shipment/Activity/ActivityLocation/Address/StateProvinceCode
StateProvinceCode Required: Yes* Activity State. FRT
Type: String
Max Allowed: 1
Length: 2...5
/TrackResponse/Shipment/Activity/ActivityLocation/Address/PostalCode
PostalCode Required: Yes* Activity postal code FRT
Type: String
Max Allowed: 1
Length: 5..16
/TrackResponse/Shipment/Activity/ActivityLocation/Address/CountryCode
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...512
/TrackResponse/Shipment/Activity/Date
Date Required: Yes* Activity Date. Format: FRT
Type: String YYYYMMDD
Max Allowed: 1
Length: 8

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 32
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Activity/Time
Time Required: Yes* Activity Time. Format: HHMMSS FRT
Type: String
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/OriginPortDetails
OriginPortDetails Required: No Details of origin port of the FRT
Type: Container shipment
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/OriginPortDetails/OriginPort
OriginPort Required: No Origin Port of the shipment FRT
Type: String
Max Allowed: 1
Length: 1...35
/TrackResponse/Shipment/OriginPortDetails/EstimatedDeparture
EstimatedDeparture Required: No Container for Estimated Departure FRT
Type: Container Time Stamp at the origin port
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/OriginPortDetails/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/OriginPortDetails/EstimatedDeparture/Time
Time Required: Yes* Time of the Estimated Departure FRT
Type: String Time Stamp at the origin port.
Max Allowed: 1 Format: HHMMSS
Length: 6
/TrackResponse/Shipment/DestinationPortDetails
DestinationPortDetail Required: No Container for the destination port FRT
s Type: Container of the shipment
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/DestinationPortDetails/DestinationPort
DestinationPort Required: Yes* Destination port of the shipment FRT
Type: String
Max Allowed: 1
Length: 1...35
/TrackResponse/Shipment/DestinationPortDetails/EstimatedArrival
EstimatedArrival Required: Yes* Container for Estimated Arrival FRT
Type: Container Time Stamp at the Destination
Max Allowed: 1 Port
Length: N/A

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 33
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/DestinationPortDetails/EstimatedArrival/Date
Date Required: Yes* Date of the Estimated Arrival Time FRT
Type: String Stamp at the Destination Port.
Max Allowed: 1 Format: YYYYMMDD
Length: 8
/TrackResponse/Shipment/DestinationPortDetails/EstimatedArrival/Time
Time Required: Yes* Time of the Estimated Arrival FRT
Type: String Time Stamp at the Destination
Max Allowed: 1 Port.
Length: 6 Format: HHMMSS
/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.
Max Allowed: 1 Format: YYYYMMDD
Length: 8
/TrackResponse/Shipment/CargoReady/Time
Time Required: Yes* Cargo Ready time for the FRT
Type: String shipment.
Max Allowed: 1 Format: HHMMSS
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
CarrierActivityInforma Required: No Container for carrier activity FRT
tion Type: Container information for the shipment
Max Allowed: UNB
Length: N/A

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 34
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/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/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 Departure time stamp. FRT
Type: String Format: YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/CarrierActivityInformation/Departure/Time
Time Required: Yes* Time of the Departure time stamp. FRT
Type: String Format: HHMMSS
Max Allowed: 1
Length: 6
/TrackResponse/Shipment/CarrierActivityInformation/OriginPort
OriginPort Required: Yes* Origin Port of the Carriers leg of FRT
Type: String the journey
Max Allowed: 1
Length: 1...30

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 35
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/CarrierActivityInformation/DestinationPort
DestinationPort Required: Yes* Destination Port of the Carriers FRT
Type: String leg of the journey
Max Allowed: 1
Length: 1...30
/TrackResponse/Shipment/Document
Document Required: No Container for the various FRT SIG
Type: Container documents returned to the
Max Allowed: 1 customer.
Length:
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 type. FRT SIG
Type: Container
Max Allowed: 1
Length:
/TrackResponse/Shipment/Document/Type/Code
Code Required: Yes* Code for the type of the FRT SIG
Type: String document.
Max Allowed: 1
Length: 01 - Signature Image
02 - Delivery Receipt
03 - Free Astray
04 - POD
/TrackResponse/Shipment/Document/Type/Description
Description Required: No Description for the type of the FRT SIG
Type: String document as described by the
Max Allowed: 1 code.
Length:
/TrackResponse/Shipment/Document/GraphicImage
GraphicImage Required: No Base64 Encoded Byte stream of FRT SIG
Type: Container the image.
Max Allowed: UNB
Length:
/TrackResponse/Shipment/Document/Format
Format Required: Yes* Container for the document FRT SIG
Type: String format.
Max Allowed: 1
Length:
/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:

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 36
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Document/Format/Description
Description Required: No Description of the document FRT SIG
Type: String format as indicated by the code.
Max Allowed: 1
Length:
/TrackResponse/Shipment/ScheduledDeliveryDate
ScheduledDeliveryDa Required: Yes* Date shipment was originally PKG,
te Type: String scheduled for delivery. Will be FRT
Max Allowed: 1 returned when available.
Length: 8 Format: YYYYMMDD
/TrackResponse/Shipment/ScheduledDeliveryTime
ScheduledDeliveryTi Required: Yes* Format: HHMMSS PKG,
me Type: String FRT
Max Allowed: 1
Length: 6
/TrackResponse/Shipment/DeliveryDateUnavailable
DeliveryDateUnavaila Required: No DeliveryDateUnavailable All
ble Type: Container container.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/DeliveryDateUnavailable/Type
Type Required: No Type is Scheduled Delivery All
Type: String
Max Allowed: 1
Length: 1..19
/TrackResponse/Shipment/DeliveryDateUnavailable/Description
Description Required: No A description is return to indicate All
Type: String the scheduled delivery date is
Max Allowed: 1 unavailable
Length: 1..73
/TrackResponse/Shipment/FileNumber
FileNumber Required: No 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 Made FRT
Type: Container Date and Time
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Appointment/Made/Date
Date Required: Yes* Appointment Made Date Format: FRT
Type: String YYYYMMDD
Max Allowed: 1
Length: 8

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 37
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Appointment/Made/Time
Time Required: Yes* Appointment Made Time Format: FRT
Type: String 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. Format: FRT
Type: String 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: 1
Length: N/A
/TrackResponse/Shipment/Package/TrackingNumber
TrackingNumber Required: Yes* TrackingNumber of the package. PKG, MI
Type: String
Max Allowed: 1
Length: 1..34
/TrackResponse/Shipment/Package/DeliveryIndicator
DeliveryIndicator Required: Yes* Indicates if the current package is PKG, MI
Type: String delivered. Possible Values:
Max Allowed: 1 "Y": Package is delivered
Length: 1..34 "N": Package is not delivered
/TrackResponse/Shipment/Package/DeliveryDate
DeliveryDate Required: Yes* The delivery date of the package. PKG, MI
Type: String Will be returned if delivery date
Max Allowed: 1 indicator is Y. The format is:
Length: 8 YYYYMMDD

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 38
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/RescheduledDeliveryDate
DeliveryIndicator Required: No The delivery is rescheduled to this PKG
Type: String date.
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/Package/RescheduledDeliveryTime
RescheduledDelivery Required: No The delivery is rescheduled to this PKG
Time Type: String time.
Max Allowed: 1
Length: 8
/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: String package to UPS Access Point
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Redirect/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 held PKG
Type: String for pickup at a UPS Access Point.
Max Allowed: 1 Date of the arrival time stamp.
Length: 8 Format: YYYYMMDD
/TrackResponse/Shipment/Package/Redirect/UPSAPAddress
UPSAPAddress Required: No UPS AP Address Container Tag. PKG
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Redirect/UPSAPAddress/AddressLine1
AddressLine1 Required: Yes* Address line 1 element of UPS PKG
Type: String Access Point address.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/Redirect/UPSAPAddress/AddressLine2
AddressLine2 Required: Yes* Address line 2 element of UPS PKG
Type: String Access Point address.
Max Allowed: 1
Length: 1..35

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 39
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/Redirect/UPSAPAddress/AddressLine3
AddressLine3 Required: Yes* Address line 3 element of UPS PKG
Type: String Access Point address.
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/Redirect/UPSAPAddress/City
City Required: Yes* City of the UPS Access Point PKG
Type: String Address.
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/Package/Redirect/UPSAPAddress/StateProvinceCode
StateProvinceCode Required: Yes* State Province Code of the UPS PKG
Type: String Access Point Address.
Max Allowed: 1
Length: 2..5
/TrackResponse/Shipment/Package/Redirect/UPSAPAddress/PostalCode
PostalCode Required: Yes* Postal Code of the UPS Access PKG
Type: String Point address.
Max Allowed: 1
Length: 5..16
/TrackResponse/Shipment/Package/Redirect/UPSAPAddress/CountryCode
CountryCode Required: Yes* Country or Territory Code of the PKG
Type: String UPS Access Point address
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Package/Reroute
Reroute Required: No When a requestor to intercept PKG
Type: Container US50/PR package at the
Max Allowed: 1 destination center at any time
Length: N/A before it has been delivered,
Consignee’s Reroute Container
Tag is provided in the track
response.
/TrackResponse/Shipment/Package/Reroute/Address
Address Required: Yes* Consignee’s Reroute Address PKG
Type: Container container tag.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Reroute/Address/AddressLine1
AddressLine1 Required: Yes* Address line element of Reroute PKG
Type: String address.
Max Allowed: 1
Length: 1..50
/TrackResponse/Shipment/Package/Reroute/Address/AddressLine2
AddressLine2 Required: Yes* Address line element of Reroute PKG
Type: String address.
Max Allowed: 1
Length: 1..50
/TrackResponse/Shipment/Package/Reroute/Address/AddressLine3
AddressLine3 Required: Yes* Address line element of Reroute PKG
Type: String address.
Max Allowed: 1
Length: 1..50

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 40
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/Reroute/Address/City
City Required: Yes* Consignee’s City. PKG
Type: String
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/Package/Reroute/Address/StateProvinceCode
StateProvinceCode Required: Yes* Consignee’s State Or Province PKG
Type: String Code.
Max Allowed: 1
Length: 5…16
/TrackResponse/Shipment/Package/Reroute/Address/PostalCode
PostalCode Required: Yes* Consignee’s Postal Code. PKG
Type: String
Max Allowed: 1
Length: 5..16
/TrackResponse/Shipment/Package/Reroute/Address/CountryCode
CountryCode Required: Yes* PKG
Type: String
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Package/ReturnTo
ReturnTo Required: No Return to Container tag that will PKG
Type: Container contain the address information of
Max Allowed: 1 who the package is returned to.
Length: N/A
/TrackResponse/Shipment/Package/ReturnTo/Address
Address Required: Yes* Return to sender address PKG
Type: Container Container tag.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/ReturnTo/Address/AddressLine1
AddressLine1 Required: Yes* Return to AddressLine1. It PKG
Type: String contains StreetPrefix,
Max Allowed: 1 StreetName, and
Length: 1...30 StreetTypeCode.
/TrackResponse/Shipment/Package/ReturnTo/Address/AddressLine2
AddressLine2 Required: Yes* Return to AddressLine2. It PKG
Type: String contains building floor, room, suite
Max Allowed: 1 or PO Box No.
Length: 1...30
/TrackResponse/Shipment/Package/ReturnTo/Address/AddressLine3
AddressLine3 Required: Yes* Return to AddressLine3 PKG
Type: String
Max Allowed: 1
Length: 1...30
/TrackResponse/Shipment/Package/ReturnTo/Address/City
City Required: Yes* Return to address city. PKG
Type: String
Max Allowed: 1
Length: 1…30

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 41
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/ReturnTo/Address/StateProvinceCode
StateProvinceCode Required: Yes* Return to state or province code. PKG
Type: String
Max Allowed: 1
Length: 2…5
/TrackResponse/Shipment/Package/ReturnTo/Address/PostalCode
PostalCode Required: Yes* Return to postal code PKG
Type: String
Max Allowed: 1
Length: 1…16
/TrackResponse/Shipment/Package/ReturnTo/Address/CountryCode
CountryCode Required: Yes* Return to country or territory code. PKG
Type: Container
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Package/PackageServiceOptions
PackageServiceOptio Required: No Container for package service PKG
ns Type: Container options
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/PackageServiceOptions/COD
COD Required: No Container for COD information. Package Signature PKG SIG
Type: String Tracking only.
Max Allowed: 1
Length: 0...35
/TrackResponse/Shipment/Package/PackageServiceOptions/COD/CODAmount
CODAmount Required: No Container for COD amount Package Signature PKG SIG
Type: String information. Tracking only.
Max Allowed: 1
Length: 0...35
/TrackResponse/Shipment/Package/PackageServiceOptions/COD/CODAmount/CurrencyCode
CurrencyCode Required: No Currency of COD amount. Package Signature PKG SIG
Type: String Tracking only.
Max Allowed: 1
Length: 0...35
/TrackResponse/Shipment/Package/PackageServiceOptions/COD/CODAmount/MonetaryValue
MonetaryValue Required: No Cash On Delivery (COD) Amount Package Signature PKG SIG
Type: String that is due. Tracking only.
Max Allowed: 1
Length: 0...30
/TrackResponse/Shipment/Package/PackageServiceOptions/COD/ControlNumber
ControlNumber Required: No Barcode COD Control Number or Package Signature PKG SIG
Type: String UPS imprinted Control Number. Tracking only.
Max Allowed: 1
Length: 0...5
/TrackResponse/Shipment/Package/PackageServiceOptions/COD/CODStatus
CODStatus Required: No Status code of whether COD was Package Signature PKG SIG
Type: String Received, Collected, Not Tracking only.
Max Allowed: 1 Collected.
Length: 0-16

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 42
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/PackageServiceOptions/SignatureRequired
SignatureRequired Required: No Container tag for PKG
Type: Container SignatureRequired option.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/PackageServiceOptions/SignatureRequired/Code
Code Required: Yes* Client Application receives Valid values: PKG
Type: String Special Instructions via the A=Adult Signature
Max Allowed: 1 package detail response Required
Length: 2 indicating Signature Required or S=Signature
Adult Signature Required when a Required
package is delivered.
/TrackResponse/Shipment/Package/PackageServiceOptions/ImportControl
ImportControl Required: No Import Control Indication is used PKG
Type: String to designate that the shipment is
Max Allowed: 1 an Import Control shipment.
Length: 1 - If the shipment is an import
control shipment then this element
will have value ‘Y’.
- For non import shipment this
indicator will not appear.
/TrackResponse/Shipment/Package/PackageServiceOptions/CommercialInvoiceRemoval
CommercialInvoiceRe Required: No Commercial Invoice Removal R = CIR requested. PKG
moval Type: String (CIR) is an accessorial or S = CIR removal
Max Allowed: 1 indication that will allow a shipper successful
Length: 1 to dictate that UPS remove the
Commercial Invoice from the
user's shipment before the
shipment is delivered to the
ultimate consignee.
/TrackResponse/Shipment/Package/PackageServiceOptions/UPScarbonneutral
UPScarbonneutral Required: Yes* Carbon Neutral is a term used to PKG
Type: String reflect a generic term for the
Max Allowed: 1 tagging to be included on any
Length: 1 document, label, e-mail, etc. used
to identify that the carbon neutral
fee is applied.
- This element will appear only
when shipment is carbon neutral
with value “Y”.
- For non carbon neutral shipping
this element won’t appear.
/TrackResponse/Shipment/Package/PackageServiceOptions/USPSPICNumber
USPSPICNumber Required: Cond USPSPICNumber is a USPS PKG
Type: String Package Identification code which
Max Allowed: 1 is returned at package service
Length: variable options level for UPS Returns
Flexible Access Shipments.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 43
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/PackageServiceOptions/ExchangeBased
ExchangeBased Required: No UPS Returns Exchange is a PKG
Type: String roundtrip transportation offering
Max Allowed: 1 designed to improve the
Length: 1 exchange of merchandise
between a shipper and receiver. If
the shipment has a Return
Exchange accessorial applied to it
the value returned will be:
R = Exchange requested
C = Exchange completed
If the shipment does not have a
Return Exchange accessorial
attached to it this element won't
display.
/TrackResponse/Shipment/Package/PackageServiceOptions/PackAndCollect
PackAndCollect Required: No Pack and Collect is a contractual PKG
Type: String returns solution designed for the
Max Allowed: 1 retrieval of high-value products
Length: 1 from the original receiver for
return to the shipper or to an
alternate location.
This element will only display
when the shipment has a pack
and collect (CAR) accessorial
applied to it with value “Y”.
For non pack and collect
shipments this element won’t
display.
/TrackResponse/Shipment/Package/Activity
Activity Required: Yes* Activity information PKG, MI
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/AlternateTrackingInfo
AlternateTrackingInfo Required: Cond Alternate tracking number. Mail Innoviation MI
Type: Container only.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/AlternateTrackingInfo/Type
Type Required: Yes* Valid values: MI
Type: String 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: No This contains value of the MI
Type: String alternate tracking number.
Max Allowed: 1
Length: 1..34

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 44
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/Activity/ActivityLocation
ActivityLocation Required: No Location of activity. PKG, MI
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address
Address Required: Yes* Address information. PKG, MI
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address/AddressLine1
AddressLine1 Required: Yes* AddressLine1 contains street PKG
Type: String prefix, street name, and street
Max Allowed: 1 type
Length: 1..30
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address/AddressLine2
AddressLine2 Required: Yes* AddressLine2 contains building PKG
Type: String floor, room, suite and PO Box
Max Allowed: 1 Number.
Length: 1..30
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address/AddressLine3
AddressLine3 Required: Yes* Additional address information. PKG
Type: String
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address/City
City Required: Yes** Activity location's city. PKG, MI
Type: String
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address/StateProvinceCode
StateProvinceCode Required: Yes** Activity location's state of province PKG, MI
Type: String code.
Max Allowed: 1
Length: 2..5
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address/PostalCode
PostalCode Required: Yes** Activity location's postal codes. PKG, MI
Type: String
Max Allowed: 1
Length: 1..16
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Address/CountryCode
CountryCode Required: Yes** Activity location's country or PKG, MI
Type: String territory code.
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Package/Activity/ActivityLocation/AddressArtifactFormat
AddressArtifactForma Required: No Address location. PKG
t Type: Container
Max Allowed: 1
Length: N/A

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 45
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/Activity/ActivityLocation/AddressArtifactFormat/StreetNumberLow
StreetNumberLow Required: Yes** Street number low PKG
Type: String
Max Allowed: 1
Length: 0..10
/TrackResponse/Shipment/Package/Activity/ActivityLocation/AddressArtifactFormat/StreetPrefix
StreetPrefix Required: Yes** Street prefix. PKG
Type: String
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Package/Activity/ActivityLocation/AddressArtifactFormat/StreetName
StreetName Required: Yes** Street name. PKG
Type: String
Max Allowed: 1
Length: 1..50
/TrackResponse/Shipment/Package/Activity/ActivityLocation/AddressArtifactFormat/StreetSuffix
StreetSuffix Required: Yes** Street suffix. PKG
Type: String
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Package/Activity/ActivityLocation/AddressArtifactFormat/StreetType
StreetType Required: Yes** Textual indication of Street Type; PKG
Type: String Avenue, Lane, etx.
Max Allowed: 1
Length: 5..16
/TrackResponse/Shipment/Package/Activity/ActivityLocation/AddressArtifactFormat/PoliticalDivision2
PoliticalDivision2 Required: Yes** Activity location's city. PKG
Type: String
Max Allowed: 1
Length: 5..16
/TrackResponse/Shipment/Package/Activity/ActivityLocation/AddressArtifactFormat/PoliticalDivision1
PoliticalDivision1 Required: Yes* PoliticalDivision1State province PKG
Type: String
Max Allowed: 1
Length: 1..30
/TrackResponse/Shipment/Package/Activity/ActivityLocation/AddressArtifactFormat/PostcodePrimaryLow
PostcodePrimaryLow Required: Yes** Postal Code. PKG
Type: String
Max Allowed: 1
Length: 5..16
/TrackResponse/Shipment/Package/Activity/ActivityLocation/AddressArtifactFormat/CountryCode
CountryCode Required: Yes** Activity location's country or PKG
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
Max Allowed: 1 transport facility of the Mail
Length: N/A Innovations activity.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 46
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/Activity/ActivityLocation/TransportFacility/Type
Type Required: Yes** Type of facility for Mail 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: 5
/TrackResponse/Shipment/Package/Activity/ActivityLocation/Description
Description Required: Yes** Activity location Description. PKG
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/Activity/ActivityLocation/SignedForByName
SignedForByName Required: Yes** Name of the person who signed PKG
Type: String
Max Allowed: 1
Length: 0..15
/TrackResponse/Shipment/Package/Activity/ActivityLocation/SignatureImage
SignatureImage Required: No Signature image and format. Package Signature PKG SIG
Type: Container Tracking only.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/ActivityLocation/SignatureImage/GraphicImage
GraphicImage Required: Yes* Base64Encoded GIF image. Package Signature PKG SIG
Type: String Tracking only.
Max Allowed: 1
Length: 2
/TrackResponse/Shipment/Package/Activity/ActivityLocation/SignatureImage/ImageFormat
ImageFormat Required: Yes* Format of the image contained in Package Signature PKG SIG
Type: Container GraphicImage. Tracking only.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/ActivityLocation/SignatureImage/ImageFormat/Code
Code Required: Yes* Format of the image contained in Package Signature PKG SIG
Type: String GraphicImage. Tracking only.
Max Allowed: 1 GIF is currently only type
Length: 3 supported

Values: 01 - GIF
/TrackResponse/Shipment/Package/Activity/ActivityLocation/SignatureImage/ImageFormat/Description
Description Required: Yes* Description of image contained in Package Signature PKG SIG
Type: String GraphicImage. Tracking only.
Max Allowed: 1
Length: 1…20

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 47
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/Activity/ActivityLocation/PODLetter
PODLetter Required: No PODLetter container. PKG,
Type: Container FRT
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/ActivityLocation/PODLetter/HTMLImage
HTMLImage Required: No HTMLimage. PKG,
Type: String FRT
Max Allowed: 1
Length: Image
/TrackResponse/Shipment/Package/Activity/ActivityLocation/ElectronicDeliveryNotification
ElectronicDeliveryNoti Required: No Container to hold the Name of the PKG,
fication Type: Container customer who authorized the FRT
Max Allowed: 1 package release.
Length: N/A
/TrackResponse/Shipment/Package/Activity/ActivityLocation/ElectronicDeliveryNotification/Name
Name Required: Yes* Name of customer who authorized PKG,
Type: String the package release. FRT
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/Activity/Status
Status Required: Yes* Package activity status Container. PKG, MI
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/Status/StatusType
StatusType Required: Yes* Container tag for activity Status PKG, MI
Type: Container type.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/Status/StatusType/Code
Code Required: Yes* Code for status type of activity. For Mail Innovations PKG, MI
Type: String I = In Transit only D, I, M, P and
Max Allowed: 1 D = Delivered X are applicable.
Length: 1..3 X = Exception
P = Pickup
M = Manifest Pickup
/TrackResponse/Shipment/Package/Activity/Status/StatusType/Description
Description Required: Yes* Description of StatusCode. PKG, MI
Type: Container
Max Allowed: 1
Length: 1..370
/TrackResponse/Shipment/Package/Activity/Status/StatusCode
StatusCode Required: Yes* Container tag for activity status PKG, MI
Type: Container code
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/Activity/Status/StatusCode/Code
Code Required: Yes* Code for status code of activity. PKG, MI
Type: String Describes the activity status type
Max Allowed: 1 in greater detail.
Length: 2

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 48
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/Activity/Date
Date Required: Yes* Date of activity. Format: PKG, MI
Type: String YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/Package/Activity/Time
Time Required: Yes* Time of activity. Format: PKG, MI
Type: String HHMMSS or HHMM
Max Allowed: 1
Length: 4
/TrackResponse/Shipment/Package/Activity/GMTDate
GMTDate Required: No Date of activity. PKG, MI
Type: String Format: YYYY-MM-DD
Max Allowed: 1
Length: 8
/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
Length: 6
/TrackResponse/Shipment/Package/Activity/GMTOffset
GMTOffset Required: No GMT Offset of activity for the time PKG, MI
Type: String zone.
Max Allowed: 1 Format: (+/-) hh:mm
Length: 6
/TrackResponse/Shipment/Package/Activity/DeliveryDateFromManifestIndicator
DeliveryDateFromMa Required: No The presence of this indicator All
nifestIndicator Type: String means manifest information is
Max Allowed: 1 available and used to calculate
Length: N/A the expected delivery date.
/TrackResponse/Shipment/Package/Activity/NextScheduleActivity
NextScheduleActivity Required: No Container tag to describe when PKG, MI
Type: Container the next scheduled activity will
Max Allowed: 1 occur.
Length: N/A
/TrackResponse/Shipment/Package/Activity/NextScheduleActivity/Date
Date Required: Yes* Date of activity. Format: PKG, MI
Type: String YYYYMMDD
Max Allowed: 1
Length: 8
/TrackResponse/Shipment/Package/Activity/NextScheduleActivity/Time
Time Required: Yes* Time of activity. Format: PKG, MI
Type: String HHMMSS or HHMM
Max Allowed: 1
Length: 6
/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

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 49
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/Message
Message Required: No Container provided when the PKG, MI
Type: Container package has additional delivery
Max Allowed: 1 information.
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: 0..2 03 – Returned To
Shipper
For Mail Innovations
only '01' is
applicable.
/TrackResponse/Shipment/Package/Message/Description
Description Required: Yes* Description of the code above. PKG, MI
Type: String
Max Allowed: 1
Length: 15
/TrackResponse/Shipment/Package/PackageWeight
PackageWeight Required: No Package Weight Container tag. PKG, MI
Type: Container
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/PackageWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Package weight unit of PKG, MI
Type: Container measurement Container tag.
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
Max Allowed: 1 (default)
Length: 3 KGS - Kilograms
OZS - Ounces
/TrackResponse/Shipment/Package/PackageWeight/UnitOfMeasurement/Description
Description Required: Yes* Description of the code above. PKG, MI
Type: String
Max Allowed: 1
Length: 1..35
/TrackResponse/Shipment/Package/PackageWeight/Weight
Weight Required: No Package's 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 Package reference number PKG, MI
Type: Container Container tag.
Max Allowed: UNB
Length: N/A

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 50
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/ReferenceNumber/Code
Code Required: Yes* Reference number type code, for PKG, MI
Type: String signifying PO #s, Invoice #s, etc.
Max Allowed: 1
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/ProductType
ProductType Required: No Container tag for the type of the PKG
Type: Container Product.
Max Allowed: 1
Length: N/A
/TrackResponse/Shipment/Package/ProductType/Code
Code Required: Yes* Code indicating the type of the PKG
Type: String Product. Its value is returned from
Max Allowed: 1 the Tracking Component.
Length: N/A
/TrackResponse/Shipment/Package/ProductType/Description
Description Required: Yes* Description of the type of the PKG
Type: String Product. Valid Value: World Ease
Max Allowed: 1 (when a shipment with
Length: 1...35 single/multiple packages is
associated with World Ease
movement).
/TrackResponse/Shipment/Package/LocationAssured
LocationAssured Required: No Indication of Location Assured Valid value: PKG
Type: String Service. 1 = Location
Max Allowed: 1 Assured
Length: 1
/TrackResponse/Shipment/Package/AlternateTrackingNumber
AlternateTrackingNu Required: No If any other tracking number is PKG
mber Type: String associated with the package.
Max Allowed: UNB This generally happens if the
Length: 35..65 package is returned or some other
exception has occured and
another new tracking number is
assigned to it.
/TrackResponse/Shipment/Package/AlternateTrackingInfo
AlternateTrackingInfo Required: Cond Alternate tracking number Mail Innovations MI
Type: Container returned for this package. This is only.
Max Allowed: UNB applicable only for Mail
Length: N/A Innovations.
/TrackResponse/Shipment/Package/AlternateTrackingInfo/Type
Type Required: Yes* Valid values: MI
Type: String 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

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 51
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/AlternateTrackingInfo/Value
Value Required: Yes* This contains value of the MI
Type: String alternate tracking number of Mail
Max Allowed: 1 Innovations.
Length: 1..34
/TrackResponse/Shipment/Package/Accessorial
Accessorial Required: No This container contains the code PKG
Type: Container and description for accessorial for
Max Allowed: UNB a given shipment.
Length: N/A
/TrackResponse/Shipment/Package/Accessorial/Code
Code Required: Yes* The code indicating accessorial For values, see PKG
Type: String for a given UPS shipment. Accessorial Codes
Max Allowed: 1 in the Appendix.
Length: 3
/TrackResponse/Shipment/Package/Accessorial/Description
Description Required: Yes* The description of the accessoria PKG
Type: String above.
Max Allowed: 1
Length: 1..100
/TrackResponse/Shipment/Package/DimensionalWeightScanIndicator
DimensionalWeightSc Required: No Present if Dimensional Weight PKG
anIndicator Type: String Scan is used to recalculate
Max Allowed: 1 schedule delivery date.
Length: 0
/TrackResponse/Shipment/Package/PreauthorizedReturnInformation
PreauthorizedReturnI Required: No Container for the Pre-authorized This container will PKG, MI
nformation Type: Container For Return Information. If this be returned only if
Max Allowed: 1 information is requested and the
Length: N/A available, then this container will PreauthorizedRetur
be populated for small packages nIndicator is present
and Mail Innovation packages. in request and Pre-
authorized For
Return Eligibility
information is
available.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 52
Tracking XML Developer Guide August 08, 2022

Name Constraint Description Validation Type

/TrackResponse/Shipment/Package/PreauthorizedReturnInformation/ReturnEligibilityIndicator
ReturnEligibilityIndicat Required: No Contains Eligibility of the original Valid values are : PKG, MI
or Type: String package to initiate the “return Y - Eligible
Max Allowed: 1 process” via the given url.
Length: 1 Valid values are : N - Not Eligible
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 request
Max Allowed: 1 a “return process” via the given
Length: 8 url.
/TrackResponse/Shipment/Package/PreauthorizedReturnInformation/ReturnRequestURL
ReturnRequestURL Required: No Contains the url that can be used PKG, MI
Type: String to initiate the “return process”.
Max Allowed: 1
Length: UNB
/TrackResponse/Shipment/Package/PreauthorizedReturnInformation/OriginalTrackingNumber
OriginalTrackingNum Required: No Contains the tracking number of PKG, MI
ber Type: String the original package.
Max Allowed: 1
Length: 1...21
/TrackResponse/Shipment/Package/PreauthorizedReturnInformation/ReturnTrackingNumber
ReturnTrackingNumb Required: No Contains the tracking number of PKG, MI
er Type: String the return package.
Max Allowed: 1
Length: 1...21
/TrackResponse/Shipment/Package/UPSPremierAccessorial
UPSPremierAccessor Required: No PKG
ial 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
UPSPremierDescripti Required: No Valid Values: PKG
on 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 Premier false
Length: N/A 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
Returns true if flight indicator is
available and return false if flight
indicator is not available.

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 53
Tracking XML Developer Guide August 08, 2022

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 54
Tracking XML Developer Guide August 08, 2022

Chapter 5: Tracking API XML Examples

Tracking Request
<?xml version="1.0"?>
<AccessRequest xml:lang="en-US">
<AccessLicenseNumber>YourLicenseNumber</AccessLicenseNumber>
<UserId>YourUserID</UserId>
<Password>YourPassword</Password>
</AccessRequest>
<?xml version="1.0"?>
<TrackRequest xml:lang="en-US">
<Request>
<TransactionReference>
<CustomerContext>Your Test Case Summary Description</CustomerContext>
</TransactionReference>
<RequestAction>Track</RequestAction>
<RequestOption>activity</RequestOption>
</Request>
<TrackingNumber>YourTrackingNumber</TrackingNumber>
</TrackRequest>

Tracking Response
<?xml version="1.0" encoding="ISO-8859-1"?>
<TrackResponse>
<Response>
<TransactionReference>
<CustomerContext>Your Test case summary Description</CustomerContext>
</TransactionReference>
<ResponseStatusCode>1</ResponseStatusCode>
<ResponseStatusDescription>Success</ResponseStatusDescription>
</Response>
<Shipment>
<Shipper>
<ShipperNumber>F00100</ShipperNumber>
<Address>
<City>HOBOKEN</City>
<StateProvinceCode>NJ</StateProvinceCode>
<PostalCode>07030</PostalCode>
<CountryCode>US</CountryCode>
</Address>
</Shipper>
<ShipmentWeight>
<UnitOfMeasurement>
<Code>LBS</Code>
</UnitOfMeasurement>
<Weight>35.00</Weight>
</ShipmentWeight>
<Service>
<Code>02</Code>
<Description>2ND DAY AIR</Description>
</Service>
<ShipmentIdentificationNumber>ATrackingNumber</ShipmentIdentificationNumber>

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 55
Tracking XML Developer Guide August 08, 2022

<Package>
<TrackingNumber>ATrackingNumber</TrackingNumber>
<Activity>
<ActivityLocation>
<Address>
<City>MAYSVILLE</City>
<PostalCode>26833 9700</PostalCode>
<CountryCode>US</CountryCode>
</Address>
<Code>MG</Code>
<Description>MET CUST MAN</Description>
<SignedForByName>Larry</SignedForByName>
</ActivityLocation>
<Status>
<StatusType>
<Code>D</Code>
<Description>DELIVERED</Description>
</StatusType>
<StatusCode>
<Code>KB</Code>
</StatusCode>
</Status>
<Date>20030313</Date>
<Time>160000</Time>
</Activity>
<PackageWeight>
<UnitOfMeasurement>
<Code>LBS</Code>
</UnitOfMeasurement>
<Weight>35.00</Weight>
</PackageWeight>
</Package>
</Shipment>
</TrackResponse>

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

Signature Tracking Request

<?xml version="1.0"?>
<AccessRequest xml:lang="en-US">
<AccessLicenseNumber>YourLicenseNumber</AccessLicenseNumber>
<UserId>YourUserID</UserId>
<Password>YourPassword</Password>
</AccessRequest>
<?xml version="1.0"?>
<TrackRequest xml:lang="en-US">
<Request>
<TransactionReference>
<CustomerContext>Your Test Case Summary Description</CustomerContext>
</TransactionReference>
<RequestAction>Track</RequestAction>
<RequestOption>15</RequestOption>
</Request>
<TrackingNumber>YourTrackingNumber</TrackingNumber>
<ShipperAccountInfo>
<CountryCode>US</CountryCode>
<PostalCode>07430</PostalCode>21093
</ShipperAccountInfo>
</TrackRequest>

Signature Tracking Response

<?xml version="1.0" encoding="UTF-8"?>
<TrackResponse>
<Response>
<TransactionReference>
<CustomerContext>Your Test Case Summary Description</CustomerContext>
</TransactionReference>
<ResponseStatusCode>1</ResponseStatusCode>
<ResponseStatusDescription>Success</ResponseStatusDescription>
</Response>
<Shipment>
<Shipper>
<ShipperNumber>12345E</ShipperNumber>
<Address>
<AddressLine1>SAMPLE SHIPPER</AddressLine1>
<AddressLine2>1000 MAIN STREET</AddressLine2>
<City>ANYTOWN</City>
<StateProvinceCode>GA</StateProvinceCode>
<PostalCode>30044</PostalCode>
<CountryCode>US</CountryCode>
</Address>
</Shipper>
<ShipTo>
<Address>
<AddressLine1>SAMPLE CONSIGNEE</AddressLine1>
<AddressLine2>1307 PEACHTREE STREET</AddressLine2>
<City>ANYTOWN</City>

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

<StateProvinceCode>GA</StateProvinceCode>
<PostalCode>30340</PostalCode>
<CountryCode>US</CountryCode>
</Address>
</ShipTo>
<Service>
<Code>001</Code>
<Description>NEXT DAY AIR</Description>
</Service>
<ReferenceNumber>
<Code>01</Code>
<Value>SAMPLE PROOF OF DELIVERY LETTER</Value>
</ReferenceNumber>
<ReferenceNumber>
<Code>01</Code>
<Value>TEST</Value>
</ReferenceNumber>
<ShipmentIdentificationNumber>1Z12345E5991872040</ShipmentIdentificationNumber>
<PickupDate>20010219</PickupDate>
<ScheduledDeliveryDate>20010220</ScheduledDeliveryDate>
<Package>
<TrackingNumber>1Z12345E5991872040</TrackingNumber>
<PackageServiceOptions>
<COD>
<CODAmount>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>10.00</MonetaryValue>
</CODAmount>
<CODStatus>Collected</CODStatus>
</COD>
</PackageServiceOptions>
<Activity>
<ActivityLocation>
<Address>
<AddressLine1>1307 PEACHTREE STREET</AddressLine1>
<City>ANYTOWN</City>
<StateProvinceCode>GA</StateProvinceCode>
<PostalCode>30340</PostalCode>
<CountryCode>US</CountryCode>
</Address>
<Code>M5</Code>
<Description>MAIL ROOM</Description>
<SignedForByName>DOE</SignedForByName>
<SignatureImage>
<GraphicImage>R0lGODdhoAFeAPcAAP///+/n5+fWxs69rd7OADs= (truncatenated for
example)</GraphicImage>
<ImageFormat>
<Code>GIF</Code>
<Description>Base 64 encoded gif</Description>
</ImageFormat>
</SignatureImage>
<PODLetter>
<HTMLImage>PCFET0NUWVBFIEhUTUwgUFVCTElDICItLy9X9IVE1MPg==(truncate
nated for example) </HTMLImage>

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

</PODLetter>
</ActivityLocation>
<Status>
<StatusType>
<Code>D</Code>
<Description>DELIVERED</Description>
</StatusType>
<StatusCode>
<Code>KM</Code>
</StatusCode>
</Status>
<Date>20010221</Date>
<Time>090600</Time>
</Activity>
<Activity>
<ActivityLocation>
<Address>
<City>ANYTOWN</City>
<StateProvinceCode>GA</StateProvinceCode>
<CountryCode>US</CountryCode>
</Address>
</ActivityLocation>
<Status>
<StatusType>
<Code>I</Code>
<Description>DESTINATION SCAN</Description>
</StatusType>
<StatusCode>
<Code>DS</Code>
</StatusCode>
</Status>
<Date>20010221</Date>
<Time>073717</Time>
</Activity>
<Activity>
<ActivityLocation>
<Address>
<City>ANYTOWN</City>
<StateProvinceCode>GA</StateProvinceCode>
<CountryCode>US</CountryCode>
</Address>
</ActivityLocation>
<Status>
<StatusType>
<Code>I</Code>
<Description>ARRIVAL SCAN</Description>
</StatusType>
<StatusCode>
<Code>AR</Code>
</StatusCode>
</Status>
<Date>20010221</Date>
<Time>063000</Time>
</Activity>

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

<Activity>
<ActivityLocation>
<Address>
<City>ANYTOWN INTL</City>
<StateProvinceCode>GA</StateProvinceCode>
<CountryCode>US</CountryCode>
</Address>
</ActivityLocation>
<Status>
<StatusType>
<Code>I</Code>
<Description>DEPARTURE SCAN</Description>
</StatusType>
<StatusCode>
<Code>DP</Code>
</StatusCode>
</Status>
<Date>20010221</Date>
<Time>052000</Time>
</Activity>
<Activity>
<ActivityLocation>
<Address>
<City>HARTSFIELD (ANYTOWN)</City>
<StateProvinceCode>GA</StateProvinceCode>
<CountryCode>US</CountryCode>
</Address>
</ActivityLocation>
<Status>
<StatusType>
<Code>I</Code>
<Description>LOCATION SCAN</Description>
</StatusType>
<StatusCode>
<Code>LC</Code>
</StatusCode>
</Status>
<Date>20010221</Date>
<Time>034756</Time>
</Activity>
<Activity>
<ActivityLocation>
<Address>
<City>PLEASANTDALE</City>
<StateProvinceCode>GA</StateProvinceCode>
<CountryCode>US</CountryCode>
</Address>
</ActivityLocation>
<Status>
<StatusType>
<Code>I</Code>
<Description>LOCATION SCAN</Description>
</StatusType>
<StatusCode>

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

<Code>LC</Code>
</StatusCode>
</Status>
<Date>20010220</Date>
<Time>192558</Time>
</Activity>
<Activity>
<ActivityLocation>
<Address>
<City>PLEASANTDALE</City>
<StateProvinceCode>GA</StateProvinceCode>
<CountryCode>US</CountryCode>
</Address>
</ActivityLocation>
<Status>
<StatusType>
<Code>I</Code>
<Description>LOCATION SCAN</Description>
</StatusType>
<StatusCode>
<Code>LC</Code>
</StatusCode>
</Status>
<Date>20010220</Date>
<Time>192500</Time>
</Activity>
<Activity>
<ActivityLocation>
<Address>
<City>PLEASANTDALE-DUNWDY</City>
<StateProvinceCode>GA</StateProvinceCode>
<CountryCode>US</CountryCode>
</Address>
</ActivityLocation>
<Status>
<StatusType>
<Code>P</Code>
<Description>PICKUP SCAN</Description>
</StatusType>
<StatusCode>
<Code>PU</Code>
</StatusCode>
</Status>
<Date>20010220</Date>
<Time>170842</Time>
</Activity>
<Activity>
<ActivityLocation>
<Address>
<CountryCode>US</CountryCode>
</Address>
</ActivityLocation>
<Status>
<StatusType>

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

<Code>M</Code>
<Description>PICKUP MANIFEST RECEIVED</Description>
</StatusType>
<StatusCode>
<Code>MP</Code>
</StatusCode>
</Status>
<Date>20010219</Date>
<Time>132203</Time>
</Activity>
<PackageWeight>
<UnitOfMeasurement>
<Code>LBS</Code>
</UnitOfMeasurement>
<Weight>1.70</Weight>
</PackageWeight>
<ReferenceNumber>
<Code>01</Code>
<Value>SAMPLE PROOF OF DELIVERY LETTER</Value>
</ReferenceNumber>
<ReferenceNumber>
<Code>01</Code>
<Value>TEST</Value>
</ReferenceNumber>
</Package>
</Shipment>
</TrackResponse>

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

Tracking API FAQs

Category Question Answer
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 accessed
image through a POD image be electronically for 18 months but cannot be
emailed? emailed.

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.

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

Category Question Answer

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.

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 play-back 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

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

Category Question Answer

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 access the POD? UPS Technology Agreement allows you to access
a POD letter (which may or may not contain
digital signature) for a maximum of 18 months.

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.

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

Category Question Answer

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 66
Tracking XML Developer Guide September 13,2023

Signature Tracking FAQs

Category Question Answer

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 access 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 accessed
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 67
Tracking XML Developer Guide September 13,2023

Appendices

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

Error Codes (XML)

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.
To discover errors, check the ResponseStatusCode element. A “1” normally indicates a successful response,
whereas a “0” indicates a Transient or Hard error. The PrimaryErrorCode element contains the error code and
description.
• Successful responses may or may not include warnings.
o Without warnings - Indicates the request has been processed as anticipated.
o With warnings - Indicates the request has been processed with potentially unanticipated results. The warning
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.

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

Code Severity Description

250003 Hard Invalid Access License number.

250004 Hard Incorrect UserId or Password.

250005 Hard No Access and Authentication Credentials provided.

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

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

Error Code Severity Description

151044 Hard No tracking information available

151045 Hard No information found

151050 Hard Too many records to display

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

154080 Warning Could not verify Signature rights

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

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.

155004 Warning Max size of the candidate list is exceeded.

155005 Hard Invalid country code for Mail Innovations.

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

Error Code Severity Description

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

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

© 2022 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 72
Tracking XML 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 73
Tracking XML 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/territory abbreviations in ISO Standard 3166.
The following table lists the country/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 Supported Supported

Code 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 74
Tracking XML Developer Guide September 13,2023

Country/Territory Name Country/Territory Supported Supported

Code 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 75
Tracking XML Developer Guide September 13,2023

Country/Territory Name Country/Territory Supported Supported

Code 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 76
Tracking XML Developer Guide September 13,2023

Country/Territory Name Country/Territory Supported Supported

Code 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 Peoples 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 77
Tracking XML Developer Guide September 13,2023

Country/Territory Name Country/Territory Supported Supported

Code 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 78
Tracking XML Developer Guide September 13,2023

Country/Territory Name Country/Territory Supported Supported

Code 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 79
Tracking XML Developer Guide September 13,2023

Country/Territory Name Country/Territory Supported Supported

Code 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 80
Tracking XML Developer Guide September 13,2023

Country/Territory Name Country/Territory Supported Supported

Code 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 81
Tracking XML 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

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

Country/Territory Currency Name Currency Code

Bhutan Ngultrum BTN

Bolivia Boliviano BOB

Bolivia Mvdol BOV

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

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

Country/Territory Currency Name Currency Code

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

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

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

Country/Territory Currency Name Currency Code

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

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

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

Country/Territory Currency Name Currency Code

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

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

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

Country/Territory Currency Name Currency Code

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

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

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

Country/Territory Currency Name Currency Code

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

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

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

Country/Territory Currency Name Currency Code

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

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

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

Country/Territory Currency Name Currency Code

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 90
Tracking XML Developer Guide September 13,2023

Current Status Codes

Code Description
001 Billing Information Received

002 In Transit

003 Exception

004 Delivered Origin CFS

005 Delivered Destination CFS

006 Warehousing

007 Out for Delivery

011 Delivered

111 Not Available

222 Not Available

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

Package 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 – 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 92
Tracking XML 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's 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 93
Tracking XML 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 94
Tracking XML 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 '2' - '15' 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 95
Tracking XML 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

UPS 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 96
Tracking XML 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 97
Tracking XML 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/territories 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 98
Tracking XML Developer Guide September 13,2023

All Countries/Territories
Shipments originating in all countries/territories

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 99
Tracking XML 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 100
Tracking XML 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 101
Tracking XML 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 102
Tracking XML Developer Guide September 13,2023

Subversion details
UPS uses sub version strategy to give back new elements in the response when there is no functionality change in
the request. In order to ensure that we do not break the 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
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 103