Tracking XML Developers Guide

Tracking - XML
7/11/2011
Tracking XML Developers Guide

July 11 2011
2011 United Parcel Service of America, Inc. All Rights Reserved. Page 1 Confidential and Proprietary
Tracking - XML
7/11/2011
Notice In all communications with UPS concerning this document, please refer to the document date located on the cover. Copyright 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. Copyright 2011 United Parcel Service of America, Inc. All Rights Reserved. Trademarks UPS Online is a registered trademark of United Parcel Service of America, Inc. All other trademarks are the property of their respective owners. Some of the UPS corporate applications use U.S. 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.
2011 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Page 2
Tracking - XML
7/11/2011
Table of Contents
1.1 Important Information................................................................................................................... 5 1.2 Welcome to the UPS API Developer's Guides ............................................................................. 6 1.2.1 What's New for Tracking in July 2011 .................................................................................. 6 1.2.2 How to Use this Guide........................................................................................................... 7 1.3 Business Processes and Rules....................................................................................................... 7 1.4 Required Steps for Integrating ...................................................................................................... 7 1.5 Planning Your Applications for XML .......................................................................................... 8 1.5.1 UPS Developer API Applications.......................................................................................... 8 1.5.2 Licensing the UPS Developer APIs..................................................................................... 10 1.5.2.1 Branding Requirements ................................................................................................ 11 1.5.3 Developing Client Applications for Developer APIs .......................................................... 11 1.5.3.1 Microsoft Visual Studio................................................................................................ 11 1.5.3.2 Java Standard Edition and Enterprise Edition .............................................................. 11 1.5.3.3 Open Source.................................................................................................................. 11 1.5.4 Getting Technical Support ................................................................................................... 12 1.5.4.1 Within the United States ...............................................................................................12 1.5.4.2 Outside of the United States ......................................................................................... 12 1.5.5 Testing and Deploying Applications ................................................................................... 13 1.5.6 Keeping Up-to-Date............................................................................................................. 13 1.6 UPS Developer API Technologies for XML .............................................................................. 13 1.6.1 Hypertext Transfer Protocol and Secure Sockets Layer 3 ................................................... 13 1.6.2 Working with HTTP and SSL in Application Programs ..................................................... 15 1.6.2.1 Microsoft Visual Studio................................................................................................ 17 1.6.2.2 Java Standard Edition and Enterprise Edition .............................................................. 18 1.6.2.3 Open Source.................................................................................................................. 18 1.6.3 Extensible Markup Language (XML).................................................................................. 20 1.6.4 Working with XML in Application Programs ..................................................................... 22 1.6.4.1 Microsoft Visual Studio................................................................................................ 22 1.6.4.2 Java Standard Edition and Enterprise Edition .............................................................. 24 1.6.4.3 Open Source.................................................................................................................. 25 1.7 Understanding XML Tracking Services ..................................................................................... 26 1.7.1 Identifying a Package or Shipment to Track........................................................................ 26 1.7.1.1 Tracking Numbers ........................................................................................................ 26 1.7.1.2 Shipment Identification Numbers ................................................................................. 26 1.7.1.3 Reference Numbers....................................................................................................... 26 1.7.1.4 PRO numbers and Air Waybill numbers ...................................................................... 27 1.7.1.5 Candidate Bookmarks ................................................................................................... 27 1.8 Tracking Reference..................................................................................................................... 28 1.8.1 Authenticating Client Applications...................................................................................... 28 1.8.2 Tracking ............................................................................................................................... 28 1.8.3 Track Request ...................................................................................................................... 30 1.8.4 Track Response.................................................................................................................... 37
Page 3
Tracking - XML
7/11/2011
1.9 Customer Integration Environment............................................................................................. 77 1.9.1 System Availability.............................................................................................................. 77 1.9.2 Server Availability Check.................................................................................................... 77 1.9.3 Tracking Usage Guidelines.................................................................................................. 77
Appendices
Appendix A Tracking Error Codes ................................................................................................ 79 Appendix B - Country Codes............................................................................................................ 82 Appendix C - Currency Codes.......................................................................................................... 89 Appendix D - Service Codes............................................................................................................. 96 Appendix E State Province Codes ............................................................................................... 109 Appendix F Tracking Request Options........................................................................................ 111 Appendix G- Shipping and Tracking Numbers for Testing............................................................ 112 Appendix H - Frequently Asked Questions: Tracking ................................................................... 114
Page 4
Tracking - XML
7/11/2011
1.1 Important Information

UPS Developer APIs
Your development of an application using the UPS Web Service APIs are governed by the UPS Technology Agreement or UPS Customer Technology Agreement you entered into with UPS. The following are key legal requirements from these agreements for the UPS Web Service APIs. For more information on all requirements for the UPS Web Service APIs, please refer to the UPS Technology Agreement or the Customer Technology Agreement.
Key Legal Requirements for UPS Developer APIs

Permitted Territories
This document can only be used in the countries listed in Exhibit C of the UPS Technology Agreement or UPS Customer Technology Agreement.
Use
The application must not be designed to allow distribution of information received through the UPS Web Service 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).
Consent to Use of UPS Mark

All screens or forms generated by your application including information received through the UPS Web Service 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.
Page 5
Tracking - XML
7/11/2011
Copyright and Proprietary Notice

In your application and any POD Letters you prepare you must include a prominent reproduction of UPSs copyright and proprietary notices in a form and format specified by UPS (See 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 Web Service APIs. Your application must present all data within each field received through the UPS Web Service APIs without amendment, deletion or modification of any type.
1.2 Welcome to the UPS API Developer's Guides

Welcome to the UPS API Developer's Guides. This guide provides the information you need to begin using UPS Developer APIs. UPS Developer APIs offer a fast and convenient way to access UPS service information using the Internet. With these Developer APIs, UPS lets you easily incorporate UPS technology in your own applications or your own web site. Your usersrunning your applications or visiting your web sitecan have up-to-the-minute access to UPS services.
1.2.1 What's New for Tracking in July 2011

With this release, requested POD will be returned even if the last activity is not the delivery record. UPS can release a Delivery Confirmation Signature Required package for customers who have signed an Electronic InfoNotice. In lieu of a signature, the POD Letter or Signature File will display the name of the person who authorized the release. Adds visibility scans for packages that were dropped off at various retail locations. The UPS Mail Innovations business unit (MI) is a high volume mail expediter for US companies seeking mail delivery with transit times similar to USPS First Class Mail, but at steep discounts. Mail Innovations shipment is applicable for US only. Mail Innovations was purchased by UPS in 2001 however the tracking systems had so far remained separate. Starting July 2011 release, users will get a single tracking site to track all their UPS shipments. The tracking Tool & WS now will have the capability to provide tracking information of Mail Innovations shipment as well. Users will be able to track Mail Innovations shipments by Mail Innovations tracking number or reference number via XML Track Tool or Track WS 2.0. Providing visibility to both the UPS Returns Exchange forward movement and the return movement after linkage Providing shipment, exception, and delivery notifications for UPS Returns Exchange forward movements and/or the associated return movements upon user request
Page 6
Tracking - XML
7/11/2011
Providing visibility to UPS Returns Pack and Collect One Delivery Attempt (PAC1A) and UPS Returns Pack and Collect Three Delivery Attempt (PAC3A) movements Providing shipment, exception, delivery, and return notifications for UPS Returns Pack and Collect movements upon user request
1.2.2 How to Use this Guide

If you are an experienced developer, you can begin developing applications quickly after reviewing "Required Steps for Integrating." If you would like a more step-by-step guide to developing and deploying the Developer APIs, "Planning Your Applications" provides advice and describes options for developing and deploying applications and web sites that use UPS Developer APIs. The "UPS Developer API Technologies" section explains key technologies on which the Developer APIs rely. That section also includes hints for using those technologies in various software development environments. If you would like to learn more about what the UPS API covered in this guide can do for your applications, refer to the section on understanding the UPS API Services in this guide. A complete technical reference to the Developer API covered in this guide is found in the API Reference section with details for the programming interfaces. Additional material, including reference tables and lists, may be found in the appendices.
1.3 Business Processes and Rules

The Tracking API supports both Ground Freight and Air Freight shipments. UPS Freight must bill the shipment before information is passed to UPS.com or QVM. UPS has a rule that header information must be established before the shipment can be displayed. Header information is established at the billing point, and that usually occurs the night of the shipment. Some Tracking data may not be returned in the response because data rolled off - see database retention times: OPLD (Manifest - Billing Info Received): 5 months XPLD (Exceptions): 9 months GIPLD (In Transit scans, Arrivals/Departures): 3 months DIALs (Delivery records/signature image): 18 months
Trade Direct small manifest uploads are kept in an advanced PLD database, and only released for visibility after the Origin scan is applied to the label.
1.4 Required Steps for Integrating

The required steps for integrating the UPS APIs are listed here for UPS XML Services.
Page 7
Tracking - XML
7/11/2011
UPS XML Services 1. 2. 3. 4. 5. 6. 7.

Review the UPS Technology Agreement available at www.ups.com. This agreement requires that you follow certain procedures and practices in using UPS Developer APIs. Develop applications that make use of standard HTTP communications protocols, SSL security, and XML-based document representations. Test your application and/or web site using the designated UPS staging environment. If you are a UPS Ready developer, review your application with UPS. Obtain UPS Label Certification for your application. (If you are a new customer or if you havent previously certified. Please see the UPS Label Certification section for further details.). Deploy your application for your customers. Ensure the UPS Shipper Account number is added to the users profile. This can be done at myups.com.
1.5 Planning Your Applications for XML

Planning is a key part of any successful development activity, and UPS Developer API applications are no exception. This section helps that planning by describing the important activities of any UPS Developer API application project. It provides an overview of the steps required to develop applications, and it describes key factors and choices necessary to deploy those applications.
1.5.1 UPS Developer API Applications

Many different types of applications can take advantage of UPS Developer APIs.Those application types include dedicated desktop applications, databases, web applications, and documents. The following figures illustrate some of the possibilities for applications using UPS Developer APIs. The only essential requirement for all of these applications is that they must have access to the Internet.
Page 8
Tracking - XML
7/11/2011
Page 9
Tracking - XML
7/11/2011
The UPS Developer APIs can be implemented withal of these types of applications and many others. Virtually any software that needs instant, up-todate access to UPS services can take advantage of UPS Developer APIs.
1.5.2 Licensing the UPS Developer APIs

As part of the UPS Technology Agreement, users of the APIs have certain obligations that are spelled out within the service agreement and its exhibits. Regardless of the manner in which the UPS Developer APIs are integrated into your specific e-commerce web site or enterprise application, you must adhere to appropriate usage requirements.
Page 10
Tracking - XML
7/11/2011
1.5.2.1 Branding Requirements

UPS should receive attribution and branding in all applications (including websites and software applications) that use the Developer APIs. No End User, Third Party Developer or Access User should be permitted to use the Developer APIs without providing branded recognition to UPS. Your use of the UPS logo can in no way imply endorsement, sponsorship or certification of your ecommerce web site or enterprise application by UPS. You are not allowed to use or alter the information returned by the UPS Developer APIs in a way that misrepresents the information or the functionality of the service.
1.5.3 Developing Client Applications for Developer APIs

When you develop software that uses the UPS Developer APIs, you are building a client application. Because the UPS Developer APIs rely on standard Internet based technology, you can develop those applications using a wide variety of software development platforms, including Microsoft's Visual Studio, the Java Standard Edition and Enterprise Edition distributions, and many open source projects. This section introduces important technologies available in each of these development environments. Later sections of this document include more details on using each platform. Look for the icons in the left margin, which identify information relevant to a particular development environment.
1.5.3.1 Microsoft Visual Studio

Developers using the Microsoft Visual Studio environment can rely on the Microsoft XML Core Services (MSXML) for interacting with UPS Developer APIs. Those services include functions to help applications create requests for and interpret responses, and they include functions to manage the communications between applications and UPS.
1.5.3.2 Java Standard Edition and Enterprise Edition

Java developers can find all the classes they need for UPS Developer APIs in the Java Standard Edition and Enterprise Edition distributions. The URL class in the java.net package provides the functions required for communication with UPS servers, and the Java API for XML Processing (JAXP) services let programs create requests and interpret responses from UPS.
1.5.3.3 Open Source

There are a number of open source efforts that include technology useful for creating Developer API client applications; open source developers may find two particular projects to be especially helpful. The libcurl project is a library of functions that can manage the communications with UPS servers. For creating requests and interpreting responses, the xerces project provides essential functions in a variety of software languages.
Page 11
Tracking - XML
7/11/2011
1.5.4 Getting Technical Support

UPS provides technical support for developers who are using the UPS Developer APIs. To get in touch with a UPS technical support engineer, fill out the technical support request form on the UPS web site.
1.5.4.1 Within the United States

UPS provides seven days-a-week support either via email or phone. The primary and most effective method for support is to use email (https://www.ups.com/upsemail/input?requestId=gec&category=techsupport& topic=onlinetools&loc=en_US&WT.svl=SubNav) since you will need to include your code for review by the UPS support team. UPS now provides phone support for all phases of development in extremely urgent situations. To access phone support please call toll free 1-877-289-6420. 7:30 AM - 9:00 PM Monday - Friday (EST) 9:00 AM - 6:00 PM Saturday and Sunday (EST) For developers in the United States, the request form may be found by selecting Contact UPS from the www.myups.com web site, or from www.ups.com from the steps below. 1. Navigate to the UPS website http://www.ups.com. 2. Select a language, (ex. United States English). 3. Log into www.ups.com with your User ID and Password. 4. Click the Support tab 5. Select Technology Support from Support tab 6. Click on Developer Resource Center, and then click UPS Developer Kit on the left-hand navigation window. 7. Click the link for "Customer Support for UPS Developer Kit" under Access and Administration. 8. Complete the e-mail form. Please explain details about errors that are being returned, and under what circumstances.
1.5.4.2 Outside of the United States

Developers outside the United States can find the technical support request in the UPS Developer APIs page within the Support section of their country's UPS web site. 1. Navigate to the UPS website http://www.ups.com. 2. Select a language, 3. Log into www.ups.com with your User ID and Password. 4. Click the Support tab 5. Select Technology Support from Support tab 6. Click on Developer Resource Center, and then click UPS Developer Kit on the left-hand navigation window.
Page 12
Tracking - XML
7/11/2011
7. Click the link for "Customer Support for UPS Developer Kit" under Access and Administration. 8. Complete the e-mail form. Please explain details about errors that are being returned, and under what circumstances. For more information or assistance with UPS technical support, please contact your UPS Developer APIs representative
1.5.5 Testing and Deploying Applications

UPS maintains a special environment to support testing and staging of applications that rely on UPS Developer APIs. This environment is called the Customer Integration Environment (CIE) and allows developers test and debug their applications by simulating transactions with UPS. The CIE site responds to requests just like the UPS production environment; however, it does not initiate actual UPS business services. For example, if you send a shipping request to the UPS production site, a UPS driver may show up at your location expecting to pick up a package (and expecting payment for the service.) Sending the shipping request to CIE will avoid this problem.
1.5.6 Keeping Up-to-Date

As UPS adds new services and features, Developer APIs will evolve, offering more features and service benefits. Once you register to use UPS Developer APIs, UPS will notify you by e-mail of updates and changes to the Developer APIs. It is essential that an accurate e-mail address for your company be maintained. In addition, UPS recommends that you complete the secondary contact information to ensure that your organization receives the latest updates. You should update your profile when changes or responsibilities for the UPS Developer APIs change within your company. You can also return to the UPS Support area of ups.com for the latest updated information about UPS Developer APIs.
1.6 UPS Developer API Technologies for XML

The foundation technologies for UPS Developer APIs are the same underlying technologies in use on the Internet today. They include the Hypertext Transfer Protocol (HTTP) with Secure Sockets Layer 3 (SSL3) security and the Extensible Markup Language (XML). Because these technologies are critical to the Internet, most software development tools provide many powerful features that make it easy for application programs to use them. This section provides a quick introduction to the technologies and to the tools that can support them.
1.6.1 Hypertext Transfer Protocol and Secure Sockets Layer 3

Today's Internet supports a wide variety of applications including email, instant messaging, web browsing, and voice communications. All of these applications have a well-defined set of rules that determines how they communicate. Those rules are known as protocols. As an
Page 13
Tracking - XML
7/11/2011
Internet application themselves, the UPS Developer APIs also rely on protocols to set the rules for their communications. The primary protocol for UPS Developer APIs is the hypertext transfer protocol, or HTTP. HTTP is a relatively simple protocol. An application that wants to use a Developer API acts as an HTTP client. It sends its request to UPS as part of an HTTP POST message. UPS servers reply to each request using an HTTP response message.
As part of the POST message, client applications indicate the type of content the message contains using an HTTP Content-Type header. For UPS Developer APIs, that content type should be application/x-www-form-urlencoded. (Presently, Version 1.1 is supported) In many cases the UPS Developer APIs exchange information that should be kept private. To protect confidential information, the Developer APIs rely on the Secure Sockets Layer 3 (SSL3) protocol in addition to HTTP. When two systems communicate using SSL, the protocol creates a secure channel between them, and it encrypts all information that they exchange using this channel. The SSL protocol that Developer APIs use is the same protocol used to secure millions of on-line purchases on the web.
Page 14
Tracking - XML
7/11/2011
1.6.2 Working with HTTP and SSL in Application Programs

UPS Developer APIs are not the only Internet services that rely on the HTTP and SSL protocols. Both protocols, in fact, were originally developed for web browsing, and they provide the foundation for the majority of Internet applications. Because HTTP and SSL are so common, software development tools make using these protocols very simple. Because HTTP and SSL are commonly used for web browsing, software development tools often rely on the same notation and abbreviations as standard web browsers. In particular, most tools identify a specific service (such as a UPS Developer API) using a Uniform Resource Locator (URL). URLs begin with an abbreviation of the communication protocol. For UPS Developer APIs that abbreviation will always be "https" to indicate HTTP and SSL. The protocol abbreviation is followed by a colon, two slashes, and the name of a server. Additional information about the specific service can follow the server name; it is written like the path to a file in a directory, with slashes separating individual folders. Figure 3 shows how a URL combines these individual components.
Page 15
Tracking - XML
7/11/2011
Figure 3. URLs identify communication protocols, servers, and specific services.
SSL Certificate Changes and Renewals: UPS has migrated from Unchained to Chained Digital Certificates to improve security for UPS servers. Chained Digital Certificates requires the use of SSL 3.0. Our migration from SSL 2.0 to 3.0 was completed between 6/15/2008 and 3/3/2009. Renewal of UPS.com SSL Certificates are coordinated by UPS Security Services every two years. There is a concern that some UPS Developer Kit users who store UPS Certificates internally may have issues when SSL Certificates are renewed. It is recommended that UPS Developer Kit users not store UPS Certificates internally; however if a customer finds this necessary due to specific needs within their company, they may need to add renewed certificates to the their trust store. There are a number of ways one can add a certificate to the application. One way to obtain the proper certificate is by placing a UPS Developer Kit URL, https://onlinetools.ups.com/ups.app/xml/Rate, for example, in a browser, connect to the URL, and double-click on the "lock" on the bottom right of the window (using Internet Explorer 7). After that the steps can be followed to install the certificate. Also, in the event that the aforementioned solution does not work successfully for you we have been provided with the following certificate which should allow you to connect once it has been successfully added. You should be able to paste the following string into Notepad and save the file locally. Then, it will be necessary to have the client application reference the file so that it will know that this is the trusted certificate for making a connection to UPS.
Page 16
Tracking - XML
7/11/2011
This is the GTE CyberTrust Root that the client must trust: -----BEGIN CERTIFICATE----MIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgY DVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJvb3 QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJ VUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJ UcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyvRL fTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4MypqfpX/1 FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/51KiOQswkwB6RJ0q1b QaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKzdcZfHeFhVYAA1IFLezEP I2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWlIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG 41tWW4/5ODFlitppK+ULdjG+BqXH/9ApybW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpS XY -----END CERTIFICATE----Finally, for more information on installing the latest VeriSign CA Root Certificate, please click on the links below: https://knowledge.verisign.com/support/ssl-certificatessupport/index?page=content&id=SO7154&actp=search&viewlocale=en_US&searchid=130823512 4970 https://knowledge.verisign.com/support/ssl-certificatessupport/index?page=content&actp=CROSSLINK&id=AR1553 https://knowledge.verisign.com/support/ssl-certificatessupport/index?page=content&id=SO4785&actp=LIST The subsections that follow provide brief introductions to using HTTP and SSL with various software development tools, including Microsoft Visual Studio, Java Standard and Enterprise Edition, and popular open source environments.

The Microsoft Visual Studio environment includes many tools, classes, and libraries that simplify the use of HTTP and SSL protocols. A very convenient set of tools are included in the Microsoft XML Core Services (MSXML). The following code fragment shows how a Visual Basic program can send a request and retrieve the response. To keep the example as simple as possible, no exception handling is included in the figure. Production software should, of course, appropriately handle all exceptions
Page 17
Tracking - XML
7/11/2011
' create the object that manages the communication Dim oXMLHttp As XMLHTTP Set oXMLHttp = New XMLHTTP ' prepare the HTTP POST request oXMLHttp.open "POST", "https://www.server.com/path", False oXMLHttp.setRequestHeader "Content-Type", _ "application/x-www-form-urlencoded" ' send the request oXMLHttp.send requestString
' server's response will be available in oXMLHttp.responseXML

Figure 4. Visual Basic programs can use features of the MSXML tools to send and receive messages using HTTP and SSL.

In a Java SE or EE environment, the URL class in the java.net package provides a convenient way to manage HTTP and SSL communications. Figure 5 contains a small code fragment that demonstrates the use of this class. As above, the fragment doesn't include exception handling that should be inherent in any production software.
import java.io.*; import java.net.*; URL url = new URL("https://www.server.com/path"); HttpURLConnection conn = (HttpURLConnection) url.openConnection(); conn.setRequestMethod("POST"); conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); conn.setDoOutput(true); PrintWriter out = new PrintWriter(conn.getOutputStream()); out.println(requestString); out.close(); BufferedReader in = new BufferedReader( new InputStreamReader(conn.getInputStream())); /* server response is available by reading the in object */
Figure 5. The URL class from the java.net package is a convenient way for Java programs to use HTTP and SSL
1.6.2.3 Open Source

The libcurl project is an open source project that includes support for using HTTP and SSL protocols. The fragment in Figure 6 shows how to set up libcurl to send a request using HTTP and SSL. It relies on a callback function to accept the server's response.
CURL *curl; CURLcode res; /* prepare to send the request */ curl = curl_easy_init();
Page 18
Tracking - XML
7/11/2011
curl_easy_setopt(curl, CURLOPT_URL, https://www.server.com/path"); curl_easy_setopt(curl, CURLOPT_POSTFIELDS, requestString); curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, fnCallback);
res = curl_easy_perform(curl);
Figure 6. The open source libcurl library simplifies the use of HTTP and SSL
Page 19
Tracking - XML
7/11/2011
1.6.3 Extensible Markup Language (XML)

The Extensible Markup Language (XML) is an international standard developed by the World Wide Web Consortium, the governing body for web standards and guidelines. XML provides a way to identify the structure of content within a document or, in the case of UPS Developer APIs, a message. Figure 7 shows how a simple XML message could describe a book.
As the figure illustrates, XML is a text-based format. XML messages contain regular text, though that text follows specific rules that XML defines. XML distinguishes different parts of a message with a label known as a tag. Tags in the example include <book>, <title>, <author>, <firstname>, etc. A tag can indicate the start of information if it begins with an angle bracket (<), and a tag can indicate the end of information if it begins with an angle bracket and a slash (</). A beginning tag, ending tag, and the information between the two make up an element. In this example the publisher element tells us that the publisher for the book is "John Wiley and Sons." The figure also shows how an XML message follows a defined structure. Elements can be contained within other elements, as <firstname> and <lastname> are included within the <author> element. This structure indicates that firstname and lastname are "children" of the author "parent."
Page 20
Tracking - XML
7/11/2011
Although XML elements can contain almost any text, there are two special characters that cannot appear within an element. Those characters are the less-than sign (<) and the ampersand (&). Elements that include these contents must replace the special characters with "<" or "&" respectively. The name of a large telecommunications company, for example, would appear as "AT&T" within an XML message. Because XML is a text-based format, software has to take extra steps to use XML with binary data. For example, some UPS services return binary image data such as the image of a shipping label. To include this data in an XML message, UPS converts it from binary to text format using an algorithm known as Base64 encoding. The "The Base16, Base32, and Base64 Data Encodings" standard, also known as RFC 3548, defines that algorithm. Although XML messages consist of a series of text characters, most software development tools represent XML messages in a tree-like data structure. That representation clarifies the structure of the message. Figure 8 shows the same XML message as Figure 7, but it uses a more visual representation to highlight the message's structure.
The example of Figure 7 and Figure 8 is a relatively simple XML message with just a few elements. UPS Developer APIs rely on XML messages that are larger than this simple example, and it is difficult to show them in a pure graph like Figure 8 without losing legibility. Figure 9 shows an alternate way of depicting the tree-like structure of XML messages; it uses the same example as before.
Page 21
Tracking - XML
7/11/2011
A great deal of information on XML is available on the Internet. A good starting point for further research is the World Wide Web Consortiums main page on XML at http://www.w3.org/XML/.
1.6.4 Working with XML in Application Programs

The popularity of Extensible Markup Language means that nearly all development environments include sophisticated support for creating and interpreting XML messages. This subsection provides a brief introduction to working with XML in Microsoft, Java, and Open Source environments. The examples it contains are only representative approaches; many other approaches are possible.

The Microsoft XML Core Services (MSXML) offers one way to work with XML documents in Visual Studio applications. Figure 10 shows one approach for creating an XML message in Visual Basic, and Figure 11 demonstrates how Visual Basic programs can interpret XML responses. To remain as simple as possible, the examples do not include any exception handling. Production software should, of course, provide full exception handling.
Page 22
Tracking - XML
7/11/2011
' Define a variable and initialize it to a new XML message Dim dom Set dom = New DOMDocument30 ' Set properties of the variable dom.async = False dom.validateOnParse = False dom.resolveExternals = False dom.preserveWhiteSpace = True ' Identify the message as XML version 1.0 Set node = dom.createProcessingInstruction("xml", "version='1.0'") dom.appendChild node Set node = Nothing ' Create the root (book) element and add it to the message Dim root Set root = dom.createElement("book") dom.appendChild root ' Create child elements and add them to the root Dim node Set node = dom.createElement("title") node.text = "HTTP Essentials: ..." root.appendChild node Set node = Nothing Set node = dom.createElement("author") Dim child Set child = dom.createElement("firstname") child.text = "Stephen" node.appendChild child Set child = Nothing Set child = dom.createElement("lastname") child.text = "Thomas" node.appendChild child root.appendChild node ' And so on
Figure 10. Visual Basic can create XML messages through the DOMDocument object.
' Define a variable to hold the parsed message Dim dom As New DOMDocument30 dom.async = False dom.validateOnParse = False dom.resolveExternals = False dom.preserveWhiteSpace = True ' Try to parse the message If dom.loadXML(messageText) = False Then ' The text did not contain valid XML End If ' Get the title information from the message Dim node As IXMLDOMNode Set node = dom.selectSingleNode("/title") If node Is Nothing Then ' The message did not contain title information
Page 23
Tracking - XML
7/11/2011
Else ' Do something with node.text End If
Figure 11. Visual Basic can read the contents of XML messages after parsing them with the DOMDocument object.
Visual Basic also has built-in classes to interpret Base64-encoded values. The Convert.FromBase64String() function converts from a Base64-encoded string to an array of 8-bit unsigned integers

The Java API for XML Processing (JAXP) is the preferred approach for working with XML messages in Java. Figure 12 shows how a BookClass object can be converted into an XML message, a process that JAXP calls marshalling. Similarly, Figure 13 shows the reverse process, where an XML message is converted into a BookClass object. This reverse process is unmarshalling. As above, exception handling code is omitted from these examples to make them as clear as possible.
import javax.xml.bind.JAXBContext; import javax.xml.bind.Marshaller; import java.io.StringWriter; /* create the book object */ BookClass book = new BookClass("HTTP Essentials...", new AuthorClass("Stephen", "Thomas"), "John Wiley and Sons", "2001", "0-471-398233"); /* convert it to an XML string */ StringWriter writer = new StringWriter(); JAXBContext context = JAXBContext.newInstance(book.class); Marshaller m = context.createMarshaller(); m.marshal(book, writer);
Figure 12. JAXP provides a convenient way for Java applications to create XML messages from Java objects. import javax.xml.bind.JAXBContext; import javax.xml.bind.Marshaller; import java.io.StringReader; /* xmlMessage contains the XML message */ StringReader reader = new StringReader(xmlMessage); JAXBContext context = JAXBContext.newInstance(Book.class); Unmarshaller u = context.createUnmarshaller(); BookClass book = (BookClass) u.unmarshal(reader); /* access properties of the book */ System.out.println(book.getAuthor().getFirstname())
Figure 13. JAXP also gives Java applications a convenient way to retrieve elements from an XML message
Page 24
Tracking - XML
7/11/2011
1.6.4.3 Open Source

As of this writing, the most popular open source tool for working with XML is the xerces project. That project includes C++, Java, and Perl implementations of an XML library. The xerces distribution includes extensive sample applications. The code fragment in Figure 14 demonstrates creating an XML message in C++ with the xerces library. Figure 15 shows sample code for accessing an element within an XML message. In both cases exception handling is not shown in order to keep the examples as simple as possible. Production software should always contain full exception handling.
DOMImplementation* impl = DOMImplementationRegistry::getDOMImplementation(X("Core")); DOMDocument* doc = impl->createDocument(0, X("book"), 0); DOMElement* rootElem = doc->getDocumentElement(); DOMElement* titleElem = doc->createElement(X("title")); rootElem->appendChild(titleElem); DOMText* titleVal = doc->createTextNode(X("HTTP Essentials...")); titleElem->appendChild(titleVal); Figure 14. The Xerces C++ library includes XMLCh* TAG_book; XMLCh* TAG_title; xercesc::XercesDOMParser *parser; XMLPlatformUtils::Initialize(); TAG_book = XMLString::transcode("book"); TAG_title = XMLString::transcode("title"); parser = new XercesDOMParser; parser->parse(inputText); DOMDocument* xmlDoc = parser->getDocument(); DOMElement* elementRoot = xmlDoc->getDocumentElement(); DOMNodeList* children = elementRoot->getChildNodes(); const XMLSize_t nodeCount = children->getLength(); for (XMLSize_t cnt = 0; cnt < nodeCount; ++cnt ) { DOMNode* currentNode = children->item(cnt); if( currentNode->getNodeType() && currentNode->getNodeType() == DOMNode::ELEMENT_NODE ) { DOMElement* currentElement = dynamic_cast< xercesc::DOMElement* >( currentNode ); if( XMLString::equals(currentElement->getTagName(), TAG_title)) { /* do something with the title */ } } } Figure 15. The Xerces C++ library also supports parsing XML messages to find individual elements.
Page 25
Tracking - XML
7/11/2011
1.7 Understanding XML Tracking Services

The Tracking API gives client applications access to UPS tracking information. With this service, clients query UPS to determine the up-to-the-minute status of a shipment or a package, including its delivery status and the time and location of the latest transit scan.
1.7.1 Identifying a Package or Shipment to Track

Applications can request tracking based on a tracking number, shipment identification number, or reference number. For freight shipments, applications can also use a candidate bookmark.
1.7.1.1 Tracking Numbers

UPS uses tracking numbers to identify and track small 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 small 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 18 months after delivery. UPS makes every effort to ensure that a tracking number uniquely identifies a package for 18 months; 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.
1.7.1.2 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 small packages, or it may be a single freight shipment. For small 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. (UPS makes every effort to ensure that a shipment identification number uniquely identifies a shipment for up to 18 months. 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.)
1.7.1.3 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
Page 26
Tracking - XML
7/11/2011
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: The destination country code. (Note: Reference numbers are available up to 6 months after delivery.)
1.7.1.4 PRO numbers and Air Waybill numbers

UPS uses PRO numbers to identify and trace a Ground Freight shipment as it moves through the UPS system. For freight shipments, a successful query by PRO number returns all of the commodities within a shipment. UPS uses Air Waybill numbers to identify and trace an Air Freight shipment as it moves through the UPS system. For freight shipments, a successful query by Air Waybill number returns all of the commodities within a shipment.
1.7.1.5 Candidate Bookmarks

When an application requests tracking information for a freight shipment using a reference number, it is possible that more than one shipment may match that reference number. In such cases, UPS returns identifying information about each shipment, and it marks each shipment with a unique candidate bookmark. 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.
Page 27
Tracking - XML
7/11/2011
1.8 Tracking Reference

This section documents the details of the XML messages, including the requests that clients send to UPS and the responses that UPS returns. UPS verifies that client applications are authorized to use the tracking tool.
1.8.1 Authenticating Client Applications

UPS Tracking Services are only available for authorized UPS customers. To enforce this policy, UPS requires that every message that a client application sends include important authentication information. That information is contained in an AccessRequest XML document that must begin each message. AccessRequest
AccessRequest AccessLicenseNumber::string UserId::string Password::string
Each AccessRequest contains three child elements: an AccessLicenseNumber, a UserId, and a Password. The following figure shows an example AccessRequest document.
<?xml version="1.0" ?> <AccessRequest xml:lang='en-US'> <AccessLicenseNumber> YOURACCESSLICENSENUMBER </AccessLicenseNumber> <UserId> YOURUSERID </UserId> <Password> YOURPASSWORD </Password> </AccessRequest>
1.8.2 Tracking
Tracking relies on a single request and response. Client applications request tracking information by sending a TrackRequest message to UPS. UPS replies with a TrackResponse message.
Example TrackRequest Message:
Page 28
Tracking - XML
7/11/2011
<?xml version="1.0" ?> <AccessRequest xml:lang='en-US'> <AccessLicenseNumber>YOURACCESSLICENSENUMBER</AccessLic enseNumber> <UserId>YOURUSERID</UserId> <Password>YOURPASSWORD</Password> </AccessRequest> <?xml version="1.0" ?> <TrackRequest> <Request> <TransactionReference> <CustomerContext>guidlikesubstance</CustomerContext> </TransactionReference> <RequestAction>Track</RequestAction> </Request> <TrackingNumber>1Z9999999999999999</TrackingNumber> </TrackRequest>
Example TrackResponse Message:

<?xml version="1.0" ?> <TrackResponse> <Response> <TransactionReference> <CustomerContext>guidlikesubstance</CustomerContext> <XpciVersion>1.0</XpciVersion> </TransactionReference> <ResponseStatusCode>1</ResponseStatusCode> <ResponseStatusDescription>Success</ResponseStatusDescription> </Response> <Shipment> <Shipper> <ShipperNumber>123X67</ShipperNumber> </Shipper> <ShipTo> <Address> <City>Timonium</City> <StateProvinceCode>MD</StateProvinceCode> <CountryCode>US</CountryCode> </Address> </ShipTo> <Service> <Code>03</Code> <Description>Ground</Description> </Service> <Package> <TrackingNumber>1Z9999999999999999</TrackingNumber> <Activity> <ActivityLocation> <Address> <City>Timonium</City>
Page 29
Tracking - XML
7/11/2011
<StateProvinceCode>MD</StateProvinceCode> <CountryCode>US</CountryCode> </Address> <Code>DL</Code> <Description>Delivered</Description> </ActivityLocation> <Status> <StatusType> <Code>XX</Code> <Description>Status XX</Description> </StatusType> <StatusCode> <Code>YY</Code> <Description>Code YY</Description> </StatusCode> </Status> </Activity> </Package> </Shipment> </TrackResponse>
1.8.3 Track Request

The Track Request
The TrackRequest message consists of two complete XML documents. The first document is an AccessRequest. It is immediately followed by (concatenated to) a TrackRequest. When a client application is undergoing testing and integration, the document combination should be sent to the URL: https://wwwcie.ups.com/ups.app/xml/Track The TrackRequest document in the request must conform to the following XML structure. TrackRequest XML Details: Note: The Required Column has four potential values: Yes: Always required No: Always optional Yes*: Conditionally required Cond: Conditional
Page 30
Tracking - XML
7/11/2011
MAXALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
Container
Yes
Yes
Yes
TrackRequest
/TrackRequest
Container for the root Track Request
N/A
Container
*Yes
Yes
Yes
Request
/TrackRequest/Request
Container for the Track Request
N/A
Container
TransactionReference
/TrackRequest/Request/TransactionReference
CustomerContext
/TrackRequest/Request/TransactionReference/ CustomerContext
TransactionReference identifies transactions between client and server. The client uses CustomerContext to synchronize request/response pairs. The client establishes CustomerContext, which can contain any information you want, as along as it is valid XML, it is echoed back by the server.
Yes
Yes
Yes
1..512
String
Yes
Yes
String
TransactionIdentifier
/TrackRequest/Request/TransactionReference/ TransactionIdentifier
Not Used. The Unique TransactionIdentifier for a given transaction.
1..20
Yes
Yes
ToolVersion
/TrackRequest/Request/TransactionReference/ ToolVersion
String
No
No
No
Current Tracking Tool Version.
Page 31
No
Yes
No
Yes
No
Yes
N/A
Yes
N/A
Yes
N/A
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAXALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
1..15
Yes
Yes
Yes
RequestAction
/TrackRequest/Request/RequestAction
Indicates the action to be taken by the XML service.
The only valid action for tracking is 'Track'.
RequestOption
/TrackRequest/Request/RequestOption
TrackingNumber
/TrackRequest/TrackingNumber
Optional processing. For Mail Innovations the only valid options are Last Activity and All activity. The packages tracking number For small 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. For freight Tracking Number will be treated as the Shipment Identification Number regardless of it is supplied in the ShipmentIdentificationNumber element or Tracking Number element.
'none' or '0'= Last Activity 'activity' or '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
String
1..15
Yes
Yes
String
Cond
9..34
Yes
Yes
None
Page 32
Yes
Yes
No
Yes
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAXALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
11..21
String
Cond
Yes
ShipmentIdentificationNum ber
/TrackRequest/ShipmentIdentificationNumber
CandidateBookmark
/TrackRequest/CandidateBookmark
ReferenceNumber
/TrackRequest/ReferenceNumber
The shipments tracking number. During Tracking and Reference Number searches, it is possible that duplicate 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. The reference number container tag. Required if a Shipment 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 The customer assigned reference number. Required if a Shipment Identification Number or Tracking Number is not present.
Yes
String
0..15
Yes
No
No
Container
Yes
Yes
N/A
135
String
Yes
Yes
Value
/TrackRequest/ReferenceNumber/Value
None
Container
PickupDateRange
/TrackRequest/PickupDateRange
Container for pickup date range. For Mail Innovations this optional field for tracking by reference number.
Yes
Yes
None
Page 33
Yes
N/A
No
Yes
No
Yes
N/A
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAXALLOWED
NAME
XPATH
DESCRIPTION The begin pickup date used to narrow a reference number search. For Mail Innovations this optional field for tracking by reference number.
VALIDATION RULES
String
Yes
Yes
BeginDate
/TrackRequest/PickupDateRange/BeginDate
YYYYMMDD
EndDate
/TrackRequest/PickupDateRange/EndDate
The end pickup date used to narrow a reference number search. For Mail Innovations this optional field for tracking by reference number. The UPS account number used to narrow a reference number search. This is not applicable for Mail Innovations. A ZIP Code (United States) or postal code (international destination) also narrows the search. For Mail Innovations this optional field for tracking by reference number to narrow the search. A country code used to narrow a reference number search. For Mail Innovations this optional field for tracking by reference number to narrow the search. Postal Code of the origin country used to narrow the reference number search. For freight Reference tracking Only
String
Yes
Yes
YYYYMMDD
6 or 10
String
Yes
Yes
No
ShipperNumber
/TrackRequest/ShipperNumber
None.
String
DestinationPostalCode
/TrackRequest/DestinationPostalCode
The destination country code is required if the destination postal code is present.
1..16
Yes
Yes
String
Yes
Yes
DestinationCountryCode
/TrackRequest/DestinationCountryCode
None.
String
1..16
Yes
No
No
OriginPostalCode
/TrackRequest/OriginPostalCode
Page 34
No
Yes
2..3
No
Yes
No
No
Yes
No
Yes
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAXALLOWED
NAME
XPATH
DESCRIPTION Country code of the origin country used to narrow the reference number search. For freight Reference tracking Only Container for the type of Shipment when doing a Reference Number search. If this container is not present, tracking defaults to small package. This is a mandatory field for reference number tracking for Mail Innovations This element will be used to indicate the type of the shipment being tracked during a Reference tracking. 01 Small Package 02 - Freight. 03 - Mail Innovations When no value is supplied this element defaults to 01 Description of the type of the shipment being tracked during Reference tracking. 01 Small Package 02 - Freight 03 - Mail Innovations TrackingOption applies to Mail Innovations only. For Mail Innovations track by number, this is a mandatory field which has to be set to '03'. If only tracking number is provided without trackingoption then it will be treated as small package tracking
VALIDATION RULES
String
Yes
2..3
No
No
OriginCountryCode
/TrackRequest/OriginCountryCode
Container
Cond
Yes
Yes
ShipmentType
/TrackRequest/ShipmentType
String
*Yes
Yes
Yes
Code
/TrackRequest/ShipmentType/Code
Default value - 01
String
0..15
Yes
Yes
Description
/TrackRequest/ShipmentType/Description
String
Cond
TrackingOption
/TrackRequest/TrackingOption
Page 35
Yes
No
No
Yes
No
Yes
Yes
N/A
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAXALLOWED
NAME
XPATH
IncludeFreight
/TrackRequest/IncludeFreight
DESCRIPTION Flag to indicate whether to include Freight while searching for the information. The valid values for this flag are:- 02 Small package Only 01- Small Package and Freight.
VALIDATION RULES
Defaults to small package only. Only when this flag is set to 01, Freight is included in the search. For all other values, the search defaults to Small Package only.
String
Yes
Yes
No
Page 36
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
1.8.4 Track Response

The Track Response The TrackResponse message contains a single XML document that conforms to the following XML structure. TrackResponse XML Details: Note: The Required Column has four potential values: Yes: Always required No: Always optional Yes*: Conditionally required Cond: Conditional
Page 37
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
Container
Yes
Yes
Yes
TrackResponse
/TrackResponse
Container for root Track response
Container
*Yes
Yes
Yes
Response
/TrackResponse/Response
Container for Track Response
Container
Yes
Yes
TransactionReference
/TrackResponse/Response/TransactionReference
CustomerContext
/TrackResponse/Response/TransactionReference /CustomerContext
TransactionReference identifies transactions between client and server. The client uses CustomerContext to synchronize request/response pairs. The client establishes CustomerContext, which can contain any information you want, as along as it is valid XML; it is echoed back by the server.
1..512
String
Yes
Yes
String
TransactionIdentifier
/TrackResponse/Response/TransactionReference /TransactionIdentifier
Not Used. The Unique TransactionIdentifier for a given transaction.
1..20
Yes
Yes
XpciVersion
/TrackResponse/Response/TransactionReference /XpciVersion
String
No
No
No
Message version. Defaults to 1.0001.
Page 38
No
Yes
No
Yes
No
Yes
N/A
No
Yes
N/A
Yes
N/A
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
ResponseStatusCode
/TrackResponse/Response/ResponseStatusCode
Identifies the success or failure of the transaction. 1 = Successful 0 = Failure
Yes
Yes
Yes
135
String
Yes
Yes
Yes
ResponseStatusDescription
/TrackResponse/Response/ResponseStatusDesc ription
Describes Response Status Code. Returns text of 'Success' or 'Failure' If an error is encountered during the interchange, the Response contains an error. If the error is present, then the ErrorSeverity and ErrorCode are required. Describes the severity of the error. TransientError - Customers data has not been processed due to system unavailability. The customer has to wait and try again. HardError - The error was encountered processing the customers data and that the data needs correction. Warning - The customers data was successfully processed; however, there were warnings encountered during processing.
Container
Cond
Yes
Yes
Error
/TrackResponse/Response/Error
String
1..15
*Yes
Yes
Yes
ErrorSeverity
/TrackResponse/Response/Error/ErrorSeverity
String
ErrorCode
/TrackResponse/Response/Error/ErrorCode
A numeric value that describes the error. Each tool defines a range of error codes.
1..15
*Yes
Yes
Yes
String
1..50
Yes
Yes
ErrorDescription
/TrackResponse/Response/Error/ErrorDescription
Describes the error code.
Page 39
Yes
No
Yes
Yes
Yes
Yes
Yes
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION Number of seconds to wait until retry. This field is populated on special conditions of the Transient Error only, as defined by the service. A number between 1 and 86400 (24 hours)
VALIDATION RULES
String
Yes
Yes
MinimumRetrySeconds
/TrackResponse/Response/Error/MinimumRetryS econds
Container
Many
Yes
Yes
ErrorLocation
/TrackResponse/Response/Error/ErrorLocation
Identifies the element in error.
1..512
String
ErrorLocationElementName
/TrackResponse/Response/Error/ErrorLocation/Er rorLocationElementName
The XPATH name of the element in error. This is a valid XPATH pointing to an element in the request document.
Yes
Yes
String
ErrorLocationAttributeName
/TrackResponse/Response/Error/ErrorLocation/Er rorLocationAttributeName
The name of the attribute in error. This is the name of the attribute contained by the Error Location Element.
1..50
Yes
Yes
String the Request data.
Many
Yes
Yes
ErrorDigest
/TrackResponse/Response/Error/ErrorDigest
The contents of the element in error.
Container
Many
Yes
Yes
Yes
Shipment
/TrackResponse/Shipment
Shipment Container tag.
Container
Yes
Yes
InquiryNumber
/TrackResponse/Shipment/InquiryNumber
Shipment Inquiry Number Container Page 40
Yes
N/A
No
Yes
N/A
Yes
No
Yes
No
Yes
No
Yes
N/A
No
Yes
1..5
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
Code
/TrackResponse/Shipment/InquiryNumber/Code
Description
/TrackResponse/Shipment/InquiryNumber/Descri ption
DESCRIPTION Code to indicate the type of Inquiry Number The codes returned for Freight HAWB - House Airway Bill HBL House Bill of Lading PRO PRO Number SUBPRO Sub-PRO Number DO Delivery Order For Mail Innovations this returns : '03'- Mail Innovation tracking number. Description of the Inquiry Number as indicated by code Description of the codes HAWB - House Airway Bill HBL - House Bill of Lading PRO PRO Number SUBPRO Sub-PRO Number DO Delivery Order For Mail Innovations this returns : '03'- Mail Innovation tracking number.
VALIDATION RULES
String
*Yes
Yes
String
1..35
*Yes
Yes
String
1..34
*Yes
Yes
Value
/TrackResponse/Shipment/InquiryNumber/Value
Value of the Inquiry Number
ShipmentIdentificationNum ber
/TrackResponse/Shipment/ShipmentIdentification Number
Shipment number to which the package belongs. This element is not returned for track requests by Reference Number.
String
1..21
Yes
No
No
Container
ShipmentType
/TrackResponse/Shipment/ShipmentType
Container for the type of Shipment when doing a Reference Number search.
Cond
Yes
Yes
Page 41
Yes
N/A
No
Yes
No
Yes
No
Yes
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
Code
/TrackResponse/Shipment/ShipmentType/Code
Description
/TrackResponse/Shipment/ShipmentType/Descrip tion
CandidateBookmark
/TrackResponse/Shipment/CandidateBookmark
DESCRIPTION This element will be used to indicate the type of the shipment being tracked during a Reference tracking. 01 Small Package 02 - Freight. 03 - Mail Innovations. During reference number tracking, the value of this element should be 01 in order to be small package. 02 will be returned for a Freight reference tracking. 03 will be returned for a Mail Innovations reference tracking Description of the type of the shipment being tracked during Reference tracking. 01 - Small Package 02 Freight 03 - Mail Innovations. For small package the description will be Small Package For Freight the description will be Freight For Mail Innovations the description will be Mail Innovations During Tracking and Reference Number searches, it is possible that duplicate 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.
VALIDATION RULES
String
*Yes
Yes
Yes
String
0..15
Yes
Yes
String
0..15
Yes
No
No
Container
Yes
Yes
Shipper
/TrackResponse/Shipment/Shipper
Shipper Container Tag
Page 42
Yes
N/A
No
No
Yes
No
Yes
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
6..10
Yes
Yes
ShipperNumber
/TrackResponse/Shipment/Shipper/ShipperNumb er
Shippers six or ten digit account number.
Container
Address
/TrackResponse/Shipment/Shipper/Address
Shippers address Container tag. The shipper address is optional for Mail Innovations and may not be present always.
01
Yes
Yes
String
1..35
Yes
AddressLine1
/TrackResponse/Shipment/Shipper/Address/Addr essLine1
Yes
No
Shippers address line 1.
String
1..35
Yes
AddressLine2
Yes
No
String
1..35
Yes
AddressLine3
Yes
No
String
1..30
Yes
Yes
City
/TrackResponse/Shipment/Shipper/Address/City
Shippers city. This is optional for Mail Innovations.
String
StateProvinceCode
/TrackResponse/Shipment/Shipper/Address/State ProvinceCode
Shippers state or province code. Required for US or Canada. This is optional for Mail Innovations Page 43
Yes
Yes
Yes
2..5
No
Yes
No
No
No
No
Yes
No
Yes
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
516
String
Yes
Yes
PostalCode
/TrackResponse/Shipment/Shipper/Address/Post alCode
Shippers postal code.
String
23
Yes
Yes
CountryCode
/TrackResponse/Shipment/Shipper/Address/Coun tryCode
Shippers country code.
Container
Yes
Yes
ShipTo
/TrackResponse/Shipment/ShipTo
Consignees ship to Container tag.
Container
Yes
Yes
Address
/TrackResponse/Shipment/ShipTo/Address
Consignees address Container tag.
String
1..35
Yes
AddressLine1
/TrackResponse/Shipment/ShipTo/Address/Addre ssLine1
Yes
No
Consignees address line 1.
String
1..35
Yes
AddressLine2
Yes
No
Consignees address line 2.
String
1..35
Yes
AddressLine3
Yes
No
Consignees address line 3. Page 44
No
No
No
Yes
N/A
No
Yes
N/A
No
Yes
No
Yes
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
1..30
Yes
Yes
City
/TrackResponse/Shipment/ShipTo/Address/City
Consignees city. This is optional for Mail Innovations.
String
StateProvinceCode
/TrackResponse/Shipment/ShipTo/Address/State ProvinceCode
Consignees state or province code. Required for US or Canada. This is optional for Mail Innovations.
Yes
Yes
516
String
Yes
Yes
PostalCode
/TrackResponse/Shipment/ShipTo/Address/Postal Code
Consignees postal code. This will be present for Mail Innovations.
String
23
Yes
Yes
CountryCode
/TrackResponse/Shipment/ShipTo/Address/Count ryCode
Consignees country code. This will be present for Mail Innovations.
Container
Yes
Yes
ShipmentWeight
/TrackResponse/Shipment/ShipmentWeight
Shipment weight Container tag
Container
Yes
Yes
UnitOfMeasurement
/TrackResponse/Shipment/ShipmentWeight/UnitO fMeasurement
Shipment weight unit of measurement Container tag.
String
*Yes
Yes
Yes
Code
/TrackResponse/Shipment/ShipmentWeight/UnitO fMeasurement/Code
Shipment weight unit of measurement code. Defaults to LBS. Page 45
Yes
Yes
N/A
No
Yes
N/A
No
Yes
No
Yes
No
Yes
2..5
No
Yes
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
Description
/TrackResponse/Shipment/ShipmentWeight/UnitO fMeasurement/Description
String
No
String
Yes
Yes
Weight
/TrackResponse/Shipment/ShipmentWeight/Weig ht
Shipments total weight. Set to 0 for shipment with package type of letter.
Container
*Yes
Yes
Yes
Service
/TrackResponse/Shipment/Service
Code
/TrackResponse/Shipment/Service/Code
Container tag for UPS service associated with the shipment. For small package Values are: 01 = Next Day Air 02 = 2nd Day Air 03 = Ground 07 = International Express 08 = International Expedited 11 = International Standard 12 = 3 Day Select 13 = Next Day Air Saver 14 = Next Day Air Early AM; 31 = Basic; 54 = International Express Plus 59 = 2 Day Air A.M. 60 = UPS Select 65 = UPS Saver 82 = UPS Today Standard 83 = UPS Today Dedicated Courier 84 = UPS Today Intercity 85 = UPS Today Express 86 = UPS Today Express Saver. 92 = LWS Standard Parcel; 93 = LWS Parcel Select; 94 = LWS Bound Printed Matter; 95 = LWS Media Mail. For Freight Values returned are: TDCB Trade Direct Cross Border TDA Trade Direct Air TDO Trade Direct Ocean 308 UPS Freight LTL 309 UPS Freight LTL Guaranteed 310 UPS Freight LTL Urgent For Mail Innovations value is : '701' - UPS Mail Innovations
String
*Yes
Yes
Yes
Page 46
Yes
Yes
N/A
Yes
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
Description
/TrackResponse/Shipment/Service/Description
DESCRIPTION Description of the service. For small package Values are: 01 = Next Day Air 02 = 2nd Day Air 03 = Ground 07 = International Express 08 = International Expedited 11 = International Standard 12 = 3 Day Select 13 = Next Day Air Saver 14 = Next Day Air Early AM 31 = Basic; 54 = International Express Plus 59 = 2 Day Air A.M. 60 = UPSSelect 65 = UPS Saver 82 = UPS Today Standard 83 = UPS Today Dedicated Courier 84 = UPS Today Intercity 85 = UPS Today Express 86 = UPS Today Express Saver. 92 = LWS Standard Parcel; 93 = LWS Parcel Select; 94 = LWS Bound Printed Matter; 95 = LWS Media Mail. For Freight Values returned are: TDCB Trade Direct Cross Border TDA Trade Direct Air TDO Trade Direct Ocean 308 UPS Freight LTL 309 UPS Freight LTL Guaranteed 310 UPS Freight LTL Urgent For Mail Innovations value is : '701' - UPS Mail Innovations
VALIDATION RULES
String
1..35
Yes
Yes
Container
Yes
Yes
ReferenceNumber
/TrackResponse/Shipment/ReferenceNumber
Shipment reference number Container tag.
Page 47
Yes
N/A
No
Yes
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
Code
/TrackResponse/Shipment/ReferenceNumber/Co de
DESCRIPTION Reference number type code, for signifying PO #s, Invoice #s, etc, for the entire shipment. For small package the codes returned are:- 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 59 -Invoice Number 60 -Manifest Key Number 61- Dealer Order Number 62 -Production Code 63 Purchase Req. Number 64 Salesperson Number 67 Transaction Ref. No. RZ -RMA 9V- COD Number For freight this can be BL or PO For Mail Innovations values are : '91' - 'USPS PIC' '93' 'USPS 30 char Concatenated barcode number' '94' - 'MailManifest System Number (MMS)' '95' - 'Mail Manifest ID (MMI)' '96' - 'Mail Innovations reference number (customer package id - (PID))'
VALIDATION RULES
String
Yes
Yes
Description
/TrackResponse/Shipment/ReferenceNumber/De scription
String
String
No
1..35
*Yes
Yes
Yes
Value
/TrackResponse/Shipment/ReferenceNumber/Val ue
Customer supplied reference number.
Container
Cond
CurrentStatus
/TrackResponse/Shipment/CurrentStatus
Container for the current status of the shipment. Page 48
Yes
N/A
No
No
Yes
Yes
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
Code
/TrackResponse/Shipment/CurrentStatus/Code
Description
/TrackResponse/Shipment/CurrentStatus/Descript ion
DESCRIPTION Code for the current status of the shipment. For Freight only: The values are:- 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 Description for the current status of the shipment. The values are:- 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
VALIDATION RULES
String
*Yes
Yes
No
String
1..35
*Yes
Yes
No
String
Yes
Yes
PickupDate
/TrackResponse/Shipment/PickupDate
Date shipment was picked-up. YYYYMMDD
Container
Yes
N/A
No
No
DeliveryDetails
/TrackResponse/Shipment/DeliveryDetails
Container for Delivery Details.
Container
DeliveryDate
/TrackResponse/Shipment/DeliveryDetails/Deliver yDate
Yes
N/A
No
No
Container for Delivery Date and Time
String
Yes
Date
/TrackResponse/Shipment/DeliveryDetails/Deliver yDate/Date
Date shipment was delivered. YYYYMMDD
Yes
No
Page 49
No
No
No
Yes
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
Time
/TrackResponse/Shipment/DeliveryDetails/Deliver yDate/Time
Time shipment was delivered. HHMMSS
Yes
No
No
Container
ServiceCenter
/TrackResponse/Shipment/DeliveryDetails/Servic eCenter
Container for the Delivery Service Center
Yes
N/A
No
No
String
1..30
*Yes
City
/TrackResponse/Shipment/DeliveryDetails/Servic eCenter/City
Yes
No
Delivery Service center city
String
*Yes
StateProvinceCode
/TrackResponse/Shipment/DeliveryDetails/Servic eCenter/StateProvinceCode
Yes
2..6
No
Delivery Service Center State
unbounded
Container
Cond
DeliveryDateTime
/TrackResponse/Shipment/DeliveryDateTime
Delivery detail info for Mail Innovations shipment only
Container
Yes
Type
/TrackResponse/Shipment/DeliveryDateTime/Typ e
Type of delivery detail.
String
Yes
Code
/TrackResponse/Shipment/DeliveryDateTime/Typ e/Code
Code of delivery detail. '01' - Delivery; '02'- Estimated Delivery; Page 50
Yes
No
No
Yes
N/A
No
No
Yes
N/A
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
1..35
Description
/TrackResponse/Shipment/DeliveryDateTime/Typ e/Description
Description of above code. '01' Delivery; '02'- Estimated Delivery;
String
Yes
Date
/TrackResponse/Shipment/DeliveryDateTime/Dat e
Date for the specific delivery type. Format is YYYYMMDD 6
String
Time
/TrackResponse/Shipment/DeliveryDateTime/Tim e
Future use
Container
Volume
/TrackResponse/Shipment/Volume
Container for the volume of the Shipment.
Yes
N/A
No
No
String
Code
/TrackResponse/Shipment/Volume/Code
Code indicating the unit of measurement for the volume
Yes
No
No
String
Description
/TrackResponse/Shipment/Volume/Description
Description of the unit of measurement as indicated by code
Yes
No
No
String
1..35
*Yes
Value
/TrackResponse/Shipment/Volume/Value
Value of the total volume of the shipment. Page 51
Yes
No
No
No
No
No
Yes
No
No
No
Yes
No
No
Yes
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
1..35
BillToName
/TrackResponse/Shipment/BillToName
Name of the person to whom the shipment is billed to.
Yes
No
No
Container
PickUpServiceCenter
/TrackResponse/Shipment/PickUpServiceCenter
Container for the pickup service center.
Yes
N/A
No
No
String
1..30
*Yes
City
/TrackResponse/Shipment/PickUpServiceCenter/ City
Yes
No
City of the pickup service center.
String
*Yes
StateProvinceCode
/TrackResponse/Shipment/PickUpServiceCenter/ StateProvinceCode
Yes
2..5
No
State of the pickup service center.
String
1..15
Yes
No
No
NumberOfPieces
/TrackResponse/Shipment/NumberOfPieces
Number of pieces in the shipment.
String
1..15
Yes
No
No
NumberOfPallets
/TrackResponse/Shipment/NumberOfPallets
Number of pallets in the shipment.
Container
ShipmentServiceOptions
/TrackResponse/Shipment/ShipmentServiceOptio ns
Container for Shipment Service Options. Currently contains COD only. Page 52
Yes
N/A
No
No
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
Container
COD
/TrackResponse/Shipment/ShipmentServiceOptio ns/COD
Yes
N/A
No
No
Container for COD for the shipment
Container
CODAmount
/TrackResponse/Shipment/ShipmentServiceOptio ns/COD/CODAmount
Yes
N/A
No
No
Container for COD amount
String
*Yes
CurrencyCode
/TrackResponse/Shipment/ShipmentServiceOptio ns/COD/CODAmount/CurrencyCode
Currency Code for COD. Default value is USD
Yes
No
String
1..30
*Yes
MonetaryValue
/TrackResponse/Shipment/ShipmentServiceOptio ns/COD/CODAmount/MonetaryValue
Yes
No
Currency Value for COD
Container
EstimatedDeliveryDetails
/TrackResponse/Shipment/EstimatedDeliveryDeta ils
Container for estimated delivery details.
Yes
N/A
No
No
String
Date
/TrackResponse/Shipment/EstimatedDeliveryDeta ils/Date
Estimated delivery date of the shipment YYYYMMDD
Yes
No
No
Container
ServiceCenter
/TrackResponse/Shipment/EstimatedDeliveryDeta ils/ServiceCenter
Container for estimated delivery service center Page 53
Yes
N/A
No
No
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
1..30
*Yes
City
/TrackResponse/Shipment/EstimatedDeliveryDeta ils/ServiceCenter/City
Yes
No
Estimated delivery service center city
String
*Yes
StateProvinceCode
/TrackResponse/Shipment/EstimatedDeliveryDeta ils/ServiceCenter/StateProvinceCode
Yes
2..8
No
Estimated delivery service center state
String
1..35
Yes
No
No
SignedForByName
/TrackResponse/Shipment/SignedForByName
Shipment signed for by name.
Container
Many
Yes
N/A
No
No
Activity
/TrackResponse/Shipment/Activity
Container for shipment activity.
Container
Many
ActivityLocation
/TrackResponse/Shipment/Activity/ActivityLocatio n
Yes
N/A
No
No
Container for shipment activity location
Container
Many
Address
/TrackResponse/Shipment/Activity/ActivityLocatio n/Address
Container for the address of the shipment activity location
Yes
N/A
No
No
String
1..30
City
/TrackResponse/Shipment/Activity/ActivityLocatio n/Address/City
Yes
No
No
Activity city. Page 54
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
StateProvinceCode
/TrackResponse/Shipment/Activity/ActivityLocatio n/Address/StateProvinceCode
Yes
2..5
No
No
Activity State.
516
String
PostalCode
/TrackResponse/Shipment/Activity/ActivityLocatio n/Address/PostalCode
Yes
No
No
Activity postal code
String
23
CountryCode
/TrackResponse/Shipment/Activity/ActivityLocatio n/Address/CountryCode
Yes
No
No
Activity country code.
1..512
String
Yes
No
No
Description
/TrackResponse/Shipment/Activity/Description
Description of the Activity
String
Yes
No
No
Date
/TrackResponse/Shipment/Activity/Date
Activity Date. YYYYMMDD 6
String
Yes
No
No
Time
/TrackResponse/Shipment/Activity/Time
Activity Time. HHMMSS
String
1..30
Yes
No
No
Trailer
/TrackResponse/Shipment/Activity/Trailer
Trailer Code for the shipment Page 55
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
Container
Yes
N/A
No
No
OriginPortDetails
/TrackResponse/Shipment/OriginPortDetails
Details of origin port of the shipment.
String
1..35
OriginPort
/TrackResponse/Shipment/OriginPortDetails/Origi nPort
Yes
No
No
Origin Port of the shipment
Container
EstimatedDeparture
/TrackResponse/Shipment/OriginPortDetails/Esti matedDeparture
Container for Estimated Departure Time Stamp at the origin port
Yes
N/A
No
No
String
Date
/TrackResponse/Shipment/OriginPortDetails/Esti matedDeparture/Date
Date of the Estimated Departure Time Stamp at the origin port. YYYYMMDD format 6
*Yes
Yes
No
String
Time
/TrackResponse/Shipment/OriginPortDetails/Esti matedDeparture/Time
Time of the Estimated Departure Time Stamp at the origin port. HHMMSS format
Yes
No
No
Container
DestinationPortDetails
/TrackResponse/Shipment/DestinationPortDetails
Container for the destination port of the shipment.
Yes
N/A
No
No
String
1..35
DestinationPort
/TrackResponse/Shipment/DestinationPortDetails/ DestinationPort
Yes
No
No
Destination port of the shipment Page 56
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
Container
EstimatedArrival
/TrackResponse/Shipment/DestinationPortDetails/ EstimatedArrival
Container for Estimated Arrival Time Stamp at the Destination Port
Yes
N/A
No
No
String
Date
/TrackResponse/Shipment/DestinationPortDetails/ EstimatedArrival/Date
Date of the Estimated Arrival Time Stamp at the Destination Port. YYYYMMDD format 6
*Yes
Yes
No
String
Time
/TrackResponse/Shipment/DestinationPortDetails/ EstimatedArrival/Time
Time of the Estimated Arrival Time Stamp at the Destination Port. HHMMSS format
Yes
No
No
1..512
String
Yes
No
No
DescriptionOfGoods
/TrackResponse/Shipment/DescriptionOfGoods
Description of Goods in the shipment.
Container
CargoReady
/TrackResponse/Shipment/CargoReady
Container for cargo ready date and time.
Yes
No
N/A
No
String
*Yes
Date
/TrackResponse/Shipment/CargoReady/Date
Cargo Ready date for the shipment. YYYYMMDD 6
Yes
No
String
Time
/TrackResponse/Shipment/CargoReady/Time
Cargo Ready time for the shipment. HHMMSS Page 57
Yes
No
No
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
Container
Yes
N/A
No
No
Manifest
/TrackResponse/Shipment/Manifest
Container for Manifest date and time.
String
*Yes
Date
/TrackResponse/Shipment/Manifest/Date
Manifest date for the shipment. YYYYMMDD. 6
Yes
No
String
Time
/TrackResponse/Shipment/Manifest/Time
Manifest time for the shipment. HHMMSS
Yes
No
No
Container
Many
CarrierActivityInformation
/TrackResponse/Shipment/CarrierActivityInformati on
Container for carrier activity information for the shipment.
Yes
N/A
No
No
String
1..30
CarrierId
/TrackResponse/Shipment/CarrierActivityInformati on/CarrierId
Yes
No
No
Id number of the carrier
String
1..35
Description
/TrackResponse/Shipment/CarrierActivityInformati on/Description
Description of the carrier e.g.: flight/vessel
Yes
No
No
String
1..35
Status
/TrackResponse/Shipment/CarrierActivityInformati on/Status
Yes
No
No
Status of the carrier Page 58
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
Container
Arrival
/TrackResponse/Shipment/CarrierActivityInformati on/Arrival
Container for arrival time stamp information of the carrier
Yes
N/A
No
No
String
*Yes
Date
/TrackResponse/Shipment/CarrierActivityInformati on/Arrival/Date
Date of the arrival time stamp. YYYYMMDD format 6
Yes
No
String
Time
/TrackResponse/Shipment/CarrierActivityInformati on/Arrival/Time
Time of the arrival time stamp. HHMMSS
Yes
No
No
Container
Departure
/TrackResponse/Shipment/CarrierActivityInformati on/Departure
Container for Departure time stamp information of the carrier
Yes
N/A
No
No
String
*Yes
Date
/TrackResponse/Shipment/CarrierActivityInformati on/Departure/Date
Date of the Departure time stamp. YYYYMMDD format 6
Yes
No
String
Time
/TrackResponse/Shipment/CarrierActivityInformati on/Departure/Time
Time of the Departure time stamp. HHMMSS
Yes
No
No
String
1..30
OriginPort
/TrackResponse/Shipment/CarrierActivityInformati on/OriginPort
Origin Port of the Carriers leg of the journey Page 59
Yes
No
No
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
1..30
DestinationPort
/TrackResponse/Shipment/CarrierActivityInformati on/DestinationPort
Destination Port of the Carriers leg of the journey
Yes
No
No
String
ScheduledDeliveryDate
/TrackResponse/Shipment/ScheduledDeliveryDat e
Date shipment was originally scheduled for delivery. Will be returned when available. YYYYMMDD. 6
Yes
Yes
No
String
Yes
ScheduledDeliveryTime
/TrackResponse/Shipment/ScheduledDeliveryTim e
Yes
No
HHMMSS.
String
1..30
Yes
No
No
FileNumber
/TrackResponse/Shipment/FileNumber
File Number of the shipment.
Container
Yes
N/A
No
No
Appointment
/TrackResponse/Shipment/Appointment
Appointment Details.
Container
Made
/TrackResponse/Shipment/Appointment/Made
Container for Appointment Made Date and Time
Yes
N/A
No
No
String
Date
/TrackResponse/Shipment/Appointment/Made/Da te
Yes
No
No
Appointment Made Date YYYYMMDD Page 60
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
Time
/TrackResponse/Shipment/Appointment/Made/Ti me
Yes
No
No
Appointment Made Time HHMMSS
Container
Requested
/TrackResponse/Shipment/Appointment/Requeste d
Container for Appointment Requested Date and Time
Yes
N/A
No
No
String
Date
/TrackResponse/Shipment/Appointment/Requeste d/Date
Appointment Requested Date YYYYMMDD 6
Yes
No
No
String
Time
/TrackResponse/Shipment/Appointment/Requeste d/Time
Appointment Requested Time HHMMSS 6
Yes
No
No
String
BeginTime
/TrackResponse/Shipment/Appointment/BeginTim e
Yes
No
No
Appointment Begin Time HHMMSS 6
String
Yes
No
No
EndTime
/TrackResponse/Shipment/Appointment/EndTime
Appointment End Time HHMMSS
Container
Yes
Package
/TrackResponse/Shipment/Package
Package Information. Page 61
Yes
N/A
No
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
134
String
Yes
TrackingNumber
/TrackResponse/Shipment/Package/TrackingNum ber
TrackingNumber of the package.
String
RescheduledDeliveryDate
/TrackResponse/Shipment/Package/Rescheduled DeliveryDate
The delivery is rescheduled to this date. 6
Yes
No
No
String
RescheduledDeliveryTime
/TrackResponse/Shipment/Package/Rescheduled DeliveryTime
Reroute
/TrackResponse/Shipment/Package/Reroute
The delivery is rescheduled to this time. When a requestor to intercept US50/PR package at the destination center at any time before it has been delivered, Consignees Reroute Container Tag is provided in the track response. .
Yes
No
No
Container
Yes
N/A
No
No
Container
Address
/TrackResponse/Shipment/Package/Reroute/Addr ess
Consignees Reroute Address Container Tag.
Yes
N/A
No
No
String
1..30
AddressLine1
/TrackResponse/Shipment/Package/Reroute/Addr ess/AddressLine1
Address line element of Reroute address
Yes
No
No
String
1..30
AddressLine2
Address line element of Reroute address Page 62
Yes
No
No
No
No
No
No
No
No
Yes
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
1..30
AddressLine3
Address line element of Reroute address
Yes
No
No
String
1..30
City
/TrackResponse/Shipment/Package/Reroute/Addr ess/City
Yes
No
No
Consignees City.
String
StateProvinceCode
/TrackResponse/Shipment/Package/Reroute/Addr ess/StateProvinceCode
Yes
2..5
No
No
Consignees State Or Province Code.
516
String
PostalCode
/TrackResponse/Shipment/Package/Reroute/Addr ess/PostalCode
Yes
No
No
Consignees Postal Code
String
23
CountryCode
/TrackResponse/Shipment/Package/Reroute/Addr ess/CountryCode
Yes
No
No
Consignees Country Code.
Container
ReturnTo
/TrackResponse/Shipment/Package/ReturnTo
Return to Container tag that will contain the address information of who the package is returned to.
Yes
N/A
No
No
Container
Address
/TrackResponse/Shipment/Package/ReturnTo/Ad dress
Return to sender address Container tag. Page 63
Yes
N/A
No
No
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
AddressLine1
/TrackResponse/Shipment/Package/ReturnTo/Ad dress/AddressLine1
Return to AddressLine1. It contains StreetPrefix, StreetName, StreetTypeCode
0..35
Yes
No
No
String
AddressLine2
Return to AddressLine2. It contains building floor, room, suite or PO Box No. .
0..35
Yes
No
No
String
0..35
AddressLine3
Yes
No
No
Return to AddressLine3
String
0..30
City
/TrackResponse/Shipment/Package/ReturnTo/Ad dress/City
Yes
No
No
Return to address city.
String
StateProvinceCode
/TrackResponse/Shipment/Package/ReturnTo/Ad dress/StateProvinceCode
Yes
0..5
No
No
Return to state or province code.
016
String
PostalCode
/TrackResponse/Shipment/Package/ReturnTo/Ad dress/PostalCode
Yes
No
No
Return to postal code
String
03
CountryCode
/TrackResponse/Shipment/Package/ReturnTo/Ad dress/CountryCode
Yes
No
No
Return to country code. Page 64
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
Container
PackageServiceOptions
/TrackResponse/Shipment/Package/PackageServ iceOptions
Yes
N/A
No
No
Container for package service options.
Container
SignatureRequired
/TrackResponse/Shipment/Package/PackageServ iceOptions/SignatureRequired
Code
/TrackResponse/Shipment/Package/PackageServ iceOptions/SignatureRequired/Code
Container tag for SignatureRequired option. Client Application receives Special Instructions via the package detail response indicating Signature Required or Adult Signature Required when a package is delivered. Valid Values: A=Adult Signature Required S=Signature Required
Yes
N/A
No
No
String
*Yes
Yes
No
String
1..35
*Yes
Description
/TrackResponse/Shipment/Package/PackageServ iceOptions/SignatureRequired/Description
ImportControl
/TrackResponse/Shipment/Package/PackageServ iceOptions/ImportControl
Description of the Signature Required. (Currently not populated). Import Control Indication is used to designate that the shipment is an Import Control shipment. If the shipment is an import control shipment then this element will have value Y. For non import shipment this indicator will not appear.
String
No
Page 65
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
CommercialInvoiceRemoval
/TrackResponse/Shipment/Package/PackageServ iceOptions/CommercialInvoiceRemoval
UPScarbonneutral
/TrackResponse/Shipment/Package/PackageServ iceOptions/UPScarbonneutral
DESCRIPTION Commercial Invoice Removal (CIR) is an accessorial or indication that will allow a shipper to dictate that UPS remove the Commercial Invoice from the user's shipment before the shipment is delivered to the ultimate consignee. When RequestOption value is 0-1 this element will have value R and for RequestOption 2-15 this element will have value R S indicating the status of the CIR. R stands for CIR requested. S stands for CIR removal successful. Carbon Neutral is a term used to reflect a generic term for the tagging to be included on any document, label, email, 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 wont appear.
VALIDATION RULES
String
No
String
No
USPSPICNumber
/TrackResponse/Shipment/Package/PackageServ iceOptions/USPSPICNumber
ExchangeBased
/TrackResponse/Shipment/Package/PackageServ iceOptions/ExchangeBased
USPSPICNumber is a USPS Package Identification code which is returned at package service options level for UPS Returns Flexible Access Shipments. UPS Returns Exchange is a roundtrip transportation offering designed to improve the exchange of merchandise between a shipper and receiver. If the shipment has a Return Exchange accessorial is applied to it the value returned will be R Exchange requested or S Exchange completed. If the shipment does not have a Return Exchange accessorial attached to it this element won't appear.
Variable
String
Cond
String
No
Page 66
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
PackAndCollect
/TrackResponse/Shipment/Package/PackageServ iceOptions/PackAndCollect
DESCRIPTION Pack and Collect is a contractual returns solution designed for the retrieval of high-value products from the original receiver for return to the shipper or to an alternate location. This element will appear only when shipment has a pack and collect (CAR) accessorial applied to it with value Y. For non pack and collect shipments this element wont appear.
VALIDATION RULES
String
No
Container
Many
Yes
Activity
/TrackResponse/Shipment/Package/Activity
Activity information
unbounded
Container
Cond
AlternateTrackingInfo
/TrackResponse/Shipment/Package/Activity/Alter nateTrackingInfo
Alternate tracking number. This is applicable only for Mail Innovations Valid values for this are - 'P' - Package ID, 'M' -Mail Manifest ID (type of Sequence number), 'S'- MMS number(type of Sequence number), 'T'Postal service Tracking ID
String
Yes
Type
/TrackResponse/Shipment/Package/Activity/Alter nateTrackingInfo/Type
String
Description
/TrackResponse/Shipment/Package/Activity/Alter nateTrackingInfo/Description
Future use
String
1..34
Yes
Value
/TrackResponse/Shipment/Package/Activity/Alter nateTrackingInfo/Value
This contains value of the alternate tracking number.
Page 67
Yes
No
No
Yes
N/A
No
No
No
Yes
No
No
Yes
N/A
No
No
Yes
N/A
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
Container
Yes
ActivityLocation
/TrackResponse/Shipment/Package/Activity/Activi tyLocation
Location of activity.
Container
Yes
Address
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/Address
Address information
130
String
AddressLine1
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/Address/AddressLine1
AddressLine1 contains street prefix, street name, street type.
Yes
No
No
130
String
AddressLine2
AddressLine2 contains building floor, room, suite and PO Box Number.
Yes
No
No
String
1..30
AddressLine3
Yes
No
No
Additional address information.
String
1..30
Yes
City
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/Address/City
Activity locations City. This is optional field for Mail Innovations
String
StateProvinceCode
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/Address/StateProvinceCode
Activity locations state of province code. This is optional field for Mail Innovations Page 68
25
Yes
Yes
No
No
Yes
No
No
No
No
No
Yes
N/A
No
No
Yes
N/A
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
116
String
Yes
PostalCode
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/Address/PostalCode
Activity Locations postal codes. This will be available for Mail Innovations
String
*Yes
Yes
CountryCode
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/Address/CountryCode
Activity locations country code. This will be available for Mail Innovations
Container
AddressArtifactFormat
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/AddressArtifactFormat
Yes
N/A
No
No
Address location.
StreetNumberLow
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/AddressArtifactFormat/StreetNumberL ow
010
String
Yes
No
No
Street Number low.
String
StreetPrefix
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/AddressArtifactFormat/StreetPrefix
Yes
No
No
Street Prefix.
String
0..50
StreetName
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/AddressArtifactFormat/StreetName
Yes
No
No
Street Name.
String
StreetSuffix
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/AddressArtifactFormat/StreetSuffix
Yes
No
No
Street Suffix. Page 69
No
No
No
No
No
Yes
No
Yes
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
StreetType
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/AddressArtifactFormat/StreetType
String
No
PoliticalDivision2
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/AddressArtifactFormat/PoliticalDivision 2
String
5..16
Yes
No
No
Activity location's city.
PoliticalDivision1
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/AddressArtifactFormat/PoliticalDivision 1
String
0..30
Yes
No
No
PoliticalDivision1State province.
PostcodePrimaryLow
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/AddressArtifactFormat/PostcodePrimar yLow
String
5..16
Yes
No
No
Postal Code.
String
CountryCode
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/AddressArtifactFormat/CountryCode
Yes
No
No
Activity locations country code.
Container
TransportFacility
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/TransportFacility
This container is for storing the type and code of the transport facility of the Mail Innovations activity
String
Type
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/TransportFacility/Type
Type of facility for Mail Innovations shipment. valid values are 'IC' for USPS and 'VT' for MI. Page 70
Yes
Yes
No
No
Yes
N/A
No
No
No
No
No
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
Code
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/TransportFacility/Code
This code is associated with the Mail Innovations facility 2
String
*Yes
Code
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/Code
Yes
No
Activity location code.
String
1..35
*Yes
Description
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/Description
Yes
No
Activity location Description.
015
String
SignedForByName
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/SignedForByName
Yes
No
No
Name of the person who signed.
PODLetter
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/PODLetter
Container
No
HTMLImage
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/PODLetter/HTMLImage
String
No
Container
ElectronicDeliveryNotificatio n
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/ElectronicDeliveryNotification
Container to hold the Name of the customer who authorized the package release Page 71
No
No
No
No
No
No
No
Yes
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
1..35
Yes
Name
/TrackResponse/Shipment/Package/Activity/Activi tyLocation/ElectronicDeliveryNotification/Name
Name of customer who authorized the package release
Container
Yes
Status
/TrackResponse/Shipment/Package/Activity/Statu s
Package activity status Container.
Container
Yes
StatusType
/TrackResponse/Shipment/Package/Activity/Statu s/StatusType
Container tag for activity Status type. Code for status type of activity I = In Transit D = Delivered X = Exception P = Pickup M = Manifest Pickup For Mail Innovations only D, I, M, P and X are applicable.
String
Yes
Code
/TrackResponse/Shipment/Package/Activity/Statu s/StatusType/Code
120
String
Yes
Description
/TrackResponse/Shipment/Package/Activity/Statu s/StatusType/Description
Status type of activity.
Container
01
Yes
StatusCode
/TrackResponse/Shipment/Package/Activity/Statu s/StatusCode
Container tag for activity status code
String
Code
/TrackResponse/Shipment/Package/Activity/Statu s/StatusCode/Code
Code for status code of activity. Describes the activity status type in greater detail Page 72
Yes
Yes
No
No
Yes
No
No
Yes
No
No
Yes
No
No
Yes
0..1
No
No
Yes
N/A
No
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
Yes
Date
/TrackResponse/Shipment/Package/Activity/Date
Date of activity. Format is YYYYMMDD 4
String
Yes
Time
/TrackResponse/Shipment/Package/Activity/Time
Time of activity. Format is HHMMSS or HHMM
Container
Many
Yes
Message
/TrackResponse/Shipment/Package/Message
Code
/TrackResponse/Shipment/Package/Message/Co de
Container provided when the package has additional delivery information. Code describing what type of message the customer can provide: Valid values: 01 On Time 02 Rescheduled 03 Returned To Shipper Suggested text to provide to the customer when the code equals 01 is 'On Time'. Suggested Text to provide to the customer when the code equals 02 is 'Rescheduled'. Suggested Text to provide to the customer when the code equals 03 is 'Returned To Shipper'. For Mail Innovations only '01' is applicable.
String
*Yes
02
Yes
String
15
Description
/TrackResponse/Shipment/Package/Message/De scription
Description of the code provided in /TrackResponse/Package/Message/Co de
Yes
Page 73
Yes
No
No
Yes
No
Yes
N/A
No
No
Yes
No
No
Yes
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
Container
PackageWeight
/TrackResponse/Shipment/Package/PackageWei ght
Container
Yes
UnitOfMeasurement
/TrackResponse/Shipment/Package/PackageWei ght/UnitOfMeasurement
Package weight unit of measurement Container tag.
String
*Yes
Yes
Code
/TrackResponse/Shipment/Package/PackageWei ght/UnitOfMeasurement/Code
Package weight unit of measurement code. Defaults to LBS.
String
1..35
Yes
Description
/TrackResponse/Shipment/Package/PackageWei ght/UnitOfMeasurement/Description
Description of the package weight measurement units.
String
7.2
Yes
Weight
/TrackResponse/Shipment/Package/PackageWei ght/Weight
Packages weight. Set to 0 for package type of letters.
Container
Many
Yes
ReferenceNumber
/TrackResponse/Shipment/Package/ReferenceNu mber
Package reference number Container tag.
String
Yes
Code
/TrackResponse/Shipment/Package/ReferenceNu mber/Code
Reference number type code, for signifying PO #s, Invoice #s, etc. Page 74
Yes
No
No
Yes
N/A
No
No
Yes
No
No
Yes
No
No
Yes
No
Yes
N/A
No
No
Yes
N/A
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION
VALIDATION RULES
String
1..35
*Yes
Yes
Value
/TrackResponse/Shipment/Package/ReferenceNu mber/Value
Customer supplied reference number.
Container
ProductType
/TrackResponse/Shipment/Package/ProductType
Container tag for the type of the Product.
Yes
N/A
No
No
Code
/TrackResponse/Shipment/Package/ProductType/ Code
Code indicating the type of the Product. Its value is returned from the Tracking Component. (Currently not populated). Description of the type of the Product. Valid Value: World Ease (when a shipment with single/multiple packages is associated with World Ease movement).
String
Yes
No
No
String
1..35
*Yes
Description
/TrackResponse/Shipment/Package/ProductType/ Description
Yes
No
String
LocationAssured
/TrackResponse/Shipment/Package/LocationAssu red
AlternateTrackingNumber
/TrackResponse/Shipment/Package/AlternateTrac kingNumber
Indication of Location Assured Service. Valid Value: 1 = Location Assured If any other tracking number is associated with the package. This generally happens if the package is returned or some other exception has occurred and another new tracking number is assigned to it.
Yes
No
No
unbounded
11..21
String
No
unbounded
Container
AlternateTrackingInfo
/TrackResponse/Shipment/Package/AlternateTrac kingInfo
Alternate tracking number returned for this package. This is applicable only for Mail Innovations Page 75
Cond
Yes
N/A
No
No
No
No
No
No
No
Yes
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
MAX ALLOWED
NAME
XPATH
DESCRIPTION Valid values for this are - 'P' - Package ID, 'M' -Mail Manifest ID (type of Sequence number), 'S'- MMS number(type of Sequence number), 'T'Postal service Tracking ID
VALIDATION RULES
String
Yes
Type
/TrackResponse/Shipment/Package/AlternateTrac kingInfo/Type
String
Description
/TrackResponse/Shipment/Package/AlternateTrac kingInfo/Description
Future use
String
1..34
Yes
Value
/TrackResponse/Shipment/Package/AlternateTrac kingInfo/Value
This contains value of the alternate tracking number of Mail Innovations.
Page 76
Yes
No
No
Yes
N/A
No
No
No
Yes
No
No
MAIL INNOVATIONS
REQUIRED
SMALL PACKAGE
FREIGHT
LENGTH
TYPE
Tracking - XML
7/11/2011
1.9 Customer Integration Environment

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. No stress testing should ever be performed by customers against any UPS systems. Once your application has been thoroughly tested, you should redirect the application to the UPS Production Environment. Please note that while the Customer Integration Environment maintains system availability 24 hours, 7 days each week, there are occasional system down times to allow for server maintenance. For integration testing, you should direct your Package and Freight Tracking test software to: https://wwwcie.ups.com/webservices/Track.
1.9.1 System Availability

The Customer Integration Environment is available 24 hours a day, 7 days a week.
1.9.2 Server Availability Check

All of the UPS services work using HTTPS POST. Using the same URL as you point your application to, perform an HTTPS GET. If the server is available, it will reply with the service name, remote user, server port, server name, and servlet path. To see this in action, type the following URL in your web browser: https://wwwcie.ups.com/webservices/Track This will be returned: Service Name: Track Remote User: null Server Port: 443 Server Name: wwwcie.ups.com Servlet Path: /Track
1.9.3 Tracking Usage Guidelines

The following guidelines are included so all UPS customers can use UPS Tracking without delays: Insure that tracking requests are valid; if error messages like tracking number not found, no information available, invalid tracking number, etc. are received, 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 AM, Next Day Air, etc.) to determine the best time of day to track and receive up to the minute tracking information. Allow for at least two seconds between individual tracking requests. Avoid automatic access from 10:00 am through 3:00 pm EST. However, you may track critical packages during this time.
Page 77
Tracking - XML
7/11/2011
Evenly distribute you information requests over the remaining 19 hour window. Make every attempt to limit requests for information to no more than 2000 per hour (evenly distributed throughout the hour). Do not track the same numbers continually throughout the day. Any less than 50% unique numbers in a given 24 hour period can result in termination. For example, if a service level indicates a guaranteed delivery time of 10:30 AM for your delivery address and the tracking information guarantee is for 30 minutes after delivery, you should track that shipment after 11:00 AM. If daily/weekly tracking requests exceed daily shipping volume by a large margin, UPS will reserve the right to suspend tracking for hat account until the situation is rectified. If a resolution can not be found and implemented, tracking for that account may be terminated.
Page 78
Tracking - XML
7/11/2011
Appendix A Tracking Error Codes

To discover errors, check the ResponseStatusCode element. A 1 normally indicates a successful response, whereas a 0 indicates an error, either Transient or Hard. When an error occurs there will also be an error code, and an error description. Success Successful responses may or may not include Warnings. (without warnings) Request is processed as anticipated by the client. (with warnings) Warning messages indicate that UPS was able to process the request; however (potentially) unanticipated results have also occurred. The warning contains information in the response that should be passed to the end user. Errors will return two different levels of severity. Transient errors are temporary errors, due to temporary high server loads or scheduled maintenance, for example. The application may re-issue the request at a later time. Hard errors indicate that an error existed in the request that UPS could not resolve. These errors are critical and prevent requests from processing. Applications should not re-issue requests with Hard errors without first correcting the error. The following table lists the errors that UPS may return in response to a request.
Error Code 150000 150020 150021 150022 150023 150024 150025 150026 150027 150028 150030 151018 151019 150029 150099 151036 151038 151040 151044 151045 151050 151051 151062 151068 151085 Severity Transient Hard Hard Hard Hard Hard Hard Hard Hard Hard Hard Hard Hard Hard Transient Hard Hard Hard Hard Hard Hard Hard Hard Hard Hard Description Tracking service unavailable Invalid pickup date range Invalid shipment identification number Invalid tracking number Invalid reference number value length Invalid destination postal code length Invalid destination country code length Invalid begin date length Invalid end date length Invalid shipper number length Invalid Request/ RequestOption Invalid tracking number No activity records found for tracking number Duplicate Tracking Numbers found in Package Detail Delivery Change Request System Unavailable Either tracking number or reference number required Shipment number required with reference number Both tracking number and reference number invalid No tracking information available No information found Too many records to display Some Records are not returned No tracking information available Invalid Shipper Number Multiple shipper numbers found
Page 79
Tracking - XML
7/11/2011
Error Code 151086 151091 151602 152012 152100 152110 152315 154010 154030 154040 154050 154070 154080 154081 154082 154083 150084 150085 154086 20011 9150001 9150002 9150003 9150004 9150006 9150007 9150007 9150007
Severity Hard Hard Hard Hard Hard Hard Hard Hard Hard Hard Hard Hard Warning warning Hard HARD Hard Hard Hard Hard Hard Hard Hard Hard Hard Hard Hard Hard
Description Maximum candidate exceeded for Reference number search. Use the tracking number search Multiple reference numbers found, it may be possible to narrow the search with additional data. Destination Country Code must be entered Number of records selected exceeds limit of 175 Enter shipper number - additional shippers used the reference No information found for reference number Multiple reference numbers found, it is not possible to qualify further. Invalid inquiry number No information for this tracking number Invalid tracking type Non-unique BCD number - Candidate List returned Signature Tracking Options not available without successful login Could not verify Signature rights Your search returned multiple Shipments. Please select from the provided results. The supplied Candidate Bookmark fails validation Specific Tracking data could not be found. It may be possible to narrow the search with additional data. Invalid origin postal code length Invalid origin country code length Missing origin country code when origin postal code is supplied The Integration indicator is no longer supported Invalid access license number for tracking request option Invalid or missing inquiry number - TrackingNumber, ShipmentIdentificationNumber, or ReferenceNumber Invalid Candidate Bookmark Shipment Type should be specified when tracking by Reference Number CountryCode should be specified when ShipperAccountInfo container is present. Missing Recipient Email Address Missing Failure Email Address Missing Language information. Either ExceptionNotificationIndicator or DeliveryNotificationIndicator has to be supplied with Quantum View Notification request. Invalid Tracking Request Document Mail Innovations Tracking Service Unavailable. Mail Innovations Tracking Information not found. Invalid request option for Mail Innovations.
9154099 9151000 155001 155002 155003
Hard Hard Transient Hard Hard
Page 80
Tracking - XML
7/11/2011
Error Code 155004 155005 155006 150040
Severity Warning Hard Hard Hard
Description Max size of the candidate list is exceeded. Invalid country code for Mail Innovations. Invalid postal code for Mail Innovations. Invalid data found or the combination of data elements is invalid
Page 81
Tracking - XML
7/11/2011
Appendix B - Country Codes

UPS country code abbreviations generally follow the recommendations of the International Standards Organization, which publishes a list of currency abbreviations in ISO Standard 3166. The following table lists the ISO country codes that ISO had defined when this document was published. The latest information is available from the ISO web site. Please note that not all UPS services are available in every country. For more information on UPS services, refer to the latest UPS Rate and Service Guide available at http://www.ups.com.
Country Code AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BV BR IO BN Forward Origin Return Origin
Country Name Afghanistan land Islands Albania Algeria American Samoa Andorra Angola Anguilla Antarctica Antigua and Barbados Argentina Armenia Aruba Australia Austria Azerbaijan Bahamas Bahrain Bangladesh Barbados Belarus Belgium Belize Benin Bermuda Bhutan Bolivia Bosnia and Herzegovina Botswana Bouvet Island Brazil British Indian Ocean Territory Brunei Darussalam
Yes
Yes Yes Yes Yes
Yes
Yes Yes
Yes Yes
Yes
Yes
Yes
Yes
Yes
Yes
Page 82
Tracking - XML
7/11/2011
Country Code BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CY CZ DK DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF
Country Name Bulgaria Burkina Faso Burundi Cambodia Cameroon Canada Cape Verde Cayman Islands Central African Republic Chad Chile China Christmas Island Cocos (Keeling) Islands Colombia Comoros Congo Congo, The Democratic Republic of Cook Islands Costa Rica Cte Divoire Croatia Cuba Cyprus Czech Republic Denmark Djibouti Dominica Dominican Republic Ecuador Egypt El Salvador Equatorial Guinea Eritrea Estonia Ethiopia Falkland Islands (Malvinas) Faroe Islands Fiji Finland France French Guiana French Polynesia
Forward Origin
Return Origin Yes
Yes
Yes
Yes Yes
Yes Yes
Yes
Yes
Yes Yes Yes Yes Yes
Yes Yes
Yes
Yes Yes Yes Yes
Yes
Yes Yes
Yes Yes
Page 83
Tracking - XML
7/11/2011
Country Code TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM VA HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KP KR
Country Name French Southern Territories Gabon Gambia Georgia Germany Ghana Gibraltar Greece Greenland Grenada Guadeloupe Guam Guatemala Guernsey Guinea Guinea-Bissau Guyana Haiti Heard Island and McDonald Islands Holy See (Vatican City State) Honduras Hong Kong Hungary Iceland India Indonesia Iran, Islamic Republic of Iraq Ireland Isle of Man Israel Italy Jamaica Japan Jersey Jordan Kazakhstan Kenya Kiribati Korea, Democratic Peoples Republic of Korea, Republic of
Forward Origin
Return Origin
Yes
Yes
Yes
Yes Yes
Yes Yes
Yes Yes
Yes
Yes Yes Yes Yes
Yes Yes Yes Yes Yes Yes
Yes Yes Yes Yes Yes
Yes Yes Yes Yes Yes Yes
Yes
Yes
Page 84
Tracking - XML
7/11/2011
Country Code KW KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL AN NC NZ
Country Name Kuwait Kyrgyzstan Lao Peoples Democratic Republic Latvia Lebanon Lesotho Liberia Libyan Arab Jamahiriya Liechtenstein Lithuania Luxembourg Macao Macedonia, The Former Yugoslav Republic of Madagascar Malawi Malaysia Maldives Mali Malta Marshall Islands Martinique Mauritania Mauritius Mayotte Mexico Micronesia, Federated States of Moldova, Republic of Monaco Mongolia Montenegro Montserrat Morocco Mozambique Myanmar Namibia Nauru Nepal Netherlands Netherlands Antilles New Caledonia New Zealand
Forward Origin
Return Origin Yes
Yes Yes
Yes
Yes Yes Yes Yes
Yes
Yes
Yes Yes
Yes
Yes
Yes Yes Yes
Yes
Yes
Yes
Yes
Page 85
Tracking - XML
7/11/2011
Country Code NI NE NG NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW SH KN LC PM VC WS SM ST SA SN RS SC SL SG SK SI
Country Name Nicaragua Niger Nigeria Nigeria Niue Norfolk Island Northern Mariana Islands Norway Oman Pakistan Palau Palestinian Territory, Occupied Panama Papua New Guinea Paraguay Peru Philippines Pitcairn Poland Portugal Puerto Rico Qatar Runion Romania Russian Federation Rwanda Saint Helena Saint Kitts and Nevis Saint Lucia Saint Pierre and Miquelon Saint Vincent and The Grenadines Samoa San Marino Sao Tome and Principe Saudi Arabia Senegal Serbia Seychelles Sierra Leone Singapore Slovakia Slovenia
Forward Origin
Return Origin Yes Yes
Yes
Yes Yes Yes Yes
Yes
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
Yes Yes Yes Yes
Yes Yes
Yes Yes
Yes Yes Yes Yes
Yes
Yes Yes Yes
Page 86
Tracking - XML
7/11/2011
Country Code SB SO ZA
Country Name Solomon Islands Somalia South Africa South Georgia and The South Sandwich Islands Spain Sri Lanka Sudan Suriname Svalbard and Jan Mayen Swaziland Sweden Switzerland Syrian Arab Republic Taiwan, Province of China Tajikistan Tanzania, United Republic of Thailand Timor-Leste Togo Tokelau Tonga Trinidad and Tobago Tunisia Turkey Turkmenistan Turks and Caicos Islands Tuvalu Uganda Ukraine United Arab Emirates United Kingdom United States United States Minor Outlying Islands Uruguay Uzbekistan Vanuatu Venezuela Viet Nam Virgin Islands, British Virgin Islands, U.S. Wallis and Futuna
Forward Origin
Return Origin
Yes
GS ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VE VN VG VI WF
Yes
Yes Yes Yes
Yes Yes Yes
Yes Yes Yes
Yes
Yes
Yes
Yes Yes Yes
Yes Yes
Yes Yes Yes Yes
Yes
Yes Yes Yes
Page 87
Tracking - XML
7/11/2011
Country Code EH YE ZM ZW
Country Name Western Sahara Yemen Zambia Zimbabwe
Forward Origin
Return Origin
Page 88
Tracking - XML
7/11/2011
Appendix C - Currency Codes

UPS currency code abbreviations generally follow the recommendations of the International Standards Organization, which publishes a list of currency abbreviations in ISO Standard 4217, for which the latest information is available from the ISO website. Exceptions are noted in bold in the table below. Note that countries sometimes change their official currency. UPS may require some 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. For the latest information, please contact your UPS Developer API representative.
Country/Region Afghanistan Albania Algeria American Samoa Andorra Angola Anguilla Antigua And Barbuda Argentina Armenia Aruba Australia Austria Azerbaijan Bahamas Bahrain Bangladesh Barbados Belarus Belgium Belize Benin
Currency Name Afghani Lek Algerian Dinar US Dollar Euro Kwanza East Caribbean Dollar East Caribbean Dollar Argentine Peso Armenian Dram Aruban Guilder Australian Dollar Euro Azerbaijanian Manat Bahamian Dollar Bahraini Dinar Taka Barbados Dollar Belarussian Ruble Euro Belize Dollar CFA Franc BCEAO Bermudian Dollar (customarily known as Bermuda Dollar) Indian Rupee Ngultrum Boliviano Mvdol Convertible Marks Pula Norwegian Krone
Currency Code AFN ALL DZD USD EUR AOA XCD XCD ARS AMD AWG AUD EUR AZN BSD BHD BDT BBD BYR EUR BZD XOF
Bermuda Bhutan Bhutan Bolivia Bolivia Bosnia and Herzegovina Botswana Bouvet Island
BMD INR BTN BOB BOV BAM BWP NOK
Page 89
Tracking - XML
7/11/2011
Country/Region Brazil British Indian Ocean Territory Brunei Darussalam Bulgaria Burkina Faso Burundi Cambodia Cameroon Canada Cape Verde Cayman Islands Central African Republic Chad Chile Chile China Christmas Island Cocos (Keeling) Islands Colombia Colombia Comoros Congo Congo, The Democratic Republic of Cook Islands Costa Rica Cte Divoire Croatia Cuba Cyprus Czech Republic Denmark Djibouti Dominica Dominican Republic Ecuador Egypt El Salvador El Salvador Equatorial Guinea Eritrea Estonia Ethiopia Falkland Islands (Malvinas) Faroe Islands
Currency Name Brazilian Real US Dollar Brunei Dollar Bulgarian Lev CFA Franc BCEAO Burundi Franc Riel CFA Franc BEAC Canadian Dollar Cape Verde Escudo Cayman Islands Dollar CFA Franc BEAC CFA Franc BEAC Chilean Peso Unidades de formento Yuan Renminbi Australian Dollar Australian Dollar Colombian Peso Unidad de Valor Real Comoro Franc CFA Franc BEAC Franc Congolais New Zealand Dollar Costa Rican Colon CFA Franc BCEAO Croatian Kuna Cuban Peso Euro Czech Koruna Danish Krone Djibouti Franc East Caribbean Dollar Dominican Peso US Dollar Egyptian Pound El Salvador Colon US Dollar CFA Franc BEAC Nakfa Kroon Ethiopian Birr Falkland Islands Pound Danish Krone
Currency Code BRL USD BND BGN XOF BIF KHR XAF CAD CVE KYD XAF XAF CLP CLF RMB AUD AUD COP COU KMF XAF CDF NZD CRC XOF HRK CUP EUR CZK DKK DJF XCD DOP USD EGP SVC USD XAF ERN EEK ETB FKP DKK
Page 90
Tracking - XML
7/11/2011
Country/Region Fiji Finland France French Guiana French Polynesia French Southern Territories Gabon Gambia Georgia Germany Ghana Gibraltar Greece Greenland Grenada Guadeloupe Guam Guatemala Guernsey Guinea Guinea-Bissau Guinea-Bissau Guyana Haiti Haiti Heard Island ond Mcdonald Islands Holy See (Vatican City State) Honduras Hong Kong Hungary Iceland India Indonesia Iran (Islamic Republic of) Iraq Ireland Israel Italy Jamaica Japan Jersey Jordan Kazakhstan
Currency Name Fiji Dollar Euro Euro Euro CFP Franc Euro CFA Franc BEAC Dalasi Lari Euro Cedi Gibraltar Pound Euro Danish Krone East Caribbean Dollar Euro US Dollar Quetzal Pound Sterling Guinea Franc Guinea-Bissau Peso CFA Franc BCEAO Guyana Dollar Gourde US Dollar Australian Dollar Euro Lempira Hong Kong Dollar Forint Iceland Krona Indian Rupee Rupiah Iranian Rial Iraqi Dinar Euro New Israeli Sheqel Euro Jamaican Dollar Yen Pound Sterling Jordanian Dinar Tenge
Currency Code FJD EUR EUR EUR XPF EUR XAF GMD GEL EUR GHC GIP EUR DKK XCD EUR USD GTQ GBP GNF GWP XOF GYD HTG USD AUD EUR HNL HKD HUF ISK INR IDR IRR IQD EUR ILS EUR JMD JPY GBP JOD KZT
Page 91
Tracking - XML
7/11/2011
Country/Region Kenya Kiribati Korea, Democratic Peoples Republic of Korea, Republic of Kuwait Kyrgyzstan Lao Peoples Democratic Republic Latvia Lebanon Lesotho Lesotho Liberia Libyan Arab Jamahiriya Liechtenstein Lithuania Luxembourg Macao Macedonia, The Former Yugoslav Republic of Madagascar Malawi Malaysia Maldives Mali Malta Marshall Islands Martinique Mauritania Mauritius Mayotte Mexico Mexico Micronesia (Federated States of) Moldova, Republic of Monaco Mongolia Montenegro Montserrat Morocco Mozambique Myanmar
Currency Name Kenyan Shilling Australian Dollar North Korean Won Won Kuwaiti Dinar Som Kip Latvian Lats Lebanese Pound Rand Loti Liberian Dollar Libyan Dinar Swiss Franc Lithuanian Litas Euro Pataca Denar Malagascy Ariary Kwacha Malaysian Ringgit Rufiyaa CFA Franc BCEAO Euro US Dollar Euro Ouguiya Mauritius Rupee Euro Mexican Peso Mexican Unidad de Inversion (UID) US Dollar Moldovan Leu Euro Tugrik Euro East Caribbean Dollar Moroccan Dirham Metical Kyat
Currency Code KES AUD KPW KRW KWD KGS LAK LVL LBP ZAR LSL LRD LYD CHF LTL EUR MOP MKD MGA MWK MYR MVR XOF EUR USD EUR MRO MUR EUR MXN MXV USD MDL EUR MNT EUR XCD MAD MZN MMK
Page 92
Tracking - XML
7/11/2011
Country/Region Namibia Namibia Nauru Nepal Netherlands Netherlands Antilles New Caledonia New Zealand Nicaragua Niger Nigeria Niue Norfolk Island Northern Mariana Islands Norway Oman Pakistan Palau Panama Panama Papua New Guinea Paraguay Peru Philippines Pitcairn Poland Portugal Puerto Rico Qatar Runion Romania Russian Federation Rwanda Saint Helena Saint Kitts and Nevis Saint Lucia Saint Pierre and Miquelon Saint Vincent and The Grenadines Samoa San Marino So Tome and Principe Saudi Arabia Senegal
Currency Name Rand Namibian Dollar Australian Dollar Nepalese Rupee Euro Netherlands Antillian Guilder CFP Franc New Zealand Dollar Cordoba Oro CFA Franc BCEAO Naira New Zealand Dollar Australian Dollar US Dollar Norwegian Krone Rial Omani Pakistan Rupee US Dollar Balboa US Dollar Kina Guarani Nuevo Sol Philippine Peso New Zealand Dollar Zloty Euro US Dollar Qatari Rial Euro New Leu Russian Ruble Rwanda Franc Saint Helena Pound East Caribbean Dollar East Caribbean Dollar Euro East Caribbean Dollar Tala Euro Dobra Saudi Riyal CFA Franc BCEAO
Currency Code ZAR NAD AUD NPR EUR ANG XPF NZD NIO XOF NGN NZD AUD USD NOK OMR PKR USD PAB USD PGK PYG PEN PHP NZD PLN EUR USD QAR EUR RON RUB RWF SHP XCD XCD EUR XCD WST EUR STD SAR XOF
Page 93
Tracking - XML
7/11/2011
Country/Region Serbia Seychelles Sierra Leone Singapore Slovakia Slovenia Solomon Islands Somalia South Africa Spain Sri Lanka Sudan Suriname Svalbard and Jan Mayen Swaziland Sweden Switzerland Switzerland Switzerland Syrian Arab Republic Taiwan, Province of China Tajikistan Tanzania, United Republic of Thailand Timor-Leste Togo Tokelau Tonga Trinidad And Tobago Tunisia Turkey Turkmenistan Turks And Caicos Islands Tuvalu Uganda Ukraine United Arab Emirates United Kingdom United States United States Minor Outlying Islands Uruguay
Currency Name Serbian Dinar Seychelles Rupee Leone Singapore Dollar Euro Euro Solomon Islands Dollar Somali Shilling Rand Euro Sri Lanka Rupee Sudanese Dinar Surinam Dollar Norwegian Krone Lilangeni Swedish Krona Swiss Franc WIR Franc WIR Euro Syrian Pound New Taiwan Dollar Somoni Tanzanian Shilling Baht US Dollar CFA Franc BCEAO New Zealand Dollar Paanga Trinidad and Tobago Dollar Tunisian Dinar New Turkish Lira Manat US Dollar Australian Dollar Uganda Shilling Hryvnia UAE Dirham Pound Sterling US Dollar US Dollar Peso Uruguayo
Currency Code RSD SCR SLL SGD EUR EUR SBD SOS ZAR EUR LKR SDD SRD NOK SZL SEK CHF CHW CHE SYP TWD TJS TZS THB USD XOF NZD TOP TTD TND TRY TMM USD AUD UGX UAH AED GBP USD USD UYU
Page 94
Tracking - XML
7/11/2011
Country/Region
Currency Name Uruguay Peso en Unidades Indexadas Uzbekistan Sum Vatu Bolivar Dong US Dollar US Dollar CFP Franc Moroccan Dirham Yemeni Rial Kwacha Zimbabwe Dollar
Currency Code
Uruguay Uzbekistan Vanuatu Venezuela Viet Nam Virgin Islands (British) Virgin Islands (US) Wallis And Futuna Western Sahara Yemen Zambia Zimbabwe
UYI UZS VUV VEB VND USD USD XPF MAD YER ZMK ZWD
Page 95
Tracking - XML
7/11/2011
Appendix D - Service Codes

UPS offers a wide variety of package delivery services. The following tables list the service code values for these services; they are ordered by the origin of the shipment. The final table lists service codes for freight shipments. For more information on UPS services, refer to the latest UPS Rate and Service Guide available at http://www.ups.com.
Service Code 000 000 000 000 000 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 Description UNASSIGNED CONSIGNEE BILLING BAG TRACKING SMALL BAGS TEMPORARY VEHICLES NEXT DAY AIR NEXT DAY AIR DELIVERY CONFIRMATION NEXT DAY AIR RETURN SERVICE EXPRESS NEXT DAY AIR A.R.S NEXT DAY AIR SATURDAY DELIVERY NEXT DAY AIR DELV CONF SAT. DEL NEXT DAY AIR EXPRESS SATURDAY DELIVERY NEXT DAY AIR WORLDWIDE SERVICES EXPRESS COD EXPRESS COD SATURDAY DELIVERY EXPRESS DELIVERY CONFIRMATION NEXT DAY AIR SHIPPER RELEASE NEXT DAY SHIP RELEASE DELV CONFIRM NEXT DAY SHIPPER RELEASE SAT DELV NEXT DAY SHIP RLSE SAT DELV CONFIRM NEXT DAY AIR RETURN SVC PROACTIVE NEXT DAY AIR LOCATION ASSURED 1DA LOCATION ASSURED DELIVERY CONF 1DA LOCATION ASSURED SIG REQUIRED 1DA LOCATION ASSURED ADULT SIG REQ 1DA LOCATION ASSURED SATURDAY DEL 1DA LOC ASSURED DEL CONF SAT DEL 1DA LOC ASSURED SIG REQ SAT DEL 1DA LOC ASRD ADULT SIG REQ SAT DEL 1DA LOCATION ASSURED COD 1DA LOC ASSURED COD ADULT SIG REQ 1DA LOCATION ASSURED COD SAT DEL 1DA LOC ASRD COD SAT DEL ADULT SIG 1DA LOCATION ASSURED SHIPPER REL 1DA LOC ASRD SHIPPER REL DEL CONF
Page 96
Tracking - XML
7/11/2011
Service Code 001 001 001 001 001 001 001 001 001 001 001 001 001 001 001 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 002 004 004 004
Description 1DA LOC ASRD SHIPPER REL SAT DEL 1DA LOC ASRD SHIP REL DEL CONF SAT NEXT DAY AIR SATURDAY RETURN SVC UPS 1DA 1 PICKUP ATTEMPT UPS 1DA 1 PICKUP ATTEMPT SAT DELIV UPS 1DA 3 PICKUP ATTEMPTS UPS 1DA 3 PICKUP ATTEMPTS SAT DELIV UPS EXPRESS (NA1) ADULT SIGNATURE UPS EXPRESS (NA1) SATURDAY DELIVERY UPS NEXT DAY AIR UPS NEXT DAY AIR SATURDAY DELIVERY UPS NEXT DAY AIR ADULT SIGNATURE UPS NEXT DAY AIR SAT DEL ADULT SIG UPS NEXT DAY AIR SHIPPER RELEASE UPS NEXT DAY AIR SAT DEL SHR RELEAS 2ND DAY AIR 2ND DAY AIR DELIVERY CONFIRMATION EXPEDITED 2ND DAY AIR A.R.S. 2ND DAY AIR RETURN SERVICE EXPEDITED COD EXPEDITED DELIVERY CONFIRMATION SECOND DAY AIR SHIPPER RELEASE SECOND DAY SHIP RELEASE DEL CONFIRM 2ND DAY AIR SAT DEL 2ND DAY AIR SAT DEL - DC-NO SIG 2ND DAY AIR SAT DEL - SIG REG. 2ND DAY AIR SAT DEL - ADULT SIG REG 2ND DAY AIR SAT DEL - COD 2ND DAY AIR SAT DEL - SHIPPER RELEA 2ND DAY AIR SAT DEL - DC-NO SIG./SH 2ND DAY AIR SATURDAY RETURN SVC UPS 2ND DAY AIR UPS 2ND DAY AIR SATURDAY DELIVERY UPS 2ND DAY AIR ADULT SIGNATURE UPS 2ND DAY AIR SAT DEL ADULT SIG UPS 2ND DAY AIR SHIPPER RELEASE UPS 2ND DAY AIR SAT DEL SHR RELEASE UPS 2DA 1 PICKUP ATTEMPT UPS 2DA 1 PICKUP ATTEMPT SAT DELIV UPS 2DA 3 PICKUP ATTEMPTS UPS 2DA 3 PICKUP ATTEMPTS SAT DELIV STANDARD GROUND DELIVERY TRACII
Page 97
Tracking - XML
7/11/2011
Service Code 004 004 004 004 004 004 004 004 004 004 004 004 004 004 004 004 004 004 004 004 004 004 004 004 004 004 007 007 007 007 007 007 007 007 007 007 007 007 007 007 007 007 007 007 007
Description GROUND A.R.S. ECONOMY GROUND RETURN SERVICE GROUND DELIVERY CONFIRMATION GROUND CALL TAG CANADA SURFACE ISPS STANDARD ARS STANDARD RETURN SERVICE STANDARD SAMMEL STANDARD COD STANDARD DELIVERY CONFIRMATION GROUND SHIPPER RELEASE GROUND SHIPPER RELEASE DELV CONFIRM GROUND LOCATION ASSURED GND LOCATION ASSURED DELIVERY CONF GND LOCATION ASSURED SIG REQUIRED GND LOCATION ASSURED ADULT SIG REQ GROUND LOCATION ASSURED COD GND LOC ASSURED COD ADULT SIG REQ GND LOCATION ASSURED SHIPPER REL GND LOC ASRD SHIPPER REL DEL CONF UPS GROUND 1 PICKUP ATTEMPT UPS GROUND 3 PICKUP ATTEMPTS UPS GROUND UPS GROUND ADULT SIGNATURE UPS GROUND SHIPPER RELEASE WORLDWIDE EXPRESS SVC WORLDWIDE EXPRESS SVC SAT DELIVERY EXPRESS EXPRESS ARS EXPRESS REURN SERVICE EXPRESS EXCHANGE COLLECT EXPRESS EXCHANGE COLLECT SAT. DEL. EXPRESS EXCHANGE COLLECT DELV CONF EXPRESS COD EXPRESS COD DELIVERY CONFIRM EXPRESS COD SAT/DEL DELIV CONFIRM EXPRESS COD SATURDAY DELIVERY EXPRESS RETURN SERVICE PROACTIVE EXPRESS SATURDAY RETURN SERVICE EXPRESS SAT RETURN SVC PROACTIVE UPS EXPRESS UPS EXPRESS SATURDAY DELIVERY UPS EXPRESS ADULT SIGNATURE UPS EXPRESS SAT DEL ADULT SIGNATURE
Page 98
Tracking - XML
7/11/2011
Service Code 007 007 007 007 007 007 007 008 008 008 008 008 008 008 008 008 008 008 008 008 011 011 011 011 011 011 011 011 011 011 012 012 012 012 012 012 012 012 012 012 012 012 012 012 013
Description UPS EXPRESS SHIPPER RELEASE UPS EXPRESS SAT DEL SHIPPER RELEASE UPS EXPRESS 1 PICKUP ATTEMPT UPS EXPRESS 1 PICKUP ATTMPT SAT DEL UPS EXPRESS 3 PICKUP ATTEMPTS UPS EXPRESS 3 PICKUP ATTMPT SAT DEL UPS EXPRESS (NA1) WORLDWIDE EXPEDITED SVC WORLDWIDE EXPEDITED WORLDWIDE EXPEDITED EXPEDITED ARS EXPEDITED RETURN SERVICE EXPEDITED EXCHANGE COLLECT EXPEDITED EXCHANGE COLLECT DEL CONF EXPEDITED COD EXPEDITED COD DELIVERY CONFIRMATION UPS EXPEDITED 1 PICKUP ATTEMPT UPS EXPEDITED 3 PICKUP ATTEMPTS UPS EXPEDITED UPS EXPEDITED ADULT SIGNATURE WORLDWIDE SERVICES-STANDARD STANDARD EXCHANGE COLLECT STANDARD EXCHANGE COLLECT DEL CONF INTERNATIONAL STANDARD COD INTERNATIONL STANDARD COD DEL CONFM UPS STANDARD UPS STANDARD ADULT SIGNATURE UPS STANDARD SHIPPER RELEASE UPS STANDARD 1 PICKUP ATTEMPT UPS STANDARD 3 PICKUP ATTEMPTS 3 DAY SELECT 3 DAY SELECT DELIVERY CONFIRMATION 3 DAY SELECT A.R.S. 3 DAY SELECT RETURN SERVICE 3 DAY SELECT EXCHANGE COLLECT 3 DAY EXCHANGE COLLECT DEL CONFIRM THREE DAY SELECT COD 3 DAY SELECT COD DELIVERY CONFIRM THREE DAY SELECT SHIPPER RELEASE THREE DAY SHIP RELEASE DELV CONFIRM UPS 3 DAY SELECT UPS 3 DAY SELECT ADULT SIGNATURE UPS 3 DAY SELECT 1 PICKUP ATTEMPT UPS 3 DAY SELECT 3 PICKUP ATTEMPTS NEXT DAY AIR SAVER
Page 99
Tracking - XML
7/11/2011
Service Code 013 013 013 013 013 013 013 013 013 013 013 013 013 013 013 013 013 013 014 014 014 014 014 014 014 014 014 014 014 014 014 014 014 014 014 014 014 014 014 015 016 021 031 054 054
Description NEXT DAY AIR SAVER DELIVERY CONF. UPS SAVER COD SATURDAY DELIVERY UPS SAVER COD SATURDAY DELIVERY UPS SAVER COD SATURDAY DELIVERY UPS SAVER COD SATURDAY DELIVERY UPS SAVER COD UPS SAVER - COD DELV CONF SIGN REQ UPS SAVER - COD D/C ADULT SIGN REQ UPS SAVER DELIVERY CONFIRMATION UPS SAVER DELIVERY CONFIRMATION UPS SAVER DELIVERY CONFIRMATION UPS SAVER DELIVERY CONFIRMATION UPS SAVER DELIVERY CONFIRMATION UPS SAVER DELIVERY CONFIRMATION NEXT DAY AIR SAVER SHIPPER RELEASE NEXT DAY SAVER SHIP RELEAS DEL CONF UPS NEXT DAY AIR SAVER UPS NEXT DAY AIR SAVER ADULT SIG NEXT DAY AIR EARLY AM NEXT DAY AIR EARLY AM/EXPRESS EAM 1DA EAM / EXPRESS EAM NEXT DAY AIR EARLY AM SATURDAY DEL EXPRESS PLUS EXPRESS PLUS COD EXPRESS PLUS COD SATURDAY DELIVERY EXPRESS PLUS DELIVERY CONFIRMATION NEXT DAY EARLY AM SHIPPER RELEASE NEXT DAY AM SHIP RELEASE SAT DELV NEXT DAY EARLY AM RETURN SERVICE UPS EARLY AM RETURN SRVC PROACTIVE NEXT DAY EARLY AM SAT RETURN SVC UPS EARLY AM UPS EARLY AM ADULT SIGNATURE UPS EARLY AM SATURDAY DELIVERY UPS EARLY AM SAT DELIVERY ADULT SIG UPS EARLY A.M. 1 PICKUP ATTEMPT UPS EARLY A.M. 1 PICKUP ATT SAT DEL UPS EARLY A.M. 3 PICKUP ATTEMPTS UPS EARLY A.M. 3 PICKUP ATT SAT DEL UPS SONIC AIR UNISTAR ECONOMY COD BASIC EXPRESS PLUS EXPRESS PLUS RETURN SERVICE
Page 100
Tracking - XML
7/11/2011
Service Code 054 054 054 054 054 054 054 054 054 054 054 054 054 059 059 059 059 059 059 064 064 064 064 064 064 064 064 065 065 065 065 065 065 065 065 065 065 065 082 082 083 083 084 085 085
Description EXPRESS PLUS DELIVERY CONFIRMATION EXPRESS PLUS COD EXPRESS PLUS COD SATURDAY DELIVERY EXPRESS PLUS SATURDAY DELIVERY EXPRESS PLUS COD DELIVERY CONFIRM EXPRESS PLUS COD SAT/DEL DEL CONFRM EXPRESS PLUS RETURN SVC PROACTIVE UPS EXPRESS PLUS UPS EXPRESS PLUS SATURDAY DELIVERY UPS EXPRESS PLUS ADULT SIGNATURE UPS EXPRESS PLUS SAT DEL ADULT SIG UPS EXPRESS PLUS 1 PICKUP ATTEMPT UPS EXPRESS PLUS 3 PICKUP ATTEMPTS 2ND DAY AIR A.M. 2ND DAY AIR A.M. DELIVERY CONFIRM. SECOND DAY AIR AM SHIPPER RELEASE SECOND DAY AM SHIP RELSE DELV CONFM UPS 2ND DAY AIR A.M. UPS 2ND DAY AIR AM ADULT SIGNATURE EXPRESS EXPRESS DELIVERY CONFIRMATION EXPRESS SATURDAY DELIVERY EARLY PICKUP EXPRESS RETURN SERVICE EARLY PICKUP EXPRESS RET SVC PROACT EARLY PICKUP EXPRESS SAT RETURN SVC EARLY PICKUP EXPRESS SAT RET PROACT UPS EXP (NA1) SAT DEL ADULT SIG REQ UPS SAVER UPS SAVER - COD UPS SAVER ARS UPS SAVER RETURN SERVICE UPS SAVER - COD DELV CONF SIGN REQ UPS SAVER - COD D/C ADULT SIGN REQ UPS SAVER RETURN SERVICE PROACTIVE UPS SAVER UPS SAVER ADULT SIGNATURE UPS SAVER 1 PICKUP ATTEMPT UPS SAVER 3 PICKUP ATTEMPTS UPS TODAY STANDARD UPS TODAY STANDARD - COD UPS TODAY DEDICATED COURIER UPS TODAY DEDICATED COURIER - COD UPS TODAY INTERCITY UPS TODAY EXPRESS UPS TODAY EXPRESS - COD
Page 101
Tracking - XML
7/11/2011
Service Code 086 086 092 092 093 094 095 64 A& J& K& M& W& 74 10 45 46 48 49 53 61 63 Y& 1 24 25 28 14 27 55 44 47 58 22 59 60 75 76 C& 9 84 A2 A3 A9 AC
Description UPS TODAY EXPRESS SAVER UPS TODAY EXPRESS SAVER - COD STANDARD PARCEL, UPS DELIVERY STANDARD PARCEL, USPS DEL, REQ SUBPARCEL SELECT, UPS DELIVERY BOUND PRINTED MATTER, UPS DELIVERY MEDIA MAIL, UPS DELIVERY UNASSIGNED CONSIGNEE BILLING BAG TRACKING SMALL BAGS TEMPORARY VEHICLES WORLDWIDE SERVICES UNASSIGNED UNASSIGNED UNASSIGNED UNASSIGNED UNASSIGNED UNASSIGNED UNASSIGNED UNASSIGNED UNASSIGNED WORLDWIDE SERVICES NEXT DAY AIR NEXT DAY AIR 1 DAY DELIV. CONFIRM. NEXT DAY AIR EXPRESS NEXT DAY AIR A.R.S. EXPRESS 1 DAY SATURDAY DELIVERY 1 DAY DELV CONF SAT DEL 1 DAY DELV CONF SAT DEL NEXT DAY AIR NEXT DAY AIR 1 DAY SATURDAY DELIVERY EXPRESS EXPRESS SATURDAY DELIV EXPRESS 1 DAY RETURN SERVICE 1 DAY RETURN SERVICE NEXT DAY AIR NEXT DAY AIR NEXT DAY AIR EARLY AM NEXT DAY AIR
Page 102
Tracking - XML
7/11/2011
Service Code AD D& C5 C6 C7 C8 C9 CA D2 D3 D4 D5 D6 D7 H5 NT P4 PG PN V3 VY W0 W1 W2 W3 W4 W5 W6 W7 W8 W9 WA WG WH WN WP Y0 Y1 Y2 3Y 4G 4A 4H T4 T5
Description NEXT DAY AIR WORLDWIDE SERVICES EXPRESS COD EXPRESS COD EXPRESS COD EXPRESS COD SAT DEL EXPRESS COD SAT DEL EXPRESS COD SAT DEL EXPRESS DELIVERY CONF. EXPRESS DELIVERY CONF. EXPRESS DELIVERY CONF. EXPRESS DELIVERY CONF. EXPRESS DELIVERY CONF. EXPRESS DELIVERY CONF. EXPRESS NEXT DAY SHIPPER RELEASE NEXT DAY SHIP/RLS DLV CN NEXT DAY SHIP REL SAT/DL NEXT DAY SHIP RLS SAT/DL NEXT DAY AIR RET SVC PRO NEXT DAY AIR LOCATN ASRD 1 DAY LOCT ASRD DLV CNFM 1 DAY LOCT ASRD DLV CNFM 1 DAY LOCT ASRD DLV CNFM 1 DAY LOCT ASRD SAT DELV 1 DAY LOCT ASRD SAT DELV 1 DAY LOCT ASRD SAT DELV 1 DAY LOCT ASRD SAT DELV NEXT DAY LOCT ASRD COD 1 DAY LOCT ASRD COD DELV 1 DAY LOCT ASRD COD SAT 1 DAY LOCT ASRD COD SAT 1 DAY LOCT ASRD SHIP REL 1 DAY LOCT ASRD SHIP REL 1 DAY LOCT ASRD SHIP SAT 1 DAY LOCT ASRD SHIP SAT NEXT DAY SAT RETURN SVC NEXT DAY SAT RETURN SVC NEXT DAY SAT RETURN SVC UPS 1DA 1 PICKUP ATTEMPT UPS 1DA 1 PU ATT SAT DEL UPS 1DA 3 PICKUP ATTEMPT UPS 1DA 3 PU ATT SAT DEL EXPRESS (NA1) ADULT SIG UPS EXPRESS NA1 SAT DEL
Page 103
Tracking - XML
7/11/2011
Service Code 7N 7P 7T 7W 7Y 8A 2 35 36 17 38 52 37 70 11 87 A6 AG CK CL CM DF DG DH NY P6 PW PY T0 T1 T2 T3 T6 T7 Y3 Y4 Y5 8T 8W 8Y 9A 9G 9H 4N 4T
Description UPS NEXT DAY AIR UPS NEXT DAY AIR SAT DEL UPS NEXT DAY AIR ADT SIG NDA AIR SAT DEL ADT SIG UPS NEXT DAY AIR SHR REL UPS NDA SAT DEL SHR REL 2ND DAY AIR 2 DAY DELIVERY CONFIRM 2 DAY DELIVERY CONFIRM EXPEDITED 2ND DAY AIR A.R.S. 2ND DAY AIR 2ND DAY AIR 2ND DAY AIR 2 DAY RETURN SERVICE 2 DAY RETURN SERVICE 2ND DAY AIR 2ND DAY AIR EXPEDITED COD EXPEDITED COD EXPEDITED COD EXPEDITED DELIVERY CONF. EXPEDITED DELIVERY CONF. EXPEDITED DELIVERY CONF. SECOND DAY SHIP RELEASE SECOND DAY SHIP RELEASE 2ND DAY AIR SAT DEL 2ND DAY AIR SAT DEL - DC 2ND DAY AIR SAT DEL - SI 2ND DAY AIR SAT DEL - AD 2ND DAY AIR SAT DEL - CO 2ND DAY AIR SAT DEL - SH 2ND DAY AIR SAT DEL - AD 2ND DAY AIR SAT DEL - DC 2ND DAY AIR SAT RETURN 2ND DAY AIR SAT RETURN 2ND DAY AIR SAT RETURN UPS 2ND DAY AIR UPS 2ND DAY AIR SAT DEL UPS 2ND DAY AIR ADT SIG UPS 2DA SAT DEL ADT SIG UPS 2ND DAY AIR SHR REL UPS 2DA SAT DEL SHR REL UPS 2DA 1 PICKUP ATTEMPT UPS 2DA 1 PU ATT SAT DEL
Page 104
Tracking - XML
7/11/2011
Service Code 4P 4W 56 20 3 5 6 8 26 42 43 51 72 79 B& Z& 78 83 90 91 95 99 A8 AJ G& AN AP AR CN CP CR DJ DK DL P2 P9 V9 VA VG VH VN VP VT VW 5G
Description UPS 2DA 3 PICKUP ATTEMPT UPS 2DA 3 PU ATT SAT DEL STANDARD STANDARD GROUND GROUND GROUND A.R.S ECONOMY GROUND GROUND DELIVERY CONFIRM GROUND DELIVERY CONFIRM GROUND GROUND STANDARD CANADA DOMESTIC SERVICE CANADA SURFACE GROUND RETURN SERVICE STANDARD A.R.S. GROUND STANDARD STANDARD STANDARD GROUND GROUND STANDARD SAMMEL GROUND GROUND GROUND STANDARD COD STANDARD COD STANDARD COD STANDARD DELIVERY CON STANDARD DELIVERY CON STANDARD DELIVERY CON GROUND SHIPPER RELEASE GROUND SHIP REL DELV CON GROUND LOCATION ASSURED GROUND LOCT ASRD DLV CON GROUND LOCT ASRD DLV CON GROUND LOCT ASRD DLV CON GROUND LOCATION ASRD COD GROUND LOCT ASRD COD DLV GROUND LOCT ASRD SHIP RL GROUND LOCT ASRD SHIP RL UPS GROUND 1 PICKUP ATT
Page 105
Tracking - XML
7/11/2011
Service Code 5H 9T 9W 9Y 66 69 Q& 80 85 92 96 DM DN GN GP H0 H1 HT HW HY N0 N1 N2 V4 Y6 Y7 Y8 Y9 AS AZ CQ CS CZ DQ 5T 5Y 5W 6A PH 67 X& 0 82 88 94
Description UPS GROUND 3 PICKUP ATT UPS GROUND UPS GROUND ADULT SIG UPS GROUND SHIPPER REL WORLDWIDE EXPRESS SVC WW EXP SVC SAT DELIVERY EXPRESS EXPRESS A.R.S. EXPRESS RETURN SERVICE EXPRESS RETURN SERVICE EXPRESS RETURN SERVICE EXPRESS EXCHANGE COLL. EXPR EXCHG COLLECT SAT EXPR EXCHG COLL DEL CONF EXPR EXCHG COLLECT SAT EXPRESS EXCHANGE COLL. EXPR EXCHG COLLECT SAT EXPRESS COD EXPRESS COD DELV CONFIRM EXPRESS COD DELV CONFIRM EXPRESS COD SAT/DELV EXPRESS COD SAT/DELV EXPRESS COD SAT/DELV EXPRESS RET SVC PROACTIV EXPRESS SATURDAY RETURN EXPRESS SATURDAY RETURN EXPRESS SATURDAY RETURN EXPRESS SAT RETRN PROACT UPS EXPRESS UPS EXPRESS SATURDAY DEL UPS EXPRESS ADULT SIG UPS EXP SAT DEL ADLT SIG UPS EXPRESS SHIPPER REL UPS EXP SAT DEL SHR REL UPS EXPRESS 1 PICKUP ATT UPS EXP 1 PU ATT SAT DEL UPS EXPRESS 3 PICKUP ATT UPS EXP 3 PU ATT SAT DEL UPS EXPRESS (NA1) WORLDWIDE EXPEDITED SVC WORLDWIDE EXPEDITED EXPEDITED EXPEDITED A.R.S. EXPEDITED RETURN SERVICE EXPEDITED
Page 106
Tracking - XML
7/11/2011
Service Code 98 DP GT H2 NG NH NN 6N 6P DW DX 68 DR GW H3 N8 N9 NA DY DZ E0 6T 6W 12 39 40 57 50 71 16 89 A7 AH DT G0 GY H4 H6 H7 P1 P8 PV 9N 9P 4Y
Description EXPEDITED EXPEDITED EXCHG COLLECT EXPED EXCHG COLLECT DELV EXPED EXCHG COLLECT DELV EXPEDITED COD EXPEDITED COD DELV CONFM EXPEDITED COD DELV CONFM UPS EXPEDTD 1 PICKUP ATT UPS EXPEDTD 3 PICKUP ATT UPS EXPEDITED UPS EXPEDITED ADULT SIG WORLDWIDE STANDARD SVC STANDARD EXCHG COLLECT STANDARD EXCHG COLL DELV STANDARD EXCHG COLL DELV INTERNTIONL STANDARD COD INTERNTIONL STANDARD COD INTERNTIONL STANDARD COD UPS STANDARD UPS STANDARD ADULT SIG UPS STANDARD SHIPPER REL UPS STANDARD 1 PICKP ATT UPS STANDARD 3 PICKP ATT 3 DAY SELECT 3 DAY DELIVERY CONFIRM 3 DAY SELECT 3 DAY SELECT A.R.S. 3 DAY SELECT 3 DAY SELECT 3 DAY SELECT RETURN SVC 3 DAY SELECT RETURN SVC 3 DAY SELECT 3 DAY SELECT 3 DAY SELECT EXCHG COLL 3 DAY DELIVERY CONFIRM 3 DAY EXCHG COLL DELV 3 DAY EXCHG COLL DELV THREE DAY SELECT COD 3 DAY SELECT COD DEL CON THREE DAY SHIPPR RELEASE 3 DAY SHIP RELS DELV CON 3 DAY SELECT COD DEL CON UPS 3 DAY SELECT UPS 3 DAY SELECT ADT SIG UPS 3DS 1 PICKUP ATTEMPT
Page 107
Tracking - XML
7/11/2011
Service Code 5A 13 29 30 23 62 A4
Description UPS 3DS 3 PICKUP ATTEMPT NEXT DAY AIR SAVER 1 DAY SAVER DEL CONFIRM 1 DAY SAVER DEL CONFIRM NEXT DAY AIR SAVER NEXT DAY AIR SAVER NEXT DAY AIR SAVER
Page 108
Tracking - XML
7/11/2011
Appendix E State Province Codes

UPS State/Province codes (for the US and Canada).
State Province Name Alaska Alabama Arkansas Arizona California Colorado Connecticut District of Columbia Delaware Florida Georgia Hawaii Iowa Idaho Illinois Indiana Kansas Kentucky Louisiana Massachusetts Maryland Maine Michigan Minnesota Missouri Mississippi Montana North Carolina North Dakota Nebraska New Hampshire New Jersey New Mexico Nevada New York Ohio Oklahoma Oregon Pennsylvania Rhode Island South Carolina Code AK AL AR AZ CA CO CT DC DE FL GA HI IA ID IL IN KS KY LA MA MD ME MI MN MO MS MT NC ND NE NH NJ NM NV NY OH OK OR PA RI SC
Page 109
Tracking - XML
7/11/2011
State Province Name South Dakota Tennessee Texas Utah Virginia Vermont Washington Wisconsin West Virginia Wyoming Alberta British Columbia Manitoba New Brunswick Newfoundland and Labrador Nova Scotia Northwest Territories Nunavut Ontario Prince Edward Island Quebec Saskatchewan Yukon Territory
Code SD TN TX UT VA VT WA WI WV WY AB BC MB NB NL NS NT NU ON PE QC SK YT
Page 110
Tracking - XML
7/11/2011
Appendix F Tracking Request Options

When requesting tracking information, applications may use the RequestOption field to indicate the specific types of information they wish to receive. The table below lists the possible values for the RequestOption and the types of tracking information each value represents. Request Option
0 1 2 3 4 5 6 7 'activity' 'none' blank or empty
Proof of Delivery
COD Info
Receiver Address
All Activity
X
Last Activity
X
X X X X X X
X X X X X X
X X X X
X X
X X X X X
Page 111
Tracking - XML
7/11/2011
Appendix G- Shipping and Tracking Numbers for Testing

UPS has set aside several shipping and tracking numbers to help developers test their applications. These special numbers are only valid with the Customer Integration Environment at wwwcie.ups.com. The following tables lists those special numbers and describes the results that developers should expect when attempting a TrackRequest. When using the Customer Integration Environment with tracking numbers other than those designated for testing, the numbers will be evaluated as production tracking numbers. Table 1 Numbers to be used for Tools
Type Tracking Tracking Value 1Z12345E0291980793 1Z12345E6692804405 1Z12345E0390515214 (Second Package: 1Z12345E0393657226) 1Z12345E1392654435 1Z12345E6892410845 1Z12345E029198079 1Z12345E1591910450 990728071 3251026119 9102084383041101186729 cgish000116630 Option Activity (All) None (Last) Service 2nd Day Air World Wide Express Ground Next Day Air Saver Next Day Air Saver Response Delivered Delivered
Shipping
None (Last)
Delivered
Tracking Tracking Tracking Tracking Tracking Tracking MI Tracking Number MI Reference Number
None (Last) Activity (All) None (Last) None (Last) Activity (All) Activity (All) None (Last) None (Last)
Transit 2nd Delivery attempt Invalid Tracking Number No Tracking Information Available
UPS Freight LTL
Delivered Delivered Origin CFS
Table 2 Numbers to be used for Web services

Type Tracking Value 1Z12345E0205271688 (Signature Availability) Option Activity (All) Service 2nd Day Air Delivered Response
Page 112
Tracking - XML
7/11/2011
Type Tracking
Value 1Z12345E6605272234 1Z12345E0305271640 (Second Package: 1Z12345E0393657226) 1Z12345E1305277940 1Z12345E6205277936 1Z12345E020527079 1Z12345E1505270452
Option None (Last)
Service World Wide Express Ground Next Day Air Saver Next Day Air Saver Delivered
Response
Shipping
None (Last)
Delivered
Tracking Tracking Tracking Tracking
None (Last) Activity (All) None (Last) None (Last) Activity (All) Activity (All) None (Last) None (Last)
Transit 2nd Delivery attempt Invalid Tracking Number No Tracking Information Available
Tracking
990728071
UPS Freight LTL
Delivered
Tracking MI Tracking Number MI Reference Number
3251026119 9102084383041101186729 cgish000116630
Delivered Origin CFS
Page 113
Tracking - XML
7/11/2011
Appendix H - Frequently Asked Questions: Tracking
API Tracking
Category HTML Reference Tracking
Tracking
Scan Types
Tracking
Tracking
Scheduled Delivery Date (SDD) and Rescheduled Delivery Date (RSD) Tracking
Question I would like to use the HTML Tracking API. We have multiple account numbers. Do we have to know and pass the origin UPS Account Number even if all accounts are listed in their MYUPS.com profile that is associated with their access key? Does a scan type display when a driver scans a Pickup Summary Barcode (PSB) in the Tracking API? Does the Tracking API provide a Scheduled Delivery Date?
Answer Sender shipper account number is an optional field in the tracking of a reference number with the HTML API. This is to narrow down the possible results as one reference number can correspond with many candidate shipments. If this field is used the country should also be included. For tracking 1Z or PTN tracking numbers, the HTML request does not include their accounts in their MyUPS profile.
UPS receives PSB scans at the shipment level (when available), but we don't display the information within our tracking systems. Yes. ScheduledDeliveryDate container described within the Developer Guide. If the SDD changes then a date is returned within the RescheduledDeliveryDate container.
What is the UPS Tracking API and Signature Tracking API?
Tracking
Tracking
How much does the UPS Tracking API cost? What is the difference between Tracking API and Signature Tracking API? Can I track freight shipments with UPS Tracking API?
Tracking
Tracking
Tracking
Tracking
UPS Tracking API is an Internet-based 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. The APIs are: 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. UPS Tracking API is free to license. There are no hidden fees or charges, though you may require IT resources or 3rd party developers depending on how complex your integration application is. Basically the Tracking and Signature Tracking API is the same, with the exception for authorization to see full Delivery address, 'delivered to' name, and Signature image. Yes. Consult the developers guide for the appropriate XML request.
Page 114
Tracking - XML
7/11/2011
API Tracking
Category Tracking
Question Is Pre Pickup Visibility available when tracking freight shipments with UPS Tracking API Can I use Tracking information in a Frame on my own site? Why can't I see my freight reference number in the XML response? Why is the Tracking Online Tools now called UPS Tracking API? Could my Tracking API license be revoked? Why am I not receiving a response on my tracking number that I just created? Information unavailable.
Tracking Tracking
Tracking Tracking
Answer No. UPS Freight must bill the shipment before information is passed to UPS.com or QVM. UPS has a rule that header information must be established before the shipment can be displayed. Header information is established at the billing point, and that usually occurs the night of the shipment. UPS strongly discourage the use of Framed information. See the UPS.Com Terms and Conditions accepted by all registered users. The Tracking API supports 2 reference numbers per freight shipment. However, freight shipments may contain many more reference numbers, the API is limited to 2. Online Tools described many different APIs. UPS Tracking API describes the Tracking API and registering for it is now simple and easier to use. UPS retains the right to revoke an access key or block access from any user that abuse the tracking system. If a shipment was created with the UPS Shipping API, UIS or UIFS, do not attempt to track it immediately because it will not be available until 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. To add shipper account for Signature tracking the user can access myUPS on UPS.Com by logging 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) All modes of transport are available within the Tracking API for; package, LTL Freight, Air Freight, and Ocean Freight. Yes, we display tracking info for BASIC on ups.com and in XOLT just like for any other small 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 small 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
Tracking Tracking Tracking
Tracking Tracking Tracking
Tracking
Tracking
How do I add shipper accounts for authorization to Signature Tracking API? What transport modes are available within the Tracking API? Does the Tracking API support Basic service?
Tracking Tracking
Transport Modes Basic tracking
Page 115
Tracking - XML
7/11/2011
API Tracking
Category Reference Number Tracking
All
API availability
Question If a customer processes 7 packages in one shipment will reference number tracking in the Tracking API play-back all seven packages or just the lead package or any one of the packages in some type of order? Within what countries are the Developer APIs available?
Answer You can track a shipment through reference 1 or reference 2 only. When tracking a multiple-piece shipment if you use the lead number it will show you the information for all the packages within that shipment however, if you track with other than the lead number it will only show the tracking information for that individual package.
The Developer APIs are available in the countries listed at ups.com by API and by country under the UPS Developer Kit - Developer APIs. Click on any particular API to go to the API page and scroll to the bottom of the page to get the country listing for that particular API. Customers are not routinely provided these UPS shield graphics without having a design/layout submitted to UPS Brand Management for approval. The customer needs to visit: https://www.upsbrandexchange.com/brandHome.awsp This site will take them through the process for downloading a limited set of sample images for layout, and how to secure an approval for customer use, as well as the high-resolution graphics. No. XPCI stands for XML Package Carrier Interface (XPCI) and defines a vocabulary and structure for describing packages, shipments, and the activity details for package carriers and their customers. XPCI is a set of DTDs that defines the terminology, transaction enveloping, and XML message definitions. For a client to be XPCIcompliant, the client must generate a well-formed XML message that validates against the XPCI DTDs. Several DTDs, organized into three categories, define XPCI: Vocabulary This DTD defines the basic business vocabulary of XPCI. All tags used in a message are defined in this DTD. Interchange This DTD defines the transactionenveloping scheme. Every message includes transaction information. Message Each message has an associated DTD that defines the vocabulary of the message. The version and date would have been related to versioning however the APIs were not versioned so they
All
UPS Logos High Resolution
How do I get access to higher resolution logos than what are available within the downloads for the UPS Developer Kit Developer APIs?
All All
Technical Support email form Technical Support email form
Is XPCI a required field within the email support form? From where is XPCI version number obtained and what does it mean?
Page 116
Tracking - XML
7/11/2011
API
Category
Question
Answer currently do not carry significance. They remain as part of the APIs so that in the event they are versioned, we have these elements just in case.
All
Technical Support Characters
How do I get technical support for the APIs at ups.com? Can Japanese Kanji character be recognized by UPS Developer APIs? Do any of the Developer APIs support Basic service?
Go to the Developer Resource Center and select email support under the UPS Developer Kit Support Column. No.
All
All
Basic
No. Basic is not supported within the Rating or Shipping APIs but is supported within the Tracking API available within the UPS Developer Kit - Developer APIs.
All
System DownTimes
Are there any designated system down times for the Developer APIs?
Yes. The overall reserved downtime for the CGI servers is Saturday 10:00 PM ET through Sunday 12:00 PM ET. However, often the window is shortened to two 15 minute intervals with one starting at 11:00 PM and the other occurring sometime between 01:00 AM and 03:00 AM ET Sunday morning for most weekends. The back end goes through numerous updates typically beginning at 11:00 PM Saturday through 4:00 AM Sunday. Typically traffic is handled in such a way that there is very little impact to customers, and any impact which does occur does so in the small 15 minute intervals mentioned previously. Having said this as this entire time is reserved for maintenance we inform customers of the possibility of experiencing issues throughout this time period so that if there are any issues which occur during maintenance we have a time window to troubleshoot and perform measures to resolve. On Sunday, the maintenance is really relegated to just ABR and freight. No. All Web Services are XML based. This is described in the section 'UPS OnLine Tools Technologies' of every developer's guide
All
ASMX
Are the Web Services versions of the APIs ASMX based?
Page 117
Tracking - XML
7/11/2011
API All
Category Web Services Empty folders within the documentation zip file.
All
Pointing to the wrong URL for API
Question The ship_dev_guide and Ship_Reference_guide folders have some sub folders that look like they should contain some code examples / samples but they are all empty? XML_Samples Visual_Basic Code_samples All empty? I keep getting, "XML document is well formed but the document is not valid." error message. What am I doing wrong?
Answer Unfortunately code samples are not provided with the Shipping API - Web Services version. The reason being is that a WSDL is included which provides all of the necessary information needed to successfully implement the API. These folders are typically utilized in the XML version of the APIs as there is no WSDL present. If the customer wishes to view the samples contained in the Shipping API they can download the documentation by logging into UPS.com, navigating to the UPS Developer Kit, and then clicking on the Shipping API link. The "XML document is well formed but the document is not valid" error message is generally returned when an element in the XML request does not adhere to the formatting defined within the Xpath section of that API's developer guide. When the API returns this error it indicates the field which is not valid in the ErrorLocationElementName element in the XML response. When we test the XML provided by you earlier in this email chain we are able to receive a successful response. This would indicate that you may be posting to an incorrect URL. The error message returned from the API should have contained a line similar to the following: <ErrorLocationElementName>XPATH TO FIRST ELEMENT WHERE XML DOESNT MATCH EXPECTED FORMAT</ErrorLocationElementName> As previously stated, this element is included in the XML error response to point you to the element of the posted request which is not valid for the Tool. When further clarification is needed you can look up the element in question in the Xpath section of the Developer Guide for the particular API. If this element lists another APIs request such as TrackRequest it would indicate that you are posting to that APIs URL and need to adjust the URL you are sending your XML to. Yes. Phone support is provided at 1st Level only and for basic API questions. This includes integration questions and production questions. However, customers questions that cannot be answered verbally will be directed to the email support form at ups.com to escalate to 3rd level via email. Phone Support Hours: MON-FRI 07:30 AM 09:00 PM EST SAT-SUN 09:00 AM 06:00 PM EST 877.289.6420
All
Phone Support
Is phone support provided for the UPS Developer Kit Developer APIs? If so, what is the number and what are the hours of operation?
Page 118
Tracking - XML
7/11/2011
API All
Category Examples of API Implementations
Question Are there any examples of implementations that we can review to understand how best to utilize the APIs?
Answer We do not share customer implementations of our tools amongst customers. On occasion we do post case studies on ups.com and articles in customer-facing newsletters, but that is only after gaining permission from the customer and working with Legal, Customer Communications, etc. Please understand that the XML tool is only data, which is transparent to the end user. How the developer implements the tool and presents results back to the end user can vary from web site to web site. These web sites may not highlight the full functionality of the tool. We need to be able to describe the value proposition of the tool without depending on another customers usage. No. We do not currently support PHP or Perl with sample code.
All
Code languages supported
Do the APIs support PHP or Perl with code sample within the Developer Guides or the developer kit zip files?
Page 119

Tracking XML Developers Guide

Uploaded by

Copyright:

Available Formats

Tracking XML Developers Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Tracking XML Developers Guide

Uploaded by

Copyright:

Available Formats

What are the main technologies used in the UPS Developer APIs?

What are the main technologies used in the UPS Developer APIs?

What programming languages are supported for developing client applications?

What programming languages are supported for developing client applications?

Tracking - XML

Tracking XML Developers Guide

1.1 Important Information

Key Legal Requirements for UPS Developer APIs

Consent to Use of UPS Mark

Copyright and Proprietary Notice

1.2 Welcome to the UPS API Developer's Guides

1.2.1 What's New for Tracking in July 2011

1.2.2 How to Use this Guide

1.3 Business Processes and Rules

1.4 Required Steps for Integrating

UPS XML Services 1. 2. 3. 4. 5. 6. 7.

1.5 Planning Your Applications for XML

1.5.1 UPS Developer API Applications

1.5.2 Licensing the UPS Developer APIs

1.5.2.1 Branding Requirements

1.5.3 Developing Client Applications for Developer APIs

1.5.3.1 Microsoft Visual Studio

1.5.3.2 Java Standard Edition and Enterprise Edition

1.5.3.3 Open Source

1.5.4 Getting Technical Support

1.5.4.1 Within the United States

1.5.4.2 Outside of the United States

1.5.5 Testing and Deploying Applications

1.5.6 Keeping Up-to-Date

1.6 UPS Developer API Technologies for XML

1.6.1 Hypertext Transfer Protocol and Secure Sockets Layer 3

1.6.2 Working with HTTP and SSL in Application Programs

Figure 3. URLs identify communication protocols, servers, and specific services.

1.6.2.1 Microsoft Visual Studio

' server's response will be available in oXMLHttp.responseXML

1.6.2.2 Java Standard Edition and Enterprise Edition

1.6.2.3 Open Source

curl_easy_setopt(curl, CURLOPT_URL, https://www.server.com/path"); curl_easy_setopt(curl, CURLOPT_POSTFIELDS, requestString); curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, fnCallback);

1.6.3 Extensible Markup Language (XML)

1.6.4 Working with XML in Application Programs

1.6.4.1 Microsoft Visual Studio

Else ' Do something with node.text End If

1.6.4.2 Java Standard Edition and Enterprise Edition

1.6.4.3 Open Source

1.7 Understanding XML Tracking Services

1.7.1 Identifying a Package or Shipment to Track

1.7.1.1 Tracking Numbers

1.7.1.2 Shipment Identification Numbers

1.7.1.3 Reference Numbers

1.7.1.4 PRO numbers and Air Waybill numbers

1.7.1.5 Candidate Bookmarks

1.8 Tracking Reference

1.8.1 Authenticating Client Applications

Example TrackResponse Message:

1.8.3 Track Request

Container for the root Track Request

Container for the Track Request

Not Used. The Unique TransactionIdentifier for a given transaction.

Current Tracking Tool Version.

Indicates the action to be taken by the XML service.