Shipping Package – WebServices

7/09/2012

Shipping Package
Web Services
Developers Guide
July 9, 2012

© 2012 United Parcel Service of America, Inc. All Rights Reserved.

Confidential and Proprietary Page 1
Shipping Package – WebServices 7/09/2012

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 2012 United Parcel Service of America, Inc. All Rights Reserved.
Trademarks
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.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 2
Shipping Package – WebServices 7/09/2012

Table of Contents

1.1 Important Information...............................................................................................................5

1.2 Welcome to the UPS API Developer's Guides..........................................................................6
1.2.1 Release features ........................................................................................................................6
1.2.2 How to Use this Guide .......................................................................................................11
1.3 Business Processes and Rules...................................................................................................11
1.4 Required Steps for Integrating Web Services ........................................................................12
1.5 Planning Your Applications for Web Services.......................................................................12
1.5.1 WebServices Applications .................................................................................................12
1.5.2 Licensing the UPS Developer API WebServices .............................................................14
1.5.2.1 Branding Requirements...............................................................................................15
1.5.2.2 UPS Review of Applications ........................................................................................15
1.5.3 Developing Web Services Clients .....................................................................................15
1.5.4 Getting Technical Support ................................................................................................18
1.5.5 Keeping Up-to-Date ...........................................................................................................20
1.6 UPS Developer API Technologies for WebServices ..............................................................21
1.6.1 Extensible Markup Language (XML)..............................................................................21
1.6.2 Simple Object Access Protocol (SOAP) ...........................................................................22
1.6.3 Web Services Definition Language (WSDL) ...................................................................23
1.6.4 Securing Web Services ......................................................................................................25
1.6.5 Indicating Errors in Client Application Requests ..........................................................28
1.7 Understanding Shipping Web Services...................................................................................29
1.7.1 What Shipping Services Can Do.......................................................................................29
1.7.1.1 Shipments .....................................................................................................................29
1.7.1.2 Cancellations (Voids)...................................................................................................29
1.7.1.3 Returns .........................................................................................................................30
1.7.2 How Shipping Services Work ...........................................................................................30
1.7.2.1 Two-Stage Shipments and Returns .............................................................................30
1.7.2.2 Single-Stage Shipments and Returns ..........................................................................31
1.7.2.3 Cancellations (Voids)...................................................................................................31
1.8 The Shipping WebServices Reference ....................................................................................33
1.8.1 Shipping Web Service........................................................................................................33
1.8.1.1 Overview .......................................................................................................................33
1.8.1.2 Shipment Operation .....................................................................................................33
1.8.2 Shipping Web Services Schema ............................................................................................34
1.9 The Void Web Services Reference.........................................................................................254
1.9.1 Void Web Service.............................................................................................................254
1.9.1.1 Overview .....................................................................................................................254
1.9.1.2 Shipment Operation ...................................................................................................254
1.9.2 Void Web Services Schema .................................................................................................255
1.10 Customer Integration Environment....................................................................................259
1.10.1 Negotiated Rates.............................................................................................................259

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 3
Shipping Package – WebServices 7/09/2012

1.10.2 Testing and Deploying Applications.............................................................................259

1.10.2.1 System Availability ...................................................................................................259
1.10.2.2 Server Availability Check.........................................................................................259
1.10.3 UPS Product Exchange Service ........................................................................................260
1.10.4 Production Access ..............................................................................................................260
1.10.5 Label Verification for Contract Services .........................................................................261
1.10.6 Other Shipping Tools.........................................................................................................262
1.10.6.1 Voiding Package Shipments ....................................................................................262
1.10.6.2 System Availability ...................................................................................................262
Appendix A- Accessing Tech Support (US Site Example) ........................................................264
Appendix B - Shipping WebServices Error Codes ....................................................................267
Appendix C - Void Shipment Web Services Error Codes.........................................................285
Appendix D – Common error codes for all webservices ...........................................................287
Appendix E - Country Codes .......................................................................................................288
Appendix F - Currency Codes .....................................................................................................295
Appendix G - Service Codes.........................................................................................................302
Appendix H - Reference Number Codes.....................................................................................304
Appendix I- International Forms Preference Criteria ..............................................................305
Appendix J- Hong Kong District Codes......................................................................................307
Appendix K- Export License Exception Codes ..........................................................................310
Appendix L- Sample Shipping and Return Labels....................................................................311
Appendix M- Shipping and Tracking Numbers for Testing.....................................................313
Appendix N- Valid Language-Dialect combination for PreAlertNotification.........................314
Appendix O – Valid Origin/Destination Combinations: for DC, DC-SR, and DC-ASR
Accessorials....................................................................................................................................315
Appendix P- Paperless Invoice Supported Countries................................................................316
Appendix Q- Paperless NAFTA Supported Countries..............................................................317
Appendix R- License exception code Possible values: Shipping API – Package.....................318
Appendix S - Frequently Asked Questions: Shipping API – Package .....................................319

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 4
Shipping Package – WebServices 7/09/2012

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.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 5
Shipping Package – WebServices 7/09/2012

Copyright and Proprietary Notice

In your application and any POD Letters you prepare you must include a prominent
reproduction of UPS’s copyright and proprietary notices in a form and format specified by
UPS (See 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 users—running your applications or visiting your web
site—can have up-to-the-minute access to UPS services.
1.2.1 Release features

Release New Features

Jul. 2011 The UPS Returns Exchange service combines delivery and collection into one
movement. It is a contractual service which combines delivery and pickup
service for single-piece, single-part shipments. The UPS Returns Pack and
Collect Service allow customers to initiate next day collections where UPS
provides the return packaging.

UPS Customers that may find value in this new service include shippers in the
high-value, high-tech, healthcare and retail business segments and are in need
of improved reverse logistics processes because they are currently facing the
challenges where shipper have difficulty collecting the exchange package and
customers do not have the correct packing materials.

Systems that support UPS Returns® Exchange will be capable of

producing two distinct Additional Routing Instruction text fields:

1. For the base case of like-product for-like product exchange, the

printed text on the label will be:

EXCHANGE – LIKE ITEM ONLY (Default option)

2. For all exchanges that are not like-for-like, printed text on the label
will be:

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 6
Shipping Package – WebServices 7/09/2012

Release New Features

EXCHANGE – DRIVER INSTRUCTIONS INSIDE

Both services are available in Canada, China, Europe, United States, and a
number of other countries both for origin and destination services (please see
appendix or UPS Rate and Service Guide).

These services enable reverse logistics for shippers of high-value, high-tech,

healthcare, and retail products. These services allow such shippers to
effectively manage the direct exchange of products (old for new) for products
that have warranty/maintenance agreements with their customers. Following
the linkage between the Exchange outbound and Exchange return shipments
an Alternate Tracking number will be passed when the package is tracked.

Note: There are no guarantees for the service other than the service level
chosen for transportation movements.
Dry Ice Overview
Coolants and refrigerants which are used to keep temperature-sensitive
products cold or frozen while in transit. Dry ice (frozen carbon dioxide) and
gel packs are the most common types of coolants / refrigerants used for
transport. This type of shipment must be marked as "Dry Ice" and its medical
purpose noted.

Please refer to UPS.com to review the rules, for Preparing Dry Ice Shipments
under IATA or 49 CFR.

Thermal Format Support

Shipping receipts for Print Return Label, Exchange Return, and Import
Control – Print Return Label shipments can be printed in thermal format.

Display of Rate Type

Introduction of “RateChartIndicator” element in the request. Response will
contain “RateChart” element only when it was explicitly requested by
providing “RateChartIndicator” in the request. List of valid values of
“RateChart” in response are: {1, 3, and 4}. Please refer details of these codes
for different regions in XPath column of these elements.

UPS Paperless Invoice

There is a new ‘override’ indicator that will remove a commercial invoice or
NAFTA/CO from each shipment request for an enabled Paperless account

The UPS Paperless Invoice product will be expanded to include North

American Free Trade Agreement Certificate of Origin (NAFTA C/O) for
international Small Package.

The Paperless Invoice and Paperless NAFTA C/O shipper will be allowed to

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 7
Shipping Package – WebServices 7/09/2012

Release New Features

print copies of their electronic documents at the time of shipping.

Returns Flexible Access and Carbon Neutral

UPS Returns Flexible Access will now have available Carbon Neutral feature
for the Shipping API and will be available for Returns Flexible Access
shipments within the United States and Puerto Rico

International Rate, Zone, and Service Updates

Rate, Zone, and Service changes for International include the following
updates:
 The following currency changes –
 Estonia from Kroon to Euros
 Cameroon from Franc to US Dollars
 Ghana from Pesewas to Ghana Cedi
 New WorldWide Express Plus service
 WorldWide Express destinations will be expanded
 Expansion of 10/25kg boxes to new destinations in Japan
 Expand Domestic Services for Croatia and Asian markets
 Support Freight Collect billing option available for services to and
from Nigeria
 Support Free Domicile billing option offered to Qatar as a destination
only
 New postal code format of 4 numeric digits for Tunisia (TN): NNNN
(N=Numeric, numbers only, no spaces, no special characters,
maximum and minimum length = 4; the postal code is required).
 Support Freight Collect Billing Option for Tanzania (TZ) and
Macedonia (MK) from Origin countries that support Freight Collect.

Jan. 2012 Global Expansion of Residential Surcharge

Canada and US50 will be valid destinations for Residential Surcharge for all
Services and all Bill Terms, regardless of the origin country.

Paperless Invoice Enhancements

 Allow for shipping systems to provide a Commercial Invoice
declaration statement of up to 550 characters
 Allow for Paperless Invoice to be turned off by shipment
 Ensure that paper Blanket NAFTA C/O “From” and “To” dates is not
greater than a 365 day range.
o The system will now return an error if the date range is
greater than 365 days.
 For paper / paperless NAFTA C/O, disallow the value of “Unknown”
in the Producer field
 New Request tag <Exclude from form>, to exclude products from the
Invoice on the NAFTA form but it must include at least one product
from invoice

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 8
Shipping Package – WebServices 7/09/2012

Release New Features

Eliminate Account Based Rates (ABR) Setup

 To streamline your ability to view your negotiated rates through the
Shipping API, UPS has implemented a new process that no longer
requires you to wait for a UPS Sales Person to activate your account.
o Simply add a UPS Account to your myUPS ID Account
Summary as you previously would and your account will be
activated automatically for negotiated rates provided you have
a contract with UPS.
o Remember to select the “Negotiated Rates Indicator” within
the XML Request to have your negotiated rates returned
within the response.

UPS Developer Kit Enhancements

Improvements to the UPS Developer Kit, a collection of Application
Programming Interfaces (APIs) that allow customers to integrate UPS
functionality directly into their business systems and web sites.
 Improved e-mail technical support – Response times for e-mail
technical support have been reduced from 24 hours to 4 hours during
normal business hours, Monday – Friday, 8:00 AM – 9:00 PM EST.
E-mail technical support can be accessed via the UPS Developer
Resource Center
 UPS Developer Kit Community – This Community allows developers
using the UPS Developer Kit APIs to access and share information
and can be accessed through the UPS Developer Resource Center
 Expand sample code languages to include PHP and Perl in the
Developer Kit

International Rate, Zone, and Service Updates

Rate, Zone, and Service changes for International include the following
updates:
 Add Zones for Argentina & Brazil Domestic Saver Service
 Expand Domestic Express Saver to Dominican Republic
 Expand Saturday Delivery accessorial to South Korea
 Expand Split Duty/VAT (SDV) Billing Option to China, New
Zealand, Nepal, Bangladesh, Sri Lanka, and Macau
 Remove Split Duty/VAT (SDV) Billing Option from Argentina,
Brazil, Chile, Dominican Republic, Mexico and Puerto Rico
 Remove Domestic Express Plus to and from Norway (NO) and
Finland (FI)

UPS Label Delivery

Update CSC phone numbers and toll call surcharges/rates for France and
Germany to the Label receipt for Label Delivery
July 2012
1. New Air Freight support for shipping and rating using the Gemini APIs.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 9
Shipping Package – WebServices 7/09/2012

Release New Features

2. Expansion to 14 new Americas countries.

 Bahamas (BS), Bermuda (BM), Bolivia (BO), Cayman

Islands (KY), Columbia (CO), Ecuador (EC), El Salvador
(SV), Honduras (HN), Nicaragua (NI), Paraguay (PY), Peru
(PE), Uruguay (UY), US Virgin Islands (VI), Venezuela (VE)

UPS Label Delivery: Labels and Receipts are supported in local language for
the above mentioned countries.

Lables and Receipts are supported in Local languages for Bulgaria, Estonia,
Greece, Latvia, Lithuania

3. Improved email Technical Support hours and response time as follows:

a. 1st Level Email Tech Support -

 Hours of operation for 1st Level Email Tech Support: 7:30am

to 9pm EST Monday through Friday and 9am to 6pm EST
Saturday and Sunday. The desk is closed on UPS Holidays.

 1st Level Email Tech Support email response time is planned

to be within 4 business hours of the initial request. Business
hours are defined as hours of operation of the tech support
desks when service technicians are working.

b. Escalation Tech Support -

 If you receive an email that your case log has been escalated
the following hours apply

 Hours of operation: 8am to 8pm EST Monday through

Friday. The desk is closed weekends and on UPS Holidays.

 Escalation Support desk response time is planned to be within

24 hours during normal hours of operation.

For more details please download and review the latest updated
Developer Guides.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 10
Shipping Package – WebServices 7/09/2012

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

 When registering for the Shipping API, a customer must either have an existing account number
or open a new account (instructions w/ screen shots noted in separate doc)
 In order to add an account number to your MyUPS ID for the US and CA, you must have your
Invoice Level Control ID and a Plan level Control ID, UPS Account Number, Country, Amount
due and date of invoice for authentication.
 You can void a shipment from the following origin countries: US, PR and CA, no restrictions
on destinations
 Date is not an element in the Shipment portions of the request… Date is an element in Pickup
portion and can be a future date…effective Jan2010 this option will only be available through
the Pickup API
 Shipping API does not have a tag to support the Electronic Export Information (EEI) for the
Shipper's Export Declaration (SED); a customer may manually enter the Employer
Identification Number (EIN) on the label.
 Must have UPS 6 digit account numbers in MyUPS profile to be able to bill to that account
number.
 Only the first AddressLine is printed for ShipFrom section on the label. Address Line 1, 2 and 3
will be printed on the label for the ShipTo Address if provided in the request

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 11
Shipping Package – WebServices 7/09/2012

1.4 Required Steps for Integrating Web Services

The required steps for integrating the UPS APIs are listed here for UPS XML Services.

UPS Web Services

Details for accessing UPS Developer API Web Services are defined within Web Services Definition
Language (WSDL) files that are part of the UPS Developer Kit. Most modern development
environments include support for automatically importing WSDL files and generating skeleton code
to access the services. Although the specific details depend on the particular development
environment, the general procedure is as follows.
1. Review the UPS Technology Agreement available at www.ups.com. This agreement requires that
you follow certain procedures and practices in using UPS Developer API Web Services.
2. Import the WSDL files into the development APIs of choice. Depending on the specific API, this
step will result in skeleton code (such as Java or C# classes) for accessing the Web Services
3. Add your functionality specific to your application and/or web site to the skeleton code.
4. Test your application and/or web site using the designated UPS staging environment.
5. If you are a UPS Ready developer, review your application with UPS.
6. Deploy your application for your customers.
7. Ensure the UPS Shipper Account number is added to the user’s profile. This can be done
at myups.com.

1.5 Planning Your Applications for Web Services

Planning is a key part of any successful development activity, and UPS WebServices applications
are no exception. This section helps that planning by describing the important activities of any UPS
WebServices 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 WebServices Applications

Many different types of applications can take advantage of WebServices. 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.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 12
Shipping Package – WebServices 7/09/2012

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 13
Shipping Package – WebServices 7/09/2012

The UPS Developer APIs can be implemented withal of these types of applications and
many others. Virtually any software that needs instant, up-to date access to UPS services
can take advantage of UPS Developer APIs.

1.5.2 Licensing the UPS Developer API WebServices

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 API WebServices are integrated into your specific e-commerce
web site or enterprise application, you must adhere to appropriate usage requirements.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 14
Shipping Package – WebServices 7/09/2012

1.5.2.1 Branding Requirements

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

1.5.2.2 UPS Review of Applications

If you distribute your application as software, please provide UPS access to, or a copy of,
your application (and/or any updates). If you host your application for the benefit of others,
please provide the Uniform Resource Locator (URL) for each location of your application.
If you build your own application, UPS might request the URL in order to review your
application. UPS may review each application for compliance with the UPS Technology
Agreement. See the Customer Integration Environment chapter for more information on the
certification process.

1.5.3 Developing Web Services Clients

The UPS Developer API Web Services rely on standard Web Services technology that is
supported by a wide variety of software development platforms. Those platforms vary from
pure open source environments such as Apache Axis (see Figure 5) to commercial products
from vendors such as Microsoft (Figure 6). Other development API that support Web
Services development include BEA WebLogic, Sun’s NetBeans, and products from both
major systems vendors including IBM and Hewlett-Packard and smaller, specialized
vendors such as Altova, Cape Clear, and Stylus Studio. Many nontraditional environments
such as Microsoft Office and Adobe Acrobat also include support for Web Services.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 15
Shipping Package – WebServices 7/09/2012

Figure 5: The Eclipse Web Tools Platform (WTP) project provides support for Web Services in a Java
development environment.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 16
Shipping Package – WebServices 7/09/2012

Figure 6: Microsoft's Web Visual Developer 2009 can create client applications for Web Services.

With any particular development environment, key parts of the development process will be
similar or the same. Web Services development relies on a technology known as Web
Services Definition Language (WSDL). This technology is a formal language based on the
Extensible Markup Language (XML). WSDL precisely and completely describes Web
Services, and standard Web Services documents themselves by “publishing” one or more
WSDL files. The UPS Developer APIs support three different Web Services, each of which
it documents in a separate WSDL file. These WSDL files are included in the UPS
Developer Kits, and can be imported directly into a software development environment.
Note, though, that the default behavior of some API is to retrieve WSDLs from a central
repository accessible on the Internet, most often the Universal Description, Discovery and
Integration (UDDI) at http://uddi.xml.org/. UPS does not publish its WSDLs through these
repositories. As a result, the development tool should be directed to import the WSDL
locally rather than through a public directory.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 17
Shipping Package – WebServices 7/09/2012

1.5.4 Getting Technical Support

Technical Support (U.S.)

There are four channels for obtaining support for the UPS Developer Kit (UDK) APIs all of which
are accessed through the UPS Developer Resource Center at the following link:

http://www.ups.com/content/us/en/resources/techsupport/developercenter.html?WT.svl=SubNav

Or by following these steps:

1. Go to www.UPS.com.
2. Mouse over the Support tab and select Technology Support
3. In the left navigation panel of the page select the link “Developer Resource Center”.

 Email Technical Support – available in the right hand column on the UPS Developer
Resource Center web page. This is the support channel for technical support and questions
regarding API integration. It is accessed by logging in to myUPS and attaching your XML
Request/Response files and any other pertinent information about your integration [please
see Appendix A for detailed instructions and screen shots]. UPS Email Technical Support
can only support the XML Request/Response pair. They cannot consult customers and
developers on how to integrate the XML into their internal or purchased software.

 UPS Developer Kit Community – available in the right hand column of the UPS Developer
Resource Center web page. This is a community forum for developers to answer one
another’s questions and share information therefore the response times may be slower. If
you have an immediate need for technical support contact UPS Email Tech Support above
and they will respond within 4 business hours (see hours below). The remainder of the site
contains online versions of all API developer guides and FAQs.

 UPS Developer Kit Knowledge Base- available in the right hand column of the UPS
Developer Resource Center web page. This is a self-service support .pdf document that can
be opened or downloaded. It contains over 240 frequently asked questions about every
mode and service supported by the UDK APIs. It’s also available in an online version at
the UPS Developer Kit Community.

 General Question Phone Support (U.S. only) – available in the right hand column of the
UPS Developer Resource Center web page. Phone support is the least comprehensive
support mechanism for the developer. This channel of support addresses questions about
the user interface at ups.com and how to gain access to the APIs and navigate the Access
Key request process. They do not provide technical support for XML Request/Response
issues and questions. Those types of questions must go through Email Technical Support.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 18
Shipping Package – WebServices 7/09/2012

Getting Started with Email Technical Support

1. Got to ups.com and log in to myUPS.

2. Hover over the “Support” tab and select “Technology Support”.
3. On the Technology Support page select the Developer Resource Center link from the left
navigation.
4. On the Developer Resource Center page select the “Email UPS” link in the right hand column.
5. Enter all relevant information including name, enter email address, select Support Category
“Technical Support”, and select Support Topic “Developer Resource” [which identifies UPS
Developer Kit APIs tech support]. Click next.
6. Scroll down to the middle of the email form and complete the fields “Your Telephone”, “Stage of
Development”, “Developer Resource” which is which API you are integrating, “Attach File” where
you attach your XML Request/Response Pair, and any pertinent description of the issues in the
“What is your question or comment?” field.
7. Select “Send Email” button.
8. A response is provided that explains someone from UPS will contact you. Please base the response
time on the detailed information listed below about tech support hours of operation and response
times.

(For screen shots of this process please see Appendix A at the end of this guide.)

1st Level Email Technical Support Business Hours and Response Times:

a. Hours of operation for 1st Level Email Tech Support: 7:30am to 9pm EST Monday through Friday
and 9am to 6pm EST Saturday and Sunday. The desk is closed on UPS Holidays.
b. 1st Level Email Tech Support email response time is planned to be within 4 business hours of the
initial request. Business hours are defined as hours of operation of the tech support desks when
service technicians are working.

This means if you submit an email tech support request after business hours the 4 hour response
clock will not begin until the following morning at 7:30am EST M-F and 9am EST Saturday and
Sunday (UPS Holidays excluded).

PLEASE NOTE:
If you are sent an email from 1st Level Email Tech Support stating your case log # has been
escalated, the 24 hour planned response clock starts from the time you receive the email from 1 st
Level Email Tech Support (provided the Escalation Support desk is open). If not, then the clock
will begin when the Escalation Support desk opens.

Escalation Support Business Hours and Response Times:

c. Hours of operation: 8am to 8pm EST Monday through Friday. The desk is closed weekends and on
UPS Holidays.
d. Escalation Support desk response time is planned to be within 24 hours during normal hours of
operation.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 19
Shipping Package – WebServices 7/09/2012

This means if your case log is escalated at 8:30pm on Friday, you will not receive an email
response from the Escalation Support desk at the latest until Monday at 8pm (Saturdays, Sundays,
and Holidays are excluded). Response times are from the time the case log was escalated plus 24
hours which do NOT include the weekends or UPS holidays

There may be some scenarios when the tech support team is meeting planned response times but it
appears as if it’s taking too long. Below is a brief example where the planned response time is met
but nothing happened over the weekend.

Example –
Customer submits tech support email at 7am on Friday. The clock for 4 hour response will not
begin until 7:30am EST for the 1st level tech support team. They respond within 4 hours at
11:30am EST that same Friday stating the case log has been escalated and providing the case log #.

The escalation desk receives the case log at 11:30am EST. They begin work on evaluating the
problem and have planned to either update the customer within 24 hours or solve the problem
within 24 hours. Either way, the customer will hear from the escalation desk within 24 hours with
some type of disposition on their case log. The escalation desk clock begins when they receive a
case log from 1st level tech support during business hours, M-F 8am to 8pm EST. In this case, the
clock begins at 11:30am EST if the escalation desk does not have an answer by 8pm EST on Friday
the desk has until 11:30am EST the following Monday to either provide a resolution or a status
update to the customer on the case log. The Escalation Desk continues work on the case log on
Monday beginning at 8am EST. They receive resolution at 1030am EST Monday and send the
resolution to the customer. The Escalation Desk has met their 24 hour planned response time.

Technical Support (Non-U.S.)

For Non-US countries supported by the UPS Developer Kit follow the instructions in Appendix A.
However, to get to the UPS Developer Resource Center page please complete the following steps.

1. Log in to myUPS for the country from which you downloaded the developer guides.
2. Select the Support tab and in the drop-down select Technology Support.
3. Select from the left navigation the “UPS Developer Resource Center” link.
4. Continue with email form as described above.

Please also note that email response times for non-US requests vary. Translations and escalations
may delay the process. If a quicker response is required, please access the US web site directly and
complete an email technical support form from the US web site.

1.5.5 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

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 20
Shipping Package – WebServices 7/09/2012

e-mail of updates and changes to the Developer APIs. You can return to the UPS Support
area of ups.com for the latest updated information about UPS 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.

To change your profile information, go to UPS.com and log in using your MyUPS.com
User ID.

1.6 UPS Developer API Technologies for WebServices

Web Services are powerful technologies that let business applications in different enterprises
communicate directly with each other. For example, a software application program that processes
orders for a mail order retailer can use Web Services to communicate with software applications at
UPS that automatically schedule the shipment for new orders.
Web Services are governed by standards bodies which include, but are not limited to, W3C and
OASIS. They are not limited to particular vendors and are available to any software application.
Applications created for one environment (such as Microsoft Windows) can seamlessly
communicate with applications in a different environment (such as Linux) without worrying about
incompatibility of the different environments.
Web Services are supported by a wide variety of software development environments, so virtually
all software developers can easily add Web Services features to their applications.
In effect, Web Services create a World Wide Web, but for computer applications instead of people.
With Web Services, communications between enterprises happens rapidly, efficiently, and reliably.
Two technologies make up the core of Web Services—the Extensible Markup Language (XML) and
the Simple Object Access Protocol (SOAP). A third technology, Web Services Definition Language
(WSDL) uses XML and SOAP to define specific Web Services.
This section concludes by describing security and error reporting for Web Services.

1.6.1 Extensible Markup Language (XML)

The Extensible Markup Language (XML) is a standard governed 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. Figure 1 shows how a simple XML
document could describe a book.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 21
Shipping Package – WebServices 7/09/2012

As the figure illustrates, XML distinguishes different parts of a document with labels
known as tags. Tags in the example include <book>, <title>, <author>, <firstname>, etc. In
this example the publisher for the book is John Wiley and Sons.

A great deal of information on XML is available on the Internet. A good starting point is the
World Wide Web Consortium’s main page on XML at http://www.w3.org/XML/.
1.6.2 Simple Object Access Protocol (SOAP)
While XML defines the information that Web Services exchange, the Simple Object Access
Protocol (SOAP) defines the methods that Web Services use to transfer those documents.
The SOAP standard defines several different approaches for sending XML documents, but
most Web Services (including those from UPS) rely on a single approach. That method uses
the Hypertext Transfer Protocol (HTTP) to send a message from a Web Services client to a
server. The server replies in the HTTP response. Figure 2 shows an example of a SOAP
header portion of a web services message.
SOAP, like XML, is governed by the World Wide Web Consortium. More information can
be found on the Internet at the W3C’s XML Protocol Working Group’s page, located at
http://www.w3.org/standards/xml/

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 22
Shipping Package – WebServices 7/09/2012

This security header block provides a mechanism for attaching security-related information
targeted at a specific recipient in the form of a SOAP actor/role. UPSSecurity is a container
element which provides the user access verification for the API Web Service.

<envr:Envelope xmlns:auth="http://www.ups.com/schema/xpci/1.0/auth"
xmlns:upss="http://www.ups.com/XMLSchema/XOLTWS/UPSS/v1.0"
xmlns:envr="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:common="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:wsf="http://www.ups.com/schema/wsf">
<envr:Header>
<upss:UPSSecurity>
<upss:UsernameToken>
<upss:Username></upss:Username>
<upss:Password></upss:Password>
</upss:UsernameToken>
<upss:ServiceAccessToken>
<upss:AccessLicenseNumber></upss:AccessLicenseNumber>
</upss:ServiceAccessToken>
</upss:UPSSecurity>
</env:Body>
</env:Envelope>

Figure 2: A sample of the UPSSecurity header portion of a web services message which structures its
content as an XML document.

1.6.3 Web Services Definition Language (WSDL)

XML and SOAP are general technologies used widely for many different purposes. The
technology that ties them specifically to Web Services is the Web Services Definition
Language (WSDL). Enterprises that make Web Services available to other enterprises
describe those services using WSDL. In effect, WSDL acts a service contract: it defines
exactly what services the enterprise offers and how clients should access those services.
WSDL documents are XML documents which conform to a specific structure. Figure 3
shows a sample WSDL document. The current version of the specification for WSDL
(version 1.1) is available as a draft submitted to the World Wide Web Consortium. It can be
found on their web site at http://www.w3.org/TR/wsdl.
Although WSDL documents, like all XML documents, are ultimately textual information,
they are not primarily intended for humans to read. Instead, WSDL documents are designed
to be read by software applications and application development API. An application tool
such as Microsoft’s Visual Studio can import a WSDL document and automatically
generate software classes that access the Web Services the WSDL defines. Developers then
add these classes to their applications, giving the programs the ability to use Web Services.
Some WSDL documents are published in special directories such as the Universal
Description, Discovery, and Integration (UDDI) registry on the Internet. UPS does not

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 23
Shipping Package – WebServices 7/09/2012

currently publish WSDL documents for UPS Developer APIs in such directories. Instead,
UPS delivers the WSDL documents as part of the software development kit.

<?xml version="1.0" encoding="UTF-8" ?>

<wsdl:definitions name="Track” xmlns="http://schemas.xmlsoap.org/wsdl/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:http="http://schemas.xmlsoap.org/wsdl/http/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
xmlns:error="http://www.ups.com/schema/xpci/1.0/error"
xmlns:common="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0"
xmlns:trk="http://www.ups.com/XMLSchema/XOLTWS/Track/v1.0"
xmlns:tns="http://www.ups.com/XMLSchema/XOLTWS/Track/v1.0/local"
targetNamespace="http://www.ups.com/XMLSchema/XOLTWS/Track/v1.0/local">
<xsd:import namespace="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0"
schemaLocation="common.xsd" />
<xsd:import namespace="http://www.ups.com/XMLSchema/XOLTWS/Error/v1.0"
schemaLocation="error2.xsd" />
<xsd:import namespace="http://www.ups.com/XMLSchema/XOLTWS/Track/v1.0"
schemaLocation="track.xsd" />
<wsdl:types />
<wsdl:message name="TrackInput">
<wsdl:part name="Body" element="trk:TrackRequest" />
</wsdl:message>
<wsdl:message name="TrackOutput">
<wsdl:part name="Body" element="trk:TrackResponse" />
</wsdl:message>
<wsdl:message name="TrackError">
<wsdl:part name="TrackError" element="error:Errors" />
</wsdl:message>
<wsdl:portType name="TrackPortType">
<wsdl:operation name="Track">
<wsdl:input name="TrackRequest" message="tns:TrackInput" />
<wsdl:output name="TrackResponse" message="tns:TrackOutput" />
<wsdl:fault name="TrackError" message="tns:TrackError" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="TrackBinding" type="tns:TrackPortType">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="Track">
<soap:operation soapAction="http://www.wwwcie.ups.com/webservices/TrackBinding"
style="document" />
<wsdl:input name="TrackRequest">
<soap:body parts="Body" use="literal" />
</wsdl:input>
<wsdl:output name="TrackResponse">
<soap:body parts="Body" use="literal" />
</wsdl:output>
<wsdl:fault name="TrackError">
<soap:fault name="TrackError" use="literal" />
</wsdl:fault>
</wsdl:operation>
</wsdl:binding>

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 24
Shipping Package – WebServices 7/09/2012

<wsdl:service name="Track">
<wsdl:port name="TrackPortTypePort" binding="tns:TrackBinding">
<soap:address location="https://www.wwwcie.ups.com/webservices/Track" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>

Figure 3: WSDL documents are specialized XML documents that define Web Services. Example
ONLY.

1.6.4 Securing Web Services

Organizations can offer Web Services using the public Internet, so Web Services standards
provide many options for securing those services. Security options can ensure that only
authorized parties are able to access Web Services, and they can protect confidential
information that may be exchanged as part of Web Services communications. Because the
breadth and depth of security options for Web Services are extensive, this subsection only
describes security features relevant to UPS Developer APIs.
The most basic security services protect confidential information from eavesdropping by
other devices on a network. To provide that protection, the UPS Developer APIs rely on the
Secure Sockets Layer 3 (SSL3) protocol. 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 UPS Developer APIs use is the same
protocol used to secure millions of on-line purchases on the Web.

Figure 4: SSL creates a secure channel across a network and protects confidential
communications using that channel.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 25
Shipping Package – WebServices 7/09/2012

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/webservices/Ship
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.

This is the Verisign Class 3 Secure Server CA - G2 certificate that the client must trust:

-----BEGIN CERTIFICATE-----
MIIGLDCCBZWgAwIBAgIQbk/6s8XmacTRZ8mSq+hYxDANBgkqhkiG9w0BAQUFADCB
wTELMAkGA1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLCBJbmMuMTwwOgYDVQQL
EzNDbGFzcyAzIFB1YmxpYyBQcmltYXJ5IENlcnRpZmljYXRpb24gQXV0aG9yaXR5
IC0gRzIxOjA4BgNVBAsTMShjKSAxOTk4IFZlcmlTaWduLCBJbmMuIC0gRm9yIGF1
dGhvcml6ZWQgdXNlIG9ubHkxHzAdBgNVBAsTFlZlcmlTaWduIFRydXN0IE5ldHdv
cmswHhcNMDkwMzI1MDAwMDAwWhcNMTkwMzI0MjM1OTU5WjCBtTELMAkGA1UEBhMC
VVMxFzAVBgNVBAoTDlZlcmlTaWduLCBJbmMuMR8wHQYDVQQLExZWZXJpU2lnbiBU
cnVzdCBOZXR3b3JrMTswOQYDVQQLEzJUZXJtcyBvZiB1c2UgYXQgaHR0cHM6Ly93
d3cudmVyaXNpZ24uY29tL3JwYSAoYykwOTEvMC0GA1UEAxMmVmVyaVNpZ24gQ2xh
c3MgMyBTZWN1cmUgU2VydmVyIENBIC0gRzIwggEiMA0GCSqGSIb3DQEBAQUAA4IB
DwAwggEKAoIBAQDUVo9XOzcopkBj0pXVBXTatRlqltZxVy/iwDSMoJWzjOE3JPMu
7UNFBY6J1/raSrX4Po1Ox/lJUEU3QJ90qqBRVWHxYISJpZ6AjS+wIapFgsTPtBR/
RxUgKIKwaBLArlwH1/ZZzMtiVlxNSf8miKtUUTovStoOmOKJcrn892g8xB85essX
gfMMrQ/cYWIbEAsEHikYcV5iy0PevjG6cQIZTiapUdqMZGkD3pz9ff17Ybz8hHyI
XLTDe+1fK0YS8f0AAZqLW+mjBS6PLlve8xt4+GaRCMBeztWwNsrUqHugffkwer/4
3RlRKyC6/qfPoU6wZ/WAqiuDLtKOVImOHikLAgMBAAGjggKpMIICpTA0BggrBgEF
BQcBAQQoMCYwJAYIKwYBBQUHMAGGGGh0dHA6Ly9vY3NwLnZlcmlzaWduLmNvbTAS
BgNVHRMBAf8ECDAGAQH/AgEAMHAGA1UdIARpMGcwZQYLYIZIAYb4RQEHFwMwVjAo
BggrBgEFBQcCARYcaHR0cHM6Ly93d3cudmVyaXNpZ24uY29tL2NwczAqBggrBgEF
BQcCAjAeGhxodHRwczovL3d3dy52ZXJpc2lnbi5jb20vcnBhMDQGA1UdHwQtMCsw
KaAnoCWGI2h0dHA6Ly9jcmwudmVyaXNpZ24uY29tL3BjYTMtZzIuY3JsMA4GA1Ud
DwEB/wQEAwIBBjBtBggrBgEFBQcBDARhMF+hXaBbMFkwVzBVFglpbWFnZS9naWYw

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 26
Shipping Package – WebServices 7/09/2012

ITAfMAcGBSsOAwIaBBSP5dMahqyNjmvDz4Bq1EgYLHsZLjAlFiNodHRwOi8vbG9n
by52ZXJpc2lnbi5jb20vdnNsb2dvLmdpZjApBgNVHREEIjAgpB4wHDEaMBgGA1UE
AxMRQ2xhc3MzQ0EyMDQ4LTEtNTIwHQYDVR0OBBYEFKXvCxHOwEEDo0plkEiyHOBX
LX1HMIHnBgNVHSMEgd8wgdyhgcekgcQwgcExCzAJBgNVBAYTAlVTMRcwFQYDVQQK
Ew5WZXJpU2lnbiwgSW5jLjE8MDoGA1UECxMzQ2xhc3MgMyBQdWJsaWMgUHJpbWFy
eSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eSAtIEcyMTowOAYDVQQLEzEoYykgMTk5
OCBWZXJpU2lnbiwgSW5jLiAtIEZvciBhdXRob3JpemVkIHVzZSBvbmx5MR8wHQYD
VQQLExZWZXJpU2lnbiBUcnVzdCBOZXR3b3JrghB92f4Hz6getxB5Z/uniTTGMA0G
CSqGSIb3DQEBBQUAA4GBAGN0Lz1Tqi+X7CYRZhr+8d5BJxnSf9jBHPniOFY6H5Cu
OcUgdav4bC1nHynCIdcUiGNLsJsnY5H48KMBJLb7j+M9AgtvVP7UzNvWhb98lR5e
YhHB2QmcQrmy1KotmDojYMyimvFu6M+O0Ro8XhnF15s1sAIjJOUFuNWI4+D6ufRf
-----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-certificates-
support/index?page=content&id=SO7154&actp=search&viewlocale=en_US&searchid=1308235124970
https://knowledge.verisign.com/support/ssl-certificates-
support/index?page=content&actp=CROSSLINK&id=AR1553
https://knowledge.verisign.com/support/ssl-certificates-
support/index?page=content&id=SO4785&actp=LIST

In addition to protecting confidential information, the UPS Developer APIs also ensure that client
applications are authorized to access UPS customer information. To gain that authorization, client
applications must supply a username, password, and license key in all requests, as the example in Figure 5
shows. UPS corporate applications verify this information before returning sensitive information for the
client applications

<?xml version="1.0" encoding="UTF-8" ?>

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/04/secext"
xmlns:upsa=”http://www.ups.com/XMLschema/XOLTWS/upssa/v1.0
xmlns:common=”http://www.ups.com/XMLschema/XOLTWS/Common/v1.0
xmlns:upss="http://www.ups.com/XMLschema/XOLTWS/UPSS/v1.0"
xmlns:wsf=”http://www.ups.com/schema/wsf”>
<env:Header>
< upss:UPSSecurity>
<upss:UsernameToken >
< upss:Username></upss:Username >
< upss:Password></upss:Password >
</upss:UsernameToken >
<upss:ServiceAccessToken >
<upss:AccessLicenseNumber></upsss:AccessLicenseNumber>
</upss:ServiceAccessToken >
</upss:UPSSecurity>

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 27
Shipping Package – WebServices 7/09/2012

</env:Header>
<env:Body>
<!-- the content of the message goes here -->
</env:Body>
</env:Envelope>

Figure 5: UPS Web Service requests must include a Username, Password, and AccessLicense.

Included in the WSDL files that document the specific Web Services are the appropriate
messages that client applications can use to pass the security credentials as SOAP header
elements. Development tools can import the WSDL document and automatically format the
request messages appropriately.

1.6.5 Indicating Errors in Client Application Requests

When an error occurs in a client application’s request, UPS Developer APIs report that error
using the standard SOAP message format. That message format defines a specific message
type, known as a fault, for error reporting. The essential components of a fault message are
the faultcode, faultstring, faultactor, and detail.
The faultcode element can contain one of four values to indicate the type of error that the
UPS Developer APIs encountered.
 VersionMismatch: The SOAP message that the client application sent used a
version of the SOAP protocol that the UPS Developer APIs could not understand.
 MustUnderstand: The SOAP message that the client application sent included an
element in the header that the UPS Developer APIs could not understand.

 Client: The request that the client application sent was not valid.

 Server: Although the client application’s request did not have any errors itself, the
UPS Developer APIs encountered an error when trying to process it.

The faultstring element contains a textual description of the error.

The faultactor element can indicate which system detected or generated the error. If present,
it contains a Uniform Resource Identifier (URI) for that system.
The detail element contains more information about the error. It includes a specific error
code and a textual description for that code.

Note: UPS encourages application developers

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 28
Shipping Package – WebServices 7/09/2012

to display the description of any unexpected

errors or warnings to the user. This
information can be invaluable when diagnosing
problems, and will normally be required by
UPS Technical Support.
It will be extremely helpful if the developer implements
and maintains logs of all transactions and activity,
including errors or warnings.

1.7 Understanding Shipping Web Services

This section provides an overview of Shipping WebServices. It describes the services available
through the Shipping API, and it explains—at an overview level—how the APIs operate.

1.7.1 What Shipping Services Can Do

The Shipping API makes UPS shipping WebServices available to client applications
that communicate with UPS using the Internet. With this API, applications can
prepare or schedule small package shipments, manage returns, or cancel previously
scheduled shipments.
1.7.1.1 Shipments

Shipping Web Services give your applications many ways to manage the shipment
of small packages to their destination. UPS offers a range of delivery time frames
from same day to standard ground transportation. Shipments may be within the
United States or international, and they may range from letter documents to large
packages. (Note: for freight services, please refer to section on UPS Freight Web
Services.)
UPS also supports many valued added services for shipments, including collect on
delivery (COD), declared value, delivery confirmation, and automatic notification
of delivery status.
For full details on all UPS shipping services, please consult the latest UPS Rate and
Service Guide available at http://www.ups.com. Note that these shipments are
sometimes called forward shipments or outbound shipments to distinguish them
from returns.
1.7.1.2 Cancellations (Voids)

If you need to cancel, or void, a previously scheduled shipment, the UPS Shipping
Services let client applications automate that task.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 29
Shipping Package – WebServices 7/09/2012

1.7.1.3 Returns

The Shipping API also supports UPS returns services. (Note: UPS can provide a
label for a return shipment even if it did not provide a label for the forward
shipment.) With return services, you can post a return label on your website,
include a label in an outbound shipment, ask UPS to email or mail the return label
to your customer, or request a UPS driver to pick up the package at the your
customer’s location. As with forward shipments, details on return shipment services
can be found in the latest UPS Rate and Service Guide at http://www.ups.com.

1.7.2 How Shipping Services Work

Because forward and return shipments share many of the same characteristics (they have an
origin, destination, service type, etc.), UPS APIs use the same procedure and message types
for both services. Cancelling or voiding a shipment requires its own procedure and message
types.
1.7.2.1 Two-Stage Shipments and Returns

For forward and return services client applications may use a two-stage procedure
to process a shipment. As Figure 1shows, the procedure begins when a client
application sends a ShipConfirmRequest to UPS. This request provides details of
the shipment and the desired UPS services. UPS replies to this request with a
ShipConfirmResponse, which completes the first stage of the process.
ShipConfirmResponses include estimated rates for the shipment. If the rates and
services are acceptable to the client, it may move to the second stage by sending a
ShipAcceptRequest to UPS. This message authorizes UPS to charge for the
shipment and process the shipment data. UPS acknowledges the request by
returning a ShipAcceptResponse. For forward shipments and for preprinted return
labels, this response includes a label for the shipment..

1 ShipConfirmRequest

2
Shipping ShipConfirmResponse Client
API Application
3

ShipAcceptRequest
ShipAcceptRequest

4 ShipAcceptResponse

Figure 1. Forward and return shipments may use four separate messages to complete the
shipment processing.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 30
Shipping Package – WebServices 7/09/2012

Clients that want to include preprinted labels as part of forward shipments must
perform this four-step procedure twice. One time processes the forward shipment,
and the second time retrieves the return label.

1.7.2.2 Single-Stage Shipments and Returns

In addition to the two-stage process the previous subsection describes, client

applications may process a forward or return shipment with a single request and
response. With this process, clients will not have the opportunity to review
estimated rates before accepting the shipment. As Figure 2 illustrates, clients invoke
this process with a ShipmentRequest message, to which UPS replies with a
ShipmentResponse.

Shipment
1 Request

Shipping Client
API Internet Application

t Shipment
2
Response

Figure 2. Clients may also process a shipment with a single request and response .

1.7.2.3 Cancellations (Voids)

To cancel, or void, a previously scheduled shipment, client applications send a

VoidShipmentRequest to UPS. As Figure 3 illustrates, UPS replies to this request
with a VoidShipmentResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 31
Shipping Package – WebServices 7/09/2012

VoidShipment
1 Request

Shipping Client
API Internet Application

VoidShipment
2
Response

Figure 3. VoidShipmentRequest messages let client applications cancel a previously scheduled

shipment.
Applications may void forward shipments up to 28 days after initially processing
them. Return shipments must be voided within 24 hours.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 32
Shipping Package – WebServices 7/09/2012

1.8 The Shipping WebServices Reference

This section documents the details of the Shipping Web Services messages, including the requests
that clients send to UPS and the responses that UPS returns.

1.8.1 Shipping Web Service

1.8.1.1 Overview
Service Operations: Shipment, ShipConfirm, ShipAccept

1.8.1.2 Shipment Operation

Type: Request-Response (client sends a request to UPS, and the UPS server replies
with a response)
SOAPAction Header: https://wwwcie.ups.com/webservices/Ship

Note: The Shipment Operation is a single pass way to create a shipment and
generate all the accompanying documents and labels. With a single transaction
which sends a ShipmentRequest and receives the ShipmentResponse, the shipment
is complete.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 33
Shipping Package – WebServices 7/09/2012

1.8.2 Shipping Web Services Schema

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
One
Yes

N/A
ShipmentRequest /ShipmentRequest

container
One
Yes

N/A
Request /ShipmentRequest/Request Request Container N/A
Optional Processing.
nonvalidate = No address
validation. validate = Fail on
failed address validation.
Defaults to validate. Note:
Full address validation is not
performed. Therefore, it is
the responsibility of the
Shipping Tool User to
ensure the address entered
1...15
string
One
Yes

is correct to avoid an Values blank, validate, or

RequestOption /ShipmentRequest/Request/RequestOption address correction fee. nonvalidate.
Container

TransactionReference
One

N/A

/ShipmentRequest/Request/TransactionRefer identifies transactions

No

TransactionReference ence between client and server. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 34
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The client uses
CustomerContext to
synchronize
request/response pairs. The
client establishes
CustomerContext, which can
contain any information you

1...512
want, as along as it is valid

string
One
/ShipmentRequest/Request/TransactionRefer XML; it is echoed back by

No
CustomerContext ence/CustomerContext the server. N/A

container
Refer to the Shipment
container table for the

One
Yes

N/A
elements under Shipment
Shipment /ShipmentRequest/Shipment Shipment Container container.
Required if all of the listed
conditions are true:
ShipFrom and ShipTo
countries are not the
The Description of Goods for same; The packaging
the shipment. Applies to type is not UPS Letter;
international shipments only. The ShipFrom and or
Provide a detailed ShipTo countries are not
description of items being in the European Union or
shipped for documents and the ShipFrom and ShipTo
non-documents. Provide countries are both in the
String

specific descriptions, such European Union and the

1...35
Cond
One

as annual reports and 9 mm shipments service type is

Description /ShipmentRequest/Shipment/Description steel screws. not UPS Standard.
Container

Type of Return service.

When this container exists,
One

N/A

the shipment is a return

No

ReturnService /ShipmentRequest/Shipment/ReturnService shipment. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 35
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Return Service types:|‘2’ =

1
UPS Print and Mail (PNM)|‘3’
= UPS Return Service 1-
Attempt (RS1) |‘5’ = UPS
Return Service 3-Attempt
(RS3)|‘8’ = UPS Electronic
Return Label (ERL)|‘9’ =
UPS Print Return Label
(PRL)|‘10’ = UPS Exchange
Print Return Label|‘11’ =
UPS Pack & Collect Service
1-Attempt Box 1|‘12’ = UPS
Pack & Collect Service 1-
Attempt Box 2|‘13 = UPS
Pack & Collect Service 1-
Attempt Box 3|‘14’ = UPS
Pack & Collect Service 1-
Attempt Box 4|‘15’ = UPS
Pack & Collect Service 1-
Attempt Box 5|‘16’ = UPS
Pack & Collect Service 3-
Attempt Box 1|‘17’ = UPS
Pack & Collect Service 3-
Attempt Box 2|‘18’ = UPS
Pack & Collect Service 3-
Attempt Box 3|‘19’ = UPS
Pack & Collect Service 3-
Attempt Box 4|‘20’ = UPS
string
Yes*
One

/ShipmentRequest/Shipment/ReturnService/C Pack & Collect Service 3-

Code ode Attempt Box 5 N/A
String
1...35
One

/ShipmentRequest/Shipment/ReturnService/D
No

Description escription Return Service description N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 36
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Indicates a shipment

0
contains written, typed, or
printed communication of no
commercial value. If
DocumentsOnly is not
specified then it implies that Empty Tag. Valid only for
the shipment contains non shipments with different
documents or documents of origin and destination
commercial value. Default is countries. The origin
a shipment contains non- country is not US, and the

string
One
/ShipmentRequest/Shipment/DocumentsOnlyI documents or documents of destination country is not

No
DocumentsOnlyIndicator ndicator commercial value. CA, PR or MX.

Container
One
Yes

N/A
Container tag for Shipper's
Shipper /ShipmentRequest/Shipment/Shipper information N/A

Shipper's company name.

For forward Shipment 35
characters are accepted, but
only 30 characters will be

1...35
string
One
Yes

printed on the label.

Name /ShipmentRequest/Shipment/Shipper/Name N/A

Required if destination is
international. Required if
Shipper's Attention Name. Invoice and Co
For forward Shipment 35 International forms are
characters are accepted, but requested and the
1...35
string
Cond
One

/ShipmentRequest/Shipment/Shipper/Attentio only 30 characters will be ShipFrom address is not

AttentionName nName printed on the label. present.

Conditionally required if
SED form (International
forms) is requested and
1...15
string
Cond
One

/ShipmentRequest/Shipment/Shipper/TaxIden Shipper's Tax Identification ship From is not

TaxIdentificationNumber tificationNumber Number mentioned.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 37
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
Cond
One

N/A
Container tag for Phone
Phone /ShipmentRequest/Shipment/Shipper/Phone Number N/A
Valid values are 0 - 9.If
Shipper country is US,
PR, CA, and VI, the
layout is area code, 7
digit PhoneNumber or
area code, 7 digit
PhoneNumber, 4 digit
extension number; for
other countries, the layout
is CountryCode, area
code, 7 digit number. A

String
phone number is required

1...15
Yes*
One
/ShipmentRequest/Shipment/Shipper/Phone/ if destination is
Number Number Shipper's phone Number. international.

String
1...4
One
/ShipmentRequest/Shipment/Shipper/Phone/
No

Extension Extension Shipper's phone extension. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 38
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

6
Size must be six
alphanumeric characters.
Must be associated with
the UserId specified in the
AccessRequest XML The
account must be a valid
UPS account number that
is active. For US, PR and
CA accounts, the account
must be either a daily
pickup account, an
occasional account, or a
customer B.I.N account.
Drop Shipper accounts
are valid for return service
shipments only if the
account is Trade Direct
(TD) enabled. All other
accounts must be either a

string
One
Yes
/ShipmentRequest/Shipment/Shipper/Shipper Shipper's six digit account daily pickup account, or
ShipperNumber Number number. an occasional account.

String
1...14
One
/ShipmentRequest/Shipment/Shipper/FaxNum
No

FaxNumber ber Shipper's Fax Number. N/A

1...50
string
One

/ShipmentRequest/Shipment/Shipper/EMailAd
No

EMailAddress dress Shipper's email address. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 39
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The package should be
returned to this address if
the package is
undeliverable. This
address appears on the
upper left hand corner of
the label. Note: If the
ShipFrom container is not
present then this address
will be used as the
ShipFrom address. If this

Container
address is used as the
ShipFrom the shipment

One
Yes

N/A
will be rated from this
Address /ShipmentRequest/Shipment/Shipper/Address Address tag Container. origin address.
The Ship from street
address including name and
number (when applicable).
Up to three occurrences are
allowed; only the first is
printed on the label. 35
characters are accepted, but
for the first occurrence, only
30 characters will be printed
on the label for return
shipments, and for RFA
Shipments only 20
Three

characters are printed on

1...35
string
Yes

/ShipmentRequest/Shipment/Shipper/Address Label. Maximum Occurrence

AddressLine /AddressLine should be three.
The shipper's City. For
forward Shipment 30
1...30

characters are accepted, but

string
One
Yes

/ShipmentRequest/Shipment/Shipper/Address only 15 characters will be

City /City printed on the label. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 40
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Required if shipper is in
the US or CA. If Shipper
country is US or CA, then
the value must be a valid
Shipper's state or province US State/ Canadian
code. For forward Shipment Province code. If the
5 characters are accepted, country is Ireland, the

string
Cond

2...5
One
/ShipmentRequest/Shipment/Shipper/Address but only 2 characters will be StateProvinceCode will
StateProvinceCode /StateProvinceCode printed on the label. contain the county.
If Shipper country is US
or Puerto Rico, 5 or 9
digits are required. . The
character - may be used
to separate the first five
digits and the last four
digits. If the Shipper
country is CA, then the
postal code is required
and must be 6
alphanumeric characters
whose format is A#A#A#
where A is an uppercase
letter and # is a digit. For
all other countries the
postal code is optional
and must be no more
string
Cond

1...9
One

/ShipmentRequest/Shipment/Shipper/Address than 9 alphanumeric

PostalCode /PostalCode Shipper's postal code. characters long.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 41
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Must be a valid UPS

2
Billing country code. For
Forward shipments it
must also be an allowable
UPS origin country. For
Return Shipment the
country code must meet
the following conditions:
1) At least two of the
following country codes
are the same: ShipTo,
ShipFrom, and Shipper.2)
None of the following
country codes are the
same and are a member
of the EU: ShipTo,
ShipFrom, and Shipper.3)
If any of the two following
Shipper’s country country codes: ShipTo/
code.Refer to Origin Country ShipFrom/ Shipper are
Information table for valid members in EU otherwise

string
One
/ShipmentRequest/Shipment/Shipper/Address Yes origin countries and their check if the shipper has
CountryCode /CountryCode UPS Billing codes. Third Country Contract.

Container
One
Yes

N/A

ShipTo /ShipmentRequest/Shipment/ShipTo Ship To Container N/A

Consignee’s company
name. For RFA Shipment 35
characters are accepted, but
1...35
string
One
Yes

only 25 characters will be

Name /ShipmentRequest/Shipment/ShipTo/Name printed on the label. N/A
Required for: UPS Next
Day Air Early A.M.
Contact name at the service, and when ShipTo
consignee’s location. For country is different than
RFA Shipment 35 characters ShipFrom country.
are accepted, but only 25 Required if Invoice
1...35
string
Cond
One

/ShipmentRequest/Shipment/ShipTo/Attention characters will be printed on International form is

AttentionName Name the label. requested

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 42
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

String
1...15
One
/ShipmentRequest/Shipment/ShipTo/TaxIdent Consignee’s tax

No
TaxIdentificationNumber ificationNumber identification number. N/A

Container
Cond
One

N/A
Phone /ShipmentRequest/Shipment/ShipTo/Phone Container for Phone Number N/A
Required for: UPS Next
Day Air Early A.M.
service, and when Ship
To country is different
than the ShipFrom
country. If ShipTo country
is US, PR, CA, and VI,
the layout is area code, 7
digit PhoneNumber or
area code, 7 digit
PhoneNumber, 4 digit
extension number;
String number; for other
countries, the layout is
1...15
Yes*
One

/ShipmentRequest/Shipment/ShipTo/Phone/N CountryCode, area code,

Number umber Consignee’s phone Number. 7 digit number.
String
1...4
One

/ShipmentRequest/Shipment/ShipTo/Phone/E Consignee’s phone

No

Extension xtension extension. N/A

If ShipTo country is US
String

10 digits allowed,
1...15
One

/ShipmentRequest/Shipment/ShipTo/FaxNum otherwise 1-15 digits

No

FaxNumber ber Consignee’s fax number. allowed.

1...50
string
One

/ShipmentRequest/Shipment/ShipTo/EMailAd
No

EMailAddress dress Consignee’s email address. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 43
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
One
Yes

N/A
Address /ShipmentRequest/Shipment/ShipTo/Address Address Container. N/A
Address Line of the
consignee. For RFA
Shipment 35 characters are
accepted, but only 25

String
Three
characters will be printed on

1...35
Yes
/ShipmentRequest/Shipment/ShipTo/Address/ the label from AddressLine Max Occurrence can be
AddressLine AddressLine elements. 3.
Consignee’s city. For RFA
Shipment 30 characters are
accepted, but only 16
characters will be printed on
the label. For Shipment
other than RFA 30

1...30
string
One
Yes
/ShipmentRequest/Shipment/ShipTo/Address/ characters are accepted, but
City City only 15 are accepted. N/A

2
If destination is US or CA,
then the value must be a
valid US State/ Canadian
Province code. If the
Consignee’s state or country is Ireland, the
string
Cond
One

/ShipmentRequest/Shipment/ShipTo/Address/ province code. Required for StateProvinceCode will

StateProvinceCode StateProvinceCode US or Canada. contain the county.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 44
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
If the ShipTo country is
US or Puerto Rico, 5 or 9
digits are required. . The
character - may be used
to separate the first five
digits and the last four
digits. If the ShipTo
country is CA, then the
postal code is required
and must be 6
alphanumeric characters
whose format is A#A#A#
where A is an uppercase
letter and # is a digit.
Otherwise optional. For
all other countries the
postal code is optional
and must be no more

string
Cond

1...9
One
/ShipmentRequest/Shipment/ShipTo/Address/ than 9 alphanumeric
PostalCode PostalCode Consignee’s postal code. characters long.
Must be a valid UPS

2
Billing country code. For
Return Shipment the
country code must meet
the following conditions:
1) At least two of the
following country codes
are the same: ShipTo,
ShipFrom, and Shipper.
2) None of the following
country codes are the
same and are a member
of the EU: ShipTo,
ShipFrom, and Shipper.
3) If any of the two
following country codes:
ShipTo/ ShipFrom/
Shipper are members in
EU otherwise check if the
string
One
Yes

/ShipmentRequest/Shipment/ShipTo/Address/ shipper has Third Country

CountryCode CountryCode Consignee’s country code. Contract.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 45
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

0
This field is a flag to indicate
if the receiver is a residential

String
location.True if

One
/ShipmentRequest/Shipment/ShipTo/Address/ ResidentialAddressIndicator

No
ResidentialAddressIndicator ResidentialAddressIndicator tag exists; false otherwise Empty Tag.

Location ID is a unique Location ID must be

String
identifier referring to a alphanumeric characters.

3...10
One
/ShipmentRequest/Shipment/ShipTo/LocationI specific shipping/receiving All letters must be

No
LocationID D location. capitalized.

Required for return

container
shipment. Required if
pickup location is different

Cond
One

N/A
from the shipper's
ShipFrom /ShipmentRequest/Shipment/ShipFrom Ship From Container address.

The ship from location’s

name or company name. 35
characters are accepted, but
for return Shipment only 30
characters will be printed on
the label, and for RFA
Shipment only 20 characters

1...35
string
Yes*
One

are printed on Label. Required if ShipFrom tag

Name /ShipmentRequest/Shipment/ShipFrom/Name is in the XML.
The ship from Attention
name. 35 characters are
accepted, but for return Required if ShipFrom tag
Shipment only 30 characters is in the XML and Invoice
will be printed on the label, or CO International forms
is requested. If not
1...35

and for RFA Shipment only

string
Cond
One

/ShipmentRequest/Shipment/ShipFrom/Attenti 20 characters are printed on present, will default to the

AttentionName onName Label. Shipper Attention Name.

Company’s Tax Identification Conditionally required if

1...15
string
Cond
One

/ShipmentRequest/Shipment/ShipFrom/TaxId Number at the pick up SED form (International

TaxIdentificationNumber entificationNumber location forms) is requested

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 46
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
If ShipFrom country is
US, PR, CA, and VI, the
layout is area code, 7
digit phone number or
area code, 7 digit phone
number, 4 digit extension
number; for other
countries, the layout is
CountryCode, area code,

Container
7 digit number. Required
if ShipFrom tag is in the

Cond
One

N/A
XML and International
Phone /ShipmentRequest/Shipment/ShipFrom/Phone Container for Phone Number forms is requested

String
1...15
Yes*
One
/ShipmentRequest/Shipment/ShipFrom/Phone The Ship from phone
Number /Number Number. N/A

String
1...4
One
/ShipmentRequest/Shipment/ShipFrom/Phone No The Ship from phone
Extension /Extension extension. N/A
If Ship from country is US
String
10 digits allowed,

1...15
One

/ShipmentRequest/Shipment/ShipFrom/FaxN otherwise 1-15 digits

No

FaxNumber umber The Ship from fax number. allowed.

The package will be
originating from or being
shipped from this
address. The shipment
container

will be rated from this

origin address to the
One
Yes

N/A

/ShipmentRequest/Shipment/ShipFrom/Addre Ship from Address destination ship to

Address ss Container. address.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 47
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

The Ship from street

address including name and
number (when applicable).
35 characters are accepted,
but for return Shipment only
30 characters will be printed

Three
on the label, and for RFA

1...35
string
Yes
/ShipmentRequest/Shipment/ShipFrom/Addre Shipment only 20 characters
AddressLine ss/AddressLine are printed on Label. Max Occurrence can be 3
The Ship from city. 30
characters are accepted, but
for return Shipment only 15
characters will be printed on
the label, and for RFA

1...30
string
One
Yes
/ShipmentRequest/Shipment/ShipFrom/Addre Shipment only 11 characters Required if ShipFrom tag
City ss/City are printed on Label. is in the XML.
Required if ShipFrom tag

2
is in the XML, and
ShipFrom/Country is US.
If ShipFrom country is US
or CA, then the value
must be a valid US State/
Canadian Province code.
string If the country is Ireland,
Cond
One

/ShipmentRequest/Shipment/ShipFrom/Addre Origin location's state or the StateProvinceCode

StateProvinceCode ss/StateProvinceCode province code. will contain the county.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 48
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Required if ShipFrom tag
is in the XML and the
ShipFrom country is the
US, Puerto Rico. For US,
Puerto Rico must be valid
5 or 9 digit postal code.
The character - may be
used to separate the first
five digits and the last
four digits. If the
ShipFrom country is CA,
then the postal code must
be 6 alphanumeric
characters whose format
is A#A#A# where A is an
uppercase letter and # is
a digit. For all other
The ship from location's countries the postal code
postal code. 9 characters is optional and must be
are accepted, but for RFA no more than 9

string
Cond

1...9
One
/ShipmentRequest/Shipment/ShipFrom/Addre shipment only 5 characters alphanumeric characters
PostalCode ss/PostalCode are printed on the label. long.
Required if ShipFrom tag

2
is in the XML. For Return
Shipment the country
code must meet the
following conditions: 1) At
least two of the following
country codes are the
same: ShipTo, ShipFrom,
and Shipper.2) None of
the following country
codes are the same and
are a member of the EU:
ShipTo, ShipFrom, and
Shipper.3) If any of the
two following country
codes: ShipTo/ ShipFrom/
Shipper are members in
EU otherwise check if the
string
One
Yes

/ShipmentRequest/Shipment/ShipFrom/Addre Origin location's country shipper has Third Country

CountryCode ss/CountryCode code. Contract.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 49
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Payment information
container for detailed
shipment charges. The two

container
shipment charges that are
available for specification It is required for non-

Cond
One

N/A
/ShipmentRequest/Shipment/PaymentInforma are Transportation charges Ground Freight Pricing
PaymentInformation tion and Duties and Taxes. shipments only.
If Duty and Tax charges
are applicable to a
shipment and a payer is

Container
not specified, the default
payer of Duty and Tax

Two
Yes

N/A
/ShipmentRequest/Shipment/PaymentInforma charges is Bill to
ShipmentCharge tion/ShipmentCharge Shipment charge container Receiver.
A shipment charge type

2
of 01 = Transportation is
required. A shipment
charge type of 02 =
Duties and Taxes is not
required; however, this
charge type is invalid for
Qualified Domestic
Shipments. A Qualified
Domestic Shipment is any
shipment in which one of
the following applies: 1)
The origin and destination
country is the same2) US
to PR shipment3) PR to
US shipment4) The origin
and destination country
are both European Union
Countries and the
GoodsNotInFreeCirculatio
n indicator is not
Values are present5) The origin and
string
One
Yes

/ShipmentRequest/Shipment/PaymentInforma 01 = Transportation, 02 = destination IATA code is

Type tion/ShipmentCharge/Type Duties and Taxes the same

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 50
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
This element or its sibling
Container for the BillShipper element, BillReceiver,
billing option. The two BillThirdParty or

Container
payment methods that are ConsigneeBilledIndicator,
available for the Bill Shipper must be present but no

One

N/A
/ShipmentRequest/Shipment/PaymentInforma billing option are account more than one can be

No
BillShipper tion/ShipmentCharge/BillShipper number or credit card. present.
Must be the same UPS

6
account number as the
one provided in
Shipper/ShipperNumber.
Either this element or the
sibling element
/ShipmentRequest/Shipment/PaymentInforma CreditCard must be

string
Cond
One
tion/ShipmentCharge/BillShipper/AccountNum provided, but both may
AccountNumber ber UPS account number not be provided.

Required if
/ShipmentRequest/Shipm
ent/PaymentInformation
/ShipmentCharge/BillShip
per/AccountNumber is not

Container
present. Credit card
payment is valid for
Cond
One

N/A
/ShipmentRequest/Shipment/PaymentInforma Credit card information shipments without return
CreditCard tion/ShipmentCharge/BillShipper/CreditCard container service only.
2
Values are 01 = American
Express, 03 = Discover, 04 = Valid values are: 01, 03,
/ShipmentRequest/Shipment/PaymentInforma MasterCard, 05 = Optima, 04 and 06. For Discover
string
Yes*
One

tion/ShipmentCharge/BillShipper/CreditCard/T 06 = VISA, 07 = Bravo, and card the ShipFrom

Type ype 08 = Diners Club country has to be US

/ShipmentRequest/Shipment/PaymentInforma
9...16
string
Yes*
One

tion/ShipmentCharge/BillShipper/CreditCard/
Number Number Credit Card number N/A
6

Valid month values are

/ShipmentRequest/Shipment/PaymentInforma Format is MMYYYY where 01-12 and valid year
string
Yes*
One

tion/ShipmentCharge/BillShipper/CreditCard/E MM is the 2 digit month and values are Present Year -

ExpirationDate xpirationDate YYYY is the 4 digit year. (Present Year + 10 years)

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 51
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Valid values are 3 or 4
digits. It is required to
provide the security code
if credit card information
is provided and when the
ShipFrom countries are
other than the below
mentioned countries.
Three or four digits that can Argentina Bahamas
be found either on top of Costa Rica
credit card number or on the Dominican Rep
/ShipmentRequest/Shipment/PaymentInforma back of credit card. Number Guatemala

string
Yes*

3...4
One
tion/ShipmentCharge/BillShipper/CreditCard/S of digits varies for different Panama Puerto Rico
SecurityCode ecurityCode type of credit card. Russia

It is required to provide
billing address if credit

Container
card information is
/ShipmentRequest/Shipment/PaymentInforma provided and when the

Cond
One

N/A
tion/ShipmentCharge/BillShipper/CreditCard/A Container to hold the Credit ShipFrom country is the
Address ddress card Billing Address. US, PR, and CA.

Three
/ShipmentRequest/Shipment/PaymentInforma Address Line 1 of the credit

1...35
string
Yes*

tion/ShipmentCharge/BillShipper/CreditCard/A card billing address. Usually Max of three AddressLine

AddressLine ddress/AddressLine Street address information. can be provided.

/ShipmentRequest/Shipment/PaymentInforma 1...30
string
Yes*
One

tion/ShipmentCharge/BillShipper/CreditCard/A City of the credit card billing

City ddress/City address N/A

/ShipmentRequest/Shipment/PaymentInforma
string
Yes*

2...5
One

tion/ShipmentCharge/BillShipper/CreditCard/A State or province code of the

StateProvinceCode ddress/StateProvinceCode credit card billing address. N/A

/ShipmentRequest/Shipment/PaymentInforma
string
Yes*

1...9
One

tion/ShipmentCharge/BillShipper/CreditCard/A Credit card billing addressee

PostalCode ddress/PostalCode postal code. N/A
Must be a valid UPS
2

/ShipmentRequest/Shipment/PaymentInforma Billing country code. For

string
Yes*
One

tion/ShipmentCharge/BillShipper/CreditCard/A Credit card billing address Discover card it should be

CountryCode ddress/CountryCode country code. US

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 52
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
This element or its sibling
element, BillShipper,
BillThirdParty or
Consignee Billed, must
be present but no more

container
than one can be present.
For a return shipment, Bill

Cond
One

N/A
/ShipmentRequest/Shipment/PaymentInforma Container for the Receiver is invalid for
BillReceiver tion/ShipmentCharge/BillReceiver BillReceiver billing option. Transportation charges.
The account must be a

6
valid UPS account
number that is active. For
US, PR and CA accounts,
the account must be a
daily pickup account, an
occasional account, a
customer B.I.N account,
or a dropper shipper
account. All other
accounts must be either a
daily pickup account, an
/ShipmentRequest/Shipment/PaymentInforma occasional account, a

string
Yes*
tion/ShipmentCharge/BillReceiver/AccountNu One drop shipper account, or
AccountNumber mber The UPS account number. a non-shipping account
container
Container for additional
information for the bill
One

N/A
/ShipmentRequest/Shipment/PaymentInforma receiver’s UPS accounts
No

Address tion/ShipmentCharge/BillReceiver/Address address. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 53
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The postal code must be
the same as the UPS
account pickup address
postal code. Required for
United States and
Canadian UPS accounts
and/or if the UPS account
pickup address has a
postal code. If the UPS
accounts pickup country
is US or Puerto Rico, the
postal code is 5 or 9
digits. The character -
may be used to separate
the first five digits and the
last four digits. If the UPS
The postal code for the UPS accounts pickup country
account's pickup address. is CA, the postal code is 6
The pickup postal code was alphanumeric characters
/ShipmentRequest/Shipment/PaymentInforma entered in the UPS system whose format is A#A#A#

string
Cond

0...9
One
tion/ShipmentCharge/BillReceiver/Address/Po when the account was set- where A is an uppercase
PostalCode stalCode up. letter and # is a digit.
This element or its sibling
element, BillShipper,
container BillReceiver or Consignee
Billed, must be present
Cond
One

N/A
/ShipmentRequest/Shipment/PaymentInforma Container for the third party but no more than one can
BillThirdParty tion/ShipmentCharge/BillThirdParty billing option. be present.
6

The account must be a

valid UPS account
number that is active. For
US, PR and CA accounts,
the account must be
either a daily pickup
account, an occasional
account, or a customer
B.I.N account, or a drop
shipper account. All other
accounts must be either a
daily pickup account, an
/ShipmentRequest/Shipment/PaymentInforma occasional account, a
string
Yes*
One

tion/ShipmentCharge/BillThirdParty/AccountN The UPS account number of drop shipper account, or

AccountNumber umber the third party shipper. a non-shipping account.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 54
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

container
Container for additional

One
Yes

N/A
/ShipmentRequest/Shipment/PaymentInforma information for the third party
Address tion/ShipmentCharge/BillThirdParty/Address UPS accounts address. N/A
The postal code must be
the same as the UPS
account pickup address
postal code. Required for
United States and
Canadian UPS accounts
and/or if the UPS account
pickup address has a
postal code. If the UPS
accounts pickup country
is US or Puerto Rico, the
postal code is 5 or 9
digits. The character -
may be used to separate
the first five digits and the
last four digits. If the UPS
The postal code for the UPS accounts pickup country
account's pickup address. is CA, the postal code is 6
The pickup postal code was alphanumeric characters
/ShipmentRequest/Shipment/PaymentInforma entered in the UPS system whose format is A#A#A#
string
Cond

0...9
One

tion/ShipmentCharge/BillThirdParty/Address/P when the account was set- where A is an uppercase

PostalCode ostalCode up. letter and # is a digit.
2

/ShipmentRequest/Shipment/PaymentInforma The country code for the

string
One
Yes

tion/ShipmentCharge/BillThirdParty/Address/ UPS account's pickup

CountryCode CountryCode address. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 55
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Empty Tag. This element

0
or its sibling element,
BillShipper, BillReceiver
or BillThirdParty, must be
present but no more than
Consignee Billing payment one can be present. This
option indicator. The billing option is valid for a
presence indicates shipment charge type of
consignee billing option is Transportation only. Only
/ShipmentRequest/Shipment/PaymentInforma selected. The absence applies to US/PR and

string
Cond
One
tion/ShipmentCharge/ConsigneeBilledIndicato indicates one of the other PR/US shipment origins
ConsigneeBilledIndicator r payment options is selected. and destination.
Split Duty VAT Indicator.The

0
presence indicates the payer
specified for Transportation
Charges will pay Empty Tag. The payment
transportation charges and method for Transportation
any duties that apply to the charges must be UPS
shipment.The payer account. The UPS

String
specified for Duties and account must be a daily

One
/ShipmentRequest/Shipment/PaymentInforma Taxes will pay the VAT pickup account or an
SplitDutyVATIndicator tion/SplitDutyVATIndicator No (Value-Added Tax) only. occasional account.

Container Container to hold the

Payment information for the Required for Ground
Cond
One

/ShipmentRequest/Shipment/FRSPaymentInf N/A Ground Freight Pricing Freight Pricing

FRSPaymentInformation ormation Shipments Shipments only
Containe

It is required if the request

Container to hold the has Ground Freight
One
Yes

N/A

/ShipmentRequest/Shipment/FRSPaymentInf Ground Freight Pricing Pricing shipment

r

Type ormation/Type payment type information indicator

2

Valid codes:
String

01=Prepaid
One
Yes

/ShipmentRequest/Shipment/FRSPaymentInf 02=FreightCollect
Code ormation/Type/Code 03=PrepaidThirdParty
50
String

Specifies the description for

One

/ShipmentRequest/Shipment/FRSPaymentInf Ground Freight Pricing

No

Description ormation/Type/Description payment type

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 56
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
If the Ground Freight

6
Pricing indicator is
present in the request,
This account number

String
must be validated to

One
Yes
/ShipmentRequest/Shipment/FRSPaymentInf check if it is Ground
AccountNumber ormation/AccountNumber The UPS account number. Freight Pricing enabled.

Container
Container to hold the Note: The Address is
information for the required only when the

Cond
One

N/A
/ShipmentRequest/Shipment/FRSPaymentInf FreightCollect and billing option is Freight
Address ormation/Address PrepaidThirdParty Address. collect or ThirdParty.

The postal code for the

String
Ground Freight Pricing

Cond

0...9
One
/ShipmentRequest/Shipment/FRSPaymentInf payment information
PostalCode ormation/Address/PostalCode address.

2
The country code for the

String
Ground Freight Pricing
One
Yes

/ShipmentRequest/Shipment/FRSPaymentInf payment information

CountryCode ormation/Address/CountryCode address.

0 Empty Tag. This indicator

is invalid for a package
string
One

GoodsNotInFreeCirculationIndica /ShipmentRequest/Shipment/GoodsNotInFree Goods Not In Free type of UPS Letter and

No

tor CirculationIndicator Circulation indicator. DocumentsOnly.

container
One

N/A

/ShipmentRequest/Shipment/ShipmentRating ShipmentRatingOptions
No

ShipmentRatingOptions Options container N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 57
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Negotiated Rates are of

0
two types Account Based
Rates (ABR) and Web
Discount Rates.
Negotiated Rates are only
returned for qualified
Shipper Account
Numbers. Eligibility is
determined using the
combination of Userid
and the ShipperÂ’s
Shipper Account Number.
If the user is qualified,
both Published rates and
Negotiated rates are
returned to the user. If the
Userid and Shipper
Account Number are not
qualified for Negotiated
rates, a warning message
is returned that indicates
ineligibility and only the
Published rates are
Negotiated Rates option returned in the response.
indicator. If the indicator is As per discount eligibility
present and the Shipper is of user, negotiated rates
String

authorized then Negotiated in the response may

One

/ShipmentRequest/Shipment/ShipmentRating Rates should be returned in contain ABR or Web

No

NegotiatedRatesIndicator Options/NegotiatedRatesIndicator the response. discount rates.

The Shipper account
0

number must be qualified

to receive Ground Freight
Pricing Shipment rates.
Ground Freight Pricing Only the Shipper account
Rates option indicator. If the number taken from
Ground Freight Pricing /ShipmentRequest/Shipm
Shipment indicator is ent/
enabled and Shipper FRSPaymentInformation/
number is authorized then AccountNumber is used
String

Ground Freight Pricing rates when checking

One

/ShipmentRequest/Shipment/ShipmentRating should be returned in the qualification for Ground

No

FRSShipmentIndicator Options/FRSShipmentIndicator response Freight Pricing rates.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 58
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1
String
/ShipmentRequest/Shipment/ShipmentRating

No
RateChartIndicator Options/RateChartIndicator

1
String
Movement Reference
/ShipmentRequest/Shipment/MovementRefer Number (MRN) information

No
MovementReferenceNumber enceNumber container

2
container
N/A
/ShipmentRequest/Shipment/ReferenceNumb Reference Number

No
ReferenceNumber er information container. N/A
Empty Tag. Allowed for

0
shipment with return
service only. Only one
shipment-level or
package-level reference
number can be bar coded
per shipment. In order to
barcode a reference
number, its value must be
no longer than 14
If the indicator is present alphanumeric characters
then the reference numbers or 24 numeric characters
string
One

/ShipmentRequest/Shipment/ReferenceNumb value will be bar coded on and cannot contain

No

BarCodeIndicator er/BarCodeIndicator the label. spaces.

Shipment Reference number
2

type code. The code

specifies the Reference Valid if the
name. Refer to the origin/destination pair is
string
One

/ShipmentRequest/Shipment/ReferenceNumb Reference Number Code not US/US or PR/PR2

No

Code er/Code table. character alpha-numeric.

Valid if the
1...35
string
Yes*
One

/ShipmentRequest/Shipment/ReferenceNumb Customer supplied reference origin/destination pair is

Value er/Value number. not US/US or PR/PR
container
One
Yes

N/A

Service /ShipmentRequest/Shipment/Service UPS service type N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 59
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Values are: 01 = Next Day

2
Air, 02 = 2nd Day Air, 03 =
Ground, 07 = Express, 08 =
Expedited, 11 = UPS
Standard, 12 = 3 Day Select,
13 = Next Day Air Saver, 14
= Next Day Air Early AM, 54 The following Services
= Express Plus, 59 = 2nd are not available to return
Day Air A.M., 65 = UPS shipment: 13 - Next Day
Saver, 82 = UPS Today Air Saver, 14 - Next Day
Standard, 83 = UPS Today Air Early AM, 59 - 2nd
Dedicated Courier, 84 = Day Air A.M., 82 = UPS
UPS Today Intercity, 85 = Today Standard, 83 =
UPS Today Express, 86 = UPS Today Dedicated
UPS Today Express Saver. Courier, 84 = UPS Today

String
Note: Only service code 03 Intercity, 85 = UPS Today

One
Yes
is used for Ground Freight Express, 86 = UPS Today
Code /ShipmentRequest/Shipment/Service/Code Pricing shipments Express Saver.

Description of the service

code. Examples are Next

1...35
string
One
/ShipmentRequest/Shipment/Service/Descripti Day Air, Worldwide Express,
No

Description on and Ground. N/A

Required for forward
shipments whose origin is
the US and destination is
Puerto Rico or Canada.
Not available for any
other shipments. FOR
Container

OTHER DESTINATIONS
the InvoiceLineTotal in
Cond
One

N/A

Container to hold the International Forms

InvoiceLineTotal /ShipmentRequest/Shipment/InvoiceLineTotal InvoiceLineTotal Information. Container must be used.
3
string
Yes*
One

/ShipmentRequest/Shipment/InvoiceLineTotal Invoice Line Total currency

CurrencyCode /CurrencyCode type.
1...19
string
Yes*
One

/ShipmentRequest/Shipment/InvoiceLineTotal Invoice Line Total amount Valid values are from 1 to

MonetaryValue /MonetaryValue for the entire shipment. 99999999

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 60
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
One

N/A
/ShipmentRequest/Shipment/ShipmentServic Container for Shipment

No
ShipmentServiceOptions eOptions Service Option N/A
Saturday delivery indicator.

0
The presence indicates

String
Saturday delivery; the

One
/ShipmentRequest/Shipment/ShipmentServic absence indicates not

No

X
X
SaturdayDeliveryIndicator eOptions/SaturdayDeliveryIndicator Saturday delivery. Empty Tag.
Indicates COD is
requested. Shipment
COD is only available for
EU origin countries and
for shipper's account type

Container
Daily Pickup and Drop
Shipping. Not available

One

N/A
/ShipmentRequest/Shipment/ShipmentServic to shipment with return

No
COD eOptions/COD COD container service.

1
Values are: 1 = cash; 9 =

String
check, cashiers check or
Yes*
One
/ShipmentRequest/Shipment/ShipmentServic money order - no cash
CODFundsCode eOptions/COD/CODFundsCode Container allowed. N/A
Yes*
One

N/A

/ShipmentRequest/Shipment/ShipmentServic
CODAmount eOptions/COD/CODAmount COD Amount Container. N/A
3
string
Yes*
One

/ShipmentRequest/Shipment/ShipmentServic COD amount currency code

CurrencyCode eOptions/COD/CODAmount/CurrencyCode type. N/A
string
Yes*

1...8
One

/ShipmentRequest/Shipment/ShipmentServic COD Amount monetary

MonetaryValue eOptions/COD/CODAmount/MonetaryValue value.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 61
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Container for the Quantum
View Notification (QVN) is
valid for all shipments
including Return service,

Container
Import Control and Returns
Flexible Access. Valid return

One

N/A
/ShipmentRequest/Shipment/ShipmentServic service types are: ERL, PRL,

No
Notification eOptions/Notification PNM, RS1, or RS3. N/A
The type of notification

1
requested. Valid Value: 2 -
Return Notification or Label Return Notification or
Creation Notification 5 - QV Label Creation
In-transit Notification 6 - QV Notification is allowed for
Ship Notification 7 - QV return shipments only.
Exception Notification 8 - QV In-transit Notification
QV Delivery Notification is allowed for return
Note:QVN Exception shipments only. QV Ship

String
notification and return Notification is allowed for

Yes*
One
/ShipmentRequest/Shipment/ShipmentServic notification are not forward moving
NotificationCode eOptions/Notification/NotificationCode applicable to GFP. shipments only

Container
Yes*
One

N/A
/ShipmentRequest/Shipment/ShipmentServic Container for Email
EMail eOptions/Notification/EMail Information N/A
Up to five email
Five

addresses are allowed for

each type of Quantum
View TM shipment
Yes to

String

notification. Up to two
1...50
One

/ShipmentRequest/Shipment/ShipmentServic Email address where the email address for return

EMailAddress eOptions/Notification/EMail/EMailAddress notification is sent notification.
The address where an There can be only one
undeliverable eMail UndeliverableEMailAddre
String

/ShipmentRequest/Shipment/ShipmentServic message is sent if the eMail ss for each type of

1...50
One

eOptions/Notification/EMail/UndeliverableEMa with the notification is Quantum View Shipment

No

UndeliverableEMailAddress ilAddress undeliverable. Notifications.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 62
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

The e-mail address specifies

the Reply To E-mail

String
/ShipmentRequest/Shipment/ShipmentServic address. The From field of

1...50
Cond
One
eOptions/Notification/EMail/FromEMailAddres the message header
FromEMailAddress s contains [email protected]. Return Notification only.

The FromName must

The name the email will occur only once for each

1...35
string
One
/ShipmentRequest/Shipment/ShipmentServic appear to be from. Defaults type of Quantum View

No
FromName eOptions/Notification/EMail/FromName to the Shipper Name. Shipment Notifications.

The Memo must occur

1...150
only once for each type of

string
One
/ShipmentRequest/Shipment/ShipmentServic User defined text that will be Quantum View Shipment

No
Memo eOptions/Notification/EMail/Memo included in the eMail. Notifications.

1...75
string
One
/ShipmentRequest/Shipment/ShipmentServic The eMail's subject. Defaults

No
Subject eOptions/Notification/EMail/Subject to text provided by UPS Return Notification only.
Specifies a reference code

2
and reference number to
display in the subject of the
Notification. The valid
subject codes are: 01 -
Shipment Reference
Number 1 02 - Shipment For return notification: If
Reference Number 2 03 - the subject code tag is
package Reference Number not provided and the
1 04 - package Reference subject text is provided,
Number 2 08 - Subject the subject of the
Text (Return Notification notification will be the
only) If a subject code is not subject text. If the subject
provided or provided that text is provided and the
refers to a nonexistent subject code tag exists,
reference number, the then the subject code
subject will default to value must be 08. If
string
One

/ShipmentRequest/Shipment/ShipmentServic shipment Identification Subject code is 08,

No

SubjectCode eOptions/Notification/EMail/SubjectCode Number subject text must exist.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 63
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Container for the Label
Delivery accessorial|Note:
Currently Label delivery
accessorial is not applicable
to GFP Required for
shipments with either
Electronic Return Label
Return Service or
ImportControl Electronic
LabelMethod type. If this

Container
container is present, either
of the LabelLinksIndicator or Valid for shipments with a

One

N/A
/ShipmentRequest/Shipment/ShipmentServic Email container should be Electronic Return Label

No

X
LabelDelivery eOptions/LabelDelivery provided. Return Service.

container
One

N/A
/ShipmentRequest/Shipment/ShipmentServic Container for the email

No

X
EMail eOptions/LabelDelivery/EMail message. N/A

The destination eMail

1...50
string
Yes*
One
/ShipmentRequest/Shipment/ShipmentServic address for the Label

X
EMailAddress eOptions/LabelDelivery/EMail/EMailAddress Delivery. N/A

The address where an

undeliverable email
/ShipmentRequest/Shipment/ShipmentServic
1...50

message is sent if the Label

string
One

eOptions/LabelDelivery/EMail/UndeliverableE Delivery email is Defaults to

No

X
UndeliverableEMailAddress MailAddress undeliverable. FromEMailAddress.
The e-mail address specifies
the Reply To E-mail
/ShipmentRequest/Shipment/ShipmentServic address. The From field of
1...50
string
Yes*
One

eOptions/LabelDelivery/EMail/FromEMailAddr the message header

X
FromEMailAddress ess contains [email protected]. N/A
String

The name notification will

1...35
One

/ShipmentRequest/Shipment/ShipmentServic appear to be from. Defaults

No

X
FromName eOptions/LabelDelivery/EMail/FromName to the Shipper Name N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 64
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1...150
string
One
/ShipmentRequest/Shipment/ShipmentServic User defined text that will be

No

X
Memo eOptions/LabelDelivery/EMail/Memo included in the email. N/A
The eMail's subject. Defaults
to the Label Delivery
Notification plus the

1...75
string
One
/ShipmentRequest/Shipment/ShipmentServic shipment ID. Defaults to text

No

X
Subject eOptions/LabelDelivery/EMail/Subject provided by UPS N/A
If the subject code tag is

2
not provided and the
subject text is provided,
the subject of the
notification will be the
Specifies a reference code subject text. If the subject
and reference number to text is provided, and the
display in the subject of the subject code tag exists,
Label Delivery notification. then the subject code
When the subject code is value must be 08;If
provided, the subject will Subject code is 08,
contain the following: UPS subject text must exist. If
Label Delivery. The a subject code is provided
reference code (the that refers to a
reference code will be nonexistent reference
mapped to the number, the subject will
string
One

/ShipmentRequest/Shipment/ShipmentServic corresponding ANSI value) default to the shipment

No

X
SubjectCode eOptions/LabelDelivery/EMail/SubjectCode Plus the reference number. identification number.
Indicates the Label and
0

Receipt URL's are to be

returned in the XML
response. Applicable for
ImportControl Electronic
string
One

/ShipmentRequest/Shipment/ShipmentServic Labels or for ReturnService

No

X
LabelLinksIndicator eOptions/LabelDelivery/LabelLinksIndicator Electronic Labels
Container
One

N/A

/ShipmentRequest/Shipment/ShipmentServic International Forms

No

InternationalForms eOptions/InternationalForms information

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 65
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Possible Values are: 01 -

2
Invoice; 02 - SED03 -
CO; 04 - NAFTA CO; 05
- Partial Invoice;
06 - Packinglist, 07 -
Customer Generated
Forms
. For shipment with
return service, 01 or 05

*Yes to Six
are the only valid values.
Note: 01 and 05 are
mutually exclusive and 05

string
One

Req
Req
Req
Req
Req
/ShipmentRequest/Shipment/ShipmentServic Indicates the name of the is only valid for return
FormType eOptions/InternationalForms/FormType International form requested. shipments only.

N/A
Container

/ShipmentRequest/Shipment/ShipmentServic Data container for

Yes*

UserCreatedForm eOptions/InternationalForms/UserCreatedFor DocumentID(s).

1

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 66
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

26
Unbounded
DocumentID represents a

String
/ShipmentRequest/Shipment/ShipmentServic document uploaded to

Yes
DocumentID eOptions/InternationalForms/UserCreatedFor Forms History.
m/DocumentID
This indicator should be

0
set when the shipper
intends to utilize UPS
paperless invoice
functionality AND the
shipper has SELF-
PREPARED other
International Forms (SED,
CO, NAFTACO) to
accompany the shipment.
It is evaluated only when:
1. Account is paperless
enabled. 2. Movement
requires an invoice.3.
Destination country
accepts paperless
Presence of the indicator invoice. 4. Invoice data is
/ShipmentRequest/Shipment/ShipmentServic means user will supply supplied by the client and
string
One

Opt
Opt
Opt
Opt
eOptions/InternationalForms/AdditionalDocum additional document, such the data passes
No

0
AdditionalDocumentIndicator entIndicator as SED, NAFTA_CO or CO. validation.
Contains description text
50

which identifies the group of

/ShipmentRequest/Shipment/ShipmentServic International forms. This
string

N/A
N/A
One

N/A
N/A

N/A
eOptions/InternationalForms/FormGroupIdNa element does not appear on
No

FormGroupIdName me the forms.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 67
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Indicates the SED filing

2
option. If UPS files SED on Applicable for SED form
shipper's behalf, there is and is required. Valid

string
Cond
One

Req
N/A
N/A
N/A

N/A
/ShipmentRequest/Shipment/ShipmentServic additional $10 charge to the values is: 01 - Shipper
SEDFilingOption eOptions/InternationalForms/SEDFilingOption shipper filing SED

Applicable for SED form

and NAFTA CO only.
Required for NAFTA CO
and SED. Ultimate
consignee contact

Container
information is required for
Holds the contact SED. Producer contact

Cond

N/A
One

N/A

N/A
N/A
N/A
N/A
/ShipmentRequest/Shipment/ShipmentServic information of various information is required for
Contacts eOptions/InternationalForms/Contacts parties. NAFTA CO

The forwarding agent is the

Cond Req
Container
company or person acting as

Sec 5a
/ShipmentRequest/Shipment/ShipmentServic agent in the trans-shipping

One

N/A

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Forwar of freight to the destination Applicable for SED form

No
ForwardAgent dAgent country. only.

Sec Sec
Sec 5a
/ShipmentRequest/Shipment/ShipmentServic Company Name or the

1...35
string
*Yes

N/A
N/A

N/A
One

N/A
eOptions/InternationalForms/Contacts/Forwar Individual name of the Applicable for SED form
CompanyName dAgent/CompanyName Forwarding agent. only.

Sec 5a
/ShipmentRequest/Shipment/ShipmentServic
1...15
string
*Yes

N/A

N/A
One

N/A
N/A
eOptions/InternationalForms/Contacts/Forwar Tax ID of the Forwarding Applicable for SED form
TaxIdentificationNumber dAgent/TaxIdentificationNumber agent. only.
Container

Sec 5a
/ShipmentRequest/Shipment/ShipmentServic
*Yes
One

N/A

N/A
N/A
N/A
eOptions/InternationalForms/Contacts/Forwar Address information of the Applicable for SED form
Address dAgent/Address Forwarding agent. only.

Sec 5a
Three

/ShipmentRequest/Shipment/ShipmentServic
1...35
string
*Yes

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Forwar Address line of the Max Occurrence must be
AddressLine dAgent/Address/AddressLine Forwarding agent. 3

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 68
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Sec 5a
/ShipmentRequest/Shipment/ShipmentServic

1...30
string
*Yes
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Forwar Applicable for SED form
City dAgent/Address/City City of the Forwarding agent. only.

Sec 5a
/ShipmentRequest/Shipment/ShipmentServic Applicable for SED form

string
Cond

1...5
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Forwar State of the Forwarding only. Required for certain
StateProvinceCode dAgent/Address/StateProvinceCode agent. countries.

Sec 5a
String
/ShipmentRequest/Shipment/ShipmentServic

1...30
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Forwar Town of the Forwarding

No
Town dAgent/Address/Town Agent
Applicable for SED form
only. Required for certain

Sec 5a
/ShipmentRequest/Shipment/ShipmentServic countries. The length of

string
Cond

1...9
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Forwar Postal code of the the postal code depends
PostalCode dAgent/Address/PostalCode Forwarding agent. on the country code.

Sec 5a
/ShipmentRequest/Shipment/ShipmentServic

string
*Yes
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Forwar Country code of the Applicable for SED form
CountryCode dAgent/Address/CountryCode Forwarding agent. only.
The ultimate consignee is
the person or company who
receives the goods for end-
Container

Req Sec 4a
use or the person or

Sec 4a
/ShipmentRequest/Shipment/ShipmentServic company listed on the export Applicable for SED form
1...35
Cond
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Ultimat license. This is the end-user only. Required when the
UltimateConsignee eConsignee of the goods. form requested is SED.

Sec 4a
/ShipmentRequest/Shipment/ShipmentServic Company Name or the
1...35
string
*Yes
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Ultimat Individual name of the Applicable for SED form
CompanyName eConsignee/CompanyName Ultimate consignee. only.
Container

Sec 4a
/ShipmentRequest/Shipment/ShipmentServic
1...50
*Yes
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Ultimat Address information of the Applicable for SED form
Address eConsignee/Address Ultimate consignee. only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 69
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Sec 4a
Three
/ShipmentRequest/Shipment/ShipmentServic

1...35
string
*Yes

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Ultimat Address line of the Ultimate Max Occurrence must be
AddressLine eConsignee/Address/AddressLine consignee. 3

Sec 4a
1...30
/ShipmentRequest/Shipment/ShipmentServic

string
*Yes
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Ultimat City of the Ultimate Applicable for SED form
City eConsignee/Address/City consignee. only.

Sec 4a
/ShipmentRequest/Shipment/ShipmentServic Applicable for SED form

string
Cond

1...5
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Ultimat State of the Ultimate only. Required for certain
StateProvinceCode eConsignee/Address/StateProvinceCode consignee. countries

Sec 4a
String
1...30
/ShipmentRequest/Shipment/ShipmentServic

One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Ultimat Town of the Ultimate

No
Town eConsignee/Address/Town consignee
Applicable for SED form
only. Required for certain

Sec 4a
String
/ShipmentRequest/Shipment/ShipmentServic countries. The length of
Cond

1...9
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Ultimat Postal code of the Ultimate the postal code depends
PostalCode eConsignee/Address/PostalCode consignee. on the country code.

Sec 4a
String

/ShipmentRequest/Shipment/ShipmentServic
*Yes
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Ultimat Country code of the Ultimate Applicable for SED form
CountryCode eConsignee/Address/CountryCode consignee. only.

Opt Sec 4b
The intermediate consignee
Container

Opt Sec Connd Opt Sec 4b

is the person or company in
/ShipmentRequest/Shipment/ShipmentServic the importing country that
1...35
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Interme makes final delivery to the Applicable for SED form
No

IntermediateConsignee diateConsignee ultimate consignee. only.

Cond Req 4b
/ShipmentRequest/Shipment/ShipmentServic Company Name or the
1...35
string
*Yes
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Interme Individual name of the Applicable for SED form
CompanyName diateConsignee/CompanyName Intermediate consignee. only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 70
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Cond Req
Container
/ShipmentRequest/Shipment/ShipmentServic

1...50
*Yes
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Interme Address information of the Applicable for SED form

4b
Address diateConsignee/Address Intermediate Consignee. only.

Cond Req 4b
Three
/ShipmentRequest/Shipment/ShipmentServic

1...35
string
*Yes

N/A
N/A
N/A
N/A
eOptions/InternationalForms/Contacts/Interme Address line of the Max Occurrence must be
AddressLine diateConsignee/Address/AddressLine Intermediate Consignee. 3

Cond Req
/ShipmentRequest/Shipment/ShipmentServic

1...30
string
*Yes

N/A
One

N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Interme City of the Intermediate Applicable for SED form

4b
City diateConsignee/Address/City Consignee. only.

Cond Req 4b
/ShipmentRequest/Shipment/ShipmentServic Applicable for SED form
string
Cond

1...5
One

N/A
N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Interme State of the Intermediate only. Required for certain
StateProvinceCode diateConsignee/Address/StateProvinceCode Consignee. countries.

Req 4b
Cond
String

/ShipmentRequest/Shipment/ShipmentServic
1...30

N/A
One

N/A
N/A

N/A
eOptions/InternationalForms/Contacts/Interme Town of the Intermediate
No

Town diateConsignee/Address/Town consignee

Applicable for SED form
only. Required for certain

Req 4b
Cond
/ShipmentRequest/Shipment/ShipmentServic countries. The length of
string
Cond

1...9

N/A
One

N/A
N/A
N/A
eOptions/InternationalForms/Contacts/Interme Postal code of the the postal code depends
PostalCode diateConsignee/Address/PostalCode Intermediate Consignee. on the country code.
2

Req 4b
Cond
/ShipmentRequest/Shipment/ShipmentServic
string
*Yes

N/A
One

N/A
N/A
N/A
eOptions/InternationalForms/Contacts/Interme Country code of the Applicable for SED form
CountryCode diateConsignee/Address/CountryCode Intermediate Consignee. only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 71
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Information of the producer.
The NAFTA Certificate of
Origin must be completed,
signed, and dated by the
exporter. When the
Certificate is completed by
the producer for use by the
exporter, it must be
completed, signed, and

Container
dated by the producer. The
/ShipmentRequest/Shipment/ShipmentServic date must be the date the Applies to NAFTA CO.

1...35
Cond

N/A
N/A

N/A
One

N/A

N/A
eOptions/InternationalForms/Contacts/Produc Certificate was completed Required for NAFTA CO
Producer er and signed. forms
The text associated with the

2
code will be printed in the
producer section instead of
producer contact
information. Use attached
List if more than one
producer’s good is included
on the Certificate, attach a Applies to NAFTA CO.
list of additional producers, Possible Values are:01:
including the legal name, AVAILABLE TO
address (including country), CUSTOMS UPON
and legal tax identification REQUEST02: SAME AS
/ShipmentRequest/Shipment/ShipmentServic number, cross-referenced to EXPORTER03:
string

N/A
One

N/A
N/A
N/A
N/A
eOptions/InternationalForms/Contacts/Produc the goods described in the ATTACHED LIST04:
No

Option er/Option Description of Goods field. UNKNOWN

Applies to NAFTA CO.
Only applicable when
producer option is empty
or not present.
Conditionally required for:
/ShipmentRequest/Shipment/ShipmentServic Company Name or the NAFTA CO, when
1...35
string
Cond

N/A

N/A
One

N/A
N/A
N/A
eOptions/InternationalForms/Contacts/Produc Individual name of the Producer option is not
CompanyName er/CompanyName Producer. specified.
Applies to NAFTA CO.
/ShipmentRequest/Shipment/ShipmentServic
1...15

Only applicable when

string

N/A
One

N/A

N/A
N/A
N/A
eOptions/InternationalForms/Contacts/Produc producer option is empty
No

TaxIdentificationNumber er/TaxIdentificationNumber Tax ID of the Producer. or not present

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 72
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to NAFTA CO.
Only applicable if
producer option is empty
or not present.

Container
Conditionally required for:
/ShipmentRequest/Shipment/ShipmentServic NAFTA CO, when

1...50
Cond

N/A
N/A

N/A
One

N/A
N/A
eOptions/InternationalForms/Contacts/Produc Address information of the Producer option is not
Address er/Address Producer. specified.

Three
/ShipmentRequest/Shipment/ShipmentServic

1...35
string
*Yes

N/A
N/A
N/A
N/A
N/A
eOptions/InternationalForms/Contacts/Produc Address line of the Max Occurrence must be
AddressLine er/Address/AddressLine Producer. 3

Applies to NAFTA CO.

Conditionally required for:
/ShipmentRequest/Shipment/ShipmentServic NAFTA CO, when

1...30
string
*Yes

N/A

N/A
One

N/A
N/A
N/A
eOptions/InternationalForms/Contacts/Produc Producer option is not
City er/Address/City City of the Producer. specified.

/ShipmentRequest/Shipment/ShipmentServic Applies to NAFTA CO.

string
Cond

1...5

N/A
One

N/A

N/A
N/A
N/A
eOptions/InternationalForms/Contacts/Produc Required for certain
StateProvinceCode er/Address/StateProvinceCode State of the Producer. countries
String
/ShipmentRequest/Shipment/ShipmentServic
1...30

N/A
One

N/A
N/A
N/A
N/A
eOptions/InternationalForms/Contacts/Produc
No

Town er/Address/Town Town of the Producer

Applies to NAFTA CO.
Required for certain
/ShipmentRequest/Shipment/ShipmentServic countries. The length of
string
Cond

1...9

N/A

N/A
One

N/A

N/A
N/A
eOptions/InternationalForms/Contacts/Produc the postal code depends
PostalCode er/Address/PostalCode Postal code of the Producer. on the country code.

/ShipmentRequest/Shipment/ShipmentServic
string
*Yes

1...2

N/A

N/A
One

N/A
N/A
N/A
eOptions/InternationalForms/Contacts/Produc Country code of the
CountryCode er/Address/CountryCode Producer. Applies to NAFTA CO
1
String

/ShipmentRequest/Shipment/ShipmentServic
eOptions/InternationalForms/Contacts/Produc Contact name at the
No

AttentionName er/AttentionName Producer location.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 73
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1
Container
/ShipmentRequest/Shipment/ShipmentServic
eOptions/InternationalForms/Contacts/Produc

No
Phone er/Phone

1
String
/ShipmentRequest/Shipment/ShipmentServic

Yes
eOptions/InternationalForms/Contacts/Produc The location's phone number
Number er/Phone/Number of the Producer

1
String
/ShipmentRequest/Shipment/ShipmentServic
eOptions/InternationalForms/Contacts/Produc The location's phone

No
Extension er/Phone/Extension extension of the Producer

1
String
/ShipmentRequest/Shipment/ShipmentServic
eOptions/InternationalForms/Contacts/Produc

No
EMailAddress er/EMailAddress Producer email address.

container
One

N/A
/ShipmentRequest/Shipment/ShipmentServic
No

SoldTo eOptions/InternationalForms/Contacts/SoldTo SoldTo Container.

/ShipmentRequest/Shipment/ShipmentServic
1...35
string
Yes*
One

eOptions/InternationalForms/Contacts/SoldTo
Name /Name Company Name.

/ShipmentRequest/Shipment/ShipmentServic
1...35
string
Yes*
One

eOptions/InternationalForms/Contacts/SoldTo
AttentionName /AttentionName Sold to contact name.

/ShipmentRequest/Shipment/ShipmentServic
1...15
string
One

eOptions/InternationalForms/Contacts/SoldTo SoldTo Tax Identification

No

TaxIdentificationNumber /TaxIdentificationNumber Number

container

/ShipmentRequest/Shipment/ShipmentServic
One

N/A

eOptions/InternationalForms/Contacts/SoldTo
No

Phone /Phone Phone Container

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 74
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

/ShipmentRequest/Shipment/ShipmentServic

1...15
string
Yes*
One
eOptions/InternationalForms/Contacts/SoldTo Sold To contact's phone
Number /Phone/Number number

/ShipmentRequest/Shipment/ShipmentServic

string
One
eOptions/InternationalForms/Contacts/SoldTo Sold To contact's phone

No

?
Extension /Phone/Extension extension
The text associated with the

2
code will be printed in the
sold to section of the NAFTA
/ShipmentRequest/Shipment/ShipmentServic CO form. the values Applies to NAFTA CO

string
One
eOptions/InternationalForms/Contacts/SoldTo indicate the following 01 – form. Possible Values

No
Option /Option Unknown are 01 and 02

container
/ShipmentRequest/Shipment/ShipmentServic

Yes*
One

N/A
eOptions/InternationalForms/Contacts/SoldTo
Address /Address Address Container.

35
/ShipmentRequest/Shipment/ShipmentServic Three
string
Yes

eOptions/InternationalForms/Contacts/SoldTo SoldTo location’s street Max Occurrence must be

AddressLine /Address/AddressLine address. 3
30
/ShipmentRequest/Shipment/ShipmentServic
string
One
Yes

eOptions/InternationalForms/Contacts/SoldTo
City /Address/City SoldTo location’s city.
5

/ShipmentRequest/Shipment/ShipmentServic
string
Cond
One

eOptions/InternationalForms/Contacts/SoldTo SoldTo location’s state or Required for certain

StateProvinceCode /Address/StateProvinceCode province code. countries.

/ShipmentRequest/Shipment/ShipmentServic
string
One

eOptions/InternationalForms/Contacts/SoldTo
No

Town /Address/Town SoldTo location’s town code.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 75
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

10
/ShipmentRequest/Shipment/ShipmentServic

string
Cond
One
eOptions/InternationalForms/Contacts/SoldTo SoldTo location’s postal
PostalCode /Address/PostalCode code.

2
/ShipmentRequest/Shipment/ShipmentServic

string
One
Yes
eOptions/InternationalForms/Contacts/SoldTo SoldTo location’s country
CountryCode /Address/CountryCode code.

1
String
/ShipmentRequest/Shipment/ShipmentServic
eOptions/InternationalForms/Contacts/SoldTo

No
EMailAddress /EMailAddress SoldTo email address.
Applies to SED, Invoice,
Partial Invoice, CO and
NAFTA CO. When any
International form is

*Yes to fifty
requested Product must

Container
be present at least once
but no more than 50.

1...50

Opt
One

Req
Req
Req
Req
/ShipmentRequest/Shipment/ShipmentServic Contains the commodity/ Note: For Partial Invoice
Product eOptions/InternationalForms/Product product information this container is optional.
Applies to all International
Forms. Optional for
Partial Invoice. Must be
/ShipmentRequest/Shipment/ShipmentServic 1...35 present at least once and
string
*Yes

Opt
One

Req
Req
Req
Req
eOptions/InternationalForms/Product/Descripti can occur for a maximum
Description on Description of the product. of 3 times
Container

Container tag for the unit's Required for Invoice

Cond

Opt
One

N/A

N/A
N/A
N/A
N/A
/ShipmentRequest/Shipment/ShipmentServic information of each product. forms and optional for
Unit eOptions/InternationalForms/Product/Unit (also called as commodity) Partial Invoice.
Total quantity of each Required for Invoice
commodity to be shipped, forms and optional for
/ShipmentRequest/Shipment/ShipmentServic measured in the units Partial Invoice. Must be
string
*Yes

1...7

Opt
One

N/A
N/A
N/A
N/A
eOptions/InternationalForms/Product/Unit/Nu specified in the Unit of numeric. Valid characters
Number mber Measure field are 0-9.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 76
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
/ShipmentRequest/Shipment/ShipmentServic Container tag for the Unit of Required for Invoice

*Yes

N/A

Opt
One

N/A

N/A
N/A

N/A
eOptions/InternationalForms/Product/Unit/Unit measurement for the forms and optional for
UnitOfMeasurement OfMeasurement commodity. Partial Invoice.
Required for Invoice
forms and optional for
Partial Invoice. Valid
entries are: BA = Barrel,
BE = Bundle, BG = Bag,
BH = Bunch, BOX = Box,
BT = Bolt, BU = Butt, CI =
Canister, CM =
Centimeter, CON =
Container , CR = Crate,
CS = Case, CT = Carton,
CY = Cylinder, DOZ =
Dozen, EA = Each, EN =
Envelope, FT = Feet, KG
= Kilogram, KGS =
Kilograms, LB = Pound,
LBS = Pounds, L = Liter,
M = Meter, NMB =
Number, PA = Packet,
PAL = Pallet, PC = Piece,
PCS = Pieces, PF = Proof
Liters, PKG = Package ,
PR = Pair, PRS = Pairs,
RL = Roll, SET = Set,
SME = Square Meters,
/ShipmentRequest/Shipment/ShipmentServic Code for the Unit of SYD = Square Yards, TU
string
1... 3
*Yes

N/A

Opt
One

N/A
N/A

N/A
eOptions/InternationalForms/Product/Unit/Unit measurement of the = Tube, YD = Yard, OTH
Code OfMeasurement/Code commodity units. = Other.
Applies to Invoice and
Partial Invoice forms.
Conditionally Required for
the Invoice and Partial
Invoice form if OTH is
/ShipmentRequest/Shipment/ShipmentServic The Unit of Measure if OTH entered as the units
string
Cond

1...3
One

N/A
N/A
N/A
N/A
eOptions/InternationalForms/Product/Unit/Unit (Other) is entered as the UnitOfMeasurement
Description OfMeasurement/Description UnitOfMeasurement code. Code

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 77
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to Invoice and
Partial Invoice form.
Required for Invoice
forms and optional for
Partial Invoice. Amount
should be greater than
zero. Valid characters
are 0-9 and. (Decimal
point). Limit to 6 digits
after the decimal. The
maximum length of the
field is 19 including '.' and
can hold up to 6 decimal
places.(#####.######,
######.#####,
#######.####,
########.###,
#########.##,########
##.#,############)The
value of this product and
the other products should
be such that the invoice
line total which is the sum
Monetary amount used to of ( number*values) of all
/ShipmentRequest/Shipment/ShipmentServic specify the worth or price of products should not

1...19
string
*Yes

N/A
N/A

Opt
One

N/A

N/A
eOptions/InternationalForms/Product/Unit/Val the commodity. Amount exceed
Value ue should be greater than zero 9999999999999999.99

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 78
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to Invoice, Partial
Invoice and NAFTA CO.
Required for NAFTA CO
and optional for Partial
Invoice. Should be at
least 6 alphanumeric. For
NAFTA CO: For each
good described in
Description of Goods
field, identify the H.S.

N/A
N/A
N/A
N/A
tariff classification to six
digits. If the good is
subject to a specific rule
of origin in Annex 401
that requires eight digits,
identify to eight digits,
6-to-15-alphanumeric using the H.S. tariff
commodity code. Customs classification of the
/ShipmentRequest/Shipment/ShipmentServic uses this code to determine country into whose

6...15
string
Cond
One

Opt
eOptions/InternationalForms/Product/Commo what duties should be territory the good is
CommodityCode dityCode assessed on the commodity. imported.
The part number or Applies to Invoice and
reference number for the Partial Invoice. Required

1...10
/ShipmentRequest/Shipment/ShipmentServic product contained in the for Invoice forms and
string
One

eOptions/InternationalForms/Product/PartNu invoice line, as indicated on optional for Partial

No

PartNumber mber the customs invoice. Invoice.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 79
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to Invoice, Partial

2
Invoice, CO and NAFTA
CO. Required for Invoice
and CO forms. Optional
for Partial Invoice.
Conditionally required for
NAFTA CO if
JointProductionIndicator
is not present. For all
other originating goods
exported to Canada,
indicate appropriately MX
or US if the goods

N/A
originate in that NAFTA
country, within the
The country in which the meaning of the NAFTA
good was manufactured, Rules of Origin
produced, or grown. For Regulations, and any
detailed information on subsequent processing in
country of origin, certificate the other NAFTA country
of origin, rules of origin, and does not increase the
any related matters, please transaction value of the
refer to the U.S. Customs goods by more than
and Border Protection Web seven percent; otherwise
/ShipmentRequest/Shipment/ShipmentServic string site at www.customs.gov or use the
Cond

Req
Req
One

Req

Opt
eOptions/InternationalForms/Product/OriginC contact your country's JointProductionIndicator
OriginCountryCode ountryCode Customs authority. for joint production.

If present, JNT will be used

as the origin of country code

N/A
N/A
N/A
N/A
N/A
EMPTY

/ShipmentRequest/Shipment/ShipmentServic on the NAFTA form and the

One

N/A

eOptions/InternationalForms/Product/JointPro Product/OriginCountryCode Applies to NAFTA CO

No

JointProductionIndicator ductionIndicator tag will be ignored. only

For each good described in
2

the Description of Goods

field, where the good is
subject to a regional value
content (RVC) requirement,
indicate NC if the RVC is Applies to NAFTA CO
/ShipmentRequest/Shipment/ShipmentServic calculated according to the only. Required for NAFTA
string
Cond

N/A
N/A
N/A
N/A
One

N/A
eOptions/InternationalForms/Product/NetCost net cost method; otherwise, CO. Possible Values:
NetCostCode Code indicate NO. NCNO

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 80
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
/ShipmentRequest/Shipment/ShipmentServic

N/A

N/A

N/A
One

N/A

N/A

N/A
eOptions/InternationalForms/Product/NetCost Date Range for regional Applies to NAFTA CO

No
NetCostDateRange DateRange value content (RVC) only.

8
If the RVC is calculated over
a period of time, it should be
identified by the begin date
/ShipmentRequest/Shipment/ShipmentServic (yyyyMMdd) of that period. Applies to NAFTA CO

string
*Yes

N/A

N/A
One

N/A

N/A
N/A
eOptions/InternationalForms/Product/NetCost (Reference: Articles 402.1, only. Format is
BeginDate DateRange/BeginDate 402.5). yyyyMMdd
If the RVC is calculated over

8
a period of time, it should be
identified by the End date
/ShipmentRequest/Shipment/ShipmentServic (yyyyMMdd) of that period. Applies to NAFTA CO

string
*Yes

N/A
N/A

N/A
One

N/A

N/A
eOptions/InternationalForms/Product/NetCost (Reference: Articles 402.1, only. Format is
EndDate DateRange/EndDate 402.5). yyyyMMdd
Indicates the criterion (A

1
through F) for each good
described in the Description
of Goods field if applicable.
The rules of origin are
contained in Chapter Four
and Annex 401. Additional
rules are described in Annex
703.2 (certain agricultural
goods), Annex 300-B,
Appendix 6 (certain textile
goods) and Annex 308.1
/ShipmentRequest/Shipment/ShipmentServic (certain automatic data Applicable for NAFTA CO
string
Cond

N/A
One

N/A
N/A
N/A
N/A
eOptions/InternationalForms/Product/Preferen processing goods and their and is required. Possible
PreferenceCriteria ceCriteria parts). Values: ABCDEF.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 81
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Indicate the following: Yes -
If shipper is the producer of
the good. If not, state 02, 03,
and 04 depending on
whether this certificate was
based upon: No [1] -
Knowledge of whether the
good qualifies as an
originating good. No [2] -
Reliance on the producers
written representation (other
than a Certificate of Origin)
that the good qualifies as an
originating good. No [3] - A
completed and signed Applicable for NAFTA CO

3 0r 5
/ShipmentRequest/Shipment/ShipmentServic Certificate for the good and is required. Possible

string
Cond

N/A
N/A
One

N/A
N/A
N/A
eOptions/InternationalForms/Product/Produce voluntarily provided to the Values: Yes, No[1], No[2],
ProducerInfo rInfo exporter by the producer. and No[3]

Opt Sec
Opt Sec
Opt Sec

N/A
N/A
2a
2a
2a
/ShipmentRequest/Shipment/ShipmentServic Any special marks, codes,

1...35
string
One
eOptions/InternationalForms/Product/MarksA and numbers that may
No
MarksAndNumbers ndNumbers appear on package Applies to CO Only

Applicable for CO and is

/ShipmentRequest/Shipment/ShipmentServic The total number of required. Should be
string
Cond

1...3
One

NumberOfPackagesPerCommodi eOptions/InternationalForms/Product/Number packages, cartons, or numeric. Valid characters

ty OfPackagesPerCommodity containers for the commodity are 0 -9.
The shipping weight,
including containers, for
each commodity with a
Container

separate Harmonized Tariff

/ShipmentRequest/Shipment/ShipmentServic Code / Schedule B Number. Applies to CO and SED
Cond
One

N/A

eOptions/InternationalForms/Product/Product This weight does not include forms only. Required for
ProductWeight Weight carrier equipment. CO and SED forms.
Container

/ShipmentRequest/Shipment/ShipmentServic
*Yes
One

N/A

eOptions/InternationalForms/Product/Product Container tag for the Unit of Applies to CO and SED

UnitOfMeasurement Weight/UnitOfMeasurement Measurement of weight forms only

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 82
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

3
/ShipmentRequest/Shipment/ShipmentServic Applies to CO and SED

string
*Yes
One
eOptions/InternationalForms/Product/Product Code for unit of forms only. Possible
Code Weight/UnitOfMeasurement/Code Measurement of weight values: KGS, LBS.

String
/ShipmentRequest/Shipment/ShipmentServic

1...20
One
eOptions/InternationalForms/Product/Product Description of the Unit of

No
Description Weight/UnitOfMeasurement/Description Measure
Applies to CO and SED
forms only. Valid
characters are 0-9 and '.'
(Decimal point). Limit to 1
digit after the decimal.
The maximum length of
/ShipmentRequest/Shipment/ShipmentServic the field is 5 including '.'

string
*Yes

1...5
One
eOptions/InternationalForms/Product/Product and can hold up to 1
Weight Weight/Weight Weight decimal place.
Includes the following
information for used self-
propelled vehicles as
defined in Customs
regulations 19 CFR 192.1:
The unique Vehicle
Identification Number (VIN)
in the proper format. Or The
Product Identification
Number (PIN) for those used
/ShipmentRequest/Shipment/ShipmentServic self propelled vehicles for
1...25
string
One

eOptions/InternationalForms/Product/VehicleI which there are no VINs. Or Applies to SED forms

No

VehicleID D the Vehicle Title Number. only

Container

/ShipmentRequest/Shipment/ShipmentServic Container tag for the Applies to SED forms

Cond
One

N/A

eOptions/InternationalForms/Product/Schedul schedule B information of a only. Required for SED

ScheduleB eB commodity form

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 83
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
A unique 10-digit commodity

10
classification code for the
item being exported. (To
classify a commodity access
the following Web page:
/ShipmentRequest/Shipment/ShipmentServic http://www.census.gov/foreig Applies to SED forms

string
*Yes
One
eOptions/InternationalForms/Product/Schedul n- only. Has to be 10
Number eB/Number trade/schedules/b/#search). characters.
The count of how many
Schedule B units of the Applies to SED forms
current good are in the only. Conditionally
shipment (SED only).For required for SED forms if
example, if the Schedule B ScheduleB
unit of measure is dozens UnitOfMeasurement is
/ShipmentRequest/Shipment/ShipmentServic and eight dozen, is being not X. Should be

1...10
string
Cond
One
eOptions/InternationalForms/Product/Schedul shipped, indicate 8 in this Numeric. Valid characters
Quantity eB/Quantity field. are 0 -9.

Container
/ShipmentRequest/Shipment/ShipmentServic *Yes The unit of measure

One

N/A
eOptions/InternationalForms/Product/Schedul indicated on the Export Applies to SED forms
UnitOfMeasurement eB/UnitOfMeasurement License. only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 84
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to SED forms
only. Required for the
SED form. Possible
Values: BBL: Barrels,
CAR: Carat, CKG:
Content Kilogram, CM2:
Square Centimeters,
CTN: Content Ton, CUR:
Curie, CYK: Clean Yield
Kilogram, DOZ: Dozen,
DPC: Dozen Pieces,
DPR: Dozen Pairs, FBM:
Fiber Meter, GCN: Gross
Containers, GM: Gram,
GRS: Gross, HUN:
Hundred, KG: Kilogram,
KM3: 1,000 Cubic Meters,
KTS: Kilogram Total
Sugars, L: Liter, M: Meter,
M2: Square Meters, M3:
Cubic Meters, MC:
Millicurie, NO: Number,
PCS: Pieces, PFL: Proof
The unit of measure Liter, PK: Pack, PRS:
indicated on the Export Pairs, RBA: Running
/ShipmentRequest/Shipment/ShipmentServic License. Enter an X if there Bales, SQ: Square, T:
string
*Yes

1...3
One

eOptions/InternationalForms/Product/Schedul is no unit of measure in the Ton, THS: 1,000, X: No

Code eB/UnitOfMeasurement/Code Schedule B Unit field. Quantity required.
String

/ShipmentRequest/Shipment/ShipmentServic
1...20
One

eOptions/InternationalForms/Product/Schedul Description of the Unit of

No

Description eB/UnitOfMeasurement/Description Measure

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 85
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Code indicating Domestic:

1
Exports that have been
produced, manufactured, or
grown in the United States
or Puerto Rico. This includes
imported merchandise which
has been enhanced in value
or changed from the form in
which imported by further
manufacture or processing
in the United States or
Puerto Rico. Foreign:
Merchandise that has
entered the United States
and is being exported again
in the same condition as
when imported. Applies to SED forms
ForeignMilitary: Exported only. Required for SED
/ShipmentRequest/Shipment/ShipmentServic merchandise that is sold form. Possible Values:

string
Cond
One
eOptions/InternationalForms/Product/ExportT under the foreign military D: Domestic; F: Foreign;
ExportType ype sales program. M: Foreign Military
Applies to SED forms
only. Required for SED
form. Valid characters are
0-9 and '.' (Decimal
point). Limit to 2 digit after
the decimal. The
maximum length of the
field is 15 including '.' and
can hold up to 2 decimal
places. Note: This value
is calculated based on the
Product/Unit/Value and
/Product/Unit/Number
(Number of Units * Price
The value of the S.E.D. per Unit). If the total value
/ShipmentRequest/Shipment/ShipmentServic commodity contained on the is incorrect it will be
1...15
string
Cond
One

eOptions/InternationalForms/Product/SEDTot S.E.D. This amount will replaced by the actual

SEDTotalValue alValue always be USD. calculated total value.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 86
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

If this container is not

Container tag for present we assume that

Container
determining whether or not the DEFAULT is selected
/ShipmentRequest/Shipment/ShipmentServic to exclude product which is "none" and all

One

N/A
eOptions/InternationalForms/Product/Exclude information from a particular products will appear on all

No
ExcludeFromForm FromForm form. forms.

Possible Values are 04 –

NAFTA CO. Please note

unbounded
that if this is used and you
Indicates the name of the DO NOT have the

String
/ShipmentRequest/Shipment/ShipmentServic International form requested corresponding form type

Yes

1..2
eOptions/InternationalForms/Product/Exclude to NOT have product requested this will be
FormType FromForm/FormType information. IGNORED.

Container
Unbounded
/ShipmentRequest/Shipment/ShipmentS Data Container holding

Yes*
erviceOptions/InternationalForms/Produc package related
PackingListInfo t/PackingListInfo information

Data Container holding

package/product related
information that will break
/ShipmentRequest/Shipment/ShipmentS up the product into each
String
Yes

erviceOptions/InternationalForms/Produc package on the packing

1

PackageAssociated t/PackingListInfo/PackageAssociated list

/ShipmentRequest/Shipment/ShipmentS Package number the

erviceOptions/InternationalForms/Produc product should be
String
Yes

t/PackingListInfo/PackageAssociated/Pa allocated to ont he

1

PackageNumber ckageNumber packing list

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 87
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

/ShipmentRequest/Shipment/ShipmentS Amount of Product

erviceOptions/InternationalForms/Produc associated with a

Yes
t/PackingListInfo/PackageAssociated/Pro package
ProductAmount ductAmount
Applies to Invoice and
Partial Invoice forms only.
Required for Invoice

1...35
string
One
/ShipmentRequest/Shipment/ShipmentServic Commercial Invoice number forms and optional for

No
InvoiceNumber eOptions/InternationalForms/InvoiceNumber assigned by the exporter Partial Invoice.
Applies to Invoice and

8
Partial Invoice forms only.
Required for Invoice
forms and optional for
Partial Invoice. Required
for Invoice form for
forward shipments. For
shipment with return
service, the user input will
be ignored, and the field
string Date when the Invoice is will be blank on the
Cond
One

/ShipmentRequest/Shipment/ShipmentServic created. Ideally this is the invoice. Format is

InvoiceDate eOptions/InternationalForms/InvoiceDate same as the ship date. yyyyMMdd
/ShipmentRequest/Shipment/ShipmentServic
1...35
string
One

eOptions/InternationalForms/PurchaseOrderN The customer's order Applies to Invoice and

No

PurchaseOrderNumber umber reference number Partial Invoice forms only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 88
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

3
Applies to Invoice and
Partial Invoice forms only.
Possible values are: CFR:
Cost and Freight, CIF:
Cost, Insurance and
Freight, CIP: Carriage
and Insurance Paid, CPT:
Carriage Paid To, DAF:
Delivered at Frontier,
DDP: Delivery Duty Paid,
DDU: Delivery Duty
Unpaid, DEQ: Delivered
Ex Quay, DES: Delivered
Ex Ship, EXW: Ex Works,
/ShipmentRequest/Shipment/ShipmentServic FAS: Free Alongside

string
One
eOptions/InternationalForms/TermsOfShipme Indicates the rights to the Ship, FCA: Free Carrier,

No
TermsOfShipment nt seller from the buyer. FOB: Free On Board.

reason to export the current

international shipment Applies to Invoice and
Possible values: SALE, Partial Invoice forms only.
GIFT, SAMPLE, RETURN, Required for Invoice
/ShipmentRequest/Shipment/ShipmentServic REPAIR, forms and Optional for

1...20
string
Cond
One
eOptions/InternationalForms/ReasonForExpor INTERCOMPANYDATA, Partial Invoice. No
ReasonForExport t Any other reason validation
1...150
string
One

/ShipmentRequest/Shipment/ShipmentServic Any extra information about Applies to Invoice and

No

Comments eOptions/InternationalForms/Comments the current shipment Partial Invoice forms only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 89
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
This is the legal explanation,
used by Customs, for the
delivering of this shipment. It
must be identical to the set
of declarations actually used
by Customs. Examples of
declarations that might be
entered in this field are: I
hereby certify that the goods
covered by this shipment
qualify as originating goods
for purposes of preferential
tariff treatment under the Applies to Invoice and
NAFTA. I hereby certify that Partial Invoice forms only.
the information on this On the invoice for return
invoice is true and correct shipment, the verbiage is
and the contents and value as follows (user input is
of this shipment is as stated ignored): The exporter of
above. EEA statement: The the products covered by
exporter of the products this document declares
covered by this document that except where
declares that except where otherwise clearly

1...550
/ShipmentRequest/Shipment/ShipmentServic otherwise clearly indicated indicated these products

string
One
eOptions/InternationalForms/DeclarationState these products are of EEA are of EEA preferential
No

DeclarationStatement ment Container preferential origin. origin

One

N/A

/ShipmentRequest/Shipment/ShipmentServic Container tag that holds the Applies to Invoice and

No

Discount eOptions/InternationalForms/Discount discount. Partial Invoice forms only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 90
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

15
Applies to Invoice and
Partial Invoice forms only.
Required for Invoice
forms and optional for
Partial Invoice. Valid
characters are 0-9 and '.'
(Decimal point). Limit to 2
digit after the decimal.
The maximum length of
the field is 15 including '.'
and can hold up to 2
decimal places. This
value should be greater
The discount to be than or equal to zero or
/ShipmentRequest/Shipment/ShipmentServic subtracted from the sum of less than or equal to the

string
*Yes
One
eOptions/InternationalForms/Discount/Moneta the total value on the value of all goods listed
MonetaryValue ryValue invoice. on the invoice.

Container
One

N/A
/ShipmentRequest/Shipment/ShipmentServic Container tag that holds the Applies to Invoice and
No

FreightCharges eOptions/InternationalForms/FreightCharges Freight Charges Partial Invoice forms only.

Applies to Invoice and
Partial Invoice forms only.
Required for Invoice
forms and optional for
Partial Invoice. Valid
characters are 0-9 and '.'
(Decimal point). Limit to 2
digit after the decimal.
The maximum length of
/ShipmentRequest/Shipment/ShipmentServic the field is 15 including '.'
0...15
string
*Yes
One

eOptions/InternationalForms/FreightCharges/ Cost to transport the and can hold up to 2

MonetaryValue MonetaryValue shipment decimal places.
Container

/ShipmentRequest/Shipment/ShipmentServic
One

N/A

eOptions/InternationalForms/InsuranceCharg Container tag that holds the Applies to Invoice and

No

InsuranceCharges es Insurance Charges Partial Invoice forms only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 91
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Applies to Invoice and

Partial Invoice forms only.
Required for Invoice
forms and optional for
Partial Invoice. Valid
characters are 0-9 and '.'
(Decimal point). Limit to 2
The amount the shipper or digit after the decimal.
receiver pays to cover the The maximum length of
/ShipmentRequest/Shipment/ShipmentServic cost of replacing the the field is 15 including '.'

0...15
string
*Yes
One
eOptions/InternationalForms/InsuranceCharg shipment if it is lost or and can hold up to 2
MonetaryValue es/MonetaryValue damaged decimal places.

Container tag that holds the

Container
information of amount that
covers additional charges

One

N/A
/ShipmentRequest/Shipment/ShipmentServic not already listed on the Applies to Invoice and

No
OtherCharges eOptions/InternationalForms/OtherCharges invoice Partial Invoice forms only.
Applies to Invoice and
Partial Invoice forms only.
Required for Invoice
forms and optional for
Partial Invoice. Valid
characters are 0-9 and '.'
(Decimal point). Limit to 2
digit after the decimal.
The maximum length of
/ShipmentRequest/Shipment/ShipmentServic the field is 15 including '.'
0...15
string
*Yes
One

eOptions/InternationalForms/OtherCharges/M The Monetary value of Other and can hold up to 2

MonetaryValue onetaryValue Charges decimal places.

Applies to Invoice and

Partial Invoice forms only.
/ShipmentRequest/Shipment/ShipmentServic Required for Complete
1...10
string
*Yes
One

eOptions/InternationalForms/OtherCharges/D Description of what the other Invoice and Optional for

Description escription charges are for. Partial Invoice forms.
3

Currency code for all the

string
Cond
One

/ShipmentRequest/Shipment/ShipmentServic monetary values of the Applies to Invoice and

CurrencyCode eOptions/InternationalForms/CurrencyCode Invoice form Partial Invoice forms only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 92
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
This field should be entered
if the NAFTA Certificate
covers multiple shipments of
identical goods as described
in the Description of Goods
field that are imported into a
NAFTA country for a
specified period of up to one
year (the blanket period).
The importation of a good for Applies to NAFTA CO

Container
which preferential treatment form only. Required for
is claimed based on this NAFTA CO. This is not

Cond
One

N/A
/ShipmentRequest/Shipment/ShipmentServic certificate must occur valid for a paperless
BlanketPeriod eOptions/InternationalForms/BlanketPeriod between these dates. shipment.
Begin date of the blanket

8
period. It is the date upon
which the Certificate Applies to NAFTA CO
becomes applicable to the form only. Required for
good covered by the blanket NAFTA CO. Format is
/ShipmentRequest/Shipment/ShipmentServic Certificate (it may be prior to yyyyMMdd. This is not

string
*Yes
One
eOptions/InternationalForms/BlanketPeriod/B the date of signing this valid for a paperless
BeginDate eginDate Certificate). shipment.
Applies to NAFTA CO

8
form only. Required for
End Date of the blanket NAFTA CO. Format is
/ShipmentRequest/Shipment/ShipmentServic period. It is the date upon yyyyMMdd. This is not
string
*Yes
One

eOptions/InternationalForms/BlanketPeriod/E which the blanket period valid for a paperless

EndDate ndDate expires. shipment.
8

Applies to CO and SED

forms only. Required for
string
Cond
One

/ShipmentRequest/Shipment/ShipmentServic The date the goods will be CO and SED forms.

ExportDate eOptions/InternationalForms/ExportDate exiting the country Format is yyyyMMdd

The name of the carrier that

is exporting the shipment.
The vessels flag number Applies to CO and SED
1...35
string
Cond
One

/ShipmentRequest/Shipment/ShipmentServic should also be entered, if the forms only. Required for

ExportingCarrier eOptions/InternationalForms/ExportingCarrier carrier is a vessel. CO and SED forms.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 93
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The four-character Standard
Carrier Alpha Code (SCAC)
for vessel, rail, and truck
shipments. For air shipment,
enter the two or three
character International Air

1...17
string
One
/ShipmentRequest/Shipment/ShipmentServic Transport Association (IATA) Applies to SED forms

No
CarrierID eOptions/InternationalForms/CarrierID code only. No Validations.

2
Applies to SED forms
only. Required for SED
forms. Valid values are:
70: Not in bond; 36:
Warehouse withdrawal for
IE; 37: Warehouse
withdrawal for T and E;
62: T and E; 63: IE; 67:

string
Cond
One
/ShipmentRequest/Shipment/ShipmentServic The two-character In Bond IE from a FTZ; 68: T and
InBondCode eOptions/InternationalForms/InBondCode Code E from a FTZ

The Import Entry Number

when the export transaction Applies to SED forms
is used as proof of export for only. Conditionally
import transactions Required for SED forms
(examples: In Bond, when In bond code value

1...25
string
Cond
One

/ShipmentRequest/Shipment/ShipmentServic Temporary Import Bond or is other than 70(Not In

EntryNumber eOptions/InternationalForms/EntryNumber Drawbacks) Bond)
Contains one of the
following: The two-digit U.S.
Postal Service abbreviation
for the state from which the
goods were shipped to the
port of export. The state that
is the source for the good
with the highest value. The
state of consolidation. The
Foreign Trade Zone number
of the zone from where the
exports are leaving. If the
string
Cond

1...5
One

/ShipmentRequest/Shipment/ShipmentServic goods were shipped from Applies to SED forms

PointOfOrigin eOptions/InternationalForms/PointOfOrigin Puerto Rico, enter PR. only. Required for SED

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 94
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Mode of transport by which
the goods are exported.
Possible values: Air,
AirContainerized, Auto,
FixedTransportInstallations,
Mail, Applies to SED forms
PassengerHandcarried, only. Required for SED.
Pedestrian, Rail, Rail, Only allowed values can
Containerized, RoadOther, be entered. Only 10
SeaBarge, Characters can appear on
/ShipmentRequest/Shipment/ShipmentServic SeaContainerized, the form. Anything greater

1...35
string
Cond
One
eOptions/InternationalForms/ModeOfTranspor SeaNoncontainerized, than 10 characters will be
ModeOfTransport t Truck, TruckContainerized truncated on the form.
Should be one of the
following-Overland: The U.S.
Customs port where the
carrier crosses the U.S.
border. -Vessel and Air: The
U.S. Customs port where the
goods are loaded on the
carrier to be exported from
the U.S. -Postal: The U.S.

1...35
string
/ShipmentRequest/Shipment/ShipmentServic One Postal Office from where the Applies to SED forms
No

PortOfExport eOptions/InternationalForms/PortOfExport goods are mailed only. No validation.

The country and the port

1...35 where the goods will be
unloaded from the exporting
string
One

/ShipmentRequest/Shipment/ShipmentServic carrier. For vessel and air Applies to SED forms

No

PortOfUnloading eOptions/InternationalForms/PortOfUnloading shipments only. only. No validation.

Pier where goods are

1...35
string
One

/ShipmentRequest/Shipment/ShipmentServic loaded. For vessel Applies to SED forms

No

LoadingPier eOptions/InternationalForms/LoadingPier shipments only only. No validation.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 95
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Information about parties to

1
transaction. Use Related, if
the parties to the transaction
are related. A related party is
an export from a U.S.
businessperson or business
to a foreign business or from
a U.S. business to a foreign
person or business where
the person has at least 10
percent of the voting shares
of the business during the
/ShipmentRequest/Shipment/ShipmentServic fiscal year. If unincorporated, Applies to SED forms

string
Cond
One
eOptions/InternationalForms/PartiesToTransa then an equivalent interest in only. Valid values are: R
PartiesToTransaction ction the business. - Related, N - Non-related

If Present, indicates that it is

a routed export transaction.
A routed export transaction
is one, where the foreign
principal party in interest
authorizes a U.S. forwarding

EMPTY
/ShipmentRequest/Shipment/ShipmentServic (or other) agent to export the
One

N/A
RoutedExportTransactionIndicato eOptions/InternationalForms/RoutedExportTra merchandise outside the Applies to SED forms
No

r nsactionIndicator U.S. only

If present indicates that the
EMPT

/ShipmentRequest/Shipment/ShipmentServic goods are containerized.

One

N/A
eOptions/InternationalForms/ContainerizedInd This applies to vessel Applies to SED forms
No

ContainerizedIndicator icator shipments only only

Container for License
information. If the product is
not licensable, a valid
license exception code
needs to be entered. If
shipping different products
Container

that are covered under

different licenses or license Applies to SED forms
Cond
One

N/A

/ShipmentRequest/Shipment/ShipmentServic exceptions, then separate only. Required for SED

License eOptions/InternationalForms/License SEDs must be created. forms.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 96
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to SED forms
only. Either License
number or License
exception code should be
present for SED form,
both License number and
License Exception code

1...35
string
Cond
One
/ShipmentRequest/Shipment/ShipmentServic The license number that cannot be present for
Number eOptions/InternationalForms/License/Number authorizes ship product. SED form.
Applies to SED forms
only. Conditionally
required for SED forms if
there is a license number.
Only applicable when
License Number is

string
Cond

1...8
One
/ShipmentRequest/Shipment/ShipmentServic provided. Format
Date eOptions/InternationalForms/License/Date License Date yyyyMMdd

Applies to SED forms

only. Either License
number or License
exception code should be
present for SED form,
both License number and
License Exception code
/ShipmentRequest/Shipment/ShipmentServic cannot be present for
string
Cond

1...4
One

eOptions/InternationalForms/License/Exceptio Please refer to Appendix Q SED form. Validated for

ExceptionCode nCode for values and descriptions. possible values
8

Export Control Classification

Number. This number Applies to SED forms
identifies categories, product only. ECCN is required
groups, strategic level of one of the following
control, and country groups. License Exception Codes
string
Cond
One

/ShipmentRequest/Shipment/ShipmentServic Some products have an is entered: CIV, CTP,

ECCNNumber eOptions/InternationalForms/ECCNNumber ECCN number. ENC, or KMI LVS

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 97
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The application will
automatically provide a copy
of the invoice or NAFTA/CO
with each response
regardless of whether the
user has enabled Paperless

String
/ShipmentRequest/Shipment/ShipmentServic account. The user now has
eOptions/InternationalForms/OverridePaperle the option to print or ignore

No
1
OverridePaperlessIndicator ssIndicator the copy provided.

String
Text for the shipper to add

300
/ShipmentRequest/Shipment/ShipmentServic additional information

No
1
ShipperMemo eOptions/InternationalForms/ShipperMemo

container
For a list of valid
origin/destination countries

One

N/A
/ShipmentRequest/Shipment/ShipmentServic please refer to the table in

No
DeliveryConfirmation eOptions/DeliveryConfirmation Appendix N Forwards Only

Valid values are: 1 -

Delivery Confirmation
Signature Required 2 -
Delivery Confirmation
string
Yes*
One

/ShipmentRequest/Shipment/ShipmentServic Adult Signature Required.

DCISType eOptions/DeliveryConfirmation/DCISType 1 Type of delivery confirmation Forwards Only
String
1...20
One

/ShipmentRequest/Shipment/ShipmentServic
No

DCISNumber eOptions/DeliveryConfirmation/DCISNumber DCIS Number

0

The flag indicates the

String

ReturnOfDocument Valid for Poland to Poland

One

/ShipmentRequest/Shipment/ShipmentServic accessorial has been without return service

No

ReturnOfDocumentIndicator eOptions/ReturnOfDocumentIndicator requested only.

0
String

Indicates that the Shipment

One

/ShipmentRequest/Shipment/ShipmentServic is an ImportControl
No

ImportControlIndicator eOptions/ImportControlIndicator shipment.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 98
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
Type of ImportControl
Label.|This container is This container is

One

N/A
/ShipmentRequest/Shipment/ShipmentServic applicable only for applicable only for

No
LabelMethod eOptions/LabelMethod ImportControl shipments. ImportControl shipments.

2
LabelMethod types:'01' =
ImportControl Print and
Mail'02' = ImportControl
One-Attempt'03' =
ImportControl Three-

String
Attempt'04' = ImportControl

Yes*
One
/ShipmentRequest/Shipment/ShipmentServic Electronic Label'05' =
Code eOptions/LabelMethod/Code ImportControl Print Label

String
1...35
One
/ShipmentRequest/Shipment/ShipmentServic

No
Description eOptions/LabelMethod/Description LabelMethod description
CommercialInvoiceRemovalI

0
ndicator allows a shipper to
dictate that UPS remove the
Commercial Invoice from the
String
/ShipmentRequest/Shipment/ShipmentServic user's shipment before the
One

CommercialInvoiceRemovalIndic eOptions/CommercialInvoiceRemovalIndicato shipment is delivered to the

No

ator r 0 ultimate consignee.

UPS carbon neutral indicator

String

presence at shipment level

One

/ShipmentRequest/Shipment/ShipmentServic is required to create carbon

No

UPScarbonneutralIndicator eOptions/UPScarbonneutralIndicator neutral Shipments.

This container is used for

unbounded

providing Pre-Alert
Container

Notifications to the
consignee for UPS
N/A

/ShipmentRequest/Shipment/ShipmentServic Exchange movements and

No

PreAlertNotification eOptions/PreAlertNotification Pack & Collect shipments.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 99
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
This container is used for
Populating EMailMessage

One

N/A
/ShipmentRequest/Shipment/ShipmentServic details for

No
EMailMessage eOptions/PreAlertNotification/EMailMessage PreAlertNotification

1…50
String
/ShipmentRequest/Shipment/ShipmentServic

One
Yes
eOptions/PreAlertNotification/EMailMessage/ EMailAddress where
EMailAddress EMailAddress PreAlertNotification is sent.

This is used for notification

1…50
String
/ShipmentRequest/Shipment/ShipmentServic when EMailAddress for

One
eOptions/PreAlertNotification/EMailMessage/ PreAlertNotification is

No
UndeliverableEMailAddress UndeliverableEMailAddress undeliverable.

Container
VoiceMessage container is
used for specifying phone

One

N/A
/ShipmentRequest/Shipment/ShipmentServic No number for receiving voice
VoiceMessage eOptions/PreAlertNotification/VoiceMessage preAlertNotification

1…15
/ShipmentRequest/Shipment/ShipmentServic String
One
Yes

eOptions/PreAlertNotification/VoiceMessage/ Phone number for receiving

PhoneNumber PhoneNumber Voice PreAlertNotification.
Container

TextMessage container is
used for specifying phone
One

N/A

/ShipmentRequest/Shipment/ShipmentServic number for receiving text

No

TextMessage eOptions/PreAlertNotification/TextMessage preAlertNotification

1…15
String

/ShipmentRequest/Shipment/ShipmentServic
One
Yes

eOptions/PreAlertNotification/TextMessage/P Phone number for receiving

PhoneNumber honeNumber Text PreAlertNotification.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 100
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
This container is used for
providing Language and

One
Yes

N/A
/ShipmentRequest/Shipment/ShipmentServic dialect details for
Locale eOptions/PreAlertNotification/Locale PreAlertNotifications.

3
Valid language-dialect
combinations are below:||
Lang Dialect| DAN97|
DEU97| ENGGB|
ENGUS| FIN97| FRA97|
FRACA| ITA97| NLD97|
POR97| SPA97|
SWE97| ENGCA|
NOR97| POL97| CES97|
ELL97| ENGCA| HEB97|
HUN97| NLD97|

String
/ShipmentRequest/Shipment/ShipmentServic NOR97| RUS97| SLK97|

One
Yes
eOptions/PreAlertNotification/Locale/Languag TUR97| VIE97| ZHOTW|
Language e Valid Language RONRO| SPAPR

2
Valid language-dialect
combinations are below:||
Lang Dialect| DAN97|
DEU97| ENGGB|
ENGUS| FIN97| FRA97|
FRACA| ITA97| NLD97|
POR97| SPA97|
SWE97| ENGCA|
NOR97| POL97| CES97|
ELL97| ENGCA| HEB97|
HUN97| NLD97|
String

NOR97| RUS97| SLK97|

One
Yes

/ShipmentRequest/Shipment/ShipmentServic TUR97| VIE97| ZHOTW|

Dialect eOptions/PreAlertNotification/Locale/Dialect Valid Dialect RONRO| SPAPR
0

Exchange forward indicator

presence at shipment level In the label routing
String

is required to create Instruction text by default

One

/ShipmentRequest/Shipment/ShipmentServic exchange forward will be EXCHANGE-LIKE

No

ExchangeForwardIndicator eOptions/ExchangeForwardIndicator Shipments. ITEM ONLY

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 101
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

For Return Shipments up

to and including 20

Container
##
packages are allowed.
US/PR origin return

Yes

N/A
Package Information movements are limited to
Package /ShipmentRequest/Shipment/Package container. only one package.

1...35
string
Cond
One
/ShipmentRequest/Shipment/Package/Descri Merchandise description of Required for shipment
Description ption package. with return service

container
Packaging type is
required for Ground

Cond
One

N/A
/ShipmentRequest/Shipment/Package/Packag Freight Pricing
Packaging ing Packaging Container Shipments only

2
Package type 24, or 25
Package types. Values are: or 30 is only allowed for
01 = UPS Letter, 02 = shipment without return
Customer Supplied service. Packaging type
Package, 03 = Tube, 04 = must be valid for all the
PAK, 21 = UPS Express following: ShipTo
Box, 24 = UPS 25KG Box, country, ShipFrom
25 = UPS 10KG Box, 30 = country, a shipment going
Pallet, 2a = Small Express from ShipTo country to
Box, 2b = Medium Express ShipFrom country, all
Box, 2c = Large Express Accessorials at both the
Box. Note: Only packaging shipment and package
string
Yes*
One

/ShipmentRequest/Shipment/Package/Packag type code 02 is applicable to level, and the shipment

Code ing/Code Ground Freight Pricing service type.

Description of packaging
String
1...35

type. Examples are letter,

One

/ShipmentRequest/Shipment/Package/Packag customer supplied, express

No

Description ing/Description box. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 102
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Length + 2*(Width +
Height) must be less than
Dimensions information or equal to 130 IN or 330

container
container. Note: Currently CM. Dimensions are
dimensions are not required for GB to GB

Cond
One

N/A
/ShipmentRequest/Shipment/Package/Dimen applicable to Ground Freight and Poland to Poland
Dimensions sions Pricing Shipments.

container
One
Yes

N/A
/ShipmentRequest/Shipment/Package/Dimen UnitOfMeasurement
UnitOfMeasurement sions/UnitOfMeasurement container N/A
Package dimensions

2
measurement code. Codes
are: IN = Inches, CM =
Centimeters, 00 = Metric
Units Of Measurement, 01 = The unit of measurement

string
One
Yes
/ShipmentRequest/Shipment/Package/Dimen English Units of must be valid for the
Code sions/UnitOfMeasurement/Code Measurement. Shipper country.

Description of the package

1...35
string
/ShipmentRequest/Shipment/Package/Dimen One dimensions measurement
No

Description sions/UnitOfMeasurement/Description units. N/A

Package length. Refer to
3 Universal Rules table for
additional information.Length
string
Yes*
One

/ShipmentRequest/Shipment/Package/Dimen must be the longest Valid values are 0 to 108

Length sions/Length dimension of the container. IN and 0 to 270 CM.
3

Package width. Refer to

string
Yes*
One

/ShipmentRequest/Shipment/Package/Dimen Universal Rules table for

Width sions/Width additional information. N/A
3

Package height. Refer to

string
Yes*
One

/ShipmentRequest/Shipment/Package/Dimen Universal Rules table for

Height sions/Height additional information. N/A
Container

Package weight is a
Cond
One

N/A

/ShipmentRequest/Shipment/Package/Packag Container to hold package required field for Ground

PackageWeight eWeight weight information. Freight Pricing shipments

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 103
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
Container to hold

One
Yes

N/A
/ShipmentRequest/Shipment/Package/Packag UnitOfMeasurement
UnitOfMeasurement eWeight/UnitOfMeasurement information. N/A

3
Package weight unit of
measurement code. Codes

string
One
Yes
/ShipmentRequest/Shipment/Package/Packag are: LBS = Pounds, KGS =
Code eWeight/UnitOfMeasurement/Code Kilograms.

1...35
string
One
/ShipmentRequest/Shipment/Package/Packag Description of the package

No
Description eWeight/UnitOfMeasurement/Description weight measurement units. N/A
Only {Average}package
Packages weight. Weight weight is required for

string
Yes*

1...5
One
/ShipmentRequest/Shipment/Package/Packag accepted for Ground Freight Pricing
Weight eWeight/Weight letters/envelopes. Shipment

0
Presence of the indicator

string
One
/ShipmentRequest/Shipment/Package/LargeP No mentions that the package is
LargePackageIndicator ackageIndicator Large Package. Empty Tag.

container
One

N/A
/ShipmentRequest/Shipment/Package/Refere Package reference number
No

ReferenceNumber nceNumber information container N/A

Empty Tag. Allowed for
0

shipment with return

service only. Only one
shipment-level or
package-level reference
number can be bar coded
per shipment. In order to
barcode a reference
number, its value must be
no longer than 14
If the indicator is present alphanumeric characters
then the reference numbers or 24 numeric characters
string
One

/ShipmentRequest/Shipment/Package/Refere value will be bar coded on and cannot contain

No

BarCodeIndicator nceNumber/BarCodeIndicator the label. spaces.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 104
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

2
Reference number type
code, for the entire
shipment. The code
specifies the Reference Valid if the
name. Refer to the origin/destination pair is

string
One
/ShipmentRequest/Shipment/Package/Refere Reference Number Code US/US or PR/PR.2

No
Code nceNumber/Code table. character alpha-numeric.
Valid if the
origin/destination pair is
US/US or PR/PR.
Supports up to 2
customer supplied
combinations of

1...35
string
Yes*
One
/ShipmentRequest/Shipment/Package/Refere Customer supplied reference Reference code- value
Value nceNumber/Value number. combinations.

0
Additional Handling
Required.The presence
indicates additional handling
is required, the absence

string
One
/ShipmentRequest/Shipment/Package/Additio No indicates no additional
AdditionalHandlingIndicator nalHandlingIndicator handling is required. Empty Tag.

container
One

N/A
/ShipmentRequest/Shipment/Package/Packag PackageServiceOtioncontain
No

PackageServiceOptions eServiceOptions er N/A

container

For a list of valid

origin/destination countries
One

N/A

/ShipmentRequest/Shipment/Package/Packag please refer to the table in

No

DeliveryConfirmation eServiceOptions/DeliveryConfirmation Appendix N Forwards Only

Valid values are: 1 -
1

Delivery Confirmation 2
- Delivery Confirmation
Signature Required 3 -
/ShipmentRequest/Shipment/Package/Packag Delivery Confirmation
string
Yes*
One

eServiceOptions/DeliveryConfirmation/DCIST Adult Signature Required.

DCISType ype Type of delivery confirmation Forwards Only

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 105
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Delivery Confirmation
/ShipmentRequest/Shipment/Package/Packag

1...11
Control number associated

string
One
eServiceOptions/DeliveryConfirmation/DCISN with the delivery

No
DCISNumber umber confirmation for the package Forwards Only

container
One

N/A
/ShipmentRequest/Shipment/Package/Packag

No
DeclaredValue eServiceOptions/DeclaredValue Container for DeclaredValue N/A

container
One

N/A
/ShipmentRequest/Shipment/Package/Packag Container for Declared

No
Type eServiceOptions/DeclaredValue/Type Value Type N/A
The user cannot specify

2
different type of declared
value for the shipment.
You can either have
shipper declared value
(DVS) or declared value
(EVS) but not both at
package level. Note: The
Declared value type. Valid Shipper Declared Value is
value are 01=EVS, 02=DVS. applicable for forward
Defaults to 01 i.e. EVS if shipments when the
string
*Yes
One

/ShipmentRequest/Shipment/Package/Packag declared value type is not billing option is freight

Code eServiceOptions/DeclaredValue/Type/Code provided. collect or third party

/ShipmentRequest/Shipment/Package/Packag
1...35
string
One

eServiceOptions/DeclaredValue/Type/Descrip
No

Description tion Declared value Description N/A

3

Declared value amount

/ShipmentRequest/Shipment/Package/Packag currency type. Defaults to Code must represent a
string
Yes*
One

eServiceOptions/DeclaredValue/CurrencyCod the non-Euro currency used currency that is a valid for

CurrencyCode e in the shipper's country. Shipper country.

/ShipmentRequest/Shipment/Package/Packag
1...19
string
Yes*
One

eServiceOptions/DeclaredValue/MonetaryVal
MonetaryValue ue Declared value amount.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 106
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Indicates COD is
requested. Package level
COD is available for
shipment without return
service from US/PR to
US/PR, CA to CA, and
CA to US.CA to US COD

container
is not allowed for package
Letter/ Envelope. COD is

One

N/A
/ShipmentRequest/Shipment/Package/Packag not valid for return service

No
COD eServiceOptions/COD COD container movements.
Values are: 0 = check,

1
cashiers check or money
order - no cash allowed, 8 =

string
Yes*
One
/ShipmentRequest/Shipment/Package/Packag cashiers check or money
CODFundsCode eServiceOptions/COD/CODFundsCode order - no cash allowed. N/A

container
Yes*
One

N/A
/ShipmentRequest/Shipment/Package/Packag
CODAmount eServiceOptions/COD/CODAmount CODAmount container N/A

/ShipmentRequest/Shipment/Package/Packag 3
string
One
Yes

eServiceOptions/COD/CODAmount/Currency COD amount currency code

CurrencyCode Code type. N/A
5

/ShipmentRequest/Shipment/Package/Packag
string
One
Yes

eServiceOptions/COD/CODAmount/Monetary Valid values: 0.01 USD -

MonetaryValue Value COD Amount. 50000.00 USD
Container
One

N/A

/ShipmentRequest/Shipment/Package/Packag Allowed for shipment

No

VerbalConfirmation eServiceOptions/VerbalConfirmation Verbal Confirmation Info. without return service.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 107
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Optional if the Shipper's
AttentionName,
PhoneNumber, and
PhoneExtension(optional)
are given and are the

Container
desired name, phone
/ShipmentRequest/Shipment/Package/Packag number and extension,

Cond
One

N/A
eServiceOptions/VerbalConfirmation/ContactI respectively, to be used for
ContactInfo nfo verbal confirmation. N/A

Optional if Shipper/
AttentionName is given
Name of the person to be and that is the name of
/ShipmentRequest/Shipment/Package/Packag the person to be

1...35
contacted for confirmation.

string
Cond
One
eServiceOptions/VerbalConfirmation/ContactI Defaults to Shipper contacted else required
Name nfo/Name AttentionName if given. for verbal confirmation.

Container
/ShipmentRequest/Shipment/Package/Packag

One

N/A
eServiceOptions/VerbalConfirmation/ContactI No
Phone nfo/Phone Phone Container N/A

String
/ShipmentRequest/Shipment/Package/Packag
1...15
Yes*
One

eServiceOptions/VerbalConfirmation/ContactI
Number nfo/Phone/Number Contact Phone Number N/A
String

/ShipmentRequest/Shipment/Package/Packag
1...4
One

eServiceOptions/VerbalConfirmation/ContactI
No

Extension nfo/Phone/Extension Contact Phone Extension N/A

The presence indicates that
0

the package may be Empty Tag. Only

String

released by driver without a available for US50/PR to

One

/ShipmentRequest/Shipment/Package/Packag signature from the US50/PR packages

No

ShipperReleaseIndicator eServiceOptions/ShipperReleaseIndicator consignee without return service.

Container
One

N/A

/ShipmentRequest/Shipment/Package/Packag Applicable for Shipment

No

Notification eServiceOptions/Notification Receiver Return Notification with returned service.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 108
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1
String
Yes*
One
/ShipmentRequest/Shipment/Package/Packag 3 - Receiver Return
NotificationCode eServiceOptions/Notification/NotificationCode Notification Code Notification

Container
Yes*
One

N/A
/ShipmentRequest/Shipment/Package/Packag Container for the e-mail
EMail eServiceOptions/Notification/EMail Message. N/A

String
/ShipmentRequest/Shipment/Package/Packag The destination email

1...50
Yes*
One
eServiceOptions/Notification/EMail/EMailAddr address of the receiver
EMailAddress ess returns notification email. N/A

The e-mail address where

an undeliverable email Defaults to

String
/ShipmentRequest/Shipment/Package/Packag message is sent if the FromEMailAddress. Only

1...50
One
eServiceOptions/Notification/EMail/Undelivera Receiver Return Notification allowed at the first
UndeliverableEMailAddress bleEMailAddress No email is undeliverable. package.

The email address listed in

the Reply To field of the
message header, includes
name and e-mail address of
String

/ShipmentRequest/Shipment/Package/Packag sender. The From field of

1...50
One

eServiceOptions/Notification/EMail/FromEMail the message header Only allowed at the first

No

FromEMailAddress Address contains [email protected]. package.

String

/ShipmentRequest/Shipment/Package/Packag The name the receiver Defaults to the Shipper

1...35
One

eServiceOptions/Notification/EMail/FromNam return notification will appear Name. Only allowed at

No

FromName e to be from. the first package.

1...150
String
One

/ShipmentRequest/Shipment/Package/Packag User defined text that will be Only allowed at the first
No

Memo eServiceOptions/Notification/EMail/Memo included in the email. package.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 109
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

The eMail's subject. Defaults

String
to the UPS Receiver Return

1...75
One
/ShipmentRequest/Shipment/Package/Packag Notification plus the Only allowed at the first

No
Subject eServiceOptions/Notification/EMail/Subject shipment ID. package

2
If the subject code tag is
not provided and the
subject text is provided,
the subject of the
notification will be the
subject text. If the subject
Specifies a reference code text is provided, and
and reference number to subject code tag exists,
display in the subject of the then the subject code
Receiver Return Notification. value must be 08;If the
When the subject code is subject code is 08, the
provided, the subject will subject text must exist. If
contain the following: UPS a subject code is provided
Receiver Return Notification. that refers to a
The reference code (the nonexistent reference
reference code will be number, the subject will

String
/ShipmentRequest/Shipment/Package/Packag mapped to the default to the tracking
One
eServiceOptions/Notification/EMail/SubjectCo corresponding ANSI value) number. Only allowed at
No

SubjectCode de Plus the reference number. the first package.

0 Returns Flexible Access
Indicator presence at
package level is required for
UPS Returns Flexible
Access Shipments. All
packages in the shipment
String

/ShipmentRequest/Shipment/Package/Packag must have the Returns

One

eServiceOptions/ReturnsFlexibleAccessIndica Flexible Access Indicator if

No

ReturnsFlexibleAccessIndicator tor one package has it.

1
Container

Cannot be used when the

N/A

/ShipmentRequest/Shipment/Package/Packag MAximum of 1. Cannot be package also contains

No

X
DryIce eServiceOptions/DryIce combined with <Hazmat> Hazmat

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 110
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1
Regulation set for dryIce
Shipment. Valid values are :
CFR = HazMat regulated by
US Dept of Transportation
within the U.S. or ground

String
shipments to Canada,

Yes

3..4
/ShipmentRequest/Shipment/Package/Packag IATA= Worldwide Air The following values are

X
RegulationSet eServiceOptions/DryIce/RegulationSet movement valid: IATA,CFR

1
Container
Yes

N/A
/ShipmentRequest/Shipment/Package/Packag

X
DryIceWeight eServiceOptions/DryIce/DryIceWeight

1
Container
/ShipmentRequest/Shipment/Package/Packag

Yes

N/A
eServiceOptions/DryIce/DryIceWeight/UnitOf

X
UnitOfMeasurement Measurement
DryIce weight unit of
1 measurement code. Valid
values are: 00 = KG(Metric
String Unit of Measurements), 01 =
/ShipmentRequest/Shipment/Package/Packag LB(English Unit of The following values are
Yes

2..3
eServiceOptions/DryIce/DryIceWeight/UnitOf Measurements), KG, LB, valid : 00 , 01, KG , KGS ,

X
Code Measurement/Code KGS, LBS LBS
1
String

/ShipmentRequest/Shipment/Package/Packag
0..20

eServiceOptions/DryIce/DryIceWeight/UnitOf Short description for

No

X
Description Measurement/Description UnitOfMeasurement
Cannot be more than
1

package weight. Should

be more than 0.0. Valid
characters are 0-9 and
.(Decimal point). Limit to
1 digit after the decimal.
The maximum length of
String

the field is 5 including .

1…5
Yes

/ShipmentRequest/Shipment/Package/Packag and can hold up to 1

X
Weight eServiceOptions/DryIce/DryIceWeight/Weight Weight decimal place.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 111
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Presence/Absence Indicator.

0
Any value inside is ignored.
Relevant only in CFR
regulation set. If present it is
used to designate the dry Ice
is for any medical use and

String
rates are adjusted for dryIce
/ShipmentRequest/Shipment/Package/Packag weight more than 2.5 Kgs or

No

X
MedicalUseIndicator eServiceOptions/DryIce/MedicalUseIndicator 5.7 LBs

Container
It is required if the Ground
Freight Pricing Shipment

Cond
One

N/A
/ShipmentRequest/Shipment/Package/Comm Container to hold the indicator is present in the
Commodity odity Commodity information request.

10
Freight Classification.

String
Freight class partially Required for Ground

One
Yes
/ShipmentRequest/Shipment/Package/Comm determines the freight rate Freight Pricing
FreightClass odity/FreightClass for the article. Shipments only

Container
One

/ShipmentRequest/Shipment/Package/Comm N/A Container to hold the NMFC

No

NMFC odity/NMFC codes

String
One
Yes

4..6

/ShipmentRequest/Shipment/Package/Comm Specifies the Commodity's Required if NMFC

PrimeCode odity/NMFC/PrimeCode NMFC prime code Container is Present
Needs to be provided
2

when the SubCode

associated with the
PrimeCode is other than
00. Backend defaults the
sub value to 00 if not
provided. If provided the
String

Sub Code should be

One

/ShipmentRequest/Shipment/Package/Comm Specifies the Commodity's associated with the

No

SubCode odity/NMFC/SubCode NMFC sub code PrimeCode of the NMFC.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 112
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
Container used to define the Required for shipment
properties required by the without return service, or

Cond
One

N/A
user to print and/or display shipment with PRL return
LabelSpecification /ShipmentRequest/LabelSpecification the UPS shipping label. service.

Container
One
Yes

N/A
/ShipmentRequest/LabelSpecification/LabelIm LabelImageFormat
LabelImageFormat ageFormat Container N/A
Label print method code that

3
the Labels are to be
generated for EPL2 For shipments without
formatted Labels use EPL, return service the valid
for SPL formatted Labels value is GIF, ZPL, EPL
use SPL, for ZPL formatted and SPL. For shipments
Labels use ZPL and for with PRL return service,

String
image formats use GIF, for the valid values are EPL,

One
Yes
/ShipmentRequest/LabelSpecification/LabelIm Star Printer format formatted ZPL, SPL, STARPL and
Code ageFormat/Code Labels use STARPL. GIF.

String
1...35
One

/ShipmentRequest/LabelSpecification/LabelIm Description of the label

No

Description ageFormat/Description image format code. N/A

Required if
/ShipmentRequest/Label
SpecificationLabelSpecifi
cation/LabelImageFormat
Browser HTTPUserAgent /Code = Gif. Default to
String

Mozilla/4.5 if this field is

1...64

String. This is the preferred

Cond
One

/ShipmentRequest/LabelSpecification/HTTPU way of identifying GIF image missing or has invalid

HTTPUserAgent serAgent type to be generated value.
Container
One
Yes

N/A

/ShipmentRequest/LabelSpecification/LabelSt Container for the EPL2, ZPL, For EPL2, ZPL, STARPL

X
LabelStockSize ockSize STARPL or SPL label size and SPL Labels.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 113
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

For EPL2, ZPL, STARPL

and SPL Labels. Only
valid values are 6 or 8.
Note: Label Image will

String
only scale up to 4 X 6,

1...3
One
Yes
/ShipmentRequest/LabelSpecification/LabelSt Height of the label image. even when requesting 4 X

X
Height ockSize/Height For IN, use whole inches. 8.

For EPL2, ZPL, STARPL

and SPL Labels. Valid
value is 4. Note: Label

String
Image will only scale up

1...3
One
Yes
/ShipmentRequest/LabelSpecification/LabelSt Width of the label image. For to 4 X 6, even when

X
Width ockSize/Width IN, use whole inches. requesting 4 X 8.

unbounded
Container
N/A
/ShipmentRequest/LabelSpecification/Instructi Routing Instruction

No
Instruction on Container
For Exchange Forward

2
Shipment, by default Label
will have Exchange Routing
instruction Text as
EXCHANGE-LIKE ITEM
ONLY. |If code value is :|01-
EXCHANGE-LIKE ITEM
String

ONLY. |02- EXCHANGE-

One
Yes

/ShipmentRequest/LabelSpecification/Instructi DRIVER INSTRUCTIONS

Code on/Code INSIDE
1…35
String
One

/ShipmentRequest/LabelSpecification/Instructi Description of the label

No

Description on/Description Instruction code.

1
Container

Container used to allow the

user a to choose to print a
No

ReceiptSpecification /ShipmentRequest/ReceiptSpecification thermal receipt.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 114
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1
Container
Yes
/ShipmentRequest/ReceiptSpecification/Imag
ImageFormat eFormat ImageFormat Container

1
String
Yes
/ShipmentRequest/ReceiptSpecification/Imag Print code that determines
Code eFormat/Code the receipt format.

1
String
/ShipmentRequest/ReceiptSpecification/Imag Description of the receipt

No
Description eFormat/Description format code.

container
One
Yes

N/A
ShipConfirmRequest /ShipConfirmRequest Request Container N/A

container
One
Yes

N/A
Request /ShipConfirmRequest/Request Request Container N/A
Optional
Processing.‘nonvalidate’ =
No address
validation.‘validate’ = Fail on
failed address
validation.Defaults to
‘validate’.Note: Full address
validation is not performed.
Therefore, it is the
responsibility of the Shipping
Tool User to ensure the
address entered is correct to
1...15
string
One
Yes

avoid an address correction Values blank, validate, or

RequestOption /ShipConfirmRequest/Request/RequestOption fee. nonvalidate.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 115
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
TransactionReference

One

N/A
/ShipConfirmRequest/Request/TransactionRe identifies transactions

No
TransactionReference ference between client andserver. N/A

The client uses

CustomerContext to
synchronize
request/responsepairs. The
client
establishesCustomerContext
, which can contain any

1...512
information you want, as

string
One
/ShipConfirmRequest/Request/TransactionRe along as it is valid XML; it is

No
CustomerContext ference/CustomerContext echoed back by the server. N/A

container
Refer to the Shipment
container table for the
One
Yes

N/A
elements under Shipment
Shipment /ShipConfirmRequest/Shipment Shipment Container container.
Required if all of the listed
conditions are true:
ShipFrom and ShipTo
countries are not the
The Description of Goods for same; The packaging
the shipment. Applies to type is not UPS Letter;
international shipments only. The ShipFrom and or
Provide a detailed ShipTo countries are not
description of items being in the European Union or
shipped for documents and the ShipFrom and ShipTo
non-documents. Provide countries are both in the
String

specific descriptions, such European Union and the

1...35
Cond
One

as "annual reports" and "9 shipments service type is

Description /ShipConfirmRequest/Shipment/Description mm steel screws". not UPS Standard.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 116
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
Type of Return service.
When this container exists,

One

N/A
/ShipConfirmRequest/Shipment/ReturnServic the shipment is a return

No
ReturnService e shipment. N/A
Return Service types:‘2’ =

1
UPS Print and Mail (PNM)‘3’
= UPS Return Service 1-
Attempt (RS1) ‘5’ = UPS
Return Service 3-Attempt
(RS3)‘8’ = UPS Electronic

string
Yes*
One
/ShipConfirmRequest/Shipment/ReturnServic Return Label (ERL)‘9’ = UPS
Code e/Code Print Return Label (PRL) N/A

String
1...35
One
/ShipConfirmRequest/Shipment/ReturnServic
No
Description e/Description Return Service description N/A
Indicates a shipment

0
contains written, typed, or
printed communication of no
commercial value. If
DocumentsOnly is not
specified then it implies that Empty Tag. Valid only for
the shipment contains non shipments with different
documents or documents of origin and destination
commercial value. Default is countries. The origin
a shipment contains non- country is not US, and the
string
One

/ShipConfirmRequest/Shipment/DocumentsO documents or documents of destination country is not

No

DocumentsOnlyIndicator nlyIndicator commercial value. CA, PR or MX.

Container
One
Yes

N/A

Container tag for Shipper’s

Shipper /ShipConfirmRequest/Shipment/Shipper information N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 117
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1...35
string
One
Yes
/ShipConfirmRequest/Shipment/Shipper/Nam
Name e Shipper’s company name. N/A
Required if destination is
international. Required if
Invoice and Co
International forms are
requested and the

1...35
string
Cond
One
/ShipConfirmRequest/Shipment/Shipper/Atten ShipFrom address is not
AttentionName tionName Shipper’s Attention Name present.

Conditionally required if
SED form (International
forms) is requested and

1...15
string
Cond
One
/ShipConfirmRequest/Shipment/Shipper/TaxId Shipper’s Tax Identification ship From is not
TaxIdentificationNumber entificationNumber Number mentioned.

Container
Cond
One

N/A
/ShipConfirmRequest/Shipment/Shipper/Phon Container tag for Phone
Phone e Number N/A
Valid values are 0 - 9.If
Shipper country is US,
PR, CA, and VI, the
layout is area code, 7
digit PhoneNumber or
area code, 7 digit
PhoneNumber, 4 digit
extension number; for
String

other countries, the layout

1...15
Yes*
One

/ShipConfirmRequest/Shipment/Shipper/Phon is CountryCode, area

Number e/Number Shipper’s phone Number. code, 7 digit number
String
1...4
One

/ShipConfirmRequest/Shipment/Shipper/Phon
No

Extension e/Extension Shipper’s phone extension. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 118
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Size must be six

6
alphanumeric characters.
Must be associated with
the UserId specified in the
AccessRequest XML The
account must be a valid
UPS account number that
is active. For US, PR and
CA accounts, the account
must be either a daily
pickup account, an
occasional account, or a
customer B.I.N account.
Drop Shipper accounts
are valid for return service
shipments only if the
account is Trade Direct
(TD) enabled. All other
accounts must be either a

string
One
Yes
/ShipConfirmRequest/Shipment/Shipper/Ship Shipper’s six digit account daily pickup account, or
ShipperNumber perNumber number. an occasional account.

String
1...14
One

/ShipConfirmRequest/Shipment/Shipper/FaxN
No

FaxNumber umber Shipper’s Fax Number. N/A

1...50
string
One

/ShipConfirmRequest/Shipment/Shipper/EMail
No

EMailAddress Address Shipper’s email address. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 119
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The package should be
returned to this address if
the package is
undeliverable. This
address appears on the
upper left hand corner of
the label. Note: If the
ShipFrom container is not
present then this address
will be used as the
ShipFrom address. If this

Container
address is used as the
ShipFrom the shipment

One
Yes

N/A
/ShipConfirmRequest/Shipment/Shipper/Addr will be rated from this
Address ess Shipper’s email address. origin address.

Three

1...35
The shipper's street address,

string
Yes
/ShipConfirmRequest/Shipment/Shipper/Addr including name and number Maximum Occurrence
AddressLine ess/AddressLine (when applicable). should be three.

1...30
string
One
/ShipConfirmRequest/Shipment/Shipper/Addr Yes
City ess/City The shipper's City N/A
Required if shipper is in
the US or CA. If Shipper
country is US or CA, then
the value must be a valid
US State/ Canadian
Province code. If the
country is Ireland, the
string
Cond

2...5
One

/ShipConfirmRequest/Shipment/Shipper/Addr Shipper's state or province StateProvinceCode will

StateProvinceCode ess/StateProvinceCode code. contain the county.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 120
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
If Shipper country is US
or Puerto Rico, 5 or 9
digits are required. . The
character - may be used
to separate the first five
digits and the last four
digits. If the Shipper
country is CA, then the
postal code is required
and must be 6
alphanumeric characters
whose format is A#A#A#
where A is an uppercase
letter and # is a digit. For
all other countries the
postal code is optional
and must be no more

string
Cond

1...9
One
/ShipConfirmRequest/Shipment/Shipper/Addr than 9 alphanumeric
PostalCode ess/PostalCode Shipper's postal code. characters long.
Must be a valid UPS

2
Billing country code. For
Forward shipments it
must also be an allowable
UPS origin country. For
Return Shipment the
country code must meet
the following conditions:1)
At least two of the
following country codes
are the same: ShipTo,
ShipFrom, and Shipper.2)
None of the following
country codes are the
same and are a member
of the EU: ShipTo,
ShipFrom, and Shipper.3)
None of the following
country codes are the
same and at least one of
them is not a member of
the EU, the shipper must
have Third Country
string
One
Yes

/ShipConfirmRequest/Shipment/Shipper/Addr contract service: ShipTo,

CountryCode ess/CountryCode Shipper's country code. ShipFrom, and Shipper.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 121
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
One
Yes

N/A
ShipTo /ShipConfirmRequest/Shipment/ShipTo Ship To Container N/A

1...35
string
One
Yes
Name /ShipConfirmRequest/Shipment/ShipTo/Name Consignee's company name. N/A

Required for: UPS Next

Day Air Early A.M.
service, and when ShipTo
country is different than
ShipFrom country.
Required if Invoice

1...35
string
Cond
One
/ShipConfirmRequest/Shipment/ShipTo/Attent Contact name at the International form is
AttentionName ionName consignee's location. requested

String
1...15
/ShipConfirmRequest/Shipment/ShipTo/TaxId One Consignee's tax
No

TaxIdentificationNumber entificationNumber Container identification number. N/A

Cond
One

N/A

/ShipConfirmRequest/Shipment/ShipTo/Phon
Phone e Container for Phone Number N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 122
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Required for: UPS Next
Day Air Early A.M.
service, and when Ship
To country is different
than the ShipFrom
country. If ShipTo country
is US, PR, CA, and VI,
the layout is area code, 7
digit PhoneNumber or
area code, 7 digit
PhoneNumber, 4 digit
extension number;
number; for other

String
countries, the layout is

1...15
Yes*
One
/ShipConfirmRequest/Shipment/ShipTo/Phon CountryCode, area code,
Number e/Number Consignee's phone Number. 7 digit number.

String
1...4
One
/ShipConfirmRequest/Shipment/ShipTo/Phon Consignee's phone

No
Extension e/Extension extension. N/A

If ShipTo country is US

String
10 digits allowed,

1...15
One
/ShipConfirmRequest/Shipment/ShipTo/FaxN otherwise 1-15 digits
No

FaxNumber umber Consignee's fax number. allowed.

1...50
string
One

/ShipConfirmRequest/Shipment/ShipTo/EMail
No

EMailAddress Address Consignee's email address. N/A

Container
One
Yes

N/A

/ShipConfirmRequest/Shipment/ShipTo/Addre
Address ss Address Container. N/A
String
Three

1...35
Yes

/ShipConfirmRequest/Shipment/ShipTo/Addre Address Line of the

AddressLine ss/AddressLine consignee. Max Occurrence can be 3

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 123
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1...30
string
One
Yes
/ShipConfirmRequest/Shipment/ShipTo/Addre
City ss/City Consignee's city. N/A
If destination is US or CA,

2
then the value must be a
valid US State/ Canadian
Province code. If the
Consignee's state or country is Ireland, the

string
Cond
One
/ShipConfirmRequest/Shipment/ShipTo/Addre province code. Required for StateProvinceCode will
StateProvinceCode ss/StateProvinceCode US or Canada. contain the county.
If the ShipTo country is
US or Puerto Rico, 5 or 9
digits are required. . The
character - may be used
to separate the first five
digits and the last four
digits. If the ShipTo
country is CA, then the
postal code is required
and must be 6
alphanumeric characters
whose format is A#A#A#
where A is an uppercase
letter and # is a digit.
Otherwise optional. For
all other countries the
postal code is optional
and must be no more
string
Cond

1...9
One

/ShipConfirmRequest/Shipment/ShipTo/Addre than 9 alphanumeric

PostalCode ss/PostalCode Consignee's postal code. characters long.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 124
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Must be a valid UPS

2
Billing country code. For
Return Shipment the
country code must meet
the following conditions:1)
At least two of the
following country codes
are the same: ShipTo,
ShipFrom, and Shipper.
2) None of the following
country codes are the
same and are a member
of the EU: ShipTo,
ShipFrom, and Shipper.
3) None of the following
country codes are the
same and at least one of
them is not a member of
the EU, the shipper must
have Third Country

string
One
Yes
/ShipConfirmRequest/Shipment/ShipTo/Addre contract service: ShipTo,
CountryCode ss/CountryCode Consignee's country code. ShipFrom, and Shipper.
This field is a flag to indicate

0
if the receiver is a residential
String location. True if
One

/ShipConfirmRequest/Shipment/ShipTo/Addre ResidentialAddressIndicator
No

ResidentialAddressIndicator ss/ResidentialAddressIndicator tag exists; false otherwise Empty Tag.

Location ID is a unique Location ID must be

String
3...10

identifier referring to a alphanumeric characters.

One

/ShipConfirmRequest/Shipment/ShipTo/Locati specific shipping/receiving All letters must be

No

LocationID onID location. capitalized.

Required for return

container

shipment. Required if
pickup location is different
Cond
One

N/A

from the shipper's

ShipFrom /ShipConfirmRequest/Shipment/ShipFrom Ship From Container address.
1...35
string
Yes*
One

/ShipConfirmRequest/Shipment/ShipFrom/Na The ship from location's Required if ShipFrom tag

Name me name or company name. is in the XML.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 125
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Required if ShipFrom tag

1...35
is in the XML and Invoice

string
Cond
One
/ShipConfirmRequest/Shipment/ShipFrom/Att The ship from Attention or CO International forms
AttentionName entionName name. is requested.

Company's Tax Identification Conditionally required if

1...15
string
Cond
One
/ShipConfirmRequest/Shipment/ShipFrom/Ta Number at the pick up SED form (International
TaxIdentificationNumber xIdentificationNumber location forms) is requested
If ShipFrom country is
US, PR, CA, and VI, the
layout is area code, 7
digit phone number or
area code, 7 digit phone
number, 4 digit extension
number; for other
countries, the layout is
CountryCode, area code,

Container
7 digit number. Required
if ShipFrom tag is in the

Cond
One

N/A
/ShipConfirmRequest/Shipment/ShipFrom/Ph XML and International
Phone one Container for Phone Number forms is requested.

String
1...15
Yes*
One

/ShipConfirmRequest/Shipment/ShipFrom/Ph The Ship from phone

Number one/Number Number. N/A
String
1...4
One

/ShipConfirmRequest/Shipment/ShipFrom/Ph The Ship from phone

No

Extension one/Extension extension. N/A

If Ship from country is US

String

10 digits allowed,
1...15
One

/ShipConfirmRequest/Shipment/ShipFrom/Fa otherwise 1-15 digits

No

FaxNumber xNumber The Ship from fax number. allowed.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 126
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The package will be
originating from or being
shipped from this
address. The shipment

container
will be rated from this
origin address to the

One
Yes

N/A
/ShipConfirmRequest/Shipment/ShipFrom/Ad Ship from Address destination ship to
Address dress Container. address..

Three
The Ship from street

1...35
string
Yes
/ShipConfirmRequest/Shipment/ShipFrom/Ad address including name and
AddressLine dress/AddressLine number (when applicable). Max Occurrence can be 3

1...30
string
One
Yes
/ShipConfirmRequest/Shipment/ShipFrom/Ad Required if ShipFrom tag
City dress/City The Ship from city. is in the XML.

2
Required if ShipFrom tag
is in the XML, and
ShipFrom/Country is US.
If ShipFrom country is US
or CA, then the value
must be a valid US State/
Canadian Province code.
If the country is Ireland,
string
Cond
One

/ShipConfirmRequest/Shipment/ShipFrom/Ad Origin location's state or the StateProvinceCode

StateProvinceCode dress/StateProvinceCode province code. will contain the county.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 127
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Required if ShipFrom tag
is in the XML and the
ShipFrom country is the
US, Puerto Rico. For US,
Puerto Rico must be valid
5 or 9 digit postal code.
The character - may be
used to separate the first
five digits and the last
four digits. If the
ShipFrom country is CA,
then the postal code must
be 6 alphanumeric
characters whose format
is A#A#A# where A is an
uppercase letter and # is
a digit. For all other
countries the postal code
is optional and must be
no more than 9

string
Cond

1...9
One
/ShipConfirmRequest/Shipment/ShipFrom/Ad The ship from location's alphanumeric characters
PostalCode dress/PostalCode postal code. long.
Required if ShipFrom tag

2
is in the XML. For Return
Shipment the country
code must meet the
following conditions:1) At
least two of the following
country codes are the
same: ShipTo, ShipFrom,
and Shipper.2) None of
the following country
codes are the same and
are a member of the EU:
ShipTo, ShipFrom, and
Shipper.3) None of the
following country codes
are the same and at least
one of them is not a
member of the EU, the
shipper must have Third
Country contract service:
string
One
Yes

/ShipConfirmRequest/Shipment/ShipFrom/Ad Origin location's country ShipTo, ShipFrom, and

CountryCode dress/CountryCode code. Shipper.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 128
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Payment information
container for detailed
shipment charges. The two

container
shipment charges that are
available for specification It is required for non-

Cond
One

N/A
/ShipConfirmRequest/Shipment/PaymentInfor are Transportation charges Ground Freight Pricing
PaymentInformation mation and Duties and Taxes. shipments only.
If Duty and Tax charges
are applicable to a
shipment and a payer is

Container
not specified, the default
payer of Duty and Tax

One
Yes

N/A
/ShipConfirmRequest/Shipment/PaymentInfor charges is Bill to
ShipmentCharge mation/ShipmentCharge Shipment charge container Receiver.
A shipment charge type

2
of 01 = Transportation is
required. A shipment
charge type of 02 =
Duties and Taxes is not
required; however, this
charge type is invalid for
Qualified Domestic
Shipments. A Qualified
Domestic Shipment is any
shipment in which one of
the following applies:1)
The origin and destination
country is the same2) US
to PR shipment3) PR to
US shipment4) The origin
and destination country
are both European Union
Countries and the
GoodsNotInFreeCirculatio
n indicator is not
Values are: 01 = present5) The origin and
string
One
Yes

/ShipConfirmRequest/Shipment/PaymentInfor Transportation, 02 = destination IATA code is

Type mation/ShipmentCharge/Type Duties and Taxes the same

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 129
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
This element or its sibling
Container for the BillShipper element, BillReceiver,
billing option. The two BillThirdParty or

Container
payment methods that are ConsigneeBilledIndicator,
available for the Bill Shipper must be present but no

One

N/A
/ShipConfirmRequest/Shipment/PaymentInfor billing option are account more than one can be

No
BillShipper mation/ShipmentCharge/BillShipper number or credit card. present.
Must be the same UPS

6
account number as the
one provided in
Shipper/ShipperNumber.
Either this element or the
sibling element
/ShipConfirmRequest/Shipment/PaymentInfor CreditCard must be

string
Cond
One
mation/ShipmentCharge/BillShipper/AccountN provided, but both may
AccountNumber umber UPS account number not be provided.
Required if
/ShipConfirmRequest/Shi
pment/PaymentInformatio
n
/ShipmentCharge/BillShip
per/AccountNumber is not

Container
present. Credit card
/ShipConfirmRequest/Shipment/PaymentInfor payment is valid for
Cond
One

N/A
mation/ShipmentCharge/BillShipper/CreditCar Credit card information shipments without return
CreditCard d container service only.
2 Values are 01 = American
Express, 03 = Discover, 04 = Valid values are: 01, 03,
/ShipConfirmRequest/Shipment/PaymentInfor MasterCard, 05 = Optima, 04 and 06.For Discover
string
Yes*
One

mation/ShipmentCharge/BillShipper/CreditCar 06 = VISA, 07 = Bravo, card the ShipFrom

Type d/Type and 08 = Diners Club country has to be US

/ShipConfirmRequest/Shipment/PaymentInfor
9...16
string
Yes*
One

mation/ShipmentCharge/BillShipper/CreditCar
Number d/Number Credit Card number N/A
6

Valid month values are

/ShipConfirmRequest/Shipment/PaymentInfor Format is MMYYYY where 01-12 and valid year
string
Yes*
One

mation/ShipmentCharge/BillShipper/CreditCar MM is the 2 digit month and values are Present Year -

ExpirationDate d/ExpirationDate YYYY is the 4 digit year. (Present Year + 10 years)

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 130
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Valid values are 3 or 4
digits. It is required to
provide the security code
if credit card information
is provided and when the
ShipFrom countries are
other than the below
mentioned countries.
Three or four digits that can Argentina
be found either on top of Bahamas Costa
credit card number or on the Rica Dominican
/ShipConfirmRequest/Shipment/PaymentInfor back of credit card. Number Rep Guatemala

string
Yes*
One

3..4
mation/ShipmentCharge/BillShipper/CreditCar of digits varies for different Panama Puerto
SecurityCode d/SecurityCode type of credit card. Rico Russia
It is required to provide
billing address if credit

Container
card information is
/ShipConfirmRequest/Shipment/PaymentInfor provided and when the

Cond
One

N/A
mation/ShipmentCharge/BillShipper/CreditCar Container to hold the Credit ShipFrom country is the
Address d/Address card Billing Address. US, PR, and CA.
/ShipConfirmRequest/Shipment/PaymentInfor Yes* Address Line 1 of the credit
Thre

1...3
strin
mation/ShipmentCharge/BillShipper/CreditCar card billing address. Usually Max of three AddressLine
e
g
5
AddressLine d/Address/AddressLine Street address information. can be provided.

1...30
/ShipConfirmRequest/Shipment/PaymentInfor string
Yes*
One

mation/ShipmentCharge/BillShipper/CreditCar City of the credit card billing

City d/Address/City address N/A

/ShipConfirmRequest/Shipment/PaymentInfor
string
Yes*

2...5
One

mation/ShipmentCharge/BillShipper/CreditCar State or province code of the

StateProvinceCode d/Address/StateProvinceCode credit card billing address. N/A
/ShipConfirmRequest/Shipment/PaymentInfor
1...9
strin
One
Yes

mation/ShipmentCharge/BillShipper/CreditCar Credit card billing addressee

g
*

PostalCode d/Address/PostalCode postal code. N/A

2

Must be a valid UPS

/ShipConfirmRequest/Shipment/PaymentInfor Billing country code. For
string
Yes*
One

mation/ShipmentCharge/BillShipper/CreditCar Credit card billing address Discover card it should be

CountryCode d/Address/CountryCode country code. US

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 131
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

This element or its sibling

element, BillShipper,
BillThirdParty or
Consignee Billed, must
be present but no more

container
than one can be present.
For a return shipment, Bill

Cond
One

N/A
/ShipConfirmRequest/Shipment/PaymentInfor Container for the Receiver is invalid for
BillReceiver mation/ShipmentCharge/BillReceiver BillReceiver billing option. Transportation charges.
The account must be a

6
valid UPS account
number that is active. For
US, PR and CA accounts,
the account must be a
daily pickup account, an
occasional account, a
customer B.I.N account,
or a dropper shipper
account. All other
accounts must be either a
daily pickup account, an
/ShipConfirmRequest/Shipment/PaymentInfor occasional account, a

string
Yes*

mation/ShipmentCharge/BillReceiver/Account One drop shipper account, or

AccountNumber Number container The UPS account number. a non-shipping account

Container for additional

information for the bill
One

N/A

/ShipConfirmRequest/Shipment/PaymentInfor receivers UPS accounts

No

Address mation/ShipmentCharge/BillReceiver/Address address. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 132
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The postal code must be
the same as the UPS
account pickup address
postal code. Required for
United States and
Canadian UPS accounts
and/or if the UPS account
pickup address has a
postal code. If the UPS
accounts pickup country
is US or Puerto Rico, the
postal code is 5 or 9
digits. The character -
may be used to separate
the first five digits and the
last four digits. If the UPS
The postal code for the UPS accounts pickup country
accounts pickup address. is CA, the postal code is 6
The pickup postal code was alphanumeric characters
/ShipConfirmRequest/Shipment/PaymentInfor entered in the UPS system whose format is A#A#A#

string
Cond

0...9
One
mation/ShipmentCharge/BillReceiver/Address when the account was set- where A is an uppercase
PostalCode /PostalCode up. letter and # is a digit.
This element or its sibling
element, BillShipper,
container BillReceiver or Consignee
Billed, must be present
Cond
One

N/A
/ShipConfirmRequest/Shipment/PaymentInfor Container for the third party but no more than one can
BillThirdParty mation/ShipmentCharge/BillThirdParty billing option. be present.
The account must be a
6

valid UPS account

number that is active. For
US, PR and CA accounts,
the account must be
either a daily pickup
account, an occasional
account, or a customer
B.I.N account, or a drop
shipper account. All other
accounts must be either a
daily pickup account, an
/ShipConfirmRequest/Shipment/PaymentInfor occasional account, a
string
Yes*
One

mation/ShipmentCharge/BillThirdParty/Accou The UPS account number of drop shipper account, or

AccountNumber ntNumber the third party shipper. a non-shipping account.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 133
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

container
/ShipConfirmRequest/Shipment/PaymentInfor Container for additional

One
Yes

N/A
mation/ShipmentCharge/BillThirdParty/Addres information for the third party
Address s UPS accounts address. N/A
The postal code must be
the same as the UPS
account pickup address
postal code. Required for
United States and
Canadian UPS accounts
and/or if the UPS account
pickup address has a
postal code. If the UPS
accounts pickup country
is US or Puerto Rico, the
postal code is 5 or 9
digits. The character -
may be used to separate
the first five digits and the
last four digits. If the UPS
The postal code for the UPS accounts pickup country
accounts pickup address. is CA, the postal code is 6
The pickup postal code was alphanumeric characters
/ShipConfirmRequest/Shipment/PaymentInfor entered in the UPS system whose format is A#A#A#
string
Cond

0...9
One

mation/ShipmentCharge/BillThirdParty/Addres when the account was set- where A is an uppercase

PostalCode s/PostalCode up. letter and # is a digit.
2

/ShipConfirmRequest/Shipment/PaymentInfor The country code for the

string
One
Yes

mation/ShipmentCharge/BillThirdParty/Addres UPS accounts pickup

CountryCode s/CountryCode address. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 134
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Empty Tag. This element

0
or its sibling element,
BillShipper, BillReceiver
or BillThirdParty, must be
present but no more than
Consignee Billing payment one can be present. This
option indicator. The billing option is valid for a
presence indicates shipment charge type of
consignee billing option is Transportation only. Only
/ShipConfirmRequest/Shipment/PaymentInfor selected. The absence applies to US/PR and

string
Cond
One
mation/ShipmentCharge/ConsigneeBilledIndic indicates one of the other PR/US shipment origins
ConsigneeBilledIndicator ator payment options is selected. and destination.
Split Duty VAT Indicator.

0
The presence indicates the
payer specified for
Transportation Charges will Empty Tag. The payment
pay transportation charges method for Transportation
and any duties that apply to charges must be UPS
the shipment. The payer account. The UPS

String
specified for Duties and account must be a daily

One
/ShipConfirmRequest/Shipment/PaymentInfor Taxes will pay the VAT pickup account or an
SplitDutyVATIndicator mation/SplitDutyVATIndicator No (Value-Added Tax) only. occasional account.

Container
Container to hold the
Payment information for the Required for Ground
Cond
One

N/A
/ShipConfirmRequest/Shipment/FRSPaymentI Ground Freight Pricing Freight Pricing
FRSPaymentInformation nformation Shipments Shipments only
Container

It is required if the request

Container to hold the has Ground Freight
One
Yes

N/A

/ShipConfirmRequest/Shipment/FRSPaymentI Ground Freight Pricing Pricing shipment

Type nformation/Type payment type information indicator
2
String

Valid codes: 01=Prepaid

One
Yes

/ShipConfirmRequest/Shipment/FRSPaymentI 02=FreightCollect
Code nformation/Type/Code 03=PrepaidThirdParty
50
String

Specifies the description for

One

/ShipConfirmRequest/Shipment/FRSPaymentI Ground Freight Pricing

No

Description nformation/Type/Description payment type

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 135
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
If the Ground Freight

6
Pricing indicator is
present in the request,
This account number

String
must be validated to

One
Yes
/ShipConfirmRequest/Shipment/FRSPaymentI check if it is Ground
AccountNumber nformation/AccountNumber The UPS account number. Freight Pricing enabled.

Container
Container to hold the Note: The Address is
information for the required only when the

Cond
One

N/A
/ShipConfirmRequest/Shipment/FRSPaymentI FreightCollect and billing option is Freight
Address nformation/Address PrepaidThirdParty Address. collect or ThirdParty.

The postal code for the

String
Ground Freight Pricing

Cond

0...9
One
/ShipConfirmRequest/Shipment/FRSPaymentI payment information
PostalCode nformation/Address/PostalCode address.

2
The country code for the

String
Ground Freight Pricing

One
Yes
/ShipConfirmRequest/Shipment/FRSPaymentI payment information
CountryCode nformation/Address/CountryCode address.

0
Empty Tag. This indicator
is invalid for a package
string
One

GoodsNotInFreeCirculationIndica /ShipConfirmRequest/Shipment/GoodsNotInF Goods Not In Free type of UPS Letter and

No

tor reeCirculationIndicator Circulation indicator. DocumentsOnly.

container
One

N/A

/ShipConfirmRequest/Shipment/ShipmentRati ShipmentRatingOptions
No

ShipmentRatingOptions ngOptions container N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 136
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The Shipper account and

0
UserId combination must
be qualified to receive
Negotiated rates. If the
indicator is present and
the Shipper is qualified
then Negotiated rates will
be returned in the
response. Only the
Shipper account number
Negotiated Rates option taken from
indicator. If the indicator is /ShipConfirmRequest/Shi
present and the Shipper is pment/Shipper/ShipperNu

String
authorized then Negotiated mber is used when

One
/ShipConfirmRequest/Shipment/ShipmentRati Rates should be returned in checking qualification for

No
NegotiatedRatesIndicator ngOptions/NegotiatedRatesIndicator the response. Negotiated rates.
The Shipper account

0
number must be qualified
to receive Ground Freight
Pricing Shipment rates.
Only the Shipper account
Ground Freight Pricing number taken from
Rates option indicator. If the /ShipConfirmRequest/Shi
Ground Freight Pricing pment/ Ground Freight
Shipment indicator is Pricing
enabled and Shipper PaymentInformation/Acco
number is authorized then untNumber is used when
String

Ground Freight Pricing rates checking qualification for

One

/ShipConfirmRequest/Shipment/ShipmentRati should be returned in the Ground Freight Pricing

No

FRSShipmentIndicator ngOptions/FRSShipmentIndicator response rates.

1
String

/ShipConfirmRequest/Shipment/ShipmentRati
No

RateChartIndicator ngOptions/RateChartIndicator
Must contain alphanumeric
18

characters only. Must be a

length of 18 characters. The
String

3rd and 4th Characters must

One

/ShipConfirmRequest/Shipment/MovementRef be the Shipper country ISO

No

MovementReferenceNumber erenceNumber Code.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 137
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

container
One

N/A
/ShipConfirmRequest/Shipment/ReferenceNu Reference Number

No
ReferenceNumber mber information container. N/A

0
Empty Tag. Allowed for
shipment with return
service only. Only one
shipment-level or
package-level reference
number can be bar coded
per shipment. In order to
barcode a reference
number, its value must be
no longer than 14
If the indicator is present alphanumeric characters
then the reference numbers or 24 numeric characters

string
One
/ShipConfirmRequest/Shipment/ReferenceNu value will be bar coded on and cannot contain

No
BarCodeIndicator mber/BarCodeIndicator the label. spaces.

2
Shipment Reference number
type code. The code
specifies the Reference Valid if the
name. Refer to the origin/destination pair is
string
One

/ShipConfirmRequest/Shipment/ReferenceNu Reference Number Code not US/US or PR/PR2

No

Code mber/Code table. character alpha-numeric.

Valid if the
1...35
string
Yes*
One

/ShipConfirmRequest/Shipment/ReferenceNu Customer supplied reference origin/destination pair is

Value mber/Value number. not US/US or PR/PR
container
One
Yes

N/A

Service /ShipConfirmRequest/Shipment/Service UPS service type N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 138
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Values are: 01 = Next Day

2
Air, 02 = 2nd Day Air, 03 =
Ground, 07 = Express, 08 =
Expedited, 11 = UPS
Standard, 12 = 3 Day Select,
13 = Next Day Air Saver, 14
= Next Day Air Early AM, 54 The following Services
= Express Plus, 59 = 2nd are not available to return
Day Air A.M., 65 = UPS shipment:13 - Next Day
Saver, 82 = UPS Today Air Saver, 14 - Next Day
Standard, 83 = UPS Today Air Early AM, 59 - 2nd
Dedicated Courier, 84 = Day Air A.M., 82 = UPS
UPS Today Intercity, 85 = Today Standard, 83 =
UPS Today Express, 86 = UPS Today Dedicated
UPS Today Express Saver. Courier, 84 = UPS Today

String
Note: Only service code 03 Intercity, 85 = UPS Today

One
Yes
is used for Ground Freight Express, 86 = UPS Today
Code /ShipConfirmRequest/Shipment/Service/Code Pricing shipments Express Saver.

Description of the service

code. Examples are Next

1...35
string
One
/ShipConfirmRequest/Shipment/Service/Descr No Day Air, Worldwide Express,
Description iption and Ground. N/A
Required for forward
shipments whose origin is
the US and destination is
Puerto Rico or Canada.
Not available for any
other shipments. FOR
Container

OTHER DESTINATIONS
the InvoiceLineTotal in
Cond
One

N/A

/ShipConfirmRequest/Shipment/InvoiceLineTo Container to hold the International Forms

InvoiceLineTotal tal InvoiceLineTotal Information. Container must be used.
3
string
Yes*
One

/ShipConfirmRequest/Shipment/InvoiceLineTo Invoice Line Total currency

CurrencyCode tal/CurrencyCode type.
1...19
string
Yes*
One

/ShipConfirmRequest/Shipment/InvoiceLineTo Invoice Line Total amount Valid values are from 1 to

MonetaryValue tal/MonetaryValue for the entire shipment. 99999999

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 139
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
One

N/A
/ShipConfirmRequest/Shipment/ShipmentSer Container for Shipment

No
ShipmentServiceOptions viceOptions Service Option N/A

0
Saturday delivery indicator.
The presence indicates

String
Saturday delivery; the

One
/ShipConfirmRequest/Shipment/ShipmentSer absence indicates not

No
SaturdayDeliveryIndicator viceOptions/SaturdayDeliveryIndicator Saturday delivery. Empty Tag.

Indicates COD is
requested. Shipment
COD is only available for
EU origin countries and
for shipper's account type

Container
Daily Pickup and Drop
Shipping. Not available

One

N/A
/ShipConfirmRequest/Shipment/ShipmentSer No to shipment with return
COD viceOptions/COD COD container service.

1
Values are: 1 = cash; 9 =
String
check, cashiers check or
Yes*
One

/ShipConfirmRequest/Shipment/ShipmentSer money order - no cash

CODFundsCode viceOptions/COD/CODFundsCode allowed. N/A
Container
Yes*
One

N/A

/ShipConfirmRequest/Shipment/ShipmentSer
CODAmount viceOptions/COD/CODAmount COD Amount Container. N/A
3
string
Yes*
One

/ShipConfirmRequest/Shipment/ShipmentSer COD amount currency code

CurrencyCode viceOptions/COD/CODAmount/CurrencyCode type. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 140
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

/ShipConfirmRequest/Shipment/ShipmentSer

string
Yes*

1...8
One
viceOptions/COD/CODAmount/MonetaryValu COD Amount monetary
MonetaryValue e value.

Container
Container for the Quantum
ViewTM notifications (QVN)

One

N/A
/ShipConfirmRequest/Shipment/ShipmentSer or Return Notification (aka

No
Notification viceOptions/Notification Label Creation Notification). N/A
The type of notification

1
requested. Valid Value: 5 -
QV In-transit Notification 6 -
QV Ship Notification 7 - QV
Exception Notification 8 - QV
Delivery Notification 2 -
Return Notification or Label
Creation Notification
Note:QVN Exception
notification and return Quantum View TM
notification are not Notification (QVN) is only
applicable to GFP QV In- allowed for shipment
String transit and Return without return service;
Notifications are only valid Return Notification is only
Yes*
One

/ShipConfirmRequest/Shipment/ShipmentSer for ImportControl and Return for allowed return service

NotificationCode viceOptions/Notification/NotificationCode shipments 1-Attempt and 3-Attempt
Container
Yes*
One

N/A

/ShipConfirmRequest/Shipment/ShipmentSer Container for Email

EMail viceOptions/Notification/EMail Information N/A

Up to five email
addresses are allowed for
each type of Quantum
View TM shipment
String

notification. Up to two
1...50
One
Yes

/ShipConfirmRequest/Shipment/ShipmentSer Email address where the email address for return

EMailAddress viceOptions/Notification/EMail/EMailAddress notification is sent notification.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 141
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

The address where an There can be only one

undeliverable eMail UndeliverableEMailAddre

String
/ShipConfirmRequest/Shipment/ShipmentSer message is sent if the eMail ss for each type of

1...50
One
viceOptions/Notification/EMail/UndeliverableE with the notification is Quantum View Shipment

No
UndeliverableEMailAddress MailAddress undeliverable. Notifications.
The e-mail address specifies
the Reply To E-mail

String
/ShipConfirmRequest/Shipment/ShipmentSer address. The From field of

1...50
Cond
One
viceOptions/Notification/EMail/FromEMailAddr the message header
FromEMailAddress ess contains [email protected]. Return Notification only.

The FromName must

The name the email will occur only once for each

1...35
string
One
/ShipConfirmRequest/Shipment/ShipmentSer appear to be from. Defaults type of Quantum View

No
FromName viceOptions/Notification/EMail/FromName to the Shipper Name. Shipment Notifications.
The Memo must occur

1...150
only once for each type of

string
One
/ShipConfirmRequest/Shipment/ShipmentSer User defined text that will be Quantum View Shipment

No
Memo viceOptions/Notification/EMail/Memo included in the eMail. Notifications.

1...75
string
One
/ShipConfirmRequest/Shipment/ShipmentSer The eMail's subject. Defaults
No
Subject viceOptions/Notification/EMail/Subject to text provided by UPS Return Notification only.
Specifies a reference code

2
and reference number to
display in the subject of the
Notification. The valid
subject codes are: 01 -
Shipment Reference
Number 1 02 - Shipment For return notification: If
Reference Number 2 03 - the subject code tag is
package Reference Number not provided and the
1 04 - package Reference subject text is provided,
Number 2 08 - Subject the subject of the
Text (Return Notification notification will be the
only) If a subject code is not subject text. If the subject
provided or provided that text is provided and the
refers to a nonexistent subject code tag exists,
reference number, the then the subject code
subject will default to value must be 08. If
string
One

/ShipConfirmRequest/Shipment/ShipmentSer shipment Identification Subject code is 08,

No

SubjectCode viceOptions/Notification/EMail/SubjectCode Number subject text must exist.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 142
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Container for the Label
Delivery accessorial.Note:
Currently Label delivery
accessorial is not applicable
to GFP Required for
shipments with either
Electronic Return Label
Return Service or
ImportControl Electronic
LabelMethod type. If this

Container
container is present, either
of the LabelLinksIndicator or Valid for shipments with a

One

N/A
/ShipConfirmRequest/Shipment/ShipmentSer Email container should be Electronic Return Label

No
LabelDelivery viceOptions/LabelDelivery provided. Return Service.

container
One

N/A
/ShipConfirmRequest/Shipment/ShipmentSer Container for the email

No
EMail viceOptions/LabelDelivery/EMail message. N/A

/ShipConfirmRequest/Shipment/ShipmentSer The destination eMail

1...50
string
Yes*
One
viceOptions/LabelDelivery/EMail/EMailAddres address for the Label
EMailAddress s Delivery. N/A

The address where an

undeliverable email
/ShipConfirmRequest/Shipment/ShipmentSer message is sent if the Label
1...50
string
One

viceOptions/LabelDelivery/EMail/Undeliverabl Delivery email is Defaults to

No

UndeliverableEMailAddress eEMailAddress undeliverable. FromEMailAddress.

The e-mail address specifies
the Reply To E-mail
/ShipConfirmRequest/Shipment/ShipmentSer
1...50

address. The From field of

string
Yes*
One

viceOptions/LabelDelivery/EMail/FromEMailA the message header

FromEMailAddress ddress contains [email protected]. N/A
String

The name notification will

1...35
One

/ShipConfirmRequest/Shipment/ShipmentSer appear to be from. Defaults

No

FromName viceOptions/LabelDelivery/EMail/FromName to the Shipper Name N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 143
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1..150
string
One
/ShipConfirmRequest/Shipment/ShipmentSer User defined text that will be

No
Memo viceOptions/LabelDelivery/EMail/Memo included in the email. N/A

The eMail's subject. Defaults

to the Label Delivery
Notification plus the

1...75
string
One
/ShipConfirmRequest/Shipment/ShipmentSer shipment ID. Defaults to text

No
Subject viceOptions/LabelDelivery/EMail/Subject provided by UPS N/A

2
If the subject code tag is
not provided and the
subject text is provided,
the subject of the
notification will be the
Specifies a reference code subject text. If the subject
and reference number to text is provided, and the
display in the subject of the subject code tag exists,
Label Delivery notification. then the subject code
When the subject code is value must be 08;If
provided, the subject will Subject code is 08,
contain the following: UPS subject text must exist. If
Label Delivery. The a subject code is provided
reference code (the that refers to a
reference code will be nonexistent reference
mapped to the number, the subject will
string
One

/ShipConfirmRequest/Shipment/ShipmentSer corresponding ANSI value) default to the shipment

No

SubjectCode viceOptions/LabelDelivery/EMail/SubjectCode Plus the reference number. identification number.

0

Indicates the Label and

Receipt URL's are to be
returned in the XML
response. Applicable for
ImportControl Electronic Valid for shipments with a
string
One

/ShipConfirmRequest/Shipment/ShipmentSer Labels or for ReturnService Electronic Return Label

No

LabelLinksIndicator viceOptions/LabelDelivery/LabelLinksIndicator Electronic Labels Return Service.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 144
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
REFER TO
InternationalForms

One

N/A
/ShipConfirmRequest/Shipment/ShipmentSer International Forms Interface Spec for the

No
InternationalForms viceOptions/InternationalForms information expansion of this node.

2
Possible Values are: 01
- Invoice 02 - SED03 -
CO 04 - NAFTA CO 05
- Partial Invoice. For
shipment with return
service, 01 or 05 are the

*Yes to Four
only valid values. Note:
01 and 05 are mutually
exclusive and 05 is only

string
One
/ShipConfirmRequest/Shipment/ShipmentSer Indicates the name of the valid for return shipments
FormType viceOptions/InternationalForms/FormType International form requested. only.
This indicator should be

0
set when the shipper
intends to utilize UPS
paperless invoice
functionality AND the
shipper has SELF-
PREPARED other
International Forms (SED,
CO, NAFTACO) to
accompany the shipment.
It is evaluated only
when:1. Account is
paperless enabled. 2.
Movement requires an
invoice.3. Destination
country accepts
Presence of the indicator paperless invoice. 4.
/ShipConfirmRequest/Shipment/ShipmentSer means user will supply Invoice data is supplied
string
One

viceOptions/InternationalForms/AdditionalDoc additional document, such by the client and the data

No

AdditionalDocumentIndicator umentIndicator as SED, NAFTA_CO or CO. passes validation.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 145
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

50
Contains description text
which identifies the group of
/ShipConfirmRequest/Shipment/ShipmentSer International forms. This

string
One
viceOptions/InternationalForms/FormGroupId element does not appear on

No
FormGroupIdName Name the forms.

2
Applicable for SED form
/ShipConfirmRequest/Shipment/ShipmentSer and is required. Valid

string
Cond
One
viceOptions/InternationalForms/SEDFilingOpti Indicates the SED filing values is:01 - Shipper
SEDFilingOption on option filing SED
Applicable for SED form
and NAFTA CO only.
Required for NAFTA CO
and SED. Ultimate
consignee contact

Container
information is required for
Holds the contact SED. Producer contact

Cond
One

N/A
/ShipConfirmRequest/Shipment/ShipmentSer information of various information is required for
Contacts viceOptions/InternationalForms/Contacts parties. NAFTA CO
The forwarding agent is the

Container
company or person acting as
/ShipConfirmRequest/Shipment/ShipmentSer One agent in the trans-shipping

N/A
viceOptions/InternationalForms/Contacts/For of freight to the destination Applicable for SED form
No

ForwardAgent wardAgent country. only.

/ShipConfirmRequest/Shipment/ShipmentSer Company Name or the

1...35
string
*Yes
One

viceOptions/InternationalForms/Contacts/For Individual name of the Applicable for SED form

CompanyName wardAgent/CompanyName Forwarding agent. only.

/ShipConfirmRequest/Shipment/ShipmentSer
1...15
string
*Yes
One

viceOptions/InternationalForms/Contacts/For Tax ID of the Forwarding Applicable for SED form

TaxIdentificationNumber wardAgent/TaxIdentificationNumber agent. only.
Container

/ShipConfirmRequest/Shipment/ShipmentSer
*Yes
One

N/A

viceOptions/InternationalForms/Contacts/For Address information of the Applicable for SED form

Address wardAgent/Address Forwarding agent. only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 146
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Three
/ShipConfirmRequest/Shipment/ShipmentSer

1...35
string
*Yes
viceOptions/InternationalForms/Contacts/For Address line of the Max Occurrence must be
AddressLine wardAgent/Address/AddressLine Forwarding agent. 3

/ShipConfirmRequest/Shipment/ShipmentSer

1...30
string
*Yes
One
viceOptions/InternationalForms/Contacts/For Applicable for SED form
City wardAgent/Address/City City of the Forwarding agent. only.

/ShipConfirmRequest/Shipment/ShipmentSer Applicable for SED form

string
Cond

1...5
One
viceOptions/InternationalForms/Contacts/For State of the Forwarding only. Required for certain
StateProvinceCode wardAgent/Address/StateProvinceCode agent. countries.

String
/ShipConfirmRequest/Shipment/ShipmentSer

1...30
One
viceOptions/InternationalForms/Contacts/For Town of the Forwarding

No
Town wardAgent/Address/Town agent
Applicable for SED form
only. Required for certain
/ShipConfirmRequest/Shipment/ShipmentSer countries. The length of

string
Cond

1...9
One
viceOptions/InternationalForms/Contacts/For Postal code of the the postal code depends
PostalCode wardAgent/Address/PostalCode Forwarding agent. on the country code.

2
/ShipConfirmRequest/Shipment/ShipmentSer
string
*Yes
One

viceOptions/InternationalForms/Contacts/For Country code of the Applicable for SED form

CountryCode wardAgent/Address/CountryCode Forwarding agent. only.

The ultimate consignee is

the person or company who
receives the goods for end-
Container

use or the person or

/ShipConfirmRequest/Shipment/ShipmentSer company listed on the export Applicable for SED form
Cond
One

N/A

viceOptions/InternationalForms/Contacts/Ulti license. This is the end-user only. Required when the

UltimateConsignee mateConsignee of the goods. form requested is SED.

/ShipConfirmRequest/Shipment/ShipmentSer Company Name or the

1...35
string
*Yes
One

viceOptions/InternationalForms/Contacts/Ulti Individual name of the Applicable for SED form

CompanyName mateConsignee/CompanyName Ultimate consignee. only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 147
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
/ShipConfirmRequest/Shipment/ShipmentSer

*Yes
One

N/A
viceOptions/InternationalForms/Contacts/Ulti Address information of the Applicable for SED form
Address mateConsignee/Address Ultimate consignee. only.

Three
/ShipConfirmRequest/Shipment/ShipmentSer

1...35
string
*Yes
viceOptions/InternationalForms/Contacts/Ulti Address line of the Ultimate Max Occurrence must be
AddressLine mateConsignee/Address/AddressLine consignee. 3

/ShipConfirmRequest/Shipment/ShipmentSer

1...30
string
*Yes
One
viceOptions/InternationalForms/Contacts/Ulti City of the Ultimate Applicable for SED form
City mateConsignee/Address/City consignee. only.

/ShipConfirmRequest/Shipment/ShipmentSer Applicable for SED form

string
Cond

1...5
viceOptions/InternationalForms/Contacts/Ulti One State of the Ultimate only. Required for certain
StateProvinceCode mateConsignee/Address/StateProvinceCode String consignee. countries

/ShipConfirmRequest/Shipment/ShipmentSer
1...30
One

viceOptions/InternationalForms/Contacts/Ulti Town of the Ultimate

No

Town mateConsignee/Address/Town consignee

Applicable for SED form
only. Required for certain
String

/ShipConfirmRequest/Shipment/ShipmentSer countries. The length of

Cond

1...9
One

viceOptions/InternationalForms/Contacts/Ulti Postal code of the Ultimate the postal code depends

PostalCode mateConsignee/Address/PostalCode consignee. on the country code.
2
String

/ShipConfirmRequest/Shipment/ShipmentSer
*Yes
One

viceOptions/InternationalForms/Contacts/Ulti Country code of the Ultimate Applicable for SED form

CountryCode mateConsignee/Address/CountryCode consignee. only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 148
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

The intermediate consignee

Container
is the person or company in
/ShipConfirmRequest/Shipment/ShipmentSer the importing country that

1...35
One
viceOptions/InternationalForms/Contacts/Inter makes final delivery to the Applicable for SED form

No
IntermediateConsignee mediateConsignee ultimate consignee. only.

/ShipConfirmRequest/Shipment/ShipmentSer Company Name or the

1...35
string
*Yes
One
viceOptions/InternationalForms/Contacts/Inter Individual name of the Applicable for SED form
CompanyName mediateConsignee/CompanyName Intermediate consignee. only.

Container
/ShipConfirmRequest/Shipment/ShipmentSer

1...50
*Yes
One
viceOptions/InternationalForms/Contacts/Inter Address information of the Applicable for SED form
Address mediateConsignee/Address Intermediate Consignee. only.

Three
/ShipConfirmRequest/Shipment/ShipmentSer

1...35
string
*Yes
viceOptions/InternationalForms/Contacts/Inter Address line of the Max Occurrence must be
AddressLine mediateConsignee/Address/AddressLine Intermediate Consignee. 3

/ShipConfirmRequest/Shipment/ShipmentSer

1...30
string
*Yes
One

viceOptions/InternationalForms/Contacts/Inter City of the Intermediate Applicable for SED form

City mediateConsignee/Address/City Consignee. only.

/ShipConfirmRequest/Shipment/ShipmentSer
viceOptions/InternationalForms/Contacts/Inter Applicable for SED form
string
Cond

1...5
One

mediateConsignee/Address/StateProvinceCo State of the Intermediate only. Required for certain

StateProvinceCode de Consignee. countries.
String

/ShipConfirmRequest/Shipment/ShipmentSer
1...30
One

viceOptions/InternationalForms/Contacts/Inter Town of the Intermediate

No

Town mediateConsignee/Address/Town consignee

Applicable for SED form

only. Required for certain
/ShipConfirmRequest/Shipment/ShipmentSer countries. The length of
string
Cond

1...9
One

viceOptions/InternationalForms/Contacts/Inter Postal code of the the postal code depends

PostalCode mediateConsignee/Address/PostalCode Intermediate Consignee. on the country code.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 149
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

2
/ShipConfirmRequest/Shipment/ShipmentSer

string
*Yes
One
viceOptions/InternationalForms/Contacts/Inter Country code of the Applicable for SED form
CountryCode mediateConsignee/Address/CountryCode Intermediate Consignee. only.
Information of the producer.
The NAFTA Certificate of
Origin must be completed,
signed, and dated by the
exporter. When the
Certificate is completed by
the producer for use by the
exporter, it must be
completed, signed, and

Container
dated by the producer. The
/ShipConfirmRequest/Shipment/ShipmentSer date must be the date the Applies to NAFTA CO.

1...35
Cond
One
viceOptions/InternationalForms/Contacts/Prod Certificate was completed Required for NAFTA CO
Producer ucer and signed. forms
The text associated with the

2
code will be printed in the
producer section instead of
producer contact
information. Use attached
List if more than one
producers good is included
on the Certificate, attach a Applies to NAFTA CO.
list of additional producers, Possible Values are:01:
including the legal name, AVAILABLE TO
address (including country), CUSTOMS UPON
and legal tax identification REQUEST, 02: SAME AS
/ShipConfirmRequest/Shipment/ShipmentSer number, cross-referenced to EXPORTER, 03:
string
One

viceOptions/InternationalForms/Contacts/Prod the goods described in the ATTACHED LIST, 04:

No

Option ucer/Option Description of Goods field. UNKNOWN

Applies to NAFTA CO.
Only applicable when
producer option is empty
or not present.
Conditionally required for:
/ShipConfirmRequest/Shipment/ShipmentSer Company Name or the
1...35

NAFTA CO, when

string
Cond
One

viceOptions/InternationalForms/Contacts/Prod Individual name of the Producer option is not

CompanyName ucer/CompanyName Producer. specified.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 150
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Applies to NAFTA CO.

/ShipConfirmRequest/Shipment/ShipmentSer Only applicable when

1...15
string
One
viceOptions/InternationalForms/Contacts/Prod producer option is empty

No
TaxIdentificationNumber ucer/TaxIdentificationNumber Tax ID of the Producer. or not present
Applies to NAFTA CO.
Only applicable if
producer option is empty
or not present.

Container
Conditionally required for:
/ShipConfirmRequest/Shipment/ShipmentSer NAFTA CO, when

1...50
Cond
One
viceOptions/InternationalForms/Contacts/Prod Address information of the Producer option is not
Address ucer/Address Producer. specified.

Three
/ShipConfirmRequest/Shipment/ShipmentSer

1...35
string
*Yes
viceOptions/InternationalForms/Contacts/Prod Address line of the Max Occurrence must be
AddressLine ucer/Address/AddressLine Producer. 3

Applies to NAFTA CO.

Conditionally required
/ShipConfirmRequest/Shipment/ShipmentSer for: NAFTA CO, when

1...30
string
*Yes
One
viceOptions/InternationalForms/Contacts/Prod Producer option is not
City ucer/Address/City City of the Producer. specified.

/ShipConfirmRequest/Shipment/ShipmentSer Applies to NAFTA CO.

string
Cond

1...5
One

viceOptions/InternationalForms/Contacts/Prod Required for certain

StateProvinceCode ucer/Address/StateProvinceCode State of the Producer. countries
String

/ShipConfirmRequest/Shipment/ShipmentSer
1...30
One

viceOptions/InternationalForms/Contacts/Prod
No

Town ucer/Address/Town Town of the Producer

Applies to NAFTA CO.
Required for certain
/ShipConfirmRequest/Shipment/ShipmentSer countries. The length of
string
Cond

1...9
One

viceOptions/InternationalForms/Contacts/Prod the postal code depends

PostalCode ucer/Address/PostalCode Postal code of the Producer. on the country code.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 151
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

/ShipConfirmRequest/Shipment/ShipmentSer

string
*Yes

1...2
One
viceOptions/InternationalForms/Contacts/Prod Country code of the
CountryCode ucer/Address/CountryCode Producer. Applies to NAFTA CO

1
String
/ShipConfirmRequest/Shipment/ShipmentSer
viceOptions/InternationalForms/Contacts/Prod

No
AttentionName ucer/AttentionName Producer Contact Name

1
Container
/ShipConfirmRequest/Shipment/ShipmentSer
viceOptions/InternationalForms/Contacts/Prod

No
Phone ucer/Phone Phone Container

1
String
/ShipConfirmRequest/Shipment/ShipmentSer
Yes

viceOptions/InternationalForms/Contacts/Prod Producer contact's Phone

Number ucer/Phone/Number Number
1
String

/ShipConfirmRequest/Shipment/ShipmentSer
viceOptions/InternationalForms/Contacts/Prod Producer contact's Phone
No

Extension ucer/Phone/Extension Extension

1
String

/ShipConfirmRequest/Shipment/ShipmentSer
viceOptions/InternationalForms/Contacts/Prod Producer contact's email
No

EMailAddress ucer/EMailAddress Address.

container

/ShipConfirmRequest/Shipment/ShipmentSer
One

N/A

viceOptions/InternationalForms/Contacts/Sold
No

SoldTo To SoldTo Container.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 152
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

/ShipConfirmRequest/Shipment/ShipmentSer

string
1..35
Yes*
One
viceOptions/InternationalForms/Contacts/Sold
Name To/Name Company Name.

/ShipConfirmRequest/Shipment/ShipmentSer

string
1..35
Yes*
One
viceOptions/InternationalForms/Contacts/Sold
AttentionName To/AttentionName Contact Name.

/ShipConfirmRequest/Shipment/ShipmentSer

string
1..15
One
viceOptions/InternationalForms/Contacts/Sold SoldTo Tax Identification

No
TaxIdentificationNumber To/TaxIdentificationNumber Number

container
/ShipConfirmRequest/Shipment/ShipmentSer
One

N/A
viceOptions/InternationalForms/Contacts/Sold
No

Phone To/Phone Phone Container

/ShipConfirmRequest/Shipment/ShipmentSer
string
1..15
Yes*
One

viceOptions/InternationalForms/Contacts/Sold Sold To contacts phone

Number To/Phone/Number number.

/ShipConfirmRequest/Shipment/ShipmentSer
string
One

viceOptions/InternationalForms/Contacts/Sold Sold To contacts phone

No

Extension To/Phone/Extension extension.

The text associated with the
2

code will be printed in the

sold to section of the NAFTA
/ShipConfirmRequest/Shipment/ShipmentSer CO form. The values Applies to NAFTA CO
string
One

viceOptions/InternationalForms/Contacts/Sold indicate the following 01 - form. Possible Values

No

Option To/Option Unknown; 02 - Various are 01 and 02

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 153
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

container
/ShipConfirmRequest/Shipment/ShipmentSer

Yes*
One

N/A
viceOptions/InternationalForms/Contacts/Sold
Address To/Address Address Container.

35
Three
/ShipConfirmRequest/Shipment/ShipmentSer

string
Yes
viceOptions/InternationalForms/Contacts/Sold SoldTo location's street Max Occurrence must be
AddressLine To/Address/AddressLine address. 3

30
/ShipConfirmRequest/Shipment/ShipmentSer

string
One
Yes
viceOptions/InternationalForms/Contacts/Sold
City To/Address/City SoldTo location's city.

5
/ShipConfirmRequest/Shipment/ShipmentSer

string
Cond

viceOptions/InternationalForms/Contacts/Sold One SoldTo location's state or Required for certain

StateProvinceCode To/Address/StateProvinceCode province code. countries.

/ShipConfirmRequest/Shipment/ShipmentSer
string
One

viceOptions/InternationalForms/Contacts/Sold
No

Town To/Address/Town SoldTo location's town code.

10

/ShipConfirmRequest/Shipment/ShipmentSer
string
Cond
One

viceOptions/InternationalForms/Contacts/Sold SoldTo location's postal

PostalCode To/Address/PostalCode code.
2

/ShipConfirmRequest/Shipment/ShipmentSer
string
One
Yes

viceOptions/InternationalForms/Contacts/Sold SoldTo location's country

CountryCode To/Address/CountryCode code.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 154
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1
String
/ShipConfirmRequest/Shipment/ShipmentSer
viceOptions/InternationalForms/Contacts/Sold Sold To contact's email

No
EMailAddress To/EMailAddress address.
Applies to SED, Invoice,
Partial Invoice, CO and
NAFTA CO. When any
International form is

*Yes to fifty
requested Product must

Container
be present at least once
but no more than 50.

1...50
One
/ShipConfirmRequest/Shipment/ShipmentSer Contains the commodity/ Note: For Partial Invoice
Product viceOptions/InternationalForms/Product product information this container is optional.
Applies to all International
Forms. Optional for
Partial Invoice. Must be
/ShipConfirmRequest/Shipment/ShipmentSer present at least once and

1...35
string
*Yes
One
viceOptions/InternationalForms/Product/Descr can occur for a maximum
Description iption Description of the product. of 3 times

Container
Container tag for the unit's Required for Invoice
1...20
Cond
One

/ShipConfirmRequest/Shipment/ShipmentSer information of each product. forms and optional for

Unit viceOptions/InternationalForms/Product/Unit (also called as commodity) Partial Invoice.
Total quantity of each Required for Invoice
commodity to be shipped, forms and optional for
/ShipConfirmRequest/Shipment/ShipmentSer measured in the units Partial Invoice. Must be
string
*Yes

1...7
One

viceOptions/InternationalForms/Product/Unit/ specified in the Unit of numeric. Valid characters

Number Number Measure field are 0-9.
Container

/ShipConfirmRequest/Shipment/ShipmentSer Container tag for the Unit of Required for Invoice

1...20
*Yes
One

viceOptions/InternationalForms/Product/Unit/ measurement for the forms and optional for

UnitOfMeasurement UnitOfMeasurement commodity. Partial Invoice.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 155
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Required for Invoice
forms and optional for
Partial Invoice. Valid
entries are: BA = Barrel,
BE = Bundle, BG = Bag,
BH = Bunch, BOX = Box,
BT = Bolt, BU = Butt, CI =
Canister, CM =
Centimeter, CON =
Container , CR = Crate,
CS = Case, CT = Carton,
CY = Cylinder, DOZ =
Dozen, EA = Each, EN =
Envelope, FT = Feet, KG
= Kilogram, KGS =
Kilograms, LB = Pound,
LBS = Pounds, L = Liter,
M = Meter, NMB =
Number, PA = Packet,
PAL = Pallet, PC = Piece,
PCS = Pieces, PF = Proof
Liters, PKG = Package ,
PR = Pair, PRS = Pairs,
RL = Roll, SET = Set,
SME = Square Meters,
/ShipConfirmRequest/Shipment/ShipmentSer Code for the Unit of SYD = Square Yards, TU
string
1... 3
*Yes
One

viceOptions/InternationalForms/Product/Unit/ measurement of the = Tube, YD = Yard, OTH

Code UnitOfMeasurement/Code commodity units. = Other.

Applies to Invoice and

Partial Invoice forms.
Conditionally Required for
the Invoice and Partial
/ShipConfirmRequest/Shipment/ShipmentSer The Unit of Measure if OTH Invoice form if OTH is
string
Cond
One

1..3

viceOptions/InternationalForms/Product/Unit/ (Other) is entered as the entered as the units

Description UnitOfMeasurement/Description UnitOfMeasurement code. UnitOfMeasurement code

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 156
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to Invoice and
Partial Invoice form.
Required for Invoice
forms and optional for
Partial Invoice. Amount
should be greater than
zero. Valid characters
are 0-9 and .(Decimal
point). Limit to 6 digits
after the decimal. The
maximum length of the
field is 12 including . and
can hold up to 6 decimal
places.(#####.######,
######.#####,
#######.####,
########.###,
#########.##,########
##.#,############)The
value of this product and
the other products should
be such that the invoice
line total which is the sum
Monetary amount used to of ( number*values) of all
/ShipConfirmRequest/Shipment/ShipmentSer specify the worth or price of products should not

1...12
string
*Yes
One

viceOptions/InternationalForms/Product/Unit/ the commodity. Amount exceed

Value Value should be greater than zero 9999999999999999.99

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 157
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to Invoice, Partial
Invoice and NAFTA CO.
Required for NAFTA CO
and optional for Partial
Invoice. Should be at
least 6 alphanumeric. For
NAFTA CO: For each
good described in
Description of Goods
field, identify the H.S.
tariff classification to six
digits. If the good is
subject to a specific rule
of origin in Annex 401
that requires eight digits,
identify to eight digits,
6-to-15-alphanumeric using the H.S. tariff
commodity code. Customs classification of the
/ShipConfirmRequest/Shipment/ShipmentSer uses this code to determine country into whose

6...15
string
Cond
One
viceOptions/InternationalForms/Product/Com what duties should be territory the good is
CommodityCode modityCode assessed on the commodity. imported.
The part number or Applies to Invoice and
reference number for the Partial Invoice. Required

1...10
/ShipConfirmRequest/Shipment/ShipmentSer product contained in the for Invoice forms and
string
One

viceOptions/InternationalForms/Product/PartN invoice line, as indicated on optional for Partial

No

PartNumber umber the customs invoice. Invoice.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 158
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to Invoice, Partial

2
Invoice, CO and NAFTA
CO. Required for Invoice
and CO forms. Optional
for Partial Invoice.
Conditionally required for
NAFTA CO if
JointProductionIndicator
is not present. For all
other originating goods
exported to Canada,
indicate appropriately MX
or US if the goods
originate in that NAFTA
country, within the
The country in which the meaning of the NAFTA
good was manufactured, Rules of Origin
produced, or grown. For Regulations, and any
detailed information on subsequent processing in
country of origin, certificate the other NAFTA country
of origin, rules of origin, and does not increase the
any related matters, please transaction value of the
refer to the U.S. Customs goods by more than
and Border Protection Web seven percent; otherwise
/ShipConfirmRequest/Shipment/ShipmentSer string site at www.customs.gov or use the
Cond
One

viceOptions/InternationalForms/Product/Origin contact your country's JointProductionIndicator

OriginCountryCode CountryCode Customs authority. for joint production.
If present, JNT will be used
as the origin of country code
EMPTY

/ShipConfirmRequest/Shipment/ShipmentSer on the NAFTA form and the

One

N/A

viceOptions/InternationalForms/Product/Joint Product/OriginCountryCode Applies to NAFTA CO

No

JointProductionIndicator ProductionIndicator tag will be ignored. only

For each good described in
2

the Description of Goods

field, where the good is
subject to a regional value
content (RVC) requirement,
indicate NC if the RVC is Applies to NAFTA CO
/ShipConfirmRequest/Shipment/ShipmentSer calculated according to the only. Required for NAFTA
string
Cond
One

viceOptions/InternationalForms/Product/NetC net cost method; otherwise, CO. Possible

NetCostCode ostCode indicate NO. Values:NCNO

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 159
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
Optional
/ShipConfirmRequest/Shipment/ShipmentSer

One

N/A
viceOptions/InternationalForms/Product/NetC Date Range for regional Applies to NAFTA CO
NetCostDateRange ostDateRange value content (RVC) only.
If the RVC is calculated over

8
a period of time, it should be
identified by the begin date
/ShipConfirmRequest/Shipment/ShipmentSer (yyyyMMdd) of that period. Applies to NAFTA CO

string
*Yes
One
viceOptions/InternationalForms/Product/NetC (Reference: Articles 402.1, only. Format is
BeginDate ostDateRange/BeginDate 402.5). yyyyMMdd
If the RVC is calculated over

8
a period of time, it should be
identified by the End date
/ShipConfirmRequest/Shipment/ShipmentSer (yyyyMMdd) of that period. Applies to NAFTA CO

string
*Yes
One
viceOptions/InternationalForms/Product/NetC (Reference: Articles 402.1, only. Format is
EndDate ostDateRange/EndDate 402.5). yyyyMMdd
Indicates the criterion (A

1
through F) for each good
described in the Description
of Goods field if applicable.
The rules of origin are
contained in Chapter Four
and Annex 401. Additional
rules are described in Annex
703.2 (certain agricultural
goods), Annex 300-B,
Appendix 6 (certain textile
goods) and Annex 308.1
/ShipConfirmRequest/Shipment/ShipmentSer (certain automatic data Applicable for NAFTA CO
string
Cond
One

viceOptions/InternationalForms/Product/Prefe processing goods and their and is required. Possible

PreferenceCriteria renceCriteria parts). Values: ABCDEF.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 160
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Indicate the following: Yes -
If shipper is the producer of
the good. If not, state 02, 03,
and 04 depending on
whether this certificate was
based upon: No[1] -
Knowledge of whether the
good qualifies as an
originating good. No[2] -
Reliance on the producers
written representation (other
than a Certificate of Origin)
that the good qualifies as an
originating good. No[3] - A
completed and signed Applicable for NAFTA CO

3 0r 5
/ShipConfirmRequest/Shipment/ShipmentSer Certificate for the good and is required. Possible

string
Cond
One
viceOptions/InternationalForms/Product/Produ voluntarily provided to the Values: Yes, No[1], No[2],
ProducerInfo cerInfo exporter by the producer. or No[3]

/ShipConfirmRequest/Shipment/ShipmentSer Any special marks, codes,

1...35
string
viceOptions/InternationalForms/Product/Mark One and numbers that may
No

MarksAndNumbers sAndNumbers appear on package Applies to CO Only

Applicable for CO and is

/ShipConfirmRequest/Shipment/ShipmentSer The total number of required. Should be
string
Cond

1...3
One

NumberOfPackagesPerCommodi viceOptions/InternationalForms/Product/Numb packages, cartons, or numeric. Valid characters

ty erOfPackagesPerCommodity containers for the commodity are 0 -9.
The shipping weight,
including containers, for
each commodity with a
Container

separate Harmonized Tariff

/ShipConfirmRequest/Shipment/ShipmentSer Code / Schedule B Number. Applies to CO and SED
Cond
One

N/A

viceOptions/InternationalForms/Product/Produ This weight does not include forms only. Required for
ProductWeight ctWeight carrier equipment. CO and SED forms.
Container

/ShipConfirmRequest/Shipment/ShipmentSer
*Yes
One

N/A

viceOptions/InternationalForms/Product/Produ Container tag for the Unit of Applies to CO and SED

UnitOfMeasurement ctWeight/UnitOfMeasurement Measurement of weight forms only

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 161
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

3
/ShipConfirmRequest/Shipment/ShipmentSer Applies to CO and SED

string
*Yes
One
viceOptions/InternationalForms/Product/Produ Code for unit of forms only. Possible
Code ctWeight/UnitOfMeasurement/Code Measurement of weight values :KGS, LBS

String
/ShipConfirmRequest/Shipment/ShipmentSer

1...20
One
viceOptions/InternationalForms/Product/Produ Description of the Unit of

No
Description ctWeight/UnitOfMeasurement/Description Measure
Applies to CO and SED
forms only. Valid
characters are 0-9 and
.(Decimal point). Limit to
1 digit after the decimal.
The maximum length of
/ShipConfirmRequest/Shipment/ShipmentSer the field is 5 including .

string
*Yes

1...5
One
viceOptions/InternationalForms/Product/Produ and can hold up to 1
Weight ctWeight/Weight Weight decimal place.
Includes the following
information for used self-
propelled vehicles as
defined in Customs
regulations 19 CFR 192.1:
The unique Vehicle
Identification Number (VIN)
in the proper format. Or The
Product Identification
Number (PIN) for those used
/ShipConfirmRequest/Shipment/ShipmentSer self propelled vehicles for
1...25
string
One

viceOptions/InternationalForms/Product/Vehic which there are no VINs. Or, Applies to SED forms

No

VehicleID leID The Vehicle Title Number. only

Container

/ShipConfirmRequest/Shipment/ShipmentSer Container tag for the Applies to SED forms

Cond
One

N/A

viceOptions/InternationalForms/Product/Sche schedule B information of a only. Required for SED

ScheduleB duleB commodity form

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 162
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

10
A unique 10-digit commodity
classification code for the
item being exported. (To
classify a commodity access
the following Web page:
/ShipConfirmRequest/Shipment/ShipmentSer http://www.census.gov/foreig Applies to SED forms

string
*Yes
One
viceOptions/InternationalForms/Product/Sche n- only. Has to be 10
Number duleB/Number trade/schedules/b/#search). characters.
The count of how many
Schedule B units of the Applies to SED forms
current good are in the only. Conditionally
shipment (SED only).For required for SED forms if
example, if the Schedule B ScheduleB
unit of measure is dozens UnitOfMeasurement is
/ShipConfirmRequest/Shipment/ShipmentSer and eight dozen, is being not X. Should be

1...10
string
Cond
One
viceOptions/InternationalForms/Product/Sche shipped, indicate 8 in this Numeric. Valid characters
Quantity duleB/Quantity field. are 0 -9.

Container
/ShipConfirmRequest/Shipment/ShipmentSer The unit of measure
*Yes
One

N/A
viceOptions/InternationalForms/Product/Sche indicated on the Export Applies to SED forms
UnitOfMeasurement duleB/UnitOfMeasurement License. only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 163
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to SED forms
only. Required for the
SED form. Possible
Values: BBL: Barrels,
CAR: Carat, CKG:
Content Kilogram, CM2:
Square Centimeters,
CTN: Content Ton, CUR:
Curie, CYK: Clean Yield
Kilogram, DOZ: Dozen,
DPC: Dozen Pieces,
DPR: Dozen Pairs, FBM:
Fiber Meter, GCN: Gross
Containers, GM: Gram,
GRS: Gross, HUN:
Hundred, KG: Kilogram,
KM3: 1,000 Cubic Meters,
KTS: Kilogram Total
Sugars, L: Liter, M: Meter,
M2: Square Meters, M3:
Cubic Meters, MC:
Millicurie, NO: Number,
PCS: Pieces, PFL: Proof
The unit of measure Liter, PK: Pack, PRS:
indicated on the Export Pairs, RBA: Running
/ShipConfirmRequest/Shipment/ShipmentSer License. Enter an X if there Bales, SQ: Square, T:
string
*Yes
One

viceOptions/InternationalForms/Product/Sche 1..3 is no unit of measure in the Ton, THS: 1,000, X: No

Code duleB/UnitOfMeasurement/Code Schedule B Unit field. Quantity required.
String

/ShipConfirmRequest/Shipment/ShipmentSer
1...20
One

viceOptions/InternationalForms/Product/Sche Description of the Unit of

No

Description duleB/UnitOfMeasurement/Description Measure

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 164
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Code indicating Domestic:

1
Exports that have been
produced, manufactured, or
grown in the United States
or Puerto Rico. This includes
imported merchandise which
has been enhanced in value
or changed from the form in
which imported by further
manufacture or processing
in the United States or
Puerto Rico. Foreign:
Merchandise that has
entered the United States
and is being exported again
in the same condition as
when imported. Applies to SED forms
ForeignMilitary: Exported only. Required for SED
/ShipConfirmRequest/Shipment/ShipmentSer merchandise that is sold form. Possible Values:

string
Cond
One
viceOptions/InternationalForms/Product/Expor under the foreign military D: Domestic, F: Foreign,
ExportType tType sales program. M: Foreign Military.
Applies to SED forms
only. Required for SED
form. Valid characters are
0-9 and .(Decimal point).
Limit to 2 digit after the
decimal. The maximum
length of the field is 15
including . and can hold
up to 2 decimal places.
Note: This value is
calculated based on the
Product/Unit/Value and
/Product/Unit/Number
(Number of Units * Price
The value of the S.E.D. per Unit). If the total value
/ShipConfirmRequest/Shipment/ShipmentSer commodity contained on the is incorrect it will be
1...15
string
Cond
One

viceOptions/InternationalForms/Product/SEDT S.E.D. This amount will replaced by the actual

SEDTotalValue otalValue always be USD. calculated total value.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 165
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
If this container is not
Container tag for present we assume that

Container
determining whether or not the DEFAULT is selected
/ShipConfirmRequest/Shipment/ShipmentSer to exclude product which is "none" and all

One

N/A
viceOptions/InternationalForms/Product/Exclu information from a particular products will appear on all

No
ExcludeFromForm deFromForm form. forms.
Possible Values are 04 –
NAFTA CO. Please note

unbounded
that if this is used and you
Indicates the name of the DO NOT have the

String
/ShipConfirmRequest/Shipment/ShipmentSer International form requested corresponding form type

Yes

1..2
viceOptions/InternationalForms/Product/Exclu to NOT have product requested this will be
FormType deFromForm/FormType information. IGNORED.

Applies to Invoice and

Partial Invoice forms only.
/ShipConfirmRequest/Shipment/ShipmentSer Required for Invoice

1...35
string
One
viceOptions/InternationalForms/InvoiceNumbe Commercial Invoice number forms and optional for

No
InvoiceNumber r assigned by the exporter Partial Invoice.
Applies to Invoice and

8
Partial Invoice forms only.
Required for Invoice
forms and optional for
Partial Invoice. Required
for Invoice form for
forward shipments. For
shipment with return
service, the user input will
be ignored, and the field
Date when the Invoice is will be blank on the
string
Cond
One

/ShipConfirmRequest/Shipment/ShipmentSer created. Ideally this is the invoice. Format is

InvoiceDate viceOptions/InternationalForms/InvoiceDate same as the ship date. yyyyMMdd

/ShipConfirmRequest/Shipment/ShipmentSer
1...35
string
One

viceOptions/InternationalForms/PurchaseOrd The customer's order Applies to Invoice and

No

PurchaseOrderNumber erNumber reference number Partial Invoice forms only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 166
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to Invoice and

3
Partial Invoice forms only.
Possible values are: CFR:
Cost and Freight, CIF:
Cost, Insurance and
Freight, CIP: Carriage
and Insurance Paid, CPT:
Carriage Paid To. DAF:
Delivered at Frontier,
DDP: Delivery Duty Paid,
DDU: Delivery Duty
Unpaid, DEQ: Delivered
Ex Quay, DES: Delivered
Ex Ship, EXW: Ex Works,
/ShipConfirmRequest/Shipment/ShipmentSer FAS: Free Alongside

string
One
viceOptions/InternationalForms/TermsOfShip Indicates the rights to the Ship, FCA: Free Carrier,

No
TermsOfShipment ment seller from the buyer. FOB: Free On Board.

reason to export the current

international shipment. Applies to Invoice and
Possible values: SALE, Partial Invoice forms only.
GIFT, SAMPLE, RETURN, Required for Invoice
/ShipConfirmRequest/Shipment/ShipmentSer REPAIR, forms and Optional for

1...20
string
Cond

viceOptions/InternationalForms/ReasonForEx One INTERCOMPANYDATA, Partial Invoice. No

ReasonForExport port Any other reason validation

1...150
string
One

/ShipConfirmRequest/Shipment/ShipmentSer Any extra information about Applies to Invoice and

No

Comments viceOptions/InternationalForms/Comments the current shipment Partial Invoice forms only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 167
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
This is the legal explanation,
used by Customs, for the
delivering of this shipment. It
must be identical to the set
of declarations actually used
by Customs. Examples of
declarations that might be
entered in this field are: I
hereby certify that the goods
covered by this shipment
qualify as originating goods
for purposes of preferential
tariff treatment under the Applies to Invoice and
NAFTA.I hereby certify that Partial Invoice forms only.
the information on this On the invoice for return
invoice is true and correct shipment, the verbiage is
and the contents and value as follows (user input is
of this shipment is as stated ignored): The exporter of
above. EEA statement: The the products covered by
exporter of the products this document declares
covered by this document that except where
declares that except where otherwise clearly

1...550
/ShipConfirmRequest/Shipment/ShipmentSer otherwise clearly indicated indicated these products

string
One
viceOptions/InternationalForms/DeclarationSt these products are of EEA are of EEA preferential
No

DeclarationStatement atement Container preferential origin. origin

One

N/A

/ShipConfirmRequest/Shipment/ShipmentSer Container tag that holds the Applies to Invoice and

No

Discount viceOptions/InternationalForms/Discount discount. Partial Invoice forms only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 168
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to Invoice and

15
Partial Invoice forms only.
Required for Invoice
forms and optional for
Partial Invoice. Valid
characters are 0-9 and
.(Decimal point). Limit to
2 digit after the decimal.
The maximum length of
the field is 15 including .
and can hold up to 2
decimal places. This
value should be greater
The discount to be than or equal to zero or
/ShipConfirmRequest/Shipment/ShipmentSer subtracted from the sum of less than or equal to the

string
*Yes
One
viceOptions/InternationalForms/Discount/Mon the total value on the value of all goods listed
MonetaryValue etaryValue invoice. on the invoice.

Container
/ShipConfirmRequest/Shipment/ShipmentSer

One

N/A
viceOptions/InternationalForms/FreightCharge Container tag that holds the Applies to Invoice and
No
FreightCharges s Freight Charges Partial Invoice forms only.
Applies to Invoice and
Partial Invoice forms only.
Required for Invoice
forms and optional for
Partial Invoice. Valid
characters are 0-9 and
.(Decimal point). Limit to
2 digit after the decimal.
The maximum length of
/ShipConfirmRequest/Shipment/ShipmentSer the field is 15 including .
0...15
string
*Yes
One

viceOptions/InternationalForms/FreightCharge Cost to transport the and can hold up to 2

MonetaryValue s/MonetaryValue shipment decimal places.
Container

/ShipConfirmRequest/Shipment/ShipmentSer
One

N/A

viceOptions/InternationalForms/InsuranceCha Container tag that holds the Applies to Invoice and

No

InsuranceCharges rges Insurance Charges Partial Invoice forms only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 169
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to Invoice and
Partial Invoice forms only.
Required for Invoice
forms and optional for
Partial Invoice. Valid
characters are 0-9 and
.(Decimal point). Limit to
The amount the shipper or 2 digit after the decimal.
receiver pays to cover the The maximum length of
/ShipConfirmRequest/Shipment/ShipmentSer cost of replacing the the field is 15 including .

0...15
string
*Yes
One
viceOptions/InternationalForms/InsuranceCha shipment if it is lost or and can hold up to 2
MonetaryValue rges/MonetaryValue damaged decimal places.

Container tag that holds the

Container
information of amount that
covers additional charges

One

N/A
/ShipConfirmRequest/Shipment/ShipmentSer not already listed on the Applies to Invoice and

No
OtherCharges viceOptions/InternationalForms/OtherCharges invoice Partial Invoice forms only.
Applies to Invoice and
Partial Invoice forms only.
Required for Invoice
forms and optional for
Partial Invoice. Valid
characters are 0-9 and
.(Decimal point). Limit to
2 digit after the decimal.
The maximum length of
/ShipConfirmRequest/Shipment/ShipmentSer the field is 15 including .
0...15
string
*Yes
One

viceOptions/InternationalForms/OtherCharges The Monetary value of Other and can hold up to 2

MonetaryValue /MonetaryValue Charges decimal places.

Applies to Invoice and

Partial Invoice forms only.
/ShipConfirmRequest/Shipment/ShipmentSer Required for Complete
1...10
string
*Yes
One

viceOptions/InternationalForms/OtherCharges Description of what the other Invoice and Optional for

Description /Description charges are for. Partial Invoice forms.
3

/ShipConfirmRequest/Shipment/ShipmentSer Currency code for all the

string
Cond
One

viceOptions/InternationalForms/CurrencyCod monetary values of the Applies to Invoice and

CurrencyCode e Invoice form Partial Invoice forms only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 170
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
This field should be entered
if the NAFTA Certificate
covers multiple shipments of
identical goods as described
in the Description of Goods
field that are imported into a
NAFTA country for a
specified period of up to one
year (the blanket period).
The importation of a good for

Container
which preferential treatment
is claimed based on this Applies to NAFTA CO

Cond
One

N/A
/ShipConfirmRequest/Shipment/ShipmentSer certificate must occur form only. Required for
BlanketPeriod viceOptions/InternationalForms/BlanketPeriod between these dates. NAFTA CO.
Begin date of the blanket

8
period. It is the date upon
which the Certificate
becomes applicable to the
good covered by the blanket Applies to NAFTA CO
/ShipConfirmRequest/Shipment/ShipmentSer Certificate (it may be prior to form only. Required for

string
*Yes
One
viceOptions/InternationalForms/BlanketPeriod the date of signing this NAFTA CO. Format is
BeginDate /BeginDate Certificate). yyyyMMdd

8
End Date of the blanket Applies to NAFTA CO
/ShipConfirmRequest/Shipment/ShipmentSer period. It is the date upon form only. Required for
string
*Yes
One

viceOptions/InternationalForms/BlanketPeriod which the blanket period NAFTA CO. Format is

EndDate /EndDate expires. yyyyMMdd
8

Applies to CO and SED

forms only. Required for
string
Cond
One

/ShipConfirmRequest/Shipment/ShipmentSer The date the goods will be CO and SED forms.

ExportDate viceOptions/InternationalForms/ExportDate exiting the country Format is yyyyMMdd
The name of the carrier that
is exporting the shipment.
/ShipConfirmRequest/Shipment/ShipmentSer The vessel's flag number Applies to CO and SED
1...35
string
Cond
One

viceOptions/InternationalForms/ExportingCarri should also be entered, if the forms only. Required for

ExportingCarrier er carrier is a vessel. CO and SED forms.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 171
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The four-character Standard
Carrier Alpha Code (SCAC)
for vessel, rail, and truck
shipments. For air shipment,
enter the two or three
character International Air

1...17
string
One
/ShipConfirmRequest/Shipment/ShipmentSer Transport Association (IATA) Applies to SED forms

No
CarrierID viceOptions/InternationalForms/CarrierID code only. No Validations.

2
Applies to SED forms
only. Required for SED
forms. Valid values are:
70: Not in bond; 36:
Warehouse withdrawal for
IE; 37: Warehouse
withdrawal for T and E;
62: T and E; 63: IE; 67:

string
Cond
One
/ShipConfirmRequest/Shipment/ShipmentSer The two-character In Bond IE from a FTZ; 68: T and
InBondCode viceOptions/InternationalForms/InBondCode Code E from a FTZ

The Import Entry Number

when the export transaction Applies to SED forms
is used as proof of export for only. Conditionally
import transactions Required for SED forms
(examples: In Bond, when In bond code value
1...25
string
Cond
One

/ShipConfirmRequest/Shipment/ShipmentSer Temporary Import Bond or is other than 70(Not In

EntryNumber viceOptions/InternationalForms/EntryNumber Drawbacks) Bond)

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 172
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Contains one of the
following: The two-digit U.S.
Postal Service abbreviation
for the state from which the
goods were shipped to the
port of export. The state that
is the source for the good
with the highest value. The
state of consolidation. The
Foreign Trade Zone number
of the zone from where the
exports are leaving. If the

string
Cond

1...5
One
/ShipConfirmRequest/Shipment/ShipmentSer goods were shipped from Applies to SED forms
PointOfOrigin viceOptions/InternationalForms/PointOfOrigin Puerto Rico, enter PR. only. Required for SED
Mode of transport by which
the goods are exported.
Possible values: Air,
AirContainerized, Auto,
FixedTransportInstallations,
Mail, Applies to SED forms
PassengerHandcarried, only. Required for SED.
Pedestrian, Rail, Only allowed values can
RailContainerized, be entered. Only 10
RoadOther, SeaBarge, Characters can appear on
/ShipConfirmRequest/Shipment/ShipmentSer SeaContainerized, the form. Anything greater
1...35
string
Cond
One

viceOptions/InternationalForms/ModeOfTrans SeaNoncontainerized, than 10 characters will be

ModeOfTransport port Truck, TruckContainerized truncated on the form.
Should be one of the
following-Overland: The U.S.
Customs port where the
carrier crosses the U.S.
border. -Vessel and Air: The
U.S. Customs port where the
goods are loaded on the
carrier to be exported from
the U.S. -Postal: The U.S.
1...35
string
One

/ShipConfirmRequest/Shipment/ShipmentSer Postal Office from where the Applies to SED forms

No

PortOfExport viceOptions/InternationalForms/PortOfExport goods are mailed only. No validation.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 173
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

The country and the port

where the goods will be
/ShipConfirmRequest/Shipment/ShipmentSer unloaded from the exporting

1...35
string
One
viceOptions/InternationalForms/PortOfUnloadi carrier. For vessel and air Applies to SED forms

No
PortOfUnloading ng shipments only. only. No validation.

Pier where goods are

1...35
string
One
/ShipConfirmRequest/Shipment/ShipmentSer loaded. For vessel Applies to SED forms

No
LoadingPier viceOptions/InternationalForms/LoadingPier shipments only only. No validation.

1
Information about parties to
transaction. Use Related, if
the parties to the transaction
are related. A related party is
an export from a U.S.
businessperson or business
to a foreign business or from
a U.S. business to a foreign
person or business where
the person has at least 10
percent of the voting shares
of the business during the
/ShipConfirmRequest/Shipment/ShipmentSer fiscal year. If unincorporated, Applies to SED forms
string
Cond
One

viceOptions/InternationalForms/PartiesToTran then an equivalent interest in only. Valid values are: R

PartiesToTransaction saction the business. - Related, N - Non-related
If Present, indicates that it is
a routed export transaction.
A routed export transaction
is one, where the foreign
principal party in interest
authorizes a U.S. forwarding
EMPTY

/ShipConfirmRequest/Shipment/ShipmentSer (or other) agent to export the

One

N/A

RoutedExportTransactionIndicato viceOptions/InternationalForms/RoutedExport merchandise outside the Applies to SED forms

No

r TransactionIndicator U.S. only

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 174
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

If present indicates that the

EMPTY
/ShipConfirmRequest/Shipment/ShipmentSer goods are containerized.

One

N/A
viceOptions/InternationalForms/Containerized This applies to vessel Applies to SED forms

No
ContainerizedIndicator Indicator shipments only only
Container for License
information. If the product is
not licensable, a valid
license exception code
needs to be entered. If
shipping different products

Container
that are covered under
different licenses or license Applies to SED forms

Cond
One

N/A
/ShipConfirmRequest/Shipment/ShipmentSer exceptions, then separate only. Required for SED
License viceOptions/InternationalForms/License SEDs must be created. forms.

Applies to SED forms

only. Either License
number or License
exception code should be
present for SED form,
both License number and
/ShipConfirmRequest/Shipment/ShipmentSer License Exception code
1...35
string
Cond
One

viceOptions/InternationalForms/License/Numb The license number that cannot be present for

Number er authorizes ship product. SED form.
Applies to SED forms
only. Conditionally
required for SED forms if
there is a license number.
Only applicable when
License Number is
string
Cond

1...8
One

/ShipConfirmRequest/Shipment/ShipmentSer provided. Format

Date viceOptions/InternationalForms/License/Date License Date yyyyMMdd

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 175
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Applies to SED forms
only. Either License
number or License
exception code should be
present for SED form,
both License number and
License Exception code
/ShipConfirmRequest/Shipment/ShipmentSer cannot be present for

string
Cond

1...4
One
viceOptions/InternationalForms/License/Exce Please refer to Appendix Q SED form. Validated for
ExceptionCode ptionCode for values and descriptions. possible values

8
Export Control Classification
Number. This number Applies to SED forms
identifies categories, product only. ECCN is required
groups, strategic level of one of the following
control, and country groups. License Exception Codes

string
Cond
One
/ShipConfirmRequest/Shipment/ShipmentSer Some products have an is entered: CIV, CTP,
ECCNNumber viceOptions/InternationalForms/ECCNNumber ECCN number. ENC, KMI, or LVS
The application will

1
automatically provide a copy
of the invoice or NAFTA/CO
with each response
regardless of whether the
String user has enabled Paperless
/ShipConfirmRequest/Shipment/ShipmentSer account. The user now has
viceOptions/InternationalForms/OverridePape the option to print or ignore
No

OverridePaperlessIndicator rlessIndicator the copy provided.

container

For a list of valid

origin/destination countries
One

N/A

/ShipConfirmRequest/Shipment/ShipmentSer please refer to the table in

No

DeliveryConfirmation viceOptions/DeliveryConfirmation Appendix N Forwards Only

1

Valid values are: 1 -

Delivery Confirmation 2
- Delivery Confirmation
Signature Required 3 -
Delivery Confirmation
string
Yes*
One

/ShipConfirmRequest/Shipment/ShipmentSer Adult Signature Required.

DCISType viceOptions/DeliveryConfirmation/DCISType Type of delivery confirmation Forwards Only

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 176
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

String
/ShipConfirmRequest/Shipment/ShipmentSer

1...20
One
viceOptions/DeliveryConfirmation/DCISNumb

No
DCISNumber er DCIS Number

0
The flag indicates the

String
ReturnOfDocument Valid for Poland to Poland

One
/ShipConfirmRequest/Shipment/ShipmentSer accessorial has been without return service

No
ReturnOfDocumentIndicator viceOptions/ReturnOfDocumentIndicator requested only.

0
String
Indicates that the Shipment

One
/ShipConfirmRequest/Shipment/ShipmentSer is an ImportControl

No
ImportControlIndicator viceOptions/ImportControlIndicator shipment.

Container
This container is
One

N/A
/ShipConfirmRequest/Shipment/ShipmentSer applicable only for
No

LabelMethod viceOptions/LabelMethod Type of ImportControl Label. ImportControl shipments.

2 LabelMethod types:'01' =
ImportControl Print and
Mail'02' = ImportControl
One-Attempt'03' =
ImportControl Three-
String

Attempt'04' = ImportControl
Yes*
One

/ShipConfirmRequest/Shipment/ShipmentSer Electronic Label'05' =

Code viceOptions/LabelMethod/Code ImportControl Print Label
String
1...35
Yes*
One

/ShipConfirmRequest/Shipment/ShipmentSer
Description viceOptions/LabelMethod/Description LabelMethod description

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 177
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

0
CommercialInvoiceRemovalI
ndicator allows a shipper to
dictate that UPS remove the
Commercial Invoice from the

String
/ShipConfirmRequest/Shipment/ShipmentSer user's shipment before the

One
CommercialInvoiceRemovalIndic viceOptions/CommercialInvoiceRemovalIndic shipment is delivered to the

No
ator ator ultimate consignee.

0
UPS carbon neutral indicator

String
presence at shipment level

One
/ShipConfirmRequest/Shipment/ShipmentSer is required to create carbon
No
UPScarbonneutralIndicator viceOptions/UPScarbonneutralIndicator neutral Shipments.
unbounded
Container

/ShipConfirmRequest/Shipment/ShipmentSer
No

PreAlertNotification viceOptions/PreAlertNotification
1
Container

/ShipConfirmRequest/Shipment/ShipmentSer
viceOptions/PreAlertNotification/EMailMessag
No

EMailMessage e
1
String

/ShipConfirmRequest/Shipment/ShipmentSer
Yes

viceOptions/PreAlertNotification/EMailMessag
EMailAddress e/EMailAddress

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 178
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1
String
/ShipConfirmRequest/Shipment/ShipmentSer
viceOptions/PreAlertNotification/EMailMessag

No
UndeliverableEMailAddress e/UndeliverableEMailAddress

1
Container
/ShipConfirmRequest/Shipment/ShipmentSer
viceOptions/PreAlertNotification/VoiceMessag

No
VoiceMessage e

1
String
/ShipConfirmRequest/Shipment/ShipmentSer

Yes
viceOptions/PreAlertNotification/VoiceMessag
PhoneNumber e/PhoneNumber

1
Container
/ShipConfirmRequest/Shipment/ShipmentSer
No

TextMessage viceOptions/PreAlertNotification/TextMessage
1
String

/ShipConfirmRequest/Shipment/ShipmentSer
Yes

viceOptions/PreAlertNotification/TextMessage
PhoneNumber /PhoneNumber
1
Container
Yes

/ShipConfirmRequest/Shipment/ShipmentSer
Locale viceOptions/PreAlertNotification/Locale
1
String

/ShipConfirmRequest/Shipment/ShipmentSer
Yes

viceOptions/PreAlertNotification/Locale/Langu
Language age

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 179
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1
String
/ShipConfirmRequest/Shipment/ShipmentSer

Yes
viceOptions/PreAlertNotification/Locale/Dialec
Dialect t

1
String
/ShipConfirmRequest/Shipment/ShipmentSer

No
ExchangeForwardIndicator viceOptions/ExchangeForwardIndicator

##
For Return Shipments up
to and including 20

Container
packages are allowed.
US/PR origin return
Yes

N/A
Package Information movements are limited to
Package /ShipConfirmRequest/Shipment/Package container. only one package.

1...35
string
Cond
One

/ShipConfirmRequest/Shipment/Package/Des Merchandise description of Required for shipment

Description cription package. with return service
container

Packaging type is
required for Ground
Cond
One

N/A

/ShipConfirmRequest/Shipment/Package/Pac Freight Pricing

Packaging kaging Packaging Container Shipments only

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 180
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

2
Package type 24, or 25
Package types. Values are: or 30 is only allowed for
01 = UPS Letter, 02 = shipment without return
Customer Supplied service. Packaging type
Package, 03 = Tube, 04 = must be valid for all the
PAK, 21 = UPS Express following: ShipTo
Box, 24 = UPS 25KG Box, country, ShipFrom
25 = UPS 10KG Box, 30 = country, a shipment going
Pallet, 2a = Small Express from ShipTo country to
Box, 2b = Medium Express ShipFrom country, all
Box, 2c = Large Express Accessorials at both the
Box. Note: Only packaging shipment and package

string
Yes*
One
/ShipConfirmRequest/Shipment/Package/Pac type code 02 is applicable to level, and the shipment
Code kaging/Code Ground Freight Pricing service type.

Description of packaging

String
1...35
type. Examples are letter,

One
/ShipConfirmRequest/Shipment/Package/Pac customer supplied, express
No

Description kaging/Description box. N/A

Length + 2*(Width +
Height) must be less than
Dimensions information or equal to 130 IN or 330
container

container. Note: Currently CM. Dimensions are

dimensions are not required for GB to GB
Cond
One

N/A

/ShipConfirmRequest/Shipment/Package/Dim applicable to Ground Freight and Poland to Poland

Dimensions ensions Pricing Shipments.
container
One
Yes

N/A

/ShipConfirmRequest/Shipment/Package/Dim UnitOfMeasurement
UnitOfMeasurement ensions/UnitOfMeasurement container N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 181
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Package dimensions

2
measurement code. Codes
are: IN = Inches, CM =
Centimeters, 00 = Metric
Units Of Measurement, 01 = The unit of measurement

string
One
Yes
/ShipConfirmRequest/Shipment/Package/Dim English Units of must be valid for the
Code ensions/UnitOfMeasurement/Code Measurement. Shipper country.

Description of the package

1...35
string
One
/ShipConfirmRequest/Shipment/Package/Dim dimensions measurement

No
Description ensions/UnitOfMeasurement/Description units. N/A
Package length. Refer to

3
Universal Rules table for
additional information.Length

string
Yes*
One
/ShipConfirmRequest/Shipment/Package/Dim must be the longest Valid values are 0 to 108
Length ensions/Length dimension of the container. IN and 0 to 270 CM.

3
Package width. Refer to

string
Yes*
One
/ShipConfirmRequest/Shipment/Package/Dim Universal Rules table for
Width ensions/Width additional information. N/A

3
Package height. Refer to
string
Yes*
One

/ShipConfirmRequest/Shipment/Package/Dim Universal Rules table for

Height ensions/Height additional information. N/A
Container

Package weight is a
Cond
One

N/A

/ShipConfirmRequest/Shipment/Package/Pac Container to hold package required field for Ground

PackageWeight kageWeight weight information. Freight Pricing shipments
Container

Container to hold
One
Yes

N/A

/ShipConfirmRequest/Shipment/Package/Pac UnitOfMeasurement
UnitOfMeasurement kageWeight/UnitOfMeasurement information. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 182
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

3
Package weight unit of
measurement code. Codes

string
One
Yes
/ShipConfirmRequest/Shipment/Package/Pac are: LBS = Pounds, KGS =
Code kageWeight/UnitOfMeasurement/Code Kilograms.

1...35
string
One
/ShipConfirmRequest/Shipment/Package/Pac Description of the package

No
Description kageWeight/UnitOfMeasurement/Description weight measurement units. N/A

Only {Average}package
weight is required for

string
Yes*

1...5
One
/ShipConfirmRequest/Shipment/Package/Pac Packages weight. Set to 1.0 Ground Freight Pricing
Weight kageWeight/Weight for package type letter. Shipment

0 Presence of the indicator

string
One

/ShipConfirmRequest/Shipment/Package/Larg mentions that the package is

No

LargePackageIndicator ePackageIndicator Large Package. Empty Tag.

container
One

N/A

/ShipConfirmRequest/Shipment/Package/Ref Package reference number

No

ReferenceNumber erenceNumber information container N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 183
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

0
Empty Tag. Allowed for
shipment with return
service only. Only one
shipment-level or
package-level reference
number can be bar coded
per shipment. In order to
barcode a reference
number, its value must be
no longer than 14
If the indicator is present alphanumeric characters
then the reference numbers or 24 numeric characters

string
One
/ShipConfirmRequest/Shipment/Package/Ref value will be bar coded on and cannot contain

No
BarCodeIndicator erenceNumber/BarCodeIndicator the label. spaces.

2
Reference number type
code, for the entire
shipment. The code
specifies the Reference Valid if the
name. Refer to the origin/destination pair is

string
/ShipConfirmRequest/Shipment/Package/Ref One Reference Number Code US/US or PR/PR.2
No

Code erenceNumber/Code table. character alpha-numeric.

Valid if the
origin/destination pair is
US/US or PR/PR.
Supports up to 2
customer supplied
combinations of
1...35
string
Yes*
One

/ShipConfirmRequest/Shipment/Package/Ref Customer supplied reference Reference code- value

Value erenceNumber/Value number. combinations.
0

Additional Handling
Required.The presence
indicates additional handling
is required, the absence
string
One

/ShipConfirmRequest/Shipment/Package/Addi indicates no additional

No

AdditionalHandlingIndicator tionalHandlingIndicator handling is required. Empty Tag.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 184
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

container
One

N/A
/ShipConfirmRequest/Shipment/Package/Pac PackageServiceOtioncontain

No
PackageServiceOptions kageServiceOptions er N/A

container
For a list of valid
origin/destination countries

One

N/A
/ShipConfirmRequest/Shipment/Package/Pac please refer to the table in

No
DeliveryConfirmation kageServiceOptions/DeliveryConfirmation Appendix N Forwards Only

1
Valid values are: 1 -
Delivery Confirmation 2
- Delivery Confirmation
Signature Required 3 -
/ShipConfirmRequest/Shipment/Package/Pac Delivery Confirmation

string
Yes*
One
kageServiceOptions/DeliveryConfirmation/DCI Adult Signature Required.
DCISType SType Type of delivery confirmation Forwards Only

Delivery Confirmation
/ShipConfirmRequest/Shipment/Package/Pac 1...11 Control number associated
string
One

kageServiceOptions/DeliveryConfirmation/DCI with the delivery

No

DCISNumber SNumber confirmation for the package Forwards Only

container
One

N/A

/ShipConfirmRequest/Shipment/Package/Pac
No

DeclaredValue kageServiceOptions/DeclaredValue Container for DeclaredValue N/A

container
One

N/A

/ShipConfirmRequest/Shipment/Package/Pac Container for Declared

No

Type kageServiceOptions/DeclaredValue/Type Value Type N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 185
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The user cannot specify

2
different type of declared
value for the shipment.
You can either have
shipper declared value
(DVS) or declared value
(EVS) but not both at
package level. Note: The
Declared value type. Valid Shipper Declared Value is
value are 01=EVS, 02=DVS. applicable for forward
/ShipConfirmRequest/Shipment/Package/Pac Defaults to 01 i.e. EVS if shipments when the

string
*Yes
One
kageServiceOptions/DeclaredValue/Type/Cod declared value type is not billing option is freight
Code e provided. collect or third party

/ShipConfirmRequest/Shipment/Package/Pac

1...35
string
One
kageServiceOptions/DeclaredValue/Type/Des

No
Description cription Declared value Description N/A

3
Declared value amount
/ShipConfirmRequest/Shipment/Package/Pac currency type. Defaults to Code must represent a
string
Yes*
One

kageServiceOptions/DeclaredValue/Currency the non-Euro currency used currency that is a valid for

CurrencyCode Code in the shipper's country. Shipper country.

/ShipConfirmRequest/Shipment/Package/Pac
1...19
string
Yes*
One

kageServiceOptions/DeclaredValue/Monetary
MonetaryValue Value Declared value amount.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 186
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Indicates COD is
requested. Package level
COD is available for
shipment without return
service from US/PR to
US/PR, CA to CA, and
CA to US.CA to US COD

container
is not allowed for package
Letter/ Envelope. COD is

One

N/A
/ShipConfirmRequest/Shipment/Package/Pac not valid for return service

No
COD kageServiceOptions/COD COD container movements.

1
Values are: 0 = check,
cashiers check or money
order - no cash allowed, 8 =

string
Yes*
One
/ShipConfirmRequest/Shipment/Package/Pac cashiers check or money
CODFundsCode kageServiceOptions/COD/CODFundsCode order - no cash allowed. N/A

container
Yes*
One

/ShipConfirmRequest/Shipment/Package/Pac N/A
CODAmount kageServiceOptions/COD/CODAmount CODAmount container N/A
3

/ShipConfirmRequest/Shipment/Package/Pac
string
One
Yes

kageServiceOptions/COD/CODAmount/Curre COD amount currency code

CurrencyCode ncyCode type. N/A
5

/ShipConfirmRequest/Shipment/Package/Pac
string
One
Yes

kageServiceOptions/COD/CODAmount/Monet Valid values: 0.01 USD -

MonetaryValue aryValue COD Amount. 50000.00 USD

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 187
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
One

N/A
/ShipConfirmRequest/Shipment/Package/Pac Allowed for shipment

No
VerbalConfirmation kageServiceOptions/VerbalConfirmation Verbal Confirmation Info. without return service.
Optional if the Shipper's
AttentionName,
PhoneNumber, and
PhoneExtension(optional)
are given and are the

Container
desired name, phone
/ShipConfirmRequest/Shipment/Package/Pac number and extension,

Cond
One

N/A
kageServiceOptions/VerbalConfirmation/Cont respectively, to be used for
ContactInfo actInfo verbal confirmation. N/A
Optional if Shipper/
AttentionName is given
Name of the person to be and that is the name of
/ShipConfirmRequest/Shipment/Package/Pac contacted for confirmation. the person to be

1...35
string
Cond
One
kageServiceOptions/VerbalConfirmation/Cont Defaults to Shipper contacted else required
Name actInfo/Name AttentionName if given. for verbal confirmation.

/ShipConfirmRequest/Shipment/Package/Pac Container
One

kageServiceOptions/VerbalConfirmation/Cont N/A
No

Phone actInfo/Phone Phone Container N/A

String

/ShipConfirmRequest/Shipment/Package/Pac
1...15
Yes*
One

kageServiceOptions/VerbalConfirmation/Cont
Number actInfo/Phone/Number Contact Phone Number N/A
String

/ShipConfirmRequest/Shipment/Package/Pac
1...4
One

kageServiceOptions/VerbalConfirmation/Cont
No

Extension actInfo/Phone/Extension Contact Phone Extension N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 188
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

0
The presence indicates that
the package may be Empty Tag. Only

String
released by driver without a available for US50/PR to

One
/ShipConfirmRequest/Shipment/Package/Pac signature from the US50/PR packages

No
ShipperReleaseIndicator kageServiceOptions/ShipperReleaseIndicator consignee without return service.

Container
One

N/A
/ShipConfirmRequest/Shipment/Package/Pac Applicable for Shipment

No
Notification kageServiceOptions/Notification Receiver Return Notification with returne service.

1
String
/ShipConfirmRequest/Shipment/Package/Pac
Yes*
One
kageServiceOptions/Notification/NotificationC 3 - Receiver Return
NotificationCode ode Notification Code Notification

Container
Yes*
One

N/A
/ShipConfirmRequest/Shipment/Package/Pac Container for the e-mail
EMail kageServiceOptions/Notification/EMail Message. N/A
String

/ShipConfirmRequest/Shipment/Package/Pac The destination email

1...50
Yes*
One

kageServiceOptions/Notification/EMail/EMailA address of the receiver

EMailAddress ddress returns notification email. N/A

The e-mail address where

an undeliverable email Defaults to
String

/ShipConfirmRequest/Shipment/Package/Pac message is sent if the FromEMailAddress. Only

1...50
One

kageServiceOptions/Notification/EMail/Undeli Receiver Return Notification allowed at the first

No

UndeliverableEMailAddress verableEMailAddress email is undeliverable. package.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 189
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The email address listed in
the Reply To field of the
message header, includes
name and e-mail address of

String
/ShipConfirmRequest/Shipment/Package/Pac

1...50
sender. The From field of

One
kageServiceOptions/Notification/EMail/FromE the message header Only allowed at the first

No
FromEMailAddress MailAddress contains [email protected]. package.

String
/ShipConfirmRequest/Shipment/Package/Pac The name the receiver Defaults to the Shipper

1...35
One
kageServiceOptions/Notification/EMail/FromN return notification will appear Name. Only allowed at

No
FromName ame to be from. the first package.

1...150
String
One
/ShipConfirmRequest/Shipment/Package/Pac User defined text that will be Only allowed at the first

No
Memo kageServiceOptions/Notification/EMail/Memo included in the email. package.

String The eMail's subject. Defaults

/ShipConfirmRequest/Shipment/Package/Pac
1...75
to the UPS Receiver Return
One

kageServiceOptions/Notification/EMail/Subjec Notification plus the Only allowed at the first

No

Subject t shipment ID. package

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 190
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

2
If the subject code tag is
not provided and the
subject text is provided,
the subject of the
notification will be the
subject text. If the subject
Specifies a reference code text is provided, and
and reference number to subject code tag exists,
display in the subject of the then the subject code
Receiver Return Notification. value must be 08;If the
When the subject code is subject code is 08, the
provided, the subject will subject text must exist. If
contain the following: UPS a subject code is provided
Receiver Return Notification. that refers to a
The reference code (the nonexistent reference
reference code will be number, the subject will

String
/ShipConfirmRequest/Shipment/Package/Pac mapped to the default to the tracking

One
kageServiceOptions/Notification/EMail/Subjec corresponding ANSI value) number. Only allowed at

No
SubjectCode tCode Plus the reference number. the first package.
Returns Flexible Access

0
Indicator presence at
package level is required for
UPS Returns Flexible
Access Shipments. All
packages in the shipment
String
/ShipConfirmRequest/Shipment/Package/Pac must have the Returns
One

kageServiceOptions/ReturnsFlexibleAccessIn Flexible Access Indicator if

No

ReturnsFlexibleAccessIndicator dicator one package has it.

1
Container

Cannot be used when the

N/A

/ShipConfirmRequest/Shipment/Package/Pac package also contains

No

X
DryIce kageServiceOptions/DryIce Hazmat
Regulation set for dryIce
1

Shipment. Valid values are :

CFR = HazMat regulated by
US Dept of Transportation
within the U.S. or ground
String

shipments to Canada,
Yes

3..4

/ShipConfirmRequest/Shipment/Package/Pac IATA= Worldwide Air The following values are

X
RegulationSet kageServiceOptions/DryIce/RegulationSet movement valid: IATA,CFR

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 191
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1
Container
Yes

N/A
/ShipConfirmRequest/Shipment/Package/Pac

X
DryIceWeight kageServiceOptions/DryIce/DryIceWeight

1
Container
/ShipConfirmRequest/Shipment/Package/Pac

Yes

N/A
kageServiceOptions/DryIce/DryIceWeight/Unit

X
UnitOfMeasurement OfMeasurement

1
DryIce weight unit of
measurement code. Valid
values are: 00 = KG(Metric
Unit of Measurements), 01 =

String
/ShipConfirmRequest/Shipment/Package/Pac Yes LB(English Unit of The following values are

2..3
kageServiceOptions/DryIce/DryIceWeight/Unit Measurements), KG, LB, valid : 00 , 01, KG , KGS ,

X
Code OfMeasurement/Code 1 KGS, LBS LBS
String

/ShipConfirmRequest/Shipment/Package/Pac
0..20

kageServiceOptions/DryIce/DryIceWeight/Unit Short description for

No

X
Description OfMeasurement/Description UnitOfMeasurement
Cannot be more than
1

package weight. Should

be more than 0.0. Valid
characters are 0-9 and
.(Decimal point). Limit to
1 digit after the decimal.
The maximum length of
String

/ShipConfirmRequest/Shipment/Package/Pac the field is 5 including .

1…5
Yes

kageServiceOptions/DryIce/DryIceWeight/Wei and can hold up to 1

X
Weight ght Weight decimal place.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 192
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

0
Presence/Absence Indicator.
Any value inside is ignored.
Relevant only in CFR
regulation set. If present it is
used to designate the dry Ice
is for any medical use and

String
/ShipConfirmRequest/Shipment/Package/Pac rates are adjusted for dryIce
kageServiceOptions/DryIce/MedicalUseIndica weight more than 2.5 Kgs or

No

X
MedicalUseIndicator tor 5.7 LBs

Container
It is required if the
Cond
One

N/A
/ShipConfirmRequest/Shipment/Package/Co Container to hold the FRSShipment indicator is
Commodity mmodity Commodity information present in the request.

10
Freight Classification.
String

Freight class partially Required for Ground

One
Yes

/ShipConfirmRequest/Shipment/Package/Co determines the freight rate Freight Pricing

FreightClass mmodity/FreightClass for the article. Shipments only
Container
One

N/A

/ShipConfirmRequest/Shipment/Package/Co Container to hold the NMFC

No

NMFC mmodity/NMFC codes

String
One
Yes

4..6

/ShipConfirmRequest/Shipment/Package/Co Specifies the Commodity's Required if NMFC

PrimeCode mmodity/NMFC/PrimeCode NMFC prime code Container is Present

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 193
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

2
String
One
/ShipConfirmRequest/Shipment/Package/Co Specifies the Commodity's

No
SubCode mmodity/NMFC/SubCode NMFC sub code

Container
Container used to define the Required for shipment
properties required by the without return service, or

Cond
One

N/A
user to print and/or display shipment with PRL return
LabelSpecification /ShipConfirmRequest/LabelSpecification the UPS shipping label. service.

Container
One
Yes

N/A
/ShipConfirmRequest/LabelSpecification/Labe LabelImageFormat
LabelImageFormat lImageFormat Container N/A
Label print method code that

3
the Labels are to be
generated for EPL2 For shipments without
formatted Labels use EPL, return service the valid
for SPL formatted Labels value is GIF, ZPL, EPL
use SPL, for ZPL formatted and SPL. For shipments
Labels use ZPL and for with PRL return service,
String

image formats use GIF, for the valid values are EPL,
One
Yes

/ShipConfirmRequest/LabelSpecification/Labe Star Printer format formatted ZPL, SPL, STARPL and

Code lImageFormat/Code Labels use STARPL. GIF.
String
1...35
One

/ShipConfirmRequest/LabelSpecification/Labe Description of the label

No

Description lImageFormat/Description image format code. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 194
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Required if
/ShipConfirmRequest/Lab
elSpecificationLabelSpeci
fication/LabelImageForma
Browser HTTPUserAgent t/Code = Gif. Default to

String
String. This is the preferred Mozilla/4.5 if this field is

1...64
Cond
One
/ShipConfirmRequest/LabelSpecification/HTT way of identifying GIF image missing or has invalid
HTTPUserAgent PUserAgent type to be generated value.

Container
One
Yes

N/A
/ShipConfirmRequest/LabelSpecification/Labe Container for the EPL2, ZPL, For EPL2, ZPL, STARPL

X
LabelStockSize lStockSize STARPL or SPL label size and SPL Labels.

For EPL2, ZPL, STARPL

and SPL Labels. Only
valid values are 6 or 8.
Note: Label Image will
String

only scale up to 4 X 6,
1...3
One
Yes

/ShipConfirmRequest/LabelSpecification/Labe Height of the label image. even when requesting 4 X

X
Height lStockSize/Height For IN, use whole inches. 8.

For EPL2, ZPL, STARPL

and SPL Labels. Valid
value is 4. Note: Label
String

Image will only scale up

1...3
One
Yes

/ShipConfirmRequest/LabelSpecification/Labe Width of the label image. For to 4 X 6, even when

X
Width lStockSize/Width IN, use whole inches. requesting 4 X 8.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 195
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

unbounded
Container
/ShipConfirmRequest/LabelSpecification/Instr Routing Instruction

No
Instruction uction Container

1
String
Yes
/ShipConfirmRequest/LabelSpecification/Instr For Exchange Forward
Code uction/Code Shipment

1
String
/ShipConfirmRequest/LabelSpecification/Instr Description of the label

No
Description uction/Description Instruction code.

1
Container
Container used to allow the
user a to choose to print a
No

ReceiptSpecification /ShipConfirmRequest/ReceiptSpecification thermal receipt.

1
Container
Yes

/ShipConfirmRequest/ReceiptSpecification/Im
ImageFormat ageFormat ImageFormat Container
1
String
Yes

/ShipConfirmRequest/ReceiptSpecification/Im Print code that determines

Code ageFormat/Code the receipt format.
1
String

/ShipConfirmRequest/ReceiptSpecification/Im Description of the receipt

No

Description ageFormat/Description format code.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 196
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

container
One
Yes

N/A
ShipAcceptRequest /ShipAcceptRequest Request Container N/A

container
One
Yes

N/A
Request /ShipAcceptRequest/Request Request Container N/A
Optional Processing.
'nonvalidate' = No address
validation. 'validate' = Fail
on failed address validation.
Defaults to validate. Note:
Full address validation is not
performed. Therefore, it is
the responsibility of the
Shipping Tool User to
ensure the address entered

1...15
string
One
Yes
is correct to avoid an Values blank, validate, or
RequestOption /ShipAcceptRequest/Request/RequestOption address correction fee. nonvalidate.
Container

TransactionReference
One

N/A

/ShipAcceptRequest/Request/TransactionRef identifies transactions

No

TransactionReference erence between client and server. N/A

The client uses
CustomerContext to
synchronize
request/response pairs. The
client establishes
CustomerContext, which can
contain any information you
1...512

want, as along as it is valid

string
One

/ShipAcceptRequest/Request/TransactionRef XML; it is echoed back by

No

CustomerContext erence/CustomerContext the server. N/A

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 197
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

unbounded
String
Encoded shipment

One
Yes
parameters required to be
ShipmentDigest /ShipAcceptRequest/ShipmentDigest passed in the accept phase. Base 64 Encoded

container
One
Yes

N/A
Shipment Response
ShipmentResponse /ShipmentResponse Container

container
One
Yes

N/A
Response /ShipmentResponse/Response Response Container.

container
One
Yes

N/A
/ShipmentResponse/Response/ResponseStat
ResponseStatus us Response Status Container.

Identifies the success or

string
One
Yes

/ShipmentResponse/Response/ResponseStat failure of the transaction. 1 =

Code us/Code Successful

Describes Response Status

1...35
string
One
Yes

/ShipmentResponse/Response/ResponseStat Code. Returns text of

Description us/Description Success.
container

Alert Container. There can

be zero to many alert
One

N/A

containers with code and

No

Alert /ShipmentResponse/Response/Alert description.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 198
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1...10
string
Yes*
One
Warning code returned by
Code /ShipmentResponse/Response/Alert/Code the system.

1...150
string
Yes*
One
/ShipmentResponse/Response/Alert/Descripti Warning messages returned
Description on by the system.

container
One

N/A
/ShipmentResponse/Response/TransactionR Transaction Reference

No
TransactionReference eference Container.

1...512
The CustomerContext

string
/ShipmentResponse/Response/TransactionR One Information which will be
No

CustomerContext eference/CustomerContext container echoed during response.

Refer to the
ShipmentResults container
One
Yes

N/A

table for the elements under

ShipmentResults /ShipmentResponse/ShipmentResults ShipmentResults container.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 199
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Shipment charges
Container. Shipment
charges info. Shipment

container
charges are only guaranteed
to be returned for shipments

Cond
One

N/A
/ShipmentResponse/ShipmentResults/Shipme whose origin country is US
ShipmentCharges ntCharges or Puerto Rico.

1
String
/ShipmentResponse/ShipmentResults/Shipme

No
RateChart ntCharges/RateChart

container
One
Yes

N/A
/ShipmentResponse/ShipmentResults/Shipme Transport Charges
TransportationCharges ntCharges/TransportationCharges container.

3
Transportation charges
currency code type. The
/ShipmentResponse/ShipmentResults/Shipme currency code used in the
string
One
Yes

ntCharges/TransportationCharges/CurrencyC Shipment request is

CurrencyCode ode returned.

Transportation and
/ShipmentResponse/ShipmentResults/Shipme
1...19

surcharges value amount.

string
One
Yes

ntCharges/TransportationCharges/MonetaryV Valid values are from 0 to

MonetaryValue alue 99999999999999.99

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 200
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

container
One
Yes

N/A
/ShipmentResponse/ShipmentResults/Shipme Service Option Charges
ServiceOptionsCharges ntCharges/ServiceOptionsCharges container.

3
Accessorial charges
currency code type. The
/ShipmentResponse/ShipmentResults/Shipme currency code used in the

string
One
Yes
ntCharges/ServiceOptionsCharges/CurrencyC Shipment request is
CurrencyCode ode returned.

Accessorial charges value

/ShipmentResponse/ShipmentResults/Shipme amount. Valid values are

1...19
string
One
Yes
ntCharges/ServiceOptionsCharges/Monetary from 0 to
MonetaryValue Value 99999999999999.99

container
One
Yes

N/A
/ShipmentResponse/ShipmentResults/Shipme
TotalCharges ntCharges/TotalCharges Total charges container.
3

Total charges currency code

type. The currency code
string
One
Yes

/ShipmentResponse/ShipmentResults/Shipme used in the Shipment

CurrencyCode ntCharges/TotalCharges/CurrencyCode request is returned.

Total charges value amount.

1...19
string
One
Yes

/ShipmentResponse/ShipmentResults/Shipme Valid values are from 0 to

MonetaryValue ntCharges/TotalCharges/MonetaryValue 99999999999999.99

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 201
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

container
One

N/A
/ShipmentResponse/ShipmentResults/Negoti Negotiated Rates Charge

No
NegotiatedRateCharges atedRateCharges Container.
Total charges container.
Account Based Rates info.
Total charges are only
returned for ABR eligible
shipper account/UserId

container
combinations when the user
includes the

One

N/A
/ShipmentResponse/ShipmentResults/Negoti NegotiatedRatesIndicator in

No
TotalCharge atedRateCharges/TotalCharge the request.

3
string
One
Yes
/ShipmentResponse/ShipmentResults/Negoti Total charges currency
CurrencyCode atedRateCharges/TotalCharge/CurrencyCode code.

/ShipmentResponse/ShipmentResults/Negoti Total charges monetary

string
1..19
One
Yes

atedRateCharges/TotalCharge/MonetaryValu value. Valid values are from

MonetaryValue e 0 to 9999999999999999.99

Ground Freight Pricing

Shipment data container.
Ground Freight Pricing
Container

shipment data is only

guaranteed to be returned
Cond
One

N/A

/ShipmentResponse/ShipmentResults/FRSSh for Ground Freight Pricing

FRSShipmentData ipmentData shipments only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 202
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Transportation charges
container. Ground Freight
Pricing transportation
charges. These are only
returned for Ground Freight
Pricing enabled shipper

Container
account number when the
user includes the

Cond
One

N/A
/ShipmentResponse/ShipmentResults/FRSSh FRSShipmentIndicator in the
TransportationCharges ipmentData/TransportationCharges request.

Container
Gross Charges container. It
/ShipmentResponse/ShipmentResults/FRSSh indicates the shipment level

One
Yes

N/A
ipmentData/TransportationCharges/GrossCha gross Ground Freight Pricing
GrossCharge rge transportation charges.

3
String
/ShipmentResponse/ShipmentResults/FRSSh
One
Yes

ipmentData/TransportationCharges/GrossCha Gross charges currency

CurrencyCode rge/CurrencyCode code
String

/ShipmentResponse/ShipmentResults/FRSSh Gross charges monetary

1..19
One
Yes

ipmentData/TransportationCharges/GrossCha value. Valid values are from

MonetaryValue rge/MonetaryValue 0 to 9999999999999999.99

Discount Amount container.

Container

It indicates the shipment

/ShipmentResponse/ShipmentResults/FRSSh level Ground Freight Pricing
One
Yes

N/A

ipmentData/TransportationCharges/DiscountA discount amount for

DiscountAmount mount transportation charges.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 203
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

3
String
/ShipmentResponse/ShipmentResults/FRSSh

One
Yes
ipmentData/TransportationCharges/DiscountA Discount Amount currency
CurrencyCode mount/CurrencyCode code.

String
/ShipmentResponse/ShipmentResults/FRSSh Discount amount monetary

1..19
One
Yes
ipmentData/TransportationCharges/DiscountA value. Valid values are from
MonetaryValue mount/MonetaryValue 0 to 9999999999999999.99

String
/ShipmentResponse/ShipmentResults/FRSSh It indicates the shipment

One
Yes

1..5
ipmentData/TransportationCharges/DiscountP level discount percentage for
DiscountPercentage ercentage transportation charges.

Container Net Charges container. It

/ShipmentResponse/ShipmentResults/FRSSh indicates the shipment level
One
Yes

ipmentData/TransportationCharges/NetCharg N/A net Ground Freight Pricing

NetCharge e transportation charges.
String

/ShipmentResponse/ShipmentResults/FRSSh
One
Yes

N/A

ipmentData/TransportationCharges/NetCharg
CurrencyCode e/CurrencyCode Net Charge currency code.
String

/ShipmentResponse/ShipmentResults/FRSSh Net charges monetary value.

1..19
One
Yes

ipmentData/TransportationCharges/NetCharg Valid values are from 0 to

MonetaryValue e/MonetaryValue 9999999999999999.99

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 204
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

container
One
Yes

N/A
/ShipmentResponse/ShipmentResults/Billing
BillingWeight Weight Billing Weight container.

Billing weight unit of

container
measurement code. The
unit of measurement used in

One
Yes

N/A
/ShipmentResponse/ShipmentResults/Billing Shipment request is
UnitOfMeasurement Weight/UnitOfMeasurement returned.

3
Code of the billing weight

string
One
Yes
/ShipmentResponse/ShipmentResults/Billing measurement units. Values
Code Weight/UnitOfMeasurement/Code are: KGS or LBS.

1...35
string
One

/ShipmentResponse/ShipmentResults/Billing Description of the billing

No

Description Weight/UnitOfMeasurement/Description 8 weight measurement units.

Billing weight. Higher of the

actual shipment weight
string
One
Yes

/ShipmentResponse/ShipmentResults/Billing versus the shipment

Weight Weight/Weight dimensional weight.
18

Returned UPS shipment ID

number.1Z Number of the
string
One
Yes

/ShipmentResponse/ShipmentResults/Shipme first package in the

ShipmentIdentificationNumber ntIdentificationNumber shipment.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 205
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

unbounded
Encoded shipment
parameters required to be
passed in the accept phase.

string
Cond
One
/ShipmentResponse/ShipmentResults/Shipme Applicable only for
ShipmentDigest ntDigest ShipConfirmResponse.

##
container
Returned Package
Information. Applicable only

N/A
/ShipmentResponse/ShipmentResults/Packag for ShipmentResponse and

No
PackageResults eResults ShipAcceptResponse.

18
Package 1Z number.
Applicable only for

string
One
Yes

/ShipmentResponse/ShipmentResults/Packag ShipmentResponse and

TrackingNumber eResults/TrackingNumber ShipAcceptResponse.
Shipment charges info.
Shipment charges are only
guaranteed to be returned
for shipments whose origin
Container

country is US or Puerto
Rico. Applicable only for
Cond
One

N/A

/ShipmentResponse/ShipmentResults/Packag ShipmentResponse and

ServiceOptionsCharges eResults/ServiceOptionsCharges ShipAcceptResponse.
Package accessorial
3

charges currency code type.

The currency code used in
the Shipment request is
/ShipmentResponse/ShipmentResults/Packag returned. Applicable only for
string
One
Yes

eResults/ServiceOptionsCharges/CurrencyCo ShipmentResponse and

CurrencyCode de ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 206
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Package accessorial
charges value amount. Valid
values are from 0 to
99999999999999.99Applica
/ShipmentResponse/ShipmentResults/Packag ble only for

1...19
string
One
Yes
eResults/ServiceOptionsCharges/MonetaryVa ShipmentResponse and
MonetaryValue lue ShipAcceptResponse.
The container for UPS
shipping label. Shipment
without return service, or

container
with PRL return service.
Applicable only for

Cond
One

N/A
/ShipmentResponse/ShipmentResults/Packag ShipmentResponse and
ShippingLabel eResults/ShippingLabel ShipAcceptResponse.

container
The container image format.
Applicable only for

One
Yes

N/A
/ShipmentResponse/ShipmentResults/Packag ShipmentResponse and
ImageFormat eResults/ShippingLabel/ImageFormat ShipAcceptResponse.
Label image code that the

3
labels are generated. Values
EPL = EPL2, SPL = SPL,
ZPL = ZPL, GIF = gif
images, or PNG for PNG
images. Only EPL, SPL, ZPL
and GIF are currently
supported. Applicable only
string
One
Yes

/ShipmentResponse/ShipmentResults/Packag for ShipmentResponse and

Code eResults/ShippingLabel/ImageFormat/Code ShipAcceptResponse.
Description of the label
image format code.
/ShipmentResponse/ShipmentResults/Packag Applicable only for
1...35
string
One

eResults/ShippingLabel/ImageFormat/Descrip ShipmentResponse and

No

Description tion ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 207
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Base 64 Encoded
unbounded
Base 64 encoded graphic
image. Applicable only for

One
Yes
/ShipmentResponse/ShipmentResults/Packag ShipmentResponse and
GraphicImage eResults/ShippingLabel/GraphicImage ShipAcceptResponse.
Base 64 encoded graphic
image of the Warsaw text
and signature box.EPL2,
ZPL and SPL labels. The
image will be returned for

Base 64 Encoded
non-US based shipments.
One image will be given per

unbounded
shipment and it will be in the
first PackageResults
/ShipmentResponse/ShipmentResults/Packag container. Applicable only for

Cond
One
InternationalSignatureGraphicIma eResults/ShippingLabel/InternationalSignatur ShipmentResponse and
ge eGraphicImage ShipAcceptResponse.

Base 64 Encoded
Base 64 encoded html
browser image rendering

unbounded
software. This is only
returned for gif and png
image formats. Applicable
Cond
One

/ShipmentResponse/ShipmentResults/Packag only for ShipmentResponse

HTMLImage eResults/ShippingLabel/HTMLImage and ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 208
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
PDF-417 is a two-
dimensional barcode, which
can store up to about 1,800
printable ASCII characters or
1,100 binary characters per
symbol. The symbol is
rectangular. The image is
Base 64 encoded and

Base 64 Encoded
returned if the
LabelImageFormat code is

unbounded
GIF. Shipment with PRL
return service only.
Applicable only for

Cond
One
/ShipmentResponse/ShipmentResults/Packag ShipmentResponse and
PDF417 eResults/ShippingLabel/PDF417 ShipAcceptResponse.

Container for the receipt of a

return shipment. Not

container
supported for ERL or PRL
Cond shipments. Applicable only

One

N/A
/ShipmentResponse/ShipmentResults/Packag for ShipmentResponse and
ShippingReceipt eResults/ShippingReceipt ShipAcceptResponse.
container

Container for a Image

Format. Applicable only for
One
Yes

N/A

/ShipmentResponse/ShipmentResults/Packag ShipmentResponse and

ImageFormat eResults/ShippingReceipt/ImageFormat ShipAcceptResponse.
4

Code representing the

format in which a receipt.
Valid values: HTML = HTML
format. Applicable only for
string
One
Yes

/ShipmentResponse/ShipmentResults/Packag ShipmentResponse and

Code eResults/ShippingReceipt/ImageFormat/Code ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 209
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Description of the image

/ShipmentResponse/ShipmentResults/Packag format code. Applicable only

1...35
string
One
eResults/ShippingReceipt/ImageFormat/Desc for ShipmentResponse and

No
Description ription ShipAcceptResponse.

Base 64 Encoded
unbounded
Base 64 encoded PRL
receipt in HTML format.
Applicable only for

One
Yes
/ShipmentResponse/ShipmentResults/Packag ShipmentResponse and
GraphicImage eResults/ShippingReceipt/GraphicImage ShipAcceptResponse.

unbounded
USPSPICNumber is USPS
Package Identification code
which is returned at package
string
Cond
One

/ShipmentResponse/ShipmentResults/Packag level for UPS Returns

USPSPICNumber eResults/USPSPICNumber Flexible Access Shipments.
Container for the High Value
reports When forward
shipments declared value
between $999 and $50,000
USD. Two copies of high
container

value report needs to be

pointed out. Applicable only
Cond
One

N/A

/ShipmentResponse/ShipmentResults/Control for ShipmentResponse and

ControlLogReceipt LogReceipt ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 210
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container for the High Value

container
report format, required if
parent exist. Applicable only

One
Yes

N/A
/ShipmentResponse/ShipmentResults/Control for ShipmentResponse and
ImageFormat LogReceipt/ImageFormat ShipAcceptResponse.

4
Code for the type of Graphic
Image for the High Value
Report. Values are: =
EPL2 (when user requests
label in EPL2 format) SPL
= SPL (when user requests
label in SPL format) ZPL =
ZPL (when user requests
label in ZPL format) HTML=
HTML (when user requests
label in HTML format)
Applicable only for

string
One
Yes
/ShipmentResponse/ShipmentResults/Control ShipmentResponse and
Code LogReceipt/ImageFormat/Code ShipAcceptResponse.

Description of the format

code. Applicable only for
string
1..35
One

/ShipmentResponse/ShipmentResults/Control ShipmentResponse and

No

Description LogReceipt/ImageFormat/Description ShipAcceptResponse.

Base 64 Encoded
unbounded

Base 64 encoded html,

EPL2, ZPL or SPL image.
Applicable only for
One
Yes

/ShipmentResponse/ShipmentResults/Control ShipmentResponse and

GraphicImage LogReceipt/GraphicImage ShipAcceptResponse.
Container tag for the
container

International forms image.

Applicable only for
Cond
One

N/A

ShipmentResponse and
Form /ShipmentResponse/ShipmentResults/Form ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 211
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

2
Code that indicates the type
of form. Possible Values01 -
All Requested International
Forms. Applicable only for

string
One
Yes
/ShipmentResponse/ShipmentResults/Form/C ShipmentResponse and
Code ode ShipAcceptResponse.

Description that indicates the

type of form. Possible
Values. All Requested
International Forms.
Applicable only for

1...35
string
One
Yes
/ShipmentResponse/ShipmentResults/Form/D ShipmentResponse and
Description escription ShipAcceptResponse.

Container tag for the

container
International forms image.
Applicable only for
Cond
One

N/A
/ShipmentResponse/ShipmentResults/Form/I ShipmentResponse and
Image mage ShipAcceptResponse.
Container tag for the
International forms image
container

format information.
Applicable only for
Cond
One

N/A

/ShipmentResponse/ShipmentResults/Form/I ShipmentResponse and

ImageFormat mage/ImageFormat ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 212
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

3
Code representing the
format in which the forms
are generated. Possible
Values: PDF = pdfOnly.
PDF is supported currently.
Applicable only for

string
Cond
One
/ShipmentResponse/ShipmentResults/Form/I ShipmentResponse and
Code mage/ImageFormat/Code ShipAcceptResponse.

Description of the form

image format code.
Applicable only for

string
1..35
One
/ShipmentResponse/ShipmentResults/Form/I ShipmentResponse and
No
Description mage/ImageFormat/Description ShipAcceptResponse.

Base 64 Encoded
unbounded
Base 64 encoded
International forms image.
Applicable only for
Cond
One

/ShipmentResponse/ShipmentResults/Form/I ShipmentResponse and

GraphicImage mage/GraphicImage ShipAcceptResponse.

Unique Id for later retrieval

of saved version of the
completed international
forms. Always returned
when code = 0101
represents international
forms. Applicable only for
1...26
string
Cond
One

/ShipmentResponse/ShipmentResults/Form/F ShipmentResponse and

FormGroupId ormGroupId ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 213
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Contains description text

which identifies the group of
International forms. This
element is part of both
request and response. This
element does not appear on
the forms. Applicable only

1...50
string
One
/ShipmentResponse/ShipmentResults/Form/F for ShipmentResponse and

No
FormGroupIdName ormGroupIdName ShipAcceptResponse.

container
The container of the COD
Turn In Page. Applicable

One

N/A
/ShipmentResponse/ShipmentResults/CODTu only for ShipmentResponse
No
CODTurnInPage rnInPage and ShipAcceptResponse.

The container of the image

container

for COD Turn In Page.

Applicable only for
One
Yes

N/A

/ShipmentResponse/ShipmentResults/CODTu ShipmentResponse and

Image rnInPage/Image ShipAcceptResponse.

The container for format of

container

COD Turn In Page.

Applicable only for
One
Yes

N/A

/ShipmentResponse/ShipmentResults/CODTu ShipmentResponse and

ImageFormat rnInPage/Image/ImageFormat ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 214
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

4
Format code of the
generated COD Turn In
Page. Valid values: HTML =
HTML format. Only HTML
format is supported for COD

String
Turn In Page. Applicable

One
Yes
/ShipmentResponse/ShipmentResults/CODTu only for ShipmentResponse
Code rnInPage/Image/ImageFormat/Code and ShipAcceptResponse.

Description of the format

code of generated COD

String
Turn In page. Applicable

1...35
One
/ShipmentResponse/ShipmentResults/CODTu only for ShipmentResponse

No
Description rnInPage/Image/ImageFormat/Description and ShipAcceptResponse.

Base 64 Encoded
unbounded
Base 64 encoded html
browser image rendering
software. Applicable only for
One
Yes

/ShipmentResponse/ShipmentResults/CODTu ShipmentResponse and

GraphicImage rnInPage/Image/GraphicImage ShipAcceptResponse.

Container for the HighValue

Report generated for
ImportControl or Return
shipments with high package
Container

declared value. Applicable

for one pass
Cond
One

N/A

/ShipmentResponse/ShipmentResults/HighVa ShipmentResponse and two-

HighValueReport lueReport pass ShipAcceptResponse.
Container

Container for the HighValue

Yes*
One

N/A

/ShipmentResponse/ShipmentResults/HighVa Report image for Import

Image lueReport/Image Control Shipments.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 215
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Container
Container for the HighValue
Report image format

Yes*
One

N/A
/ShipmentResponse/ShipmentResults/HighVa information for Import
ImageFormat lueReport/Image/ImageFormat Control Shipments.

3
Code representing the
format in which the

String
HighValueReport is

Yes*
One
/ShipmentResponse/ShipmentResults/HighVa generated. Possible Values:
Code lueReport/Image/ImageFormat/Code PDF = 'pdf'

String
1...35
One
/ShipmentResponse/ShipmentResults/HighVa Description of the image

No
Description lueReport/Image/ImageFormat/Description format

unbounded
String
Yes*
One

/ShipmentResponse/ShipmentResults/HighVa Base 64 Encoded PDF

GraphicImage lueReport/Image/GraphicImage Image

LabelURL is returned only if

the LabelLinksIndicator is
requested for an
ImportControl shipment or
for a Return shipment. URL
unbounded

will point to a label and can

also point to
String

HighValueReport,
Cond
One

/ShipmentResponse/ShipmentResults/LabelU CustomsInvoice and

LabelURL RL ImportControl instructions.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 216
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
LocalLanguageLabelURL is
returned only if the
LabelLinksIndicator is
requested for an
ImportControl shipment or
for a Return shipment. URL
will point to a label and can
also point to

unbounded
HighValueReport,
CustomsInvoice and

String
ImportControl instructions in

Cond
One
/ShipmentResponse/ShipmentResults/LocalL the Country's local language
LocalLanguageLabelURL anguageLabelURL if supported by UPS.

unbounded
ReceiptURL is returned if the
LabelLinksIndicator is

String
requested for an

Cond
One
/ShipmentResponse/ShipmentResults/Receipt ImportControl shipment or a
ReceiptURL URL Return shipment.

LocalLanguageReceiptURL
is returned if the
LabelLinksIndicator is
requested for an
unbounded
ImportControl shipment or a
Return shipment. The URL
String

will contain the receipt in the

Cond
One

/ShipmentResponse/ShipmentResults/LocalL Country's local language if

LocalLanguageReceiptURL anguageReceiptURL supported by UPS.
container
One
Yes

N/A

Shipment Response
ShipConfirmResponse /ShipConfirmResponse Container
container
One
Yes

N/A

Response /ShipConfirmResponse/Response Response Container.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 217
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

container
One
Yes

N/A
/ShipConfirmResponse/Response/ResponseS
ResponseStatus tatus Response Status Container.

1
Identifies the success or

string
One
Yes
/ShipConfirmResponse/Response/ResponseS failure of the transaction. 1 =
Code tatus/Code Successful

Describes Response Status

1...35
string
One
Yes
/ShipConfirmResponse/Response/ResponseS Code. Returns text of
Description tatus/Description Success.

container
Alert Container. There can
be zero to many alert
One

N/A
containers with code and
No

Alert /ShipConfirmResponse/Response/Alert description.

1...10
string
Yes*
One

Warning code returned by

Code /ShipConfirmResponse/Response/Alert/Code the system.
1...150
string
Yes*
One

/ShipConfirmResponse/Response/Alert/Descri Warning messages returned

Description ption by the system.
container
One

N/A

/ShipConfirmResponse/Response/Transactio Transaction Reference

No

TransactionReference nReference Container.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 218
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1...512
The CustomerContext

string
One
/ShipConfirmResponse/Response/Transactio Information which will be

No
CustomerContext nReference/CustomerContext echoed during response.

container
Refer to the
ShipmentResults container

One
Yes

N/A
table for the elements under
ShipmentResults /ShipConfirmResponse/ShipmentResults ShipmentResults container.

Shipment charges
Container. Shipment
charges info. Shipment

container
charges are only guaranteed
to be returned for shipments
Cond
One

N/A
/ShipConfirmResponse/ShipmentResults/Ship whose origin country is US
ShipmentCharges mentCharges or Puerto Rico.
1
String

/ShipConfirmResponse/ShipmentResults/Ship
No

RateChart mentCharges/RateChart
container
One
Yes

N/A

/ShipConfirmResponse/ShipmentResults/Ship Transport Charges

TransportationCharges mentCharges/TransportationCharges container.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 219
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

3
Transportation charges
currency code type. The
/ShipConfirmResponse/ShipmentResults/Ship currency code used in the

string
One
Yes
mentCharges/TransportationCharges/Currenc Shipment request is
CurrencyCode yCode returned.

Transportation and
/ShipConfirmResponse/ShipmentResults/Ship surcharges value amount.

1...19
string
One
Yes
mentCharges/TransportationCharges/Monetar Valid values are from 0 to
MonetaryValue yValue 99999999999999.99

container
One
Yes

N/A
/ShipConfirmResponse/ShipmentResults/Ship Service Option Charges
ServiceOptionsCharges mentCharges/ServiceOptionsCharges container.

3
Accessorial charges
currency code type. The
/ShipConfirmResponse/ShipmentResults/Ship currency code used in the
string
One
Yes

mentCharges/ServiceOptionsCharges/Curren Shipment request is

CurrencyCode cyCode returned.

Accessorial charges value

/ShipConfirmResponse/ShipmentResults/Ship amount. Valid values are
1...19
string
One
Yes

mentCharges/ServiceOptionsCharges/Moneta from 0 to
MonetaryValue ryValue 99999999999999.99
container
One
Yes

N/A

/ShipConfirmResponse/ShipmentResults/Ship
TotalCharges mentCharges/TotalCharges Total charges container.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 220
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

3
Total charges currency code
type. The currency code

string
One
Yes
/ShipConfirmResponse/ShipmentResults/Ship used in the Shipment
CurrencyCode mentCharges/TotalCharges/CurrencyCode request is returned.

Total charges value amount.

1...19
string
One
Yes
/ShipConfirmResponse/ShipmentResults/Ship Valid values are from 0 to
MonetaryValue mentCharges/TotalCharges/MonetaryValue 99999999999999.99

container
One

N/A
/ShipConfirmResponse/ShipmentResults/Neg Negotiated Rates Charge

No
NegotiatedRateCharges otiatedRateCharges Container.

Total charges container.

Account Based Rates info.
Total charges are only
returned for ABR eligible
shipper account/UserId
container

combinations when the user

includes the
One

N/A

/ShipConfirmResponse/ShipmentResults/Neg NegotiatedRatesIndicator in
No

TotalCharge otiatedRateCharges/TotalCharge the request.

3

/ShipConfirmResponse/ShipmentResults/Neg
string
One
Yes

otiatedRateCharges/TotalCharge/CurrencyCo Total charges currency

CurrencyCode de code.

/ShipConfirmResponse/ShipmentResults/Neg Total charges monetary

string
1..19
One
Yes

otiatedRateCharges/TotalCharge/MonetaryVa value. Valid values are from

MonetaryValue lue 0 to 9999999999999999.99

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 221
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Ground Freight Pricing

Shipment data container.
Ground Freight Pricing

Container
shipment data is only
guaranteed to be returned

Cond
One

N/A
/ShipConfirmResponse/ShipmentResults/FRS for Ground Freight Pricing
FRSShipmentData ShipmentData shipments only.

Transportation charges
container. Ground Freight
Pricing transportation
charges. These are only
returned for Ground Freight
Pricing enabled shipper

Container
account number when the
user includes the
Cond
One

N/A
/ShipConfirmResponse/ShipmentResults/FRS FRSShipmentIndicator in the
TransportationCharges ShipmentData/TransportationCharges request.

Container

Gross Charges container. It

/ShipConfirmResponse/ShipmentResults/FRS indicates the shipment level
One
Yes

N/A

ShipmentData/TransportationCharges/GrossC gross FRS transportation

GrossCharge harge charges.
3
String

/ShipConfirmResponse/ShipmentResults/FRS
One
Yes

ShipmentData/TransportationCharges/GrossC Gross charges currency

CurrencyCode harge/CurrencyCode code
String

/ShipConfirmResponse/ShipmentResults/FRS Gross charges monetary

1..19
One
Yes

ShipmentData/TransportationCharges/GrossC value. Valid values are from

MonetaryValue harge/MonetaryValue 0 to 9999999999999999.99

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 222
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Discount Amount container.

Container
It indicates the shipment
/ShipConfirmResponse/ShipmentResults/FRS level Ground Freight Pricing

One
Yes

N/A
ShipmentData/TransportationCharges/Discou discount amount for
DiscountAmount ntAmount transportation charges.

3
String
/ShipConfirmResponse/ShipmentResults/FRS

One
Yes
ShipmentData/TransportationCharges/Discou Discount Amount currency
CurrencyCode ntAmount/CurrencyCode code.

String
/ShipConfirmResponse/ShipmentResults/FRS Discount amount monetary

1..19
One
Yes
ShipmentData/TransportationCharges/Discou value. Valid values are from
MonetaryValue ntAmount/MonetaryValue 0 to 9999999999999999.99

String
/ShipConfirmResponse/ShipmentResults/FRS It indicates the shipment

One
Yes

1..5
ShipmentData/TransportationCharges/Discou level discount percentage for
DiscountPercentage ntPercentage transportation charges.

Container

Net Charges container. It

/ShipConfirmResponse/ShipmentResults/FRS indicates the shipment level
One
Yes

N/A

ShipmentData/TransportationCharges/NetCha net Ground Freight Pricing

NetCharge rge transportation charges.
String

/ShipConfirmResponse/ShipmentResults/FRS
One
Yes

N/A

ShipmentData/TransportationCharges/NetCha
CurrencyCode rge/CurrencyCode Net Charge currency code.
String

/ShipConfirmResponse/ShipmentResults/FRS Net charges monetary value.

1..19
One
Yes

ShipmentData/TransportationCharges/NetCha Valid values are from 0 to

MonetaryValue rge/MonetaryValue 9999999999999999.99

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 223
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

container
One
Yes

N/A
/ShipConfirmResponse/ShipmentResults/Billin
BillingWeight gWeight Billing Weight container.

Billing weight unit of

container
measurement code. The
unit of measurement used in

One
Yes

N/A
/ShipConfirmResponse/ShipmentResults/Billin Shipment request is
UnitOfMeasurement gWeight/UnitOfMeasurement returned.

3
Code of the billing weight

string
One
Yes
/ShipConfirmResponse/ShipmentResults/Billin measurement units. Values
Code gWeight/UnitOfMeasurement/Code are: KGS or LBS.

1...35
string
One

/ShipConfirmResponse/ShipmentResults/Billin Description of the billing

No

Description gWeight/UnitOfMeasurement/Description 8 weight measurement units.

Billing weight. Higher of the

actual shipment weight
versus the shipment
dimensional weight. Set to 0
string
One
Yes

/ShipConfirmResponse/ShipmentResults/Billin for package type of letters or

Weight gWeight/Weight envelopes.
18

Returned UPS shipment ID

number. 1Z Number of the
string
One
Yes

/ShipConfirmResponse/ShipmentResults/Ship first package in the

ShipmentIdentificationNumber mentIdentificationNumber shipment.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 224
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

unbounded
Encoded shipment
parameters required to be
passed in the accept phase.

string
Cond
One
/ShipConfirmResponse/ShipmentResults/Ship Applicable only for
ShipmentDigest mentDigest ShipConfirmResponse.

##
container
Returned Package
Information. Applicable only

N/A
/ShipConfirmResponse/ShipmentResults/Pac for ShipConfirmResponse

No
PackageResults kageResults and ShipAcceptResponse.

18
Package 1Z number.
Applicable only for

string
One
Yes

/ShipConfirmResponse/ShipmentResults/Pac ShipConfirmResponse and

TrackingNumber kageResults/TrackingNumber ShipAcceptResponse.

Shipment charges info.

Shipment charges are only
guaranteed to be returned
for shipments whose origin
Container

country is US or Puerto
Rico. Applicable only for
Cond
One

N/A

/ShipConfirmResponse/ShipmentResults/Pac ShipConfirmResponse and

ServiceOptionsCharges kageResults/ServiceOptionsCharges ShipAcceptResponse.
Package accessorial
3

charges currency code type.

The currency code used in
the Shipment request is
/ShipConfirmResponse/ShipmentResults/Pac returned. Applicable only for
string
One
Yes

kageResults/ServiceOptionsCharges/Currenc ShipConfirmResponse and

CurrencyCode yCode ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 225
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Package accessorial
charges value amount. Valid
values are from 0 to
99999999999999.99Applica
/ShipConfirmResponse/ShipmentResults/Pac

1...19
ble only for

string
One
Yes
kageResults/ServiceOptionsCharges/Monetar ShipConfirmResponse and
MonetaryValue yValue ShipAcceptResponse.

The container for UPS

shipping label. Shipment
without return service, or

container
with PRL return service.
Applicable only for

Cond
One

N/A
/ShipConfirmResponse/ShipmentResults/Pac ShipConfirmResponse and
ShippingLabel kageResults/ShippingLabel ShipAcceptResponse.
The container image format.

contai
Applicable only for

One
Yes

N/A
ner
/ShipConfirmResponse/ShipmentResults/Pac ShipConfirmResponse and
ImageFormat kageResults/ShippingLabel/ImageFormat ShipAcceptResponse.
Label image code that the

3
labels are generated. Values
EPL = EPL2, SPL = SPL,
ZPL = ZPL, GIF = gif
images, or PNG for PNG
images. Only EPL, SPL, ZPL
and GIF are currently
/ShipConfirmResponse/ShipmentResults/Pac supported. Applicable only
string
One
Yes

kageResults/ShippingLabel/ImageFormat/Cod for ShipConfirmResponse

Code e and ShipAcceptResponse.

Description of the label

image format code.
/ShipConfirmResponse/ShipmentResults/Pac Applicable only for
1...35
string
One

kageResults/ShippingLabel/ImageFormat/Des ShipConfirmResponse and

No

Description cription ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 226
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Base 64 Encoded
unbounded
Base 64 encoded graphic
image. Applicable only for

One
Yes
/ShipConfirmResponse/ShipmentResults/Pac ShipConfirmResponse and
GraphicImage kageResults/ShippingLabel/GraphicImage ShipAcceptResponse.

Base 64 encoded graphic

image of the Warsaw text
and signature box. EPL2,
ZPL and SPL labels. The
image will be returned for

Base 64 Encoded
non-US based shipments.
One image will be given per

unbounded
shipment and it will be in the
first PackageResults
/ShipConfirmResponse/ShipmentResults/Pac container. Applicable only for
Cond
One
InternationalSignatureGraphicIma kageResults/ShippingLabel/InternationalSigna ShipConfirmResponse and
ge tureGraphicImage ShipAcceptResponse.

Base 64 encoded html

Base 64 Encoded

browser image rendering

software. This is only
unbounded

returned for gif and png

image formats. Applicable
only for
Cond
One

/ShipConfirmResponse/ShipmentResults/Pac ShipConfirmResponse and

HTMLImage kageResults/ShippingLabel/HTMLImage ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 227
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
PDF-417 is a two-
dimensional barcode, which
can store up to about 1,800
printable ASCII characters or
1,100 binary characters per
symbol. The symbol is
rectangular. The image is
Base 64 encoded and

Base 64 Encoded
returned if the
LabelImageFormat code is

unbounded
GIF. Shipment with PRL
return service only.
Applicable only for

Cond
One
/ShipConfirmResponse/ShipmentResults/Pac ShipConfirmResponse and
PDF417 kageResults/ShippingLabel/PDF417 ShipAcceptResponse.

Container for the receipt of a

return shipment. Not

container
supported for ERL or PRL
shipments. Applicable only
Cond
One

N/A
/ShipConfirmResponse/ShipmentResults/Pac for ShipConfirmResponse
ShippingReceipt kageResults/ShippingReceipt and ShipAcceptResponse.

container

Container for a Image

Format. Applicable only for
One
Yes

N/A

/ShipConfirmResponse/ShipmentResults/Pac ShipConfirmResponse and

ImageFormat kageResults/ShippingReceipt/ImageFormat ShipAcceptResponse.
4

Code representing the

format in which a receipt.
Valid values: HTML = HTML
/ShipConfirmResponse/ShipmentResults/Pac format. Applicable only for
string
One
Yes

kageResults/ShippingReceipt/ImageFormat/C ShipConfirmResponse and

Code ode ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 228
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Description of the image

/ShipConfirmResponse/ShipmentResults/Pac format code. Applicable only

1...35
string
One
kageResults/ShippingReceipt/ImageFormat/D for ShipConfirmResponse

No
Description escription and ShipAcceptResponse.

Base 64 Encoded
unbounded
Base 64 encoded PRL
receipt in HTML format.
Applicable only for

One
Yes
/ShipConfirmResponse/ShipmentResults/Pac ShipConfirmResponse and
GraphicImage kageResults/ShippingReceipt/GraphicImage ShipAcceptResponse.

1
String
/ShipConfirmResponse/ShipmentResults/Pac
No

USPSPICNumber kageResults/USPSPICNumber
Container for the High Value
reports When forward
shipments declared value
between $999 and $50,000
USD. Two copies of high
container

value report needs to be

pointed out. Applicable only
Cond
One

N/A

/ShipConfirmResponse/ShipmentResults/Cont for ShipConfirmResponse

ControlLogReceipt rolLogReceipt and ShipAcceptResponse.

Container for the High Value

container

report format, required if

parent exist Applicable only
One
Yes

N/A

/ShipConfirmResponse/ShipmentResults/Cont for ShipConfirmResponse

ImageFormat rolLogReceipt/ImageFormat and ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 229
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

4
Code for the type of Graphic
Image for the High Value
Report. Values are: EPL =
EPL2 (when user requests
label in EPL2 format) SPL
= SPL (when user requests
label in SPL format) ZPL =
ZPL (when user requests
label in ZPL format) HTML=
HTML (when user requests
label in HTML format)
Applicable only for

string
One
Yes
/ShipConfirmResponse/ShipmentResults/Cont ShipConfirmResponse and
Code rolLogReceipt/ImageFormat/Code ShipAcceptResponse.

Description of the format

code. Applicable only for

string
1..35
One
/ShipConfirmResponse/ShipmentResults/Cont ShipConfirmResponse and

No
Description rolLogReceipt/ImageFormat/Description ShipAcceptResponse.

Base 64 Encoded
unbounded
Base 64 encoded html,
EPL2, ZPL or SPL image.
Applicable only for
One
Yes

/ShipConfirmResponse/ShipmentResults/Cont ShipConfirmResponse and

GraphicImage rolLogReceipt/GraphicImage ShipAcceptResponse.

Container tag for the

container

International forms image.

Applicable only for
Cond
One

N/A

/ShipConfirmResponse/ShipmentResults/For ShipConfirmResponse and

Form m ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 230
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

2
Code that indicates the type
of form. Possible Values01 -
All Requested International
Forms. Applicable only for

string
One
Yes
/ShipConfirmResponse/ShipmentResults/For ShipConfirmResponse and
Code m/Code ShipAcceptResponse.

Description that indicates the

type of form. Possible
Values: All Requested
International Forms.
Applicable only for

1...35
string
One
Yes
/ShipConfirmResponse/ShipmentResults/For ShipConfirmResponse and
Description m/Description ShipAcceptResponse.

Container tag for the

container
International forms image.
Applicable only for

Cond
One

N/A
/ShipConfirmResponse/ShipmentResults/For ShipConfirmResponse and
Image m/Image ShipAcceptResponse.

Container tag for the

container International forms image
format information.
Applicable only for
Cond
One

N/A
/ShipConfirmResponse/ShipmentResults/For ShipConfirmResponse and
ImageFormat m/Image/ImageFormat ShipAcceptResponse.
Code representing the
3

format in which the forms

are generated. Possible
Values: PDF = pdfOnly.
PDF is supported currently.
Applicable only for
string
Cond
One

/ShipConfirmResponse/ShipmentResults/For ShipConfirmResponse and

Code m/Image/ImageFormat/Code ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 231
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Description of the form

image format code.
Applicable only for

string
1..35
One
/ShipConfirmResponse/ShipmentResults/For ShipConfirmResponse and

No
Description m/Image/ImageFormat/Description ShipAcceptResponse.

Base 64 Encoded
unbounded
Base 64 encoded
International forms image.
Applicable only for

Cond
One
/ShipConfirmResponse/ShipmentResults/For ShipConfirmResponse and
GraphicImage m/Image/GraphicImage ShipAcceptResponse.

Unique Id for later retrieval

of saved version of the
completed international
forms. Always returned
when code = 0101
represents international
forms. Applicable only for

1...26
string
Cond
One

/ShipConfirmResponse/ShipmentResults/For ShipConfirmResponse and

FormGroupId m/FormGroupId ShipAcceptResponse.
Contains description text
which identifies the group of
International forms. This
element is part of both
request and response. This
element does not appear on
the forms. Applicable only
1...50
string
One

/ShipConfirmResponse/ShipmentResults/For for ShipConfirmResponse

No

FormGroupIdName m/FormGroupIdName and ShipAcceptResponse.

The container of the COD
container

Turn In Page. Applicable

only for
One

N/A

/ShipConfirmResponse/ShipmentResults/CO ShipConfirmResponse and

No

CODTurnInPage DTurnInPage ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 232
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
The container of the image

container
for COD Turn In Page.
Applicable only for

One
Yes

N/A
/ShipConfirmResponse/ShipmentResults/CO ShipConfirmResponse and
Image DTurnInPage/Image ShipAcceptResponse.

The container for format of

container
COD Turn In Page.
Applicable only for

One
Yes

N/A
/ShipConfirmResponse/ShipmentResults/CO ShipConfirmResponse and
ImageFormat DTurnInPage/Image/ImageFormat ShipAcceptResponse.

4
Format code of the
generated COD Turn In
Page. Valid values: HTML =
HTML format. Only HTML
format is supported for COD
Turn In Page. Applicable

String
only for

One
/ShipConfirmResponse/ShipmentResults/CO Yes ShipConfirmResponse and
Code DTurnInPage/Image/ImageFormat/Code ShipAcceptResponse.
Description of the format
code of generated COD
Turn In page. Applicable
String
1...35 only for
One

/ShipConfirmResponse/ShipmentResults/CO ShipConfirmResponse and

No

Description DTurnInPage/Image/ImageFormat/Description ShipAcceptResponse.

Base 64 Encoded
unbounded

Base 64 encoded html

browser image rendering
software. Applicable only for
One
Yes

/ShipConfirmResponse/ShipmentResults/CO ShipConfirmResponse and

GraphicImage DTurnInPage/Image/GraphicImage ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 233
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Container for the HighValue
Report generated for
ImportControl or Return
shipments with high package

Container
declared value. Applicable
for one pass

Cond
One

N/A
/ShipConfirmResponse/ShipmentResults/High ShipmentResponse and two-
HighValueReport ValueReport pass ShipAcceptResponse.

Container
Container for the HighValue

Yes*
One

N/A
/ShipConfirmResponse/ShipmentResults/High Report image for Import
Image ValueReport/Image Control Shipments.

Container for the HighValue

Container
Report image format
information for Import
Yes*
One

N/A
/ShipConfirmResponse/ShipmentResults/High Control Shipments or return
ImageFormat ValueReport/Image/ImageFormat Shipments.

3
Code representing the
format in which the
String

HighValueReport is
Yes*
One

/ShipConfirmResponse/ShipmentResults/High generated.|Possible Values:

Code ValueReport/Image/ImageFormat/Code PDF = “pdf”
String
1...35
One

/ShipConfirmResponse/ShipmentResults/High Description of the image

No

Description ValueReport/Image/ImageFormat/Description format

unbounded
String
Yes*
One

/ShipConfirmResponse/ShipmentResults/High Base 64 Encoded PDF

GraphicImage ValueReport/Image/GraphicImage Image

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 234
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
LabelURL is returned only if

1
the LabelLinksIndicator is
requested for an
ImportControl shipment or
for a Return shipment. URL

String
will point to a label and can
/ShipConfirmResponse/ShipmentResults/Lab also point to

No
LabelURL elURL HighValueReport

1
LocalLanguageLabelURL is
returned only if the
LabelLinksIndicator is
requested for an
ImportControl shipment or
for a Return shipment. URL

String
will point to a label and can
/ShipConfirmResponse/ShipmentResults/Loc also point to

No
LocalLanguageLabelURL alLanguageLabelURL HighValueReport
Receipt URL is returned if

1
the LabelLinksIndicator is

String
requested for an
/ShipConfirmResponse/ShipmentResults/Rec No ImportControl shipment or a
ReceiptURL eiptURL Return shipment.
1 LocalLanguageReceiptURL
is returned if the
LabelLinksIndicator is
requested for an
ImportControl shipment or a
Return shipment. The URL
String

will contain the receipt in the

/ShipConfirmResponse/ShipmentResults/Loc Country's local language if
No

LocalLanguageReceiptURL alLanguageReceiptURL supported by UPS.

container
One
Yes

N/A

Shipment Response
ShipAcceptResponse /ShipAcceptResponse Container
container
One
Yes

N/A

Response /ShipAcceptResponse/Response Response Container.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 235
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

container
One
Yes

N/A
/ShipAcceptResponse/Response/ResponseSt
ResponseStatus atus Response Status Container.

1
Identifies the success or

string
One
Yes
/ShipAcceptResponse/Response/ResponseSt failure of the transaction. 1 =
Code atus/Code Successful

Describes Response Status

1...35
string
One
Yes
/ShipAcceptResponse/Response/ResponseSt Code. Returns text of
Description atus/Description "Success".

container
Alert Container. There can
be zero to many alert
One

N/A
containers with code and
No

Alert /ShipAcceptResponse/Response/Alert description.

1...10
string
Yes*
One

Warning code returned by

Code /ShipAcceptResponse/Response/Alert/Code the system.
1...150
string
Yes*
One

/ShipAcceptResponse/Response/Alert/Descri Warning messages returned

Description ption by the system.
container
One

N/A

/ShipAcceptResponse/Response/Transaction Transaction Reference

No

TransactionReference Reference Container.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 236
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1...512
The CustomerContext

string
One
/ShipAcceptResponse/Response/Transaction Information which will be

No
CustomerContext Reference/CustomerContext echoed during response.

container
Refer to the
ShipmentResults container

One
Yes

N/A
table for the elements under
ShipmentResults /ShipAcceptResponse/ShipmentResults ShipmentResults container.

Shipment charges
Container. Shipment
charges info. Shipment

container
charges are only guaranteed
to be returned for shipments
Cond
One

N/A
/ShipAcceptResponse/ShipmentResults/Ship whose origin country is US
ShipmentCharges mentCharges or Puerto Rico.
1
String

/ShipAcceptResponse/ShipmentResults/Ship
No

RateChart mentCharges/RateChart
container
One
Yes

N/A

/ShipAcceptResponse/ShipmentResults/Ship Transport Charges

TransportationCharges mentCharges/TransportationCharges container.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 237
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

3
Transportation charges
currency code type. The
/ShipAcceptResponse/ShipmentResults/Ship currency code used in the

string
One
Yes
mentCharges/TransportationCharges/Currenc Shipment request is
CurrencyCode yCode returned.

Transportation and
/ShipAcceptResponse/ShipmentResults/Ship surcharges value amount.

1...19
string
One
Yes
mentCharges/TransportationCharges/Monetar Valid values are from 0 to
MonetaryValue yValue 99999999999999.99

container
One
Yes

N/A
/ShipAcceptResponse/ShipmentResults/Ship Service Option Charges
ServiceOptionsCharges mentCharges/ServiceOptionsCharges container.

3
Accessorial charges
currency code type. The
/ShipAcceptResponse/ShipmentResults/Ship currency code used in the
string
One
Yes

mentCharges/ServiceOptionsCharges/Curren Shipment request is

CurrencyCode cyCode returned.

Accessorial charges value

/ShipAcceptResponse/ShipmentResults/Ship amount. Valid values are
1...19
string
One
Yes

mentCharges/ServiceOptionsCharges/Moneta from 0 to
MonetaryValue ryValue 99999999999999.99
container
One
Yes

N/A

/ShipAcceptResponse/ShipmentResults/Ship
TotalCharges mentCharges/TotalCharges Total charges container.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 238
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

3
Total charges currency code
type. The currency code

string
One
Yes
/ShipAcceptResponse/ShipmentResults/Ship used in the Shipment
CurrencyCode mentCharges/TotalCharges/CurrencyCode request is returned.

Total charges value amount.

1...19
string
One
Yes
/ShipAcceptResponse/ShipmentResults/Ship Valid values are from 0 to
MonetaryValue mentCharges/TotalCharges/MonetaryValue 99999999999999.99

container
One

N/A
/ShipAcceptResponse/ShipmentResults/Nego Negotiated Rates Charge

No
NegotiatedRateCharges tiatedRateCharges Container.

Total charges container.

Account Based Rates info.
Total charges are only
returned for ABR eligible
container shipper account/UserId
combinations when the user
includes the
One

N/A
/ShipAcceptResponse/ShipmentResults/Nego NegotiatedRatesIndicator in
No

TotalCharge tiatedRateCharges/TotalCharge the request.

3

/ShipAcceptResponse/ShipmentResults/Nego
string
One
Yes

tiatedRateCharges/TotalCharge/CurrencyCod Total charges currency

CurrencyCode e code.

/ShipAcceptResponse/ShipmentResults/Nego Total charges monetary

string
1..19
One
Yes

tiatedRateCharges/TotalCharge/MonetaryVal value. Valid values are from

MonetaryValue ue 0 to 9999999999999999.99

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 239
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Ground Freight Pricing

Shipment data container.
Ground Freight Pricing

Container
shipment data is only
guaranteed to be returned

Cond
One

N/A
/ShipAcceptResponse/ShipmentResults/FRS for Ground Freight Pricing
FRSShipmentData ShipmentData shipments only.

Transportation charges
container. Ground Freight
Pricing transportation
charges. These are only
returned for Ground Freight
Pricing enabled shipper

Container
account number when the
user includes the

Cond
One

N/A
/ShipAcceptResponse/ShipmentResults/FRS FRSShipmentIndicator in the
TransportationCharges ShipmentData/TransportationCharges request.

Container
Gross Charges container. It
/ShipAcceptResponse/ShipmentResults/FRS indicates the shipment level
One
Yes

N/A
ShipmentData/TransportationCharges/GrossC gross Ground Freight Pricing
GrossCharge harge transportation charges.
3
String

/ShipAcceptResponse/ShipmentResults/FRS
One
Yes

ShipmentData/TransportationCharges/GrossC Gross charges currency

CurrencyCode harge/CurrencyCode code
String

/ShipAcceptResponse/ShipmentResults/FRS Gross charges monetary

1..19
One
Yes

ShipmentData/TransportationCharges/GrossC value. Valid values are from

MonetaryValue harge/MonetaryValue 0 to 9999999999999999.99

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 240
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Discount Amount container.

Container
It indicates the shipment
/ShipAcceptResponse/ShipmentResults/FRS level Ground Freight Pricing

One
Yes

N/A
ShipmentData/TransportationCharges/Discou discount amount for
DiscountAmount ntAmount transportation charges.

3
String
/ShipAcceptResponse/ShipmentResults/FRS

One
Yes
ShipmentData/TransportationCharges/Discou Discount Amount currency
CurrencyCode ntAmount/CurrencyCode code.

String
/ShipAcceptResponse/ShipmentResults/FRS Discount amount monetary

1..19
One
Yes
ShipmentData/TransportationCharges/Discou value. Valid values are from
MonetaryValue ntAmount/MonetaryValue 0 to 9999999999999999.99

String

/ShipAcceptResponse/ShipmentResults/FRS It indicates the shipment

One
Yes

1..5
ShipmentData/TransportationCharges/Discou level discount percentage for
DiscountPercentage ntPercentage transportation charges.
Container

Net Charges container. It

/ShipAcceptResponse/ShipmentResults/FRS indicates the shipment level
One
Yes

N/A

ShipmentData/TransportationCharges/NetCha net Ground Freight Pricing

NetCharge rge transportation charges.
String

/ShipAcceptResponse/ShipmentResults/FRS
One
Yes

N/A

ShipmentData/TransportationCharges/NetCha
CurrencyCode rge/CurrencyCode Net Charge currency code.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 241
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

String
/ShipAcceptResponse/ShipmentResults/FRS Net charges monetary value.

1..19
One
Yes
ShipmentData/TransportationCharges/NetCha Valid values are from 0 to
MonetaryValue rge/MonetaryValue 9999999999999999.99

container
One
Yes

N/A
/ShipAcceptResponse/ShipmentResults/Billin
BillingWeight gWeight Billing Weight container.

Billing weight unit of

container
measurement code. The
unit of measurement used in

One
Yes

N/A
/ShipAcceptResponse/ShipmentResults/Billin Shipment request is
UnitOfMeasurement gWeight/UnitOfMeasurement returned.

3
string Code of the billing weight
One
Yes

/ShipAcceptResponse/ShipmentResults/Billin measurement units. Values

Code gWeight/UnitOfMeasurement/Code 1...35 are: KGS or LBS.
string
One

/ShipAcceptResponse/ShipmentResults/Billin Description of the billing

No

Description gWeight/UnitOfMeasurement/Description weight measurement units.

8

Billing weight. Higher of the

actual shipment weight
versus the shipment
dimensional weight. Set to 0
string
One
Yes

/ShipAcceptResponse/ShipmentResults/Billin for package type of letters or

Weight gWeight/Weight envelopes.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 242
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

18
Returned UPS shipment ID
number. 1Z Number of the

string
One
Yes
/ShipAcceptResponse/ShipmentResults/Ship first package in the
ShipmentIdentificationNumber mentIdentificationNumber shipment.

unbounded
Encoded shipment
parameters required to be
passed in the accept phase.

string
Cond
One
/ShipAcceptResponse/ShipmentResults/Ship Applicable only for
ShipmentDigest mentDigest ShipConfirmResponse.

##
container
Returned Package
Information. Applicable only

N/A
/ShipAcceptResponse/ShipmentResults/Pack for ShipmentResponse and
No

PackageResults ageResults ShipAcceptResponse.

18

Package 1Z number.
Applicable only for
string
One
Yes

/ShipAcceptResponse/ShipmentResults/Pack ShipmentResponse and

TrackingNumber ageResults/TrackingNumber ShipAcceptResponse.

Shipment charges info.

Shipment charges are only
guaranteed to be returned
for shipments whose origin
Container

country is US or Puerto
Rico. Applicable only for
Cond
One

N/A

/ShipAcceptResponse/ShipmentResults/Pack ShipmentResponse and

ServiceOptionsCharges ageResults/ServiceOptionsCharges ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 243
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

3
Package accessorial
charges currency code type.
The currency code used in
the Shipment request is
/ShipAcceptResponse/ShipmentResults/Pack returned. Applicable only for

string
One
Yes
ageResults/ServiceOptionsCharges/Currency ShipmentResponse and
CurrencyCode Code ShipAcceptResponse.
Package accessorial
charges value amount. Valid
values are from 0 to
99999999999999.99Applica
/ShipAcceptResponse/ShipmentResults/Pack ble only for

1...19
string
One
Yes
ageResults/ServiceOptionsCharges/Monetary ShipmentResponse and
MonetaryValue Value ShipAcceptResponse.
The container for UPS
shipping label. Shipment
without return service, or

container
with PRL return service.
Cond Applicable only for
One

N/A
/ShipAcceptResponse/ShipmentResults/Pack ShipmentResponse and
ShippingLabel ageResults/ShippingLabel ShipAcceptResponse.
The container image format.
contai

Applicable only for

One
Yes

N/A
ner

/ShipAcceptResponse/ShipmentResults/Pack ShipmentResponse and

ImageFormat ageResults/ShippingLabel/ImageFormat ShipAcceptResponse.
3

Label image code that the

labels are generated. Values
EPL = EPL2, SPL = SPL,
ZPL = ZPL, GIF = gif
images, or PNG for PNG
images. Only EPL, SPL, ZPL
and GIF are currently
supported. Applicable only
string
One
Yes

/ShipAcceptResponse/ShipmentResults/Pack for ShipmentResponse and

Code ageResults/ShippingLabel/ImageFormat/Code ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 244
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Description of the label

image format code.
/ShipAcceptResponse/ShipmentResults/Pack Applicable only for

1...35
string
One
ageResults/ShippingLabel/ImageFormat/Desc ShipmentResponse and

No
Description ription ShipAcceptResponse.

Base 64 Encoded
unbounded
Base 64 encoded graphic
image. Applicable only for

One
Yes
/ShipAcceptResponse/ShipmentResults/Pack ShipmentResponse and
GraphicImage ageResults/ShippingLabel/GraphicImage ShipAcceptResponse.

Base 64 encoded graphic

image of the Warsaw text
and signature box. EPL2,
ZPL and SPL labels. The
image will be returned for

Base 64 Encoded
non-US based shipments.
One image will be given per

unbounded
shipment and it will be in the
first PackageResults
/ShipAcceptResponse/ShipmentResults/Pack container. Applicable only for
Cond
One

InternationalSignatureGraphicIma ageResults/ShippingLabel/InternationalSignat ShipmentResponse and

ge ureGraphicImage ShipAcceptResponse.
Base 64 Encoded

Base 64 encoded html

browser image rendering
unbounded

software. This is only

returned for gif and png
image formats. Applicable
Cond
One

/ShipAcceptResponse/ShipmentResults/Pack only for ShipmentResponse

HTMLImage ageResults/ShippingLabel/HTMLImage and ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 245
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

PDF-417 is a two-
dimensional barcode, which
can store up to about 1,800
printable ASCII characters or
1,100 binary characters per
symbol. The symbol is
rectangular. The image is
Base 64 encoded and

Base 64 Encoded
returned if the
LabelImageFormat code is

unbounded
GIF. Shipment with PRL
return service only.
Applicable only for

Cond
One
/ShipAcceptResponse/ShipmentResults/Pack ShipmentResponse and
PDF417 ageResults/ShippingLabel/PDF417 ShipAcceptResponse.

Container for the receipt of a

return shipment. Not

container
supported for ERL or PRL
shipments. Applicable only
Cond
One

N/A
/ShipAcceptResponse/ShipmentResults/Pack for ShipmentResponse and
ShippingReceipt ageResults/ShippingReceipt ShipAcceptResponse.
container
Container for a Image
Format. Applicable only for
One
Yes

N/A
/ShipAcceptResponse/ShipmentResults/Pack ShipmentResponse and
ImageFormat ageResults/ShippingReceipt/ImageFormat ShipAcceptResponse.
4

Code representing the

format in which a receipt.
Valid values: HTML = HTML
/ShipAcceptResponse/ShipmentResults/Pack format. Applicable only for
string
One
Yes

ageResults/ShippingReceipt/ImageFormat/Co ShipmentResponse and

Code de ShipAcceptResponse.

Description of the image

/ShipAcceptResponse/ShipmentResults/Pack format code. Applicable only
1...35
string
One

ageResults/ShippingReceipt/ImageFormat/De for ShipmentResponse and

No

Description scription ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 246
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Base 64 Encoded
unbounded
Base 64 encoded PRL
receipt in HTML format.
Applicable only for

One
Yes
/ShipAcceptResponse/ShipmentResults/Pack ShipmentResponse and
GraphicImage ageResults/ShippingReceipt/GraphicImage ShipAcceptResponse.

unbounded
USPSPICNumber is USPS
Package Identification code
which is returned at package

string
Cond
One
/ShipAcceptResponse/ShipmentResults/Pack level for UPS Returns
USPSPICNumber ageResults/USPSPICNumber Flexible Access Shipments.

Container for the High Value

reports When forward
shipments declared value
between $999 and $50,000
USD. Two copies of high
container

value report needs to be

pointed out. Applicable only
Cond
One

N/A

/ShipAcceptResponse/ShipmentResults/Contr for ShipmentResponse and

ControlLogReceipt olLogReceipt ShipAcceptResponse.

Container for the High Value

container

report format, required if

parent exist Applicable only
One
Yes

N/A

/ShipAcceptResponse/ShipmentResults/Contr for ShipmentResponse and

ImageFormat olLogReceipt/ImageFormat ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 247
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules
Code for the type of Graphic

4
Image for the High Value
Report. Values are: EPL =
EPL2 (when user requests
label in EPL2 format) SPL
= SPL (when user requests
label in SPL format) ZPL =
ZPL (when user requests
label in ZPL format) HTML=
HTML (when user requests
label in HTML format)
Applicable only for

string
One
Yes
/ShipAcceptResponse/ShipmentResults/Contr ShipmentResponse and
Code olLogReceipt/ImageFormat/Code ShipAcceptResponse.

Description of the format

code. Applicable only for

string
1..35
One
/ShipAcceptResponse/ShipmentResults/Contr ShipmentResponse and

No
Description olLogReceipt/ImageFormat/Description ShipAcceptResponse.

Base 64 Encoded
unbounded
Base 64 encoded html,
EPL2, ZPL or SPL image.
Applicable only for
One
Yes

/ShipAcceptResponse/ShipmentResults/Contr ShipmentResponse and

GraphicImage olLogReceipt/GraphicImage ShipAcceptResponse.

Container tag for the

container

International forms image.

Applicable only for
Cond
One

N/A

ShipmentResponse and
Form /ShipAcceptResponse/ShipmentResults/Form ShipAcceptResponse.
2

Code that indicates the type

of form. Possible Values01 -
All Requested International
Forms. Applicable only for
string
One
Yes

/ShipAcceptResponse/ShipmentResults/Form ShipmentResponse and

Code /Code ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 248
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Description that indicates the

type of form. Possible
Values: All Requested
International Forms.
Applicable only for

1...35
string
One
Yes
/ShipAcceptResponse/ShipmentResults/Form ShipmentResponse and
Description /Description ShipAcceptResponse.

Container tag for the

container
International forms image.
Applicable only for

Cond
One

N/A
/ShipAcceptResponse/ShipmentResults/Form ShipmentResponse and
Image /Image ShipAcceptResponse.

Container tag for the

International forms image

container
format information.
Applicable only for

Cond
One

N/A
/ShipAcceptResponse/ShipmentResults/Form ShipmentResponse and
ImageFormat /Image/ImageFormat ShipAcceptResponse.
Code representing the

3
format in which the forms
are generated. Possible
Values: PDF = pdfOnly.
PDF is supported currently.
Applicable only for
string
Cond
One

/ShipAcceptResponse/ShipmentResults/Form ShipmentResponse and

Code /Image/ImageFormat/Code ShipAcceptResponse.

Description of the form

image format code.
Applicable only for
string
1..35
One

/ShipAcceptResponse/ShipmentResults/Form ShipmentResponse and

No

Description /Image/ImageFormat/Description ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 249
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

Base 64 Encoded
unbounded
Base 64 encoded
International forms image.
Applicable only for

Cond
One
/ShipAcceptResponse/ShipmentResults/Form ShipmentResponse and
GraphicImage /Image/GraphicImage ShipAcceptResponse.

Unique Id for later retrieval

of saved version of the
completed international
forms. Always returned
when code = 0101
represents international
forms. Applicable only for

1...26
string
Cond
One
/ShipAcceptResponse/ShipmentResults/Form ShipmentResponse and
FormGroupId /FormGroupId ShipAcceptResponse.

Contains description text

which identifies the group of
International forms. This
element is part of both
request and response. This
element does not appear on
the forms. Applicable only
1...50
string
One

/ShipAcceptResponse/ShipmentResults/Form for ShipmentResponse and

No

FormGroupIdName /FormGroupIdName ShipAcceptResponse.

container

The container of the COD

Turn In Page. Applicable
One

N/A

/ShipAcceptResponse/ShipmentResults/COD only for ShipmentResponse

No

CODTurnInPage TurnInPage and ShipAcceptResponse.

The container of the image

container

for COD Turn In Page.

Applicable only for
One
Yes

N/A

/ShipAcceptResponse/ShipmentResults/COD ShipmentResponse and

Image TurnInPage/Image ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 250
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

The container for format of

container
COD Turn In Page.
Applicable only for

One
Yes

N/A
/ShipAcceptResponse/ShipmentResults/COD ShipmentResponse and
ImageFormat TurnInPage/Image/ImageFormat ShipAcceptResponse.

4
Format code of the
generated COD Turn In
Page. Valid values: HTML =
HTML format. Only HTML
format is supported for COD

String
Turn In Page. Applicable

One
Yes
/ShipAcceptResponse/ShipmentResults/COD only for ShipmentResponse
Code TurnInPage/Image/ImageFormat/Code and ShipAcceptResponse.

Description of the format

code of generated COD

String
Turn In page. Applicable

1...35
/ShipAcceptResponse/ShipmentResults/COD One only for ShipmentResponse
No

Description TurnInPage/Image/ImageFormat/Description and ShipAcceptResponse.

Base 64 Encoded
unbounded

Base 64 encoded html

browser image rendering
software. Applicable only for
One
Yes

/ShipAcceptResponse/ShipmentResults/COD ShipmentResponse and

GraphicImage TurnInPage/Image/GraphicImage ShipAcceptResponse.
1

Container for the HighValue

Report generated for
ImportControl or Return
shipments with high package
Container

declared value.Applicable
for one pass
/ShipAcceptResponse/ShipmentResults/High ShipmentResponse and two-
No

HighValueReport ValueReport pass ShipAcceptResponse.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 251
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1
Container
Container for the HighValue
Report image for Import

Yes
/ShipAcceptResponse/ShipmentResults/High Control Shipments or for
Image ValueReport/Image return shipments.

1
Container for the HighValue

Container
Report image format
information for Import

Yes
/ShipAcceptResponse/ShipmentResults/High Control Shipments or for
ImageFormat ValueReport/Image/ImageFormat return shipments.

1
Code representing the
format in which the

String
HighValueReport is
/ShipAcceptResponse/ShipmentResults/High Yes generated.|Possible Values:
Code ValueReport/Image/ImageFormat/Code PDF = “pdf”
1
String

/ShipAcceptResponse/ShipmentResults/High Description of the image

No

Description ValueReport/Image/ImageFormat/Description format

1
String
Yes

/ShipAcceptResponse/ShipmentResults/High Base 64 Encoded PDF

GraphicImage ValueReport/Image/GraphicImage Image
1

LabelURL is returned only if

the LabelLinksIndicator is
requested for an
ImportControl shipment or
for a Return shipment. URL
String

will point to a label and can

/ShipAcceptResponse/ShipmentResults/Label also point to
No

LabelURL URL HighValueReport

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 252
Shipping Package – WebServices 7/09/2012

Shipment Only
Max Allowed

Return Only
Required

Partial IV
Nafta CO
Invoice
Length
Type

EEI
CO
Name XPath Description Validation Rules

1
LocalLanguageLabelURL is
returned only if the
LabelLinksIndicator is
requested for an
ImportControl shipment or
for a Return shipment. URL

String
will point to a label and can
/ShipAcceptResponse/ShipmentResults/Local also point to

No
LocalLanguageLabelURL LanguageLabelURL HighValueReport

1
ReceiptURL is returned if the
LabelLinksIndicator is

String
requested for an
/ShipAcceptResponse/ShipmentResults/Recei ImportControl shipment or a

No
ReceiptURL ptURL Return shipment.

1
LocalLanguageReceiptURL
is returned if the
LabelLinksIndicator is
requested for an
ImportControl shipment or a
Return shipment. The URL

String
will contain the receipt in the
/ShipAcceptResponse/ShipmentResults/Local Country's local language if
No

LocalLanguageReceiptURL LanguageReceiptURL supported by UPS.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 253
Shipping Package – WebServices 7/09/2012

1.9 The Void Web Services Reference

This section documents the details of the Void Web Services message, including the request that
clients send to UPS and the response that UPS returns.

1.9.1 Void Web Service

1.9.1.1 Overview
Service Operations: Void Shipment

1.9.1.2 Shipment Operation

Type: Request-Response (client sends a request to UPS, and the UPS server
replies with a response)
SOAPAction Header: https://wwwcie.ups.com/webservices/Void

Note: The Void Operation is a single pass way to void a shipment. With a single
transaction which sends a VoidShipmentWebServicesRequest and receives the
VoidShipmentWebServicesResponse to confirm the void.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 254
Shipping Package – WebServices 7/09/2012

1.9.2 Void Web Services Schema

REQUIRED

ALLOWED

LENGTH
TYPE
MAX
NAME XPATH DESCRIPTION VALIDATION RULES

Container
One
Yes

N/A
/VoidShipmentRequest/Re
Request quest Request Container N/A

String
One
/VoidShipmentRequest/Re

No

1
RequestOption quest/RequestOption Optional processing. No options Not used. Left for future uses

Container
TransactionReference identifies

One

N/A
/VoidShipmentRequest/Re transactions between

No
TransactionReference quest/TransactionReference client and server. N/A
The client uses CustomerContext
to synchronize Request /response
pairs. The client establishes
CustomerContext, which can

1...512
String
/VoidShipmentRequest/Re contain any information you want,

One
quest/TransactionReference/CustomerCont as along as it is valid XML; it is
No
CustomerContext ext echoed back by the server. N/A

String
/VoidShipmentRequest/Re
quest/TransactionReference/TransactionIde One The Unique Transaction Identifier Empty Tag. Not used. Left for
No

4
TransactionIdentifier ntifier for a given transaction future uses.

Container
One
Yes

The container for the Ship Void

VoidShipment /VoidShipmentRequest/VoidShipment 1 Request N/A
Alpha-numeric. Must pass 1Z
One
Yes

Stri

/VoidShipmentRequest/VoidShipment/Ship The shipments identification rules. Must be

ng

18

ShipmentIdentificationNumber mentIdentificationNumber number upper case.

String

Alpha-numeric. Must pass 1Z

One

/VoidShipmentRequest/VoidShipment/Track The package's identification rules. Must be

No

18

TrackingNumber ingNumber number upper case

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 255
Shipping Package – WebServices 7/09/2012

container
One
Yes

N/A
VoidShipmentResponse /VoidShipmentResponse Void Response Container.

container
One
Yes

N/A
Response /VoidShipmentResponse/Response Response Container.

container
One
Yes

N/A
/VoidShipmentResponse/R
ResponseStatus esponse/ResponseStatus Response Status Container.

string
One
Yes
/VoidShipmentResponse/Response/Respon Identifies the success or failure of

1
Code seStatus/Code the transaction.1 = Successful

Describes Response Status Code.

string

1-35
One
Yes
/VoidShipmentResponse/Response/Respon Returns text of
Description seStatus/Description Success

container
Alert Container. There can be zero
to many alert
One

N/A
containers with code and
No

Alert /VoidShipmentResponse/Response/Alert description.

string
Yes*

1-10
One

/VoidShipmentResponse/Response/Alert/C Warning code returned by the

Code ode system

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 256
Shipping Package – WebServices 7/09/2012

1-150
string
Yes*

One
/VoidShipmentResponse/Response/Alert/D Warning messages returned by
Description escription the system.

container
One

N/A
/VoidShipmentResponse/Response/Transa

No
TransactionReference ctionReference Transaction Reference Container.

1-512
The CustomerContext Information

string
One
/VoidShipmentResponse/Response/Transa which will be echoed

No
CustomerContext ctionReference/CustomerContext during response.

The Unique TransactionIdentifier

Information for that
transaction. This will be present

string
One
/VoidShipmentResponse/Response/Transa only if requested in the

No

35
TransactionIdentifier ctionReference/TransactionIdentifier request.

Container
One
Yes

N/A
SummaryResult /VoidShipmentResponse/SummaryResult Container for the Summary Result

Container
One
Yes

N/A
/VoidShipmentResponse/SummaryResult/S Container for the status of the
Status tatus Summary Result
String
One
Yes

/VoidShipmentResponse/SummaryResult/S Code for the status of the

1

Code tatus/Code Summary Result

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 257
Shipping Package – WebServices 7/09/2012

String

1-35
One
Yes
/VoidShipmentResponse/SummaryResult/S Description of the status of the
Description tatus/Description Summary Result

Container
One

N/A
/VoidShipmentResponse/PackageLevelRes Contains the Package Level

No
PackageLevelResult ult Results

String
*Yes

One
/VoidShipmentResponse/PackageLevelRes The package's identification

18
TrackingNumber ult/TrackingNumber number

Container
* Yes

One
/VoidShipmentResponse/PackageLevelRes

1
Status ult/Status Contains the status code tags.

The Package Level void status

code. A numeric value

String
that describes the status code.1 =
*Yes

One
/VoidShipmentResponse/PackageLevelRes Voided or Already

1
Code ult/Status/Code Voided; 0 = Not Voided

String

1...15
*Yes

One

/VoidShipmentResponse/PackageLevelRes A text description of the status

Description ult/Status/Description code.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 258
Shipping Package – WebServices 7/09/2012

1.10 Customer Integration Environment

The Customer Integration Environment (CIE) 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 CIE maintains system availability 24 hours, 7 days each week, there are
occasional system down times to allow for server maintenance.
1.10.1 Negotiated Rates

Negotiated Rates are available in the UPS Customer Integration Environment and are
returned when the Negotiated Rate indicator is provided in the rate request. The Negotiated
Rates returned do not reflect the contractual rate and may vary. (Generally they are 1% off
the published rate.)
Also in the Customer Integration Environment the shipper eligibility for Negotiated Rates is
not fully verified. For shipper eligibility requirements refer to Negotiated Rates section
within UPS Rates & Service Selection.
For integration testing, you should direct your test Shipping software to:
https://wwwcie.ups.com/webservices/Ship.

1.10.2 Testing and Deploying Applications

UPS maintains a special web site to support testing and staging of applications that rely on
the Shipping Web Services. This site lets developers test and debug their applications by
simulating transactions with UPS. The staging site responds to Web Services requests just
like the UPS production site; 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 the staging site will avoid this problem.
The web site for testing and staging is the UPS Customer Integration Environment. You can
access this test site by using the domain name of wwwcie.ups.com. If you are using
development API that automatically generate messages based on the WSDL files, you may
need to edit the WSDL files so that they direct the request to the staging site or the
production site, as appropriate.

1.10.2.1 System Availability

The Customer Integration Environment is available 24 hours a day, 7 days a week.

1.10.2.2 Server Availability Check

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 259
Shipping Package – WebServices 7/09/2012

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/ups.app/xml/ShipConfirm
The following will be returned:
Service Name: ShipWS
Remote User: null
Server Port: 443
Server Name: wwwcie.ups.com
Servlet Path: /Ship

1.10.3 UPS Product Exchange Service

Email Pre-alert notification will be sent with a custom text in case of exchange
forward shipment, if user provided prealert notification Email in the request.

1.10.4 Production Access

NEW! UPS now grants both test and production access for the Shipping API immediately
without any further requests. To use production environment just point to the Production
URLs outlined below.

Prior to moving to the Production environment, you should verify that your XML is well-
formed (successful responses) and be able to produce the following:

 Void Request

 High Value Report

 Label Recovery

 A proportional UPS Address label

Questions about your XML request and response need to be directed to API Technical
Support. Please see section “Getting Technical Support”.

<Please refer to sample label at Appendix L as reference>

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 260
Shipping Package – WebServices 7/09/2012

Once your testing is completed please direct your Shipping Package XML to the Production
URL:

https://onlinetools.ups.com/webservices/Ship

1.10.5 Label Verification for Contract Services

Returns Flexible Access (RFA) requires Label Certification. Please complete the steps
noted below.

 Ask your Account Representative to submit a Label Testing Request Form to the Label
Verification Group prior to submitting your RFA labels for review

 Request a UPS Return Label by sending an email with your pickup address to
[email protected]

 Create 10 RFA shipments/labels with a return service code of PRL

 Submit the RFA labels to the Label Verification Group using the UPS provided Return
Label

UPS will contact you via email within 5 business days to inform you of your approval status
for RFA. Once granted, please direct your Shipping Package XML to the Production URL:

https://onlinetools.ups.com/webservices/Ship

Note: UPS reserves the right to revoke shipping privileges from any customers who fail to
abide by the Certification Requirements outlined above.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 261
Shipping Package – WebServices 7/09/2012

1.10.6 Other Shipping Tools

1.10.6.1 Voiding Package Shipments

Test your Void application using the set of 1Zs listed below:

NUMBER(S) EXPECTED RESULT

1ZISDE016691676846 A successful XML response will be
returned for a shipment level void request.
.
1Z2220060290602143 A successful XML response will be
returned for a shipment level void
request.
1Z2220060294314162 and Tracking Number A successful XML response will be
1Z2220060291994175 returned for a package level void request.
The request will void the package in the
shipment.
1Z2220060292690189 and Tracking Number A successful XML response will be
1Z2220060292002190 returned for a package level void request.
The request will void the package in the
shipment. .
1ZISDE016691609089 with Tracking Numbers A successful XML response will be
1ZISDE016694068891 and 1ZISDE016690889305 returned for a package level void request.
The request will void all the packages.
1Z2220060290530202 with Tracking Number A successful XML response will be
1Z2220060293874210 and 1Z2220060292634221 returned with a partial void for a package
level void request. The request will void
package 1Z2220060293874210 but
package 1Z2220060292634221 cannot be
voided.

This will ensure that your application has the ability to process success and error
responses correctly.
For integration testing, you should direct your test Void Package Shipment software
to:
https://wwwcie.ups.com/webservices/Void
1.10.6.2 System Availability

The Customer Integration Environment is available 24 hours a day, 7 days a

week.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 262
Shipping Package – WebServices 7/09/2012

1.10.6.3 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/Void
The following will be returned:
Service Name: Void
Remote User: null
Server Port: 443
Server Name: wwwcie.ups.com
Servlet Path: /Void

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 263
Shipping Package – WebServices 7/09/2012

Appendix A- Accessing Tech Support (US Site Example)

Go to ups.com and log in to myUPS with your ID and PW.

Hover over the “Support” tab, and select “Technology Support” from the drop-down.

From the Technology Support page select the Developer Resource Center link from the left navigation .

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 264
Shipping Package – WebServices 7/09/2012

From the Developer Resource Center page select the “Email UPS” link in right hand column.

Complete Name, email address, Support Category must be “Technical Support”, and Support Topic must be
“Developer Resource”. Select the “Next” button.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 265
Shipping Package – WebServices 7/09/2012

Scroll down the page and complete the remainder of the email form including “Your Telephone”, “Stage of
Development”, “Developer Resource” which is which API you are integrating, “Attach File” where you
attach your XML Request/Response Pair, and any pertinent description of the issues in the “What is your
question or comment?” field. Select “Send Email” button.

The screen below will appear. Please see “Technical Support (US)” within this document for tech support
hours of operation and response times.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 266
Shipping Package – WebServices 7/09/2012

Appendix B - Shipping WebServices Error Codes

If you get a < ShipmentResponse > in a SOAP Envelope’s Body part, it means the request is
processed successfully. Otherwise, a SOAP Fault will be returned in a SOAP Envelope’s Body part.
In a good response, check the ResponseStatusCode element. A “1” normally indicates a successful
response. When you get a SOAP FAULT, check the Errors and the sub-element ErrorDetail. The
value of <Severity> can be either Transient or Hard. When an error occurs there will also be an
error code, and an error description in PrimaryErrorCode element.

 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, it is a
user error. 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.

Shipping Web Service specific errors:

Error Code Severity Description

120020 Hard Max packages per shipment exceeded
120021 Hard The same shipment cannot be requested to be created more than once.
Using user generated forms is not permitted. Please attach your user
120023 Warning generated forms with your shipment.
Uploading of your user generated International Forms was not successful.
120024 Warning Please attach the international forms to your shipment.
120100 Hard Missing or invalid shipper number
120101 Hard Missing or invalid shipper name
120102 Hard Missing or invalid shipper address line 1
120103 Hard Invalid shipper address line 2
120104 Hard Invalid shipper address line 3
120105 Hard Missing or invalid Shipper City
120106 Hard Missing or invalid Shipper StateProvinceCode
120107 Hard Missing or invalid Shipper PostalCode. (Description)
120108 Hard Missing or invalid Shipper CountryCode
120109 Hard Missing or invalid Shipper PhoneNumber
120110 Hard Missing or invalid Shipper AttentionName
120111 Hard Shipper EmailAddress cannot exceed a length of 50 characters

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 267
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

120112 Hard Shipper EmailAddress is an invalid format
120113 Hard Shipper number must contain alphanumeric characters only
120114 Hard Shipper phone extension cannot exceed the length of 4.
120115 Hard Shipper PhoneNumber must be at least 10 alphanumeric characters
120116 Hard Shipper phone extension must contain only numbers
Shipper phone extension is allowed only if the shipper is located in US,
120117 Hard Puerto Rico or Canada
120118 Hard Shipper phone extension is only valid if a phone number is given.
The country associated with Shippers ShipperNumber must be the same as
120120 Hard the shipments Shippers country
120121 Hard The Shippers shipper number cannot be used for the shipment.
120122 Hard Invalid Shipper ShipperNumber
120124 Hard The requested service is unavailable between the selected locations
120125 Hard Consignee billing is only supported in US or Pureto Rico
120200 Hard Missing or invalid ShipTo CompanyName
120201 Hard Missing or invalid ShipTo AttentionName
120202 Hard Missing or invalid ShipTo AddressLine1
120203 Hard Invalid ShipTo AddressLine2
120204 Hard Invalid ShipTo AddressLine3
120205 Hard Missing or invalid ShipTo City
120206 Hard Missing or invalid ShipTo StateProvinceCode
120207 Hard Missing or invalid ShipTo PostalCode. (Description)
120208 Hard Missing or invalid ShipTo CountryCode
120209 Hard Missing or invalid ShipTo PhoneNumber
120210 Hard ShipTo EmailAddress cannot exceed a length of 50 characters
120211 Hard ShipTo EmailAddress is an invalid format
120212 Hard ShipTo PhoneExtension cannot exceed the length of 4.
120213 Hard ShipTo PhoneNumber must be at least 10 alphanumeric characters
120214 Hard ShipTo PhoneExtension must contain only numbers
120216 Hard ShipTo PhoneExtension is only valid if a phone number is given
ShipTo phone number and phone extension together cannot be more than
120217 Hard 15 digits long
Missing or Invalid ShipTo tax identification. TaxID may not exceed a
120218 Hard length of 15.
120300 Hard Missing or invalid ShipFrom CompanyName
120301 Hard Missing or invalid ShipFrom AttentionName
120302 Hard Missing or invalid ShipFrom AddressLine1
120303 Hard Invalid ShipFrom AddressLine2
120304 Hard Invalid ShipFrom AddressLine3
120305 Hard Missing or invalid ShipFrom City
120306 Hard Missing or invalid ShipFrom StateProvinceCode
120307 Hard Missing or invalid ShipFrom PostalCode. (Description)
120308 Hard Missing or invalid ShipFrom CountryCode
120309 Hard Missing or invalid ShipFrom PhoneNumber

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 268
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

120310 Hard ShipFrom EmailAddress cannot exceed a length of 50 characters
120311 Hard ShipFrom EmailAddress is an invalid format
120312 Hard ShipFromPhoneExtension cannot exceed the length of 4.
120313 Hard ShipFrom PhoneNumber must be at least 10 alphanumeric characters
120314 Hard ShipFromPhoneExtension must contain only numbers
120316 Hard ShipFromPhoneExtension is only valid if a phone number is given
ShipFrom phone number and phone extension together cannot be more
120318 Hard than 15 digits long
120400 Hard Missing or invalid shipment payment method
120402 Hard Missing or invalid credit card type
120403 Hard Missing or invalid credit card number
120404 Hard Missing or invalid credit card expiration date
120406 Hard creditcard number is not valid for the credit card type
120407 Hard The credit card provided as the payment method has expired.
120408 Hard Missing credit card type
UPS account number that was provided as the payment method is missing
120412 Hard or invalid.
120414 Hard Credit card authorization failed, contact your financial institution
120416 Hard A single billing option is required per shipment
120417 Hard The account number for FRS payment information is not FRS enabled
120437 Hard Third party or freight collect shippers postal code is missing or invalid.
120500 Hard Missing or invalid Service Code
120501 Hard Invalid Shipment ReferenceNumber Value
120502 Hard InvoiceLineTotal/MonetaryValue must be greater than 0
120503 Hard Shipment Description cannot exceed the length of 35 characters
120504 Hard InvoiceLineTotal is not allowed for this shipment
120505 Hard Saturday Delivery Option cannot be used for this shipment
120506 Hard Invalid Shipment ReferenceNumber Code
120512 Hard Shipment Description is required for this shipment.
120515 Hard { notification type} Memo cannot exceed the length of 150 characters
The {order} Email Address used for { notification type} exceeds the
120517 Hard maximum length of 50 characters
The format of the {order} Email Address entered for { notification type} is
120518 Hard invalid
The {order} Email Address entered for { notification type} is missing or
120519 Hard contains invalid characters
120522 Hard Alternate Delivery Time is not valid for any available services
Shipment DocumentsOnly is invalid with the shipments origin/destination
120523 Hard pair
120524 Hard Package Pickup Request is not available with this shipments service
120526 Hard InvoiceLineTotal MonetaryValue may not exceed the length of 8
120530 Hard SuiteRoomID length of shipment pickup cannot exceed 8 characters
120531 Hard FloorID length of shipment pickup cannot exceed 3 characters
120532 Hard Location length of shipment pickup cannot exceed 11 characters
120533 Hard The earliest shipment pickup time is required
120534 Hard The latest shipment pickup time is required

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 269
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

120535 Hard Contact name of shipment pickup is required
120536 Hard Contact phone number of shipment pickup is required
120538 Hard Shipment Pickup Error: (further description is provided in XML)
120549 Hard Invalid ReferenceNumber BarCodeIndicator.
Invalid COD currency code. Please use the destination country currency
120597 Hard code.
Package Delivery Confirmation is not allowed with the shipment
120598 Hard origin/destination.
120600 Hard Missing Package Packaging Type Code
120601 Hard Missing or invalid Package weight
Missing or invalid Combination of package length, width, and height
120602 Hard values.
120603 Hard Invalid Package Reference Value
120604 Hard Invalid package declared value
120605 Hard Mismatch package dimensions with package type
120606 Hard Mismatch package dimensions, package type and package weight
120607 Hard Invalid Package Reference Code
120608 Hard Package weight is required
120609 Hard All Package Dimensions are required and each must be greater than 0
120610 Hard Invalid COD monetary value
120611 Hard The contact name of verbal confirmation cannot exceed a length of 35
The contact phone number of verbal confirmation cannot exceed the
120612 Hard length of 15
The contact phone number of verbal confirmation must be at least 10
120613 Hard alphanumeric characters
The contact phone extension of verbal confirmation cannot exceed the
120614 Hard length of 4
The contact phone extension of verbal confirmation must contain numbers
120615 Hard only
120616 Hard Package weight cannot exceed a length of 6
120617 Hard Package declared value cannot exceed a value of 999
120618 Hard Contact name is required for verbal confirmation of delivery
120619 Hard Contact phone number is required for verbal confirmation of delivery
Package PackageWeight, Package DimensionalWeight, Package
120620 Hard OversizePackage and Package Dimensions do not apply to UPS Envelopes
Package declared value cannot be greater than {Monetary Amount}
120621 Hard {Currency Code}
120622 Hard Package description is required
120623 Hard Invalid Package description
120624 Hard Only one package is allowed for this movement.
120626 Hard The COD Funds Code is invalid. Please check the value entered
120644 Hard LabelDelivery is not valid with the shipment
No more than two email addresses for Receiver Return Notification are
120654 Hard allowed in a shipment.
{0} of Receiver Return Notification is only allowed to be specified at the
120655 Hard first package that has Receiver Return Notification.
120661 Hard For a shipment, the maximum number of {0} allowed for Quantum View

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 270
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

notification is 1.
120662 Hard Invalid Subject Code of {Notification type}
120663 Hard Invalid From name of {Notification type}
120664 Hard Invalid UndeliverableEMailAddress of {Notification type}
120665 Hard Invalid FromEMailAddress of {Notification type}
120666 Hard Missing or invalid subject text of {Notification type}
120704 Hard Missing/Invalid LabelSpecification LabelStockSize Height
120705 Hard Missing/Invalid LabelSpecification LabelStockSize Width.
120759 Hard MovementReferenceNumber must contain alphanumeric characters only.
120760 Hard MovementReferenceNumber must be a length of 18 characters.
Invalid MovementReferenceNumber . The 3rd and 4th Character Must be
120761 Hard the Shipper country ISO Code.
120801 Hard Address Validation Error on Shipper address
120802 Hard Address Validation Error on ShipTo address
120803 Hard Address Validation Error on ShipFrom address
User Id and Shipper Number combination is not qualified to receive
120900 Warning negotiated rates.
120901 Warning Negotiated rates are unavailable at this time
121005 Hard The COD option cannot be combined with the Return Services option.
121006 Hard The COD option cannot be combined with the UPS Import Control option.
121011 Hard Dangerous Goods cannot be shipped using UPS Import Control.
The Saturday Delivery option cannot be combined with the Return
121015 Hard Services option.
The Delivery Confirmation option cannot be combined with the Return
121020 Hard Services option.
The Delivery Confirmation option cannot be combined with the UPS
121021 Hard Import Control option.
121025 Hard The maximum declared amount $50,000 is exceeded
121030 Hard Packages must weigh more than zero pounds.
121031 Hard Packages must weigh more than zero kilogram
121035 Hard {description}
121036 Hard {description}
121040 Hard The Return Services are unavailable with the requested service.
The UPS Import Control accessories are unavailable with the requested
121041 Hard service.
121045 Hard The Saturday Delivery option is unavailable with the requested service.
Saturday Delivery may not be combined with the package type for the
121047 Hard given product.
121050 Hard Package exceeds the maximum size total constraints { description}
121055 Hard Package exceeds the maximum length constraint of {description} inches. .
121056 Hard Package exceeds the maximum length constraint of {description} cm.
121057 Hard The measurement system is not valid
121063 Hard Accessorial cannot be shipped with the selected service.
121070 Hard {Rating error description}.
121085 Hard The requested accessory cannot be added to the shipment.
121087 Hard The Authorized Return Service option is not allowed for shipments.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 271
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

121090 Hard {Rating error description}
121091 Hard {Rating error description}
121100 Hard The selected service is invalid for the shipment origin.
121105 Hard The given accessory key is invalid for the shipment origin.
121106 Hard The specified country, origin or destination, is not supported.
121107 Hard A blank origin postal was specified.
121115 Hard The COD amount must be greater than zero
The COD amount cannot exceed $1,000 when a cashiers check or money
121120 Hard order is requested.
The COD value entered exceeds the maximum allowed for cash of
121121 Hard {amount} ({currency code})
121125 Hard The COD amount cannot exceed $50,000.
The COD value entered exceeds the maximum allowed for check of
121126 Hard {amount} ({currency code})
The Saturday Pickup option cannot be combined with the UPS Import
121131 Hard Control option.
The Saturday Pickup option cannot be combined with the Saturday
121135 Hard Delivery option.
121140 Hard Saturday Pickup is unavailable with the selected service.
121150 Hard Delivery confirmation is unavailable with the selected service.
The COD option is unavailable with the selected service, UPS account
121155 Hard type, and/or with the shipments origin/destination pair.
121156 Hard Package Level COD is not valid for the shipment origin and/or destination
121160 Hard The accessory is invalid with the billing option.
The Verbal Confirmation of Deliveryoption cannot be combined with the
121165 Hard Return Services option.
The Verbal Confirmation of Delivery option cannot be combined with the
121166 Hard UPS Import Control option.
The Delivery Confirmation option cannot be combined with the Verbal
121170 Hard Confirmation of Delivery option.
121175 Hard Verbal Confirmation of Delivery is unavailable with the selected service.
The payer's transportation country is not valid for carbon neutral
121182 Hard shipments.
121195 Hard The selected billing option is unavailable with the selected service.
121196 Hard The selected billing option is unavailable with UPS Letters.
121200 Hard Saturday Delivery is unavailable to desired destination.
121205 Hard Additional Handling is unavailable with the selected service.
121206 Hard Additional Handling is unavailable with UPS Letters.
UPS Next Day Air Early A.M. service is not available to the requested
121208 Hard destination. Please select UPS Next Day Air service as an alternative.
121210 Hard The selected service is not available from the origin to the destination.
A package-level accessorial is not available with the shipments origin/dest
121211 Hard pair. (Description) will be a detailed description based on the shipment.
The requested package type is not allowed in a shipment from the origin to
121212 Hard the destination
121213 Hard {Rating error description}

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 272
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

121214 Hard UPS cannot ship from the origin country to the destination country
121215 Hard The selected service is not available to residential destinations.
121225 Hard Return Services are unavailable to the given destination.
121230 Hard Next Day Air Early AM Surcharge is unavailable with the selected service.
121231 Hard Switzerland Domestic Container must weigh greater than 2 KG
Worldwide Express Plus from Europe to Switzerland must be UPS
121232 Hard Envelope or document only
121235 Hard {rating error description}
121255 Hard Shipper Duty Fee is unavailable with the selected service.
121260 Hard Shipper Duty Fee is unavailable with the selected billing option.
121261 Hard Accessory may not be combined with the product.
121262 Hard Accessory may not be combined with the accessory.
121265 Hard The selected billing option is unavailable to the desired country.
121266 Hard The currency code is invalid for the shipment.
121267 Hard The Ship From Country is invalid for the credit card.
121268 Hard The Billing address Country is invalid for the credit card.
121285 Hard {Rating error description}
121286 Hard {Rating error description}
121290 Hard The given billing option is invalid
121295 Hard {Rating error description}
121315 Hard The Authorized Return Service is unavailable with the selected accessorial.
121317 Hard The UPS Import Control option is unavailable with the selected accessory.
121320 Hard The Authorized Return Service is unavailable with the selected service.
The Authorized Return Service is unavailable with the selected billing
121325 Hard option.
121330 Hard The Certificate of Origin is unavailable with the selected accessorial.
121335 Hard The Certificate of Origin is unavailable with the selected service.
121340 Hard The Certificate of Origin is unavailable with the selected billing option.
The Shipper Export Declaration is unavailable with the selected
121345 Hard accessorial.
121350 Hard The Shipper Export Declaration is unavailable with the selected service.
The Shipper Export Declaration is unavailable with the selected billing
121355 Hard option.
The Worldwide Express Plus Surcharge is unavailable with the selected
121360 Hard service.
121363 Hard The One Time Pickup Surcharge is unavailable with the selected service.
121365 Hard Accessorial is not available with the selected access method.
121370 Hard Invalid access method.
Letter service is invalid for shipments with more than 1 package.
International shipment cannot be made with multiple 10KG or 25KG
121375 Hard packages
An Import Control option and a Return Service option are not valid on the
121452 Hard same shipment.
Shipments cannot exceed a COD amount of $5,000 when requesting a
121460 Hard cashiers check or money order.
121500 Hard {Rating error description}

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 273
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

121501 Hard {Rating error Description}
121502 Hard The selected country does not allow forward movements.
121510 Hard Unsupported package type.
121511 Hard Unsupported accessory type
121512 Hard Unsupported billing option
121513 Hard Unsupported service
Weight of (actual weight) exceeds maximum for rating the requested
121515 Warning container. Using standard package rates.
The UPS account number specified for Transportation charges is invalid
121520 Hard for Split Duty VAT shipment.
121521 Hard Invalid payer of Duty and Tax
121523 Hard Invalid GoodsNotInFreeCirculationIndicator
The payer of Duty and Tax charges is not required for UPS Letter,
121524 Hard Documents of No Commercial Value or Qualified Domestic Shipments.
The payment method specified for Transportation charges is invalid for
121526 Hard return service.
121530 Hard The payer of Duty and Tax charges is required.
121531 Hard Invalid SplitDutyVATIndicator
The payer of Duty and Tax charges is invalid for Split Duty VAT
121532 Hard shipment.
The payer of Transportation charges and the payer of Duty and Tax
121534 Hard charges must not be the same for Split Duty VAT shipment.
The payer of Transportation charges is invalid for Split Duty VAT
121535 Hard shipment.
121536 Hard Bill Receiver is an invalid payer of an international return movement.
For a domestic return movement, the payer of the freight must be in the
121538 Hard country of the return movement
For an EU return movement, the payer of the freight must be in an EU
121539 Hard country.
The UPS Returns Flexible Access option is unavailable with the requested
121565 Hard accessory.
The UPS Returns Flexible Access option is available only with Return
121570 Hard Services Print Mail, Electronic Return Label, and Print Return Label.
The UPS Returns Flexible Access option is unavailable with Additional
121575 Hard Handling.
The UPS Returns Flexible Access option is unavailable with Large
121580 Hard Package.
The UPS Returns Flexible Access option is available for US and Puerto
121585 Hard Rico shippers only.
The maximum per package weight for the UPS Returns Flexible Access
121590 Hard option is ...
The maximum length (the longest side) of a UPS Returns Flexible Access
121595 Hard package is ...
The maximum length of the second-longest side of a UPS Returns Flexible
121600 Hard Access package is ...
The maximum total size constraint (length + girth, where girth is 2 x width
121605 Hard plus 2 x height) of a UPS Returns Flexible Access package is …

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 274
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

The maximum declared value amount for the UPS Returns Flexible Access
121610 Hard option is ...
All packages in the shipment must have the UPS Returns Flexible Access
121615 Hard option if 1 package has it.
121780 Hard Commercial Invoice Removal is valid only for Import Control shipments.
121801 Hard {0}
121802 Hard {0}
123005 Warning (Description)
123010 Warning Package(s) in this shipment contains a warning: (Description)
123020 Warning Invalid Ship From postal code
123021 Warning Invalid Ship To postal code
{Rating Error Description} The weight exceeds the limit for the UPS
123060 Warning Letter/Envelope rate and will be rated using the weight.
124022 Hard 'Invalid number of shipment level notifications
125000 Hard Missing or invalid shipment digest.
Invalid or missing international forms form type. Valid values are 01, 02,
128001 Hard
03 or 04
Invalid or missing forward agent company name. Valid length is 1 to 35
128002 Hard
alphanumeric
Invalid or missing forward agent tax id. Valid length is 1 to 15
128003 Hard
alphanumeric
Invalid or missing forward agent address line 1. Valid length is 1 to 35
128004 Hard
alphanumeric
128005 Hard Invalid forward agent address line 2. Valid length is 0 to 35 alphanumeric
128006 Hard Invalid forward agent address line 3. Valid length is 0 to 35 alphanumeric
128007 Hard Invalid or missing forward agent city. Valid length is 1 to 30 alphanumeric
Invalid forward agent state province code. Valid length is 0 to 5
128008 Hard
alphanumeric
128009 Hard Invalid forward agent postal code. Valid length is 0 to 9 alphanumeric
128010 Hard Invalid or missing forward agent country code
Invalid or missing ultimate consignee company name. Valid length is 1 to
128011 Hard
35 alphanumeric
Invalid or missing ultimate consignee addressLine1. Valid length is 1 to 35
128012 Hard
alphanumeric
Invalid ultimate consignee address line 2. Valid length is 0 to 35
128013 Hard
alphanumeric
Invalid ultimate consignee address line 3. Valid length is 0 to 35
128014 Hard
alphanumeric
Invalid or missing ultimate consignee city. Valid length is 1 to 30
128015 Hard
alphanumeric
128016 Hard Invalid ultimate consignee state province code. Valid length is 0 to 5
alphanumeric
128017 Hard Invalid ultimate consignee postal code. Valid length is 0 to 9 alphanumeric
128018 Hard Invalid or missing ultimate consignee country code
Invalid or missing intermediate consignee company name. Valid length is
128019 Hard
1 to 35 alphanumeric
Invalid or missing intermediate consignee address line 1. Valid length is 1
128020 Hard
to 35 alphanumeric

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 275
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

Invalid intermediate consignee address line 2. Valid length is 0 to 35
128021 Hard
alphanumeric
Invalid intermediate consignee address line 3. Valid length is 0 to 35
128022 Hard
alphanumeric
Invalid or missing intermediate consignee city. Valid length is 1 to 30
128023 Hard
alphanumeric
128024 Hard Invalid intermediate consignee state province code. Valid length is 0 to 5
alphanumeric
Invalid intermediate consignee postal code. Valid length is 0 to 9
128025 Hard
alphanumeric
128026 Hard Invalid or missing intermediate consignee country code
128027 Hard Invalid or missing producer option. Valid values are 01, 02, 03 or 04
Invalid or missing producer company name. Valid length is 1 to 35
128028 Hard
alphanumeric
Invalid or missing producer address line 1. Valid length is 1 to 35
128029 Hard
alphanumeric
128030 Hard Invalid producer address line 2. Valid length is 0 to 35 alphanumeric
128031 Hard Invalid producer address line 3. Valid length is 0 to 35 alphanumeric
128032 Hard Invalid or missing producer city. Valid length is 1 to 30 alphanumeric
128033 Hard
Invalid producer state province code. Valid length is 0 to 5 alphanumeric
128034 Hard Invalid producer postal code. Valid length is 0 to 9 alphanumeric
128035 Hard Invalid or missing producer country code
128036 Hard Invalid telephone number.
128030 Hard Invalid producer email address. Valid length is 0 to 50 alphanumeric
128030 Hard Invalid producer tax id. Valid length is 0 to 15 alphanumeric
128039 Hard Invalid number of products. Valid number of products are 1 to 50
128041 Hard The form specified for the product must be one of the requested forms.
If invoice is a requested international form, all specified products must
128042 Hard
belong to invoice
Invalid or missing product unit number for product number {0}. Valid
128043 Hard
length is 1 to 7 numeric
Invalid or missing Product/Unit/UnitOfMeasurement/Code for product
128044 Hard
number {0}. Valid length is 1 to 3 alphanumeric
Product/Unit/UnitOfMeasurement/Description is required when
128045 Hard Product/Unit/UnitOfMeasurement/Code is ""OTH"" for product number
{0}. Valid length is 1 to 3 alphanumeric
Invalid or missing product unit value for product number {0}. Valid length
128046 Hard
is 1 to 12 numeric and it can hold up to 6 decimal places
128047 Hard Invalid part number. Valid length is 0 to 10 alphanumeric
Invalid commodity code for product number {0}. Valid length is 6 to 15
128048 Hard
alphanumeric
128049 Hard Invalid or missing product origin country code for product number {0}
Invalid or missing net cost code for product number {0}. Valid values are
128050 Hard
NC or NO
Invalid or missing net cost date range begin date for product number {0}.
128051 Hard
Valid format is yyyyMMdd
Invalid or missing net cost date range end date for product number {0}.
128052 Hard
Valid format is yyyyMMdd

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 276
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

Invalid or missing preference criteria for product number {0}. Valid values
128053 Hard
are A through F
Invalid or missing producer info for product number {0}. Valid values are
128054 Hard
YES, NO[1], NO[2] or NO[3]
Invalid or missing marks and numbers for product number {0}. Valid
128055 Hard
length is 1 to 35 alphanumeric
Invalid or missing product weight unit of measurement code for product
128056 Hard
number {0}. Valid values are KGS or LBS
Invalid or missing product weight for product number {0}. Valid length is
128057 Hard
1 to 5 and it can hold up to 1 decimal places.
Invalid product vehicle ID for product number {0}. Valid length is 1 to 25
128058 Hard
alphanumeric
Invalid or missing product schedule B number for product number {0}.
128059 Hard
Valid length is 10 alphanumeric
Invalid product schedule B quantity for product number {0}. Valid length
128060 Hard
is 0 to 10 numeric
Invalid or missing product schedule B unit of measurement code for
128061 Hard
product number {0}. Valid length is 1 to 3 alphanumeric
Schedule B quantity is required when the schedule B unit of measurement
128062 Hard
code is not equal to X
Invalid or missing export type for product number {0}. Valid values are D,
128063 Hard
F or M
Invalid or missing SED total value for product number {0}. Valid length is
128064 Hard
1 to 15 numeric and can hold up to 2 decimal places
128065 Hard Invalid invoice number. Valid length is 0 to 35 alphanumeric
128066 Hard Invalid or missing invoice date. Valid format is yyyyMMdd
128067 Hard Invalid purchase order number. Valid length is 0 to 35 alphanumeric
128068 Hard Invalid terms of shipment.
128069 Hard Invalid or missing reason for export. Valid length is 1 to 20 alphanumeric
128070 Hard Invalid additional comments. Valid length is 0 to 150 alphanumeric
128071 Hard Invalid declaration statement. Valid length is 0 to 250 alphanumeric
Invalid discount monetary value. Valid length is 0 to 15 numeric and can
128072 Hard hold up to 2 decimal places. Discount can not be greater than the invoice
line total.
Invalid freight charges monetary value. Valid length is 0 to 15 numeric and
128073 Hard
can hold up to 2 decimal places.
Invalid other charges monetary value. Valid length is 0 to 15 numeric and
128074 Hard
can hold up to 2 decimal places.
Invalid or missing other charges description. Valid length is 1 to 10
128075 Hard
alphanumeric
128076 Hard Invalid or missing blanket period begin date. Valid format is yyyyMMdd
128077 Hard Invalid or missing blanket period end date. Valid format is yyyyMMdd
128078 Hard Invalid or missing export date. Valid format is yyyyMMdd
128079 Hard Invalid or missing export carrier. Valid length is 1 to 35 alphanumeric
128080 Hard Invalid carrier ID. Valid length is 0 to 2 alphanumeric
128081 Hard Invalid or missing in bond code. Valid length is 2 alphanumeric
Entry number is required when the in bond code is other than 70. Valid
128082 Hard
Length is 1 to 25 alpha numeric
128083 Hard Invalid or missing point of origin. Valid length is 1 to 5 alphanumeric

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 277
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

128084 Hard Invalid or missing mode of transport. Valid length is 1 to 35 alphanumeric
128085 Hard Invalid port of export. Valid length is 0 to 35 alphanumeric
128086 Hard
Invalid port of unloading. Valid length is 0 to 35 alphanumeric
128087 Hard Invalid loading pier. Valid length is 0 to 35 alphanumeric
128088 Hard Invalid or missing parties to transaction. Valid values are R or N
128089 Hard Invalid license number. Valid length is 0 to 35 alphanumeric
128090 Hard Invalid or missing license date. Valid format is yyyyMMdd
128091 Hard Invalid license exception code. Valid length is 0 to 4 alphanumeric
Either license number or license exception code must be present for a SED
128092 Hard
form.
128093 Hard Invalid ECCN number code. Valid length is 1 to 8 alphanumeric
Sold to information is required when an invoice or NAFTA CO is
128094 Hard
requested.
Invalid or missing sold to company name. Valid length is 1 to 35
128095 Hard
alphanumeric
Invalid or missing sold to address line 1. Valid length is 1 to 35
128096 Hard
alphanumeric
128097 Hard Invalid sold to address line 2. Valid length is 0 to 35 alphanumeric
128098 Hard Invalid sold to address line 3. Valid length is 0 to 35 alphanumeric
128099 Hard Invalid or missing sold to city. Valid length is 1 to 30 alphanumeric
128100 Hard Invalid sold to state province code. Valid length is 0 to 5 alphanumeric
128101 Hard Invalid sold to postal code. Valid length is 0 to 9 alphanumeric
128102 Hard Invalid or missing sold to country code
128103 Hard The selected international form is not valid for the shipment origin country
The selected international form is not valid for the shipment origin and
128104 Hard
product origin combination.
The selected international form is not valid for the shipment origin and
128105 Hard
destination countries
Invalid or missing sold to attention name. Valid value is 1 to 35
128109 Hard
alphanumeric
128110 Hard Invalid sold to option. Valid values are 01 or 02
128111 Hard Commodity code is required for NAFTA CO
Invalid insurance monetary value. Valid length is 0 to 15 numeric and can
128112 Hard
hold up to 2 decimal places.
Invalid product description for product number {0}. Product description
128113 Hard
should be present at least once. Valid range is 0 to 35 alphanumeric
128114 Hard Invalid or missing currency code. Valid length is 3 alphanumeric.
Invalid or missing sold to phone number. Valid length is 1 to 15
128115 Hard
alphanumeric.
Invalid sold to tax identification number. Valid length is 1 to 15
128116 Hard
alphanumeric.
128117 Hard Invalid or missing Shipper tax identification.
Invalid license information. Either license number and license date or
128118 Hard license exception code and ECCN number must be present. Both the
combinations can not be present together.
Invalid or missing product NumberOfPackagesPerCommodity. Valid
128119 Hard
length is 1-3 Numerics.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 278
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

128120 Hard
Origin country must be different than destination country.
128121 Hard Missing value of other unit of measurement.
128122 Hard
Invalid net cost date range.
128123 Hard Invoice cannot be requested for non-document forward shipments.
128124 Hard Invalid blanket period.
128125 Hard Invalid or missing ShipFrom tax identification.
Invalid or missing SED filing option. SED filing option is required when
128126 Hard
SED form is requested. Valid values are 01 and 02.
Invalid or missing international forms form type for shipment with return
128201 Hard
service. Valid value is 01 or 05.
128202 Hard International forms can not be requested for letters or documents.
128203 Hard Duplicate contact information
128204 Hard
Invalid form group id name. valid range is 0 to 50 alphanumeric
Duplicate International FormType Information. valid values are 01, 02, 03,
128205 Hard
04
Invalid combination of international forms. Both partial and complete
128210 Hard
invoice form cannot be selected together.
128211 Hard Invalid Email Address
128212 Hard Invalid or missing ShipTo tax identification.
Invalid or missing producer attention name. Valid value is 1 to 35
128213 Hard
alphanumeric
128214 Hard Invalid telephone extension. Valid length is 1 to 4 alphanumeric.
128215 Hard Invalid telephone extension. Valid length is 1 to 4 alphanumeric.
Invalid or missing international forms form type for ExcludeFromForm.
128216 Hard
Valid values are 04.
A NAFTA Certificate of Origin must have at least one commodity in a
128217 Hard
request.
128218 Hard A Commercial Invoice must have at least one commodity in a request.
128219 Hard A Blanket Period can not exceed 365 days.
128220 Hard The Total Product units allocated to packages do not match.
128221 Hard Product not associated with a package.
128222 Hard Invalid number of products. The valid number of products is 1 to 1000.
128223 Hard Invalid or missing DocumentID.
128224 Hard Invalid or missing Product Currency Code.
128225 Hard Invalid or missing Invoice Line Total.
128226 Hard Exceeds maximum number of International Forms (13) allowed per
Shipment.
128227 Hard Invalid or missing Package Number (Product is selected to be placed in a
Package that does not exist).
128228 Hard Invalid or missing Product number.
128229 Hard Invalid or missing packing list info.
128230 Hard Invalid or missing package associated data.
128231 Hard Invalid Product Id.
128232 Hard Exceeds the maximum number of packages allowed for the packing list

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 279
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

128233 Hard User generated forms size exceeds total allowable limit for shipment of
5MB.
128234 Hard Invalid or missing Shipper Memo.
128235 Hard Invalid PackageInfo object.
128236 Hard Invalid or missing Tracking Number.
128237 Hard No form data found for given formsGroupID.
128238 Hard No PDF found for given documentId.
128239 Hard Exceeds maximum number of Document IDs (13) allowed per Shipment.
128240 Hard Invalid or missing User Created Form Data.
128241 Hard A shipment can only contain one Commercial Invoice.
9120211 Hard Missing or invalid declared value currency code for package {0}.
9120212 Hard Missing or invalid declared value monetary value for package {0}.
9120213 Hard Shipper release is not allowed with return service.
The verbal confirmation of delivery option cannot be combined with the
9120214 Hard Return Services option.
9120215 Hard Missing verbal confirmation phone number for package {0}.
9120216 Hard Missing or invalid package notification code for package {0}.
9120217 Hard Missing package notification email information for package {0}.
9120218 Hard Missing or invalid notification email address for package {0}.
Receiver Return Notification is not allowed for the shipment without
9120219 Hard return service.
9120225 Hard Missing commodity information for package{0}
9120226 Hard Missing package NMFC prime code of commodity for package{0}
9120227 Hard Missing package weight container information for package{0}
9120228 Hard Missing packaging type for Package {0}.
9120241 Hard Missing label specification information.
9120242 Hard Missing label specification label image format.
9120243 Hard Missing label specification label image format Code.
9120244 Hard Missing label specification label stock size.
9120245 Hard Invalid label specification label stock dimensions.
9120300 Hard Cannot use multiple types of currency in a shipment.
9120301 Hard A shipment can have only one type of unit of measurement for dimensions.
9120302 Hard A shipment can have only one type of unit of measurement for a weight.
9120400 Hard Missing or invalid shipment digest.
9120401 Hard Invalid shipment object.
9120800 Hard Missing contact information.
9120801 Hard Missing sold to address information.
9120802 Hard No more than 3 address line information can be given for sold to address.
9120803 Hard Missing forward agent address information.
No more than 3 address line information can be given for forward agent
9120804 Hard address.
9120805 Hard Missing intermediate consignee address information.
No more than 3 address line information can be given for intermediate
9120806 Hard consignee address.
9120807 Hard Missing ultimate consignee address information.
9120808 Hard No more than 3 address line information can be given for ultimate

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 280
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

consignee address.
9120809 Hard Missing producer information.
9120810 Hard Missing producer address information.
No more than 3 address line information can be given for producer
9120811 Hard address.
9120812 Hard Missing product weight information for product number {0}.
Missing product weight unit of measurement information for product
9120813 Hard number {0}.
9120814 Hard Missing product unit information for product number {0}.
9120815 Hard Missing product unit of measurement information for product number {0}.
9120816 Hard Missing schedule B information for product number {0}.
Missing schedule B unit of measurement information for product number
9120817 Hard {0}.
9120818 Hard Missing blanket period information.
9120819 Hard Missing license information.
9121000 Hard Invalid Ship Request Document
9129087 Hard Invalid Shipment Delivery Confirmation Type
129203 Hard Account is not authorized for UPS Exchange service
129204 Hard Account is not authorized for UPS Pack and Collect service
126086 Hard PreAlertNotification Phone Number is missing
126087 Hard PreAlert Notification Phone Number may not exceed length of 15
126088 Hard PreAlertNotification Dialect length must be less than or equal to 2
126089 Hard PreAlertNotification Language-Dialect Pair not valid
Pre-alert notification is valid only with UPS Returns Exchange and UPS
126090 Hard Returns Pack and Collect shipments
126091 Hard Notification Language is missing
126092 Hard Notification Dialect is missing
126093 Hard Notification Language must be less than or equal to 3
9120246 Hard Missing/Invalid Label Instruction Code
9120247 Hard Invalid set of Label Instruction Codes
9120248 Hard LabelSpecification/Instruction is not allowed with the shipment
124998 Hard ReceiptSpecification applies only for PRL or Exchange Return Receipt.
124999 Hard Invalid ImageFormat code
9126005 Hard DryIce DryIceWeight Weight is absent or doesn't meet specification.
9126007 Hard DryIce DryIceWeight UnitOfMeasurment Code has invalid value.
9126044 Hard DryIce Regulation is required or has invalid value.
126000 Hard Shipper is not eligible to ship Dry Ice.
All packages with DryIce RegulationSet must contain the same Regulation
126008 Hard Set.
126009 Hard DryIce RegulationSet for non-US PR origins destinations should be IATA.
126010 Hard DryIce DryIceWeight Weight cannot be larger than package weight.
126077 Hard Number of DryIce items per Package is greater than 1.
126078 Hard DryIce item cannot exist on the same package as another HazMat.
20004 Hard Cannot access the high level business components, {0}
20005 Hard Cannot access the low level business components, {0}
20007 Hard Missing required field, {0}

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 281
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

20008 Hard The field, {0}, contains invalid data, {1}
20010 Hard The phone number contains invalid characters
20011 Hard The Integration Indicator is no longer supported
250010 Hard Illegal Request Action
250011 Hard Illegal Request Option
250012 Hard No tool is requested
250019 Hard Invalid field value
250020 Hard Invalid developer license number
250021 Hard The data length is in error for CompanyName
250022 Hard The data length is in error for AddressLine1
250023 Hard The data length is in error for AddressLine2
250024 Hard The data length is in error for AddressLine3
250025 Hard The data length is in error for City
250026 Hard Invalid country code
250027 Hard The data is in error for StateProvinceCode
250028 Hard The data length is in error for PostalCode
250029 Hard The data is in error for phone number
250030 Hard Invalid e-mail address
250031 Hard Invalid URL
250032 Hard Invalid Country Code in AccessLicenseProfile
250033 Hard Invalid Language Code in AccessLicenseProfile
250034 Hard Invalid ToolVersion
250035 Hard The data length is in error for the name of contact person
250036 Hard The data length is in error for the title of contact person
250037 Hard The data is in error for fax number
250038 Hard Error in Shipper Number
250040 Hard Client software profile is missed for the 3rd party developer license
250041 Hard Invalid ToolID
250042 Hard Tool Version not available for the Access License
250043 Hard Tool ID not available for the Access License
250044 Hard Tool Version not licensed for developer
250045 Hard Tool already licensed
250046 Hard User already has a license
250047 Hard License number revoked
250048 Hard Missing License Agreement Text
250049 Hard Invalid License Agreement Text
250051 Hard Not allowed to create new license
250052 Hard Authorization system is currently unavailable
250060 Hard The data length is in error for the Software Installer
250061 Hard The data length is in error for the Software Product Name
250062 Hard The data length is in error for the Software Provider
250063 Hard The data length is in error for the Software Version Number
250064 Hard Invalid ToolID/ToolVersion
110001 Hard XML Rating and Service Selection Service Unavailable
120001 Hard XML Shipping System is unavailable, please try again later.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 282
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

150000 Hard Tracking service unavailable
9120068 Hard Either credit card or account number information is needed but not both.
Invalid or missing international forms form type for ExcludeFromForm.
128216 Hard Valid values are 04.
A NAFTA Certificate of Origin must have at least one commodity in the
128217 Hard request.
128218 Hard A Commercial Invoice must have at least one commodity in the request.
120910 TPFCNegotiatedRatesIndicator is applicable only for Third party/Freight
Warning Collect shipments.
120911 Shipper not authorized to request for the Third Party/Freight Collect
Warning negotiated rates for this shipment.
126098 Warning Account authentication is required to be completed to get negotiated rates.
126099 Warning Credit Card is the only valid payment method for this type of account.
PackageServiceOption HazMat Quantity is absent or doesn't meet
9126004 Hard specification.
9126006 Hard PackageServiceOption HazMat TransportationMode has invalid value.
9126030 Hard PackageServiceOption HazMat Regulation required or has invalid value.
Shipper is not eligible to ship Hazardous Material / International
126001 Hard Dangerous Goods.
126004 Hard HazMat Quantity is absent or doesn't meet specification.
126006 Hard HazMat TransportationMode has invalid value.
Package/HazMatPackageInformation required with either
126011 Hard AllPackedInOneIndicator/OverPackedIndicator values.
126032 Hard HazMat ClassDivisionNumber is required.
126033 Hard HazMat ClassDivisionNumber exceeds maximum length of 7 characters.
126034 Hard HazMat ClassDivisionNumber violates datatype. Only ASCII allowed.
126035 Hard HazMat Quantity is required.
126036 Hard HazMat Quantity exceeds maximum value.
126038 Hard HazMat UOM not set or invalid.
126039 Hard HazMat UOM value exceeds maximum length of 10 characters.
126040 Hard HazMat UOM violates datatype only ASCII allowed.
126041 Hard HazMat ProperShippingName is required and not set.
126042 Hard HazMat ProperShippingName exceeds maximum length of 150 characters.
126043 Hard HazMat ProperShippingName violates datatype only ASCII allowed.
126045 Hard HazMat ReferenceNumber exceeds maximum of 15 characters.
126046 Hard HazMat ReferenceNumber violates datatype only ASCII allowed.
126047 Hard HazMat ReportableQuantity exceeds maximum length of 2 characters.
126048 Hard HazMat ReportableQuantity violates datatype only ASCII allowed.
126051 Hard HazMat IDNumber Number exceeds maximum length of 6 characters.
126052 Hard HazMat IDNumber Number violates datatype only ASCII allowed.
126055 Hard HazMat PackagingGroupType exceeds maximum length of 5 characters.
126056 Hard HazMat PackagingGroupType violates datatype only ASCII allowed.
126059 Hard HazMat PackagingInstructionCode is Required.
HazMat PackagingInstructionCode exceeds maximum length of 4
126060 Hard characters.
126061 Hard HazMat PackagingInstructionCode violates datatype only ASCII allowed.
126062 Hard HazMat TransportationMode exceeds maximum length of 30 characters.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 283
Shipping Package – WebServices 7/09/2012

Error Code Severity Description

126063 Hard HazMat TransportationMode violates datatype only ASCII allowed.
126064 Hard HazMat EmergencyPhone required since Regulation Set is TDG
HazMat EmergencyPhone Number exceeds maximum length of 25
126065 Hard characters.
126066 Hard HazMat EmergencyPhone Number violates datatype only ASCII allowed.
HazMat AdditionalDescription Info exceeds maximum length of 255
126069 Hard characters.
126070 Hard HazMat AdditionalDescription Info violates datatype only ASCII allowed.
126071 Hard HazMat PackagingType is required.
126072 Hard HazMat PackagingType exceeds maximum length of 255 characters.
126073 Hard HazMat PackagingType violates datatype only ASCII allowed.
126076 Hard Number of HazMat entities per package cannot be greater than 3.
126079 Hard HazMat EmergencyContact Information is required for this shipment
HazMat EmergencyContact Information exceeds maximum length of 35
126080 Hard characters.
HazMat EmergencyContact Information violates datatype only ASCII
126081 Hard allowed.
126082 Hard Package HazMatPackageInformation AllPackedInOneIndicator is optional.
126083 Hard Package HazMatPackageInformation OverpackedIndicator is optional.
Package HazMatPackageInformation QValue must exist with
126084 Hard RegulationSet IATA when AllPackedInOneIndicator present.
HazMatPackageInformation QValue must be decimal value with one
126085 Hard significant digit.
120444 Hard Invalid Bill-To type

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 284
Shipping Package – WebServices 7/09/2012

Appendix C - Void Shipment Web Services Error Codes

If you get a < VoidShipmentResponse > in a SOAP Envelope’s Body part, it means the request is
processed successfully. Otherwise, a SOAP Fault will be returned in a SOAP Envelope’s Body part.
In a good response, check the ResponseStatusCode element. A “1” normally indicates a successful
response. When you get a SOAP FAULT, check the Errors and the sub-element ErrorDetail. The
value of <Severity> can be either Transient or Hard. When an error occurs there will also be an
error code, and an error description in PrimaryErrorCode element.

 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, it is a
user error. 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 Severity Description
190001 Transient Void not available at this time
190002 Transient Invalid/Missing registration ID
190100 Hard Invalid ShipmentIdentificationNumber.
190101 Hard Time for voiding has expired.

190102 Hard No shipment found within the allowed void period

The Pickup Request associated with this shipment has already

190103 Hard been completed
190104 Hard Return shipments cannot be voided.

190105 Hard Pickup Cancellation is not Available on this Pickup Request

190106 Hard Pickup Cancellation is not Available on this Pickup Request

The Pickup Request associated with this shipment has previously

190107 Hard been canceled
The Pickup Request associated with this shipment cannot be
190108 Hard canceled
190109 Hard Invalid TrackingNumber
190110 Hard Invalid Void Package {0}
190111 Hard Package Void Limit Exceeded

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 285
Shipping Package – WebServices 7/09/2012

Error
Code Severity Description

190112 Hard Return Service Shipments cannot be Voided at the Package Level

190113 Hard International Shipments cannot be Voided at the Package Level

190114 Hard Invalid Return Service Void Date
190115 Hard Invalid Void Date
A Label cannot be generated for a voided Return Service
190116 Hard Shipment
190117 Hard The Shipment has already been voided
190118 Hard Same Day Service Void Not Allowed.

The requested Void was successful, but the associated Pickup was
190119 Warning not Cancelled

190121 Hard None of the submitted packages were voided

190122 Hard Package(s) {0} selected to void is(are) invalid

Import Control Shipment cannot be voided later than 3 am of the

190124 Hard day after the shipment uploaded.
Import Control Shipments does not allow package void in a
190125 Hard shipment

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 286
Shipping Package – WebServices 7/09/2012

Appendix D – Common error codes for all webservices

Common Errors can apply to all web services;

Code Severity Description

10001 Hard The XML document is not well formed

10002 Hard The XML document is well formed but the document is not valid
10003 Hard The XML document is either empty or null

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

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

20001 Transient General process failure
The specified service name, {0}, and version number, {1}, combination is
20002 Hard invalid

20003 Hard Please check the server environment for the proper J2EE ws apis
20006 Hard Invalid request action

20012 Hard The Client Information exceeds its Maximum Limit of {0}
250000 Hard No XML declaration in the XML document

250001 Hard Invalid Access License for the tool. Please re-license.
250002 Hard Invalid UserId/Password
250003 Hard Invalid Access License number
250004 Hard Incorrect UserId or Password
250005 Hard No Access and Authentication Credentials provided

250006 Hard The maximum number of user access attempts was exceeded

250007 Hard The UserId is currently locked out; please try again in 24 hours.
250009 Hard License Number not found in the UPS database
250050 Transient License system not available

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 287
Shipping Package – WebServices 7/09/2012

Appendix E - 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 Forward Return

Code Country Name Origin Origin
AF Afghanistan
AX Åland Islands
AL Albania Yes
DZ Algeria
AS American Samoa
AD Andorra Yes
AO Angola
AI Anguilla Yes
AQ Antarctica
AG Antigua and Barbados Yes
AR Argentina Yes Yes
AM Armenia
AW Aruba
AU Australia Yes Yes
AT Austria Yes Yes
AZ Azerbaijan
BS Bahamas Yes
BH Bahrain Yes
BD Bangladesh
BB Barbados
BY Belarus
BE Belgium Yes Yes
BZ Belize
BJ Benin
BM Bermuda Yes Yes
BT Bhutan
BO Bolivia Yes
BA Bosnia and Herzegovina
BW Botswana
BV Bouvet Island
BR Brazil Yes Yes
British Indian Ocean
IO Territory
BN Brunei Darussalam

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 288
Shipping Package – WebServices 7/09/2012

Country Forward Return

Code Country Name Origin Origin
BG Bulgaria Yes
BF Burkina Faso
BI Burundi
KH Cambodia
CM Cameroon
CA Canada Yes Yes
CV Cape Verde
KY Cayman Islands Yes
CF Central African Republic
TD Chad
CL Chile Yes Yes
CN China Yes Yes
CX Christmas Island
CC Cocos (Keeling) Islands
CO Colombia Yes Yes
KM Comoros
CG Congo
Congo, The Democratic
CD Republic of
CK Cook Islands
CR Costa Rica Yes Yes
CI Côte Divoire
HR Croatia Yes
CU Cuba
CY Cyprus Yes
CZ Czech Republic Yes Yes
DK Denmark Yes Yes
DJ Djibouti
DM Dominica
DO Dominican Republic Yes Yes
EC Ecuador Yes Yes
EG Egypt Yes
SV El Salvador Yes Yes
GQ Equatorial Guinea
ER Eritrea
EE Estonia Yes
ET Ethiopia
FK Falkland Islands (Malvinas)
FO Faroe Islands
FJ Fiji
FI Finland Yes Yes
FR France Yes Yes
GF French Guiana
PF French Polynesia

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 289
Shipping Package – WebServices 7/09/2012

Country Forward Return

Code Country Name Origin Origin
TF French Southern Territories
GA Gabon
GM Gambia
GE Georgia
DE Germany Yes Yes
GH Ghana
GI Gibraltar
GR Greece Yes Yes
GL Greenland
GD Grenada Yes
GP Guadeloupe
GU Guam
GT Guatemala Yes Yes
GG Guernsey Yes Yes
GN Guinea
GW Guinea-Bissau
GY Guyana
HT Haiti Yes
Heard Island and
HM McDonald Islands
Holy See (Vatican City
VA State)
HN Honduras Yes Yes
HK Hong Kong Yes Yes
HU Hungary Yes Yes
IS Iceland Yes
IN India Yes Yes
ID Indonesia Yes Yes
IR Iran, Islamic Republic of
IQ Iraq
IE Ireland Yes Yes
IM Isle of Man

IL Israel Yes Yes

IT Italy Yes Yes
JM Jamaica Yes
JP Japan Yes Yes
JE Jersey Yes Yes
JO Jordan
KZ Kazakhstan
KE Kenya
KI Kiribati
Korea, Democratic Peoples
KP Republic of

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 290
Shipping Package – WebServices 7/09/2012

Country Forward Return

Code Country Name Origin Origin
KR Korea, Republic of Yes Yes
KW Kuwait Yes
KG Kyrgyzstan
Lao Peoples Democratic
LA Republic
LV Latvia Yes
LB Lebanon Yes
LS Lesotho
LR Liberia
LY Libyan Arab Jamahiriya
LI Liechtenstein Yes
LT Lithuania Yes
LU Luxembourg Yes
MO Macao Yes Yes
Macedonia, The Former
MK Yugoslav Republic of
MG Madagascar
MW Malawi
MY Malaysia Yes Yes
MV Maldives
ML Mali
MT Malta Yes
MH Marshall Islands
MQ Martinique Yes
MR Mauritania
MU Mauritius
YT Mayotte
MX Mexico Yes Yes
Micronesia, Federated
FM States of
MD Moldova, Republic of
MC Monaco Yes
MN Mongolia
ME Montenegro Yes
MS Montserrat Yes
MA Morocco
MZ Mozambique
MM Myanmar
NA Namibia
NR Nauru
NP Nepal
NL Netherlands Yes Yes
AN Netherlands Antilles
NC New Caledonia

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 291
Shipping Package – WebServices 7/09/2012

Country Forward Return

Code Country Name Origin Origin
NZ New Zealand Yes Yes
NI Nicaragua Yes Yes
NE Niger
NG Nigeria Yes
NG Nigeria
NU Niue
NF Norfolk Island
MP Northern Mariana Islands
NO Norway Yes Yes
OM Oman Yes
PK Pakistan Yes
PW Palau Yes
Palestinian Territory,
PS Occupied
PA Panama Yes Yes
PG Papua New Guinea
PY Paraguay Yes Yes
PE Peru Yes Yes
PH Philippines Yes Yes
PN Pitcairn
PL Poland Yes Yes
PT Portugal Yes Yes
PR Puerto Rico Yes Yes
QA Qatar Yes
RE Réunion
RO Romania Yes Yes
RU Russian Federation Yes Yes
RW Rwanda
SH Saint Helena
KN Saint Kitts and Nevis Yes
LC Saint Lucia Yes
PM Saint Pierre and Miquelon
Saint Vincent and The
VC Grenadines Yes
WS Samoa
SM San Marino Yes
ST Sao Tome and Principe
SA Saudi Arabia Yes
SN Senegal
RS Serbia Yes
SC Seychelles
SL Sierra Leone
SG Singapore Yes Yes
SK Slovakia Yes

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 292
Shipping Package – WebServices 7/09/2012

Country Forward Return

Code Country Name Origin Origin
SI Slovenia Yes
SB Solomon Islands
SO Somalia
ZA South Africa Yes

South Georgia and

GS The South Sandwich Islands
ES Spain Yes Yes
LK Sri Lanka Yes
SD Sudan
SR Suriname Yes
SJ Svalbard and Jan Mayen
SZ Swaziland
SE Sweden Yes Yes
CH Switzerland Yes Yes
SY Syrian Arab Republic
TW Taiwan, Province of China Yes Yes
TJ Tajikistan
TZ Tanzania, United Republic of
TH Thailand Yes Yes
TL Timor-Leste
TG Togo
TK Tokelau
TO Tonga
TT Trinidad and Tobago
TN Tunisia Yes
TR Turkey Yes Yes
TM Turkmenistan
TC Turks and Caicos Islands Yes
TV Tuvalu
UG Uganda
UA Ukraine Yes
AE United Arab Emirates Yes
GB United Kingdom Yes Yes
US United States Yes Yes
United States Minor
UM Outlying Islands
UY Uruguay Yes Yes
UZ Uzbekistan
VU Vanuatu
VE Venezuela Yes Yes
VN Viet Nam Yes
VG Virgin Islands, British
VI Virgin Islands, U.S. Yes Yes

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 293
Shipping Package – WebServices 7/09/2012

Country Forward Return

Code Country Name Origin Origin
WF Wallis and Futuna
EH Western Sahara
YE Yemen
ZM Zambia
ZW Zimbabwe

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 294
Shipping Package – WebServices 7/09/2012

Appendix F - 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 Currency Name Currency Code

Afghanistan Afghani AFN
Albania Lek ALL
Algeria Algerian Dinar DZD
American Samoa US Dollar USD
Andorra Euro EUR
Angola Kwanza AOA
Anguilla East Caribbean Dollar XCD
Antigua And Barbuda East Caribbean Dollar XCD
Argentina Argentine Peso ARS
Armenia Armenian Dram AMD
Aruba Aruban Guilder AWG
Australia Australian Dollar AUD
Austria Euro EUR
Azerbaijan Azerbaijanian Manat AZN
Bahamas Bahamian Dollar BSD
Bahrain Bahraini Dinar BHD
Bangladesh Taka BDT
Barbados Barbados Dollar BBD
Belarus Belarussian Ruble BYR
Belgium Euro EUR
Belize Belize Dollar BZD
Benin CFA Franc BCEAO XOF
Bermudian Dollar
(customarily known as
Bermuda Bermuda Dollar) BMD
Bhutan Indian Rupee INR
Bhutan Ngultrum BTN
Bolivia Boliviano BOB
Bolivia Mvdol BOV
Bosnia and Herzegovina Convertible Marks BAM
Botswana Pula BWP
Bouvet Island Norwegian Krone NOK
Brazil Brazilian Real BRL

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 295
Shipping Package – WebServices 7/09/2012

British Indian Ocean

Territory US Dollar USD
Brunei Darussalam Brunei Dollar BND
Bulgaria Bulgarian Lev BGN
Burkina Faso CFA Franc BCEAO XOF
Burundi Burundi Franc BIF
Cambodia Riel KHR
Cameroon US Dollar USD
Canada Canadian Dollar CAD
Cape Verde Cape Verde Escudo CVE
Cayman Islands Cayman Islands Dollar KYD
Central African Republic CFA Franc BEAC XAF
Chad CFA Franc BEAC XAF
Chile Chilean Peso CLP
Chile Unidades de formento CLF
China Yuan Renminbi RMB
Christmas Island Australian Dollar AUD
Cocos (Keeling) Islands Australian Dollar AUD
Colombia Colombian Peso COP
Colombia Unidad de Valor Real COU
Comoros Comoro Franc KMF
Congo CFA Franc BEAC XAF
Congo, The Democratic Republic of Franc Congolais CDF
Cook Islands New Zealand Dollar NZD
Costa Rica Costa Rican Colon CRC
Côte Divoire CFA Franc BCEAO XOF
Croatia Croatian Kuna HRK
Cuba Cuban Peso CUP
Cyprus Euro EUR
Czech Republic Czech Koruna CZK
Denmark Danish Krone DKK
Djibouti Djibouti Franc DJF
Dominica East Caribbean Dollar XCD
Dominican Republic Dominican Peso DOP
Ecuador US Dollar USD
Egypt Egyptian Pound EGP
El Salvador El Salvador Colon SVC
El Salvador US Dollar USD
Equatorial Guinea CFA Franc BEAC XAF
Eritrea Nakfa ERN
Estonia Euro EUR
Ethiopia Ethiopian Birr ETB
Falkland Islands (Malvinas) Falkland Islands Pound FKP
Faroe Islands Danish Krone DKK
Fiji Fiji Dollar FJD
Finland Euro EUR

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 296
Shipping Package – WebServices 7/09/2012

France Euro EUR

French Guiana Euro EUR
French Polynesia CFP Franc XPF
French Southern Territories Euro EUR
Gabon CFA Franc BEAC XAF
Gambia Dalasi GMD
Georgia Lari GEL
Germany Euro EUR
Ghana Cedi GHS
Gibraltar Gibraltar Pound GIP
Greece Euro EUR
Greenland Danish Krone DKK
Grenada East Caribbean Dollar XCD
Guadeloupe Euro EUR
Guam US Dollar USD
Guatemala Quetzal GTQ
Guernsey Pound Sterling GBP
Guinea Guinea Franc GNF
Guinea-Bissau Guinea-Bissau Peso GWP
Guinea-Bissau CFA Franc BCEAO XOF
Guyana Guyana Dollar GYD
Haiti Gourde HTG
Haiti US Dollar USD
Heard Island ond
Mcdonald Islands Australian Dollar AUD
Holy See (Vatican
City State) Euro EUR
Honduras Lempira HNL
Hong Kong Hong Kong Dollar HKD
Hungary Forint HUF
Iceland Iceland Krona ISK
India Indian Rupee INR
Indonesia Rupiah IDR
Iran (Islamic Republic of) Iranian Rial IRR
Iraq Iraqi Dinar IQD
Ireland Euro EUR
Israel New Israeli Sheqel ILS
Italy Euro EUR
Jamaica Jamaican Dollar JMD
Japan Yen JPY
Jersey Pound Sterling GBP
Jordan Jordanian Dinar JOD
Kazakhstan Tenge KZT
Kenya Kenyan Shilling KES
Kiribati Australian Dollar AUD

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 297
Shipping Package – WebServices 7/09/2012

Korea, Democratic
Peoples Republic of North Korean Won KPW
Korea, Republic of Won KRW
Kuwait Kuwaiti Dinar KWD
Kyrgyzstan Som KGS
Lao Peoples Democratic
Republic Kip LAK
Latvia Latvian Lats LVL
Lebanon Lebanese Pound LBP
Lesotho Rand ZAR
Lesotho Loti LSL
Liberia Liberian Dollar LRD
Libyan Arab Jamahiriya Libyan Dinar LYD
Liechtenstein Swiss Franc CHF
Lithuania Lithuanian Litas LTL
Luxembourg Euro EUR
Macao Pataca MOP
Macedonia, The Former
Yugoslav Republic of Denar MKD
Madagascar Malagascy Ariary MGA
Malawi Kwacha MWK
Malaysia Malaysian Ringgit MYR
Maldives Rufiyaa MVR
Mali CFA Franc BCEAO XOF
Malta Euro EUR
Marshall Islands US Dollar USD
Martinique Euro EUR
Mauritania Ouguiya MRO
Mauritius Mauritius Rupee MUR
Mayotte Euro EUR
Mexico Mexican Peso MXN
Mexican Unidad de
Mexico Inversion (UID) MXV
Micronesia (Federated
States of) US Dollar USD
Moldova, Republic of Moldovan Leu MDL
Monaco Euro EUR
Mongolia Tugrik MNT
Montenegro Euro EUR
Montserrat East Caribbean Dollar XCD
Morocco Moroccan Dirham MAD
Mozambique Metical MZN
Myanmar Kyat MMK
Namibia Rand ZAR
Namibia Namibian Dollar NAD
Nauru Australian Dollar AUD

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 298
Shipping Package – WebServices 7/09/2012

Nepal Nepalese Rupee NPR

Netherlands Euro EUR
Netherlands Antillian
Netherlands Antilles Guilder ANG
New Caledonia CFP Franc XPF
New Zealand New Zealand Dollar NZD
Nicaragua Cordoba Oro NIO
Niger CFA Franc BCEAO XOF
Nigeria Naira NGN
Niue New Zealand Dollar NZD
Norfolk Island Australian Dollar AUD
Northern Mariana Islands US Dollar USD
Norway Norwegian Krone NOK
Oman Rial Omani OMR
Pakistan Pakistan Rupee PKR
Palau US Dollar USD
Panama Balboa PAB
Panama US Dollar USD
Papua New Guinea Kina PGK
Paraguay Guarani PYG
Peru Nuevo Sol PEN
Philippines Philippine Peso PHP
Pitcairn New Zealand Dollar NZD
Poland Zloty PLN
Portugal Euro EUR
Puerto Rico US Dollar USD
Qatar Qatari Rial QAR
Réunion Euro EUR
Romania New Leu RON
Russian Federation Russian Ruble RUB
Rwanda Rwanda Franc RWF
Saint Helena Saint Helena Pound SHP
Saint Kitts and Nevis East Caribbean Dollar XCD
Saint Lucia East Caribbean Dollar XCD
Saint Pierre and Miquelon Euro EUR
Saint Vincent and The
Grenadines East Caribbean Dollar XCD
Samoa Tala WST
San Marino Euro EUR
São Tome and Principe Dobra STD
Saudi Arabia Saudi Riyal SAR
Senegal CFA Franc BCEAO XOF
Serbia Serbian Dinar RSD
Seychelles Seychelles Rupee SCR
Sierra Leone Leone SLL
Singapore Singapore Dollar SGD

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 299
Shipping Package – WebServices 7/09/2012

Slovakia Euro EUR

Slovenia Euro EUR
Solomon Islands Solomon Islands Dollar SBD
Somalia Somali Shilling SOS
South Africa Rand ZAR
Spain Euro EUR
Sri Lanka Sri Lanka Rupee LKR
Sudan Sudanese Dinar SDD
Suriname Surinam Dollar SRD
Svalbard and Jan Mayen Norwegian Krone NOK
Swaziland Lilangeni SZL
Sweden Swedish Krona SEK
Switzerland Swiss Franc CHF
Switzerland WIR Franc CHW
Switzerland WIR Euro CHE
Syrian Arab Republic Syrian Pound SYP
Taiwan, Province of China New Taiwan Dollar TWD
Tajikistan Somoni TJS
Tanzania, United Republic
of Tanzanian Shilling TZS
Thailand Baht THB
Timor-Leste US Dollar USD
Togo CFA Franc BCEAO XOF
Tokelau New Zealand Dollar NZD
Tonga Paanga TOP
Trinidad and Tobago
Trinidad And Tobago Dollar TTD
Tunisia Tunisian Dinar TND
Turkey New Turkish Lira TRY
Turkmenistan Manat TMM
Turks And Caicos Islands US Dollar USD
Tuvalu Australian Dollar AUD
Uganda Uganda Shilling UGX
Ukraine Hryvnia UAH
United Arab Emirates UAE Dirham AED
United Kingdom Pound Sterling GBP
United States US Dollar USD
United States Minor Outlying Islands US Dollar USD
Uruguay Peso Uruguayo UYU
Uruguay Peso en
Unidades
Uruguay Indexadas UYI
Uzbekistan Uzbekistan Sum UZS
Vanuatu Vatu VUV
Venezuela Bolivar VEB
Viet Nam Dong VND

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 300
Shipping Package – WebServices 7/09/2012

Virgin Islands (British) US Dollar USD

Virgin Islands (US) US Dollar USD
Wallis And Futuna CFP Franc XPF
Western Sahara Moroccan Dirham MAD

Yemen Yemeni Rial YER

Zambia Kwacha ZMK
Zimbabwe Zimbabwe Dollar ZWD

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 301
Shipping Package – WebServices 7/09/2012

Appendix G - 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.

Shipping Rating
Service Service
Description Category Code Code
UPS Express Polish Domestic Shipments 07 07
UPS ExpeditedSM Polish Domestic Shipments 08 08
UPS Standard Polish Domestic Shipments 11 11
UPS Worldwide Express PlusSM Polish Domestic Shipments 54 54
UPS Saver Polish Domestic Shipments 65 65
UPS Today StandardSM Polish Domestic Shipments 82 82
UPS Today Dedicated CourrierSM Polish Domestic Shipments 83 83
UPS Today Express Polish Domestic Shipments 85 85
UPS Today Express Saver Polish Domestic Shipments 86 86
UPS Express Shipments Originating in Canada 01 01
UPS Worldwide ExpeditedSM Shipments Originating in Canada 08 02
UPS Standard Shipments Originating in Canada 11 11
UPS Three-Day Select® Shipments Originating in Canada 12 12
UPS Express Early A.M. SM Shipments Originating in Canada 14 14
UPS Saver SM Shipments Originating in Canada 65 13
Shipments Originating in Canada
UPS Express to the United States 01 07
UPS Express Shipments Originating in Mexico 07 07
UPS ExpeditedSM Shipments Originating in Mexico 08 08
UPS Standard Shipments Originating in Mexico 11 11
UPS Express Plus Shipments Originating in Mexico 54 54
UPS Saver Shipments Originating in Mexico 65 65
UPS Express Shipments Originating in Other Countries 07 07
UPS Worldwide ExpeditedSM Shipments Originating in Other Countries 08 08
UPS Standard Shipments Originating in Other Countries 11 11
UPS Worldwide Express PlusSM Shipments Originating in Other Countries 54 54
UPS Saver Shipments Originating in Other Countries 65 65
UPS Next Day Air® Shipments Originating in Puerto Rico 01 01
UPS Second Day Air® Shipments Originating in Puerto Rico 02 02
UPS Ground Shipments Originating in Puerto Rico 03 03
UPS Worldwide ExpressSM Shipments Originating in Puerto Rico 07 07
UPS Worldwide ExpeditedSM Shipments Originating in Puerto Rico 08 08
UPS Next Day Air® Early A.M. SM Shipments Originating in Puerto Rico 14 14
UPS Worldwide Express PlusSM Shipments Originating in Puerto Rico 54 54
UPS Saver Shipments Originating in Puerto Rico 65 65
UPS Express Shipments Originating in the European Union 07 07

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 302
Shipping Package – WebServices 7/09/2012

UPS ExpeditedSM Shipments Originating in the European Union 08 08

UPS Standard Shipments Originating in the European Union 11 11
UPS Worldwide Express PlusSM Shipments Originating in the European Union 54 54
UPS Saver Shipments Originating in the European Union 65 65
UPS Next Day Air® Shipments Originating in United States 01 01
UPS Second Day Air® Shipments Originating in United States 02 02
UPS Ground Shipments Originating in United States 03 03
UPS Worldwide ExpressSM Shipments Originating in United States 07 07
UPS Worldwide ExpeditedSM Shipments Originating in United States 08 08
UPS Standard Shipments Originating in United States 11 11
UPS Three-Day Select® Shipments Originating in United States 12 12
UPS Next Day Air® Early A.M. SM Shipments Originating in United States 14 14
UPS Worldwide Express PlusSM Shipments Originating in United States 54 54
UPS Second Day Air A.M.® Shipments Originating in United States 59 59
UPS Saver Shipments Originating in United States 65 65
UPS Next Day Air® United States Domestic Shipments 01 01
UPS Second Day Air® United States Domestic Shipments 02 02
UPS Ground United States Domestic Shipments 03 03
UPS Three-Day Select® United States Domestic Shipments 12 12
UPS Next Day Air Saver® United States Domestic Shipments 13 13
UPS Next Day Air® Early A.M. SM United States Domestic Shipments 14 14
UPS Second Day Air A.M.® United States Domestic Shipments 59 59
UPS Saver United States Domestic Shipments 65 65

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 303
Shipping Package – WebServices 7/09/2012

Appendix H - Reference Number Codes

Shipments and packages may include a reference number. The type of reference number may be
indicated by a reference number code. The following table lists the reference number code values.

Code Description
AJ Accounts Receivable Customer Account
AT Appropriation Number
BM Bill of Lading Number
9V Collect on Delivery (COD) Number
ON Dealer Order Number
DP Department Number
3Q Food and Drug Administration (FDA) Product Code
IK Invoice Number
MK Manifest Key Number
MJ Model Number
PM Part Number
PC Production Code
PO Purchase Order Number
RQ Purchase Request Number
RZ Return Authorization Number
SA Salesperson Number
SE Serial Number
ST Store Number
TN Transaction Reference Number
EI Employer’s ID Number
TJ Federal Taxpayer ID No.
SY Social Security Number

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 304
Shipping Package – WebServices 7/09/2012

Appendix I- International Forms Preference Criteria

Preference criteria are required in North American Free Trade Agreement Certificate of Origin
(NAFTA CO) documents. The following table lists the defined criteria and their use.

Criteria Meaning
The good is \"wholly obtained or produced entirely\" in the territory of one or more of the
NAFTA countries as referenced in Article 415.Note: The purchase of a good in the territory
does not necessarily render it\" wholly obtained or produced.\" If the good is an
A agricultural good, see also criterion F and Annex 703.2. (Reference: Article 401(a) and 415)
The good is produced entirely in the territory of one or more of the NAFTA
countries and satisfies the specific rule of origin, set out in Annex 401 that
applies to its tariff classification. The rule may include a tariff classification change, regional
value-content requirement, or a combination there-of. The good must also satisfy all other
applicable requirements of Chapter Four. If the good is an agricultural good, see also criterionF and
B Annex 703.2. (Reference: Article 401(b))

The good is produced entirely in the territory of one or more of the NAFTA countries exclusively
from originating materials. Under this criterion, one or more of the materials may not fall within the
definition of \"wholly produced or obtained,\" as set out in Article 415. All materials used in the
production of the good must qualify as \"originating\" by meeting the rules of Article 401(a) through
(d). If the good is an agricultural good, see also criterion F and Annex703.2. Reference: Article
C 401(c).

Goods are produced in the territory of one or more of the NAFTA countries but do not meet the
applicable rule of origin, set out in is an agricultural good, see also criterion F and
Annex703.2. Reference: Article 401(c). Annex 401, because certain non-originating materials do not
undergo the required change in tariff classification. The goods do nonetheless meet the regional
value-content requirement specified in Article 401 (d). This criterion is limited to the following two
circumstances: (1) The good was imported into the territory of a NAFTA country in an unassembled
or disassembled form but was classified as an assembled good, pursuant to H.S. General Rule of
Interpretation 2(a). or (2).The good incorporated one or more non- originating materials, provided for
as parts under the H.S., which could not undergo a change in tariff classification because the
originating materials, provided for as parts under the H.S., which could not undergo a change in tariff
classification because the heading provided for both the good and its parts and was not further
subdivided into subheadings, or the subheading provided for both the good and its parts and was not
further subdivided. Note: This criterion does not apply to Chapters 61 through 63 of the H.S.
D (Reference: Article 401(d))
Certain automatic data processing goods and their parts, specified in Annex308.1,
that do not originate in the territory are considered originating upon importation into the
territory of a NAFTA country from the territory of another NAFTA country when the
most-favored- nation tariff rate of the good conforms to the rate established in Annex 308.1
E and is common to all NAFTA countries. (Reference: Annex 308.1)

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 305
Shipping Package – WebServices 7/09/2012

Criteria Meaning
The good is an originating agricultural good under preference criterion A, B, or C above
and is not subject to a quantitative restriction in the importing NAFTA country
because it is a \"qualifying good\" as defined in Annex 703.2, Section A or B (please specify).
A good listed in Appendix 703.2B.7 is also exempt from quantitative restrictions and is
eligible for NAFTA preferential tariff treatment if it meets the definition of \"qualifying good\" in
Section A of Annex 703.2. Note: This criterion does not apply to goods that wholly originate
in Canada or the United States and are imported into either country. Note: A tariff rate quota is
F not a quantitative restriction

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 306
Shipping Package – WebServices 7/09/2012

Appendix J- Hong Kong District Codes

The following table lists the codes UPS uses to represent Hong Kong districts.

Code District
SD1 ABERDEEN
AD ADMIRALTY
SD2 AP LEI CHAU
CB CAUSEWAY BAY
CD CENTRAL
KT1 CHA KWO LING
CW1 CHAI WAN
CLK1 CHAK LAP KOK
ISL1 CHEUNG CHAU
CSW CHEUNG SHA WAN
CH CHOI HUNG
SD3 CHUNG HOM KOK
DH DAIMOND HILL
SD4 DEEP WATER BAY
ISL2 DISCOVERY BAY
FL FANLING
NP1 FORTRESS HILL
ST1 FOTAN
HV HAPPY VALLEY
HMT HO MAN TIN
HH HUNGHOM
JD JORDAN
NT1 KAM TIN
WD1 KENNEDY TOWN
KLB KOWLOON BAY
KLC KOWLOON CITY
KLT KOWLOON TONG
KC1 KWAI CHUNG
KC2 KWAI FONG
KC3 KWAI HING
KT2 KWUN TONG
LCK1 LAI CHI KOK
LCK2 LAI KING
LT3 LAM TIN
ISL3 LAMMA ISLAND
ISL4 LANTAU ISLAND
LF1 LOK FU
ST2 MA ON SHAN
LCK3 MEI FOO
SD5 MIDDLE BAY

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 307
Shipping Package – WebServices 7/09/2012

Code District
ML1 MID-LEVEL
MK1 MONGKOK
WD2 MOUNT DAVIS
NTK NGAU TAU KOK
NP2 NORTH POINT
ISL5 PING CHAU
SD6 POK FU LAM
MK2 PRINCE EDWARD
QB QUARRY BAY
SD7 REPULSE BAY
SK SAI KUNG
WD3 SAI WAN
SWH SAI WAN HO
WD4 SAI YING PUN
SPK SAN PO KONG
SS1 SHA TAU KOK
SSP SHAM SHUI PO
NT2 SHAM TSENG
ST3 SHATIN
SKW SHAU KEI WAN
SKM SHEK KIP MEI
NT4 SHEK KONG
SD8 SHEK O
WD5 SHEK TONG TSUI
SS2 SHEUNG SHUI
SW SHEUNG WAN
SL SHUN LEE
ST4 SIU LEK YUEN
CW2 SIU SAI WAN
SD9 SOUTH BAY
SD10 SOUTHERN DISTRICT
SD11 STANLEY
ML2 TAI HANG
TKT TAI KOK TSUI
NT5 TAI LAM CHUNG
TP TAI PO
SD12 TAI TAM
ST5 TAI WAI
NT6 TAP SHEK KOK
ML3 THE PEAK
NP3 TIN HAU
NT7 TIN SHUI WAI
SD13 TIN WAN
TKW TO KWA WAN
TKO TSEUNG KWAN O

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 308
Shipping Package – WebServices 7/09/2012

Code District
TST1 TSIM SHA TSUI
TST2 TSIM SHA TSUI EAST
NT8 TSING LUNG TAU
TY TSING YI
TW TSUEN WAN
TWS TSZ WAN SHAN
NT9 TUEN MUN
CLK2 TUNG CHUNG
SD14 WAH FU
WC WANCHAI
LF2 WANG TAU HOM
WD6 WESTERN DISTRICT
SD15 WONG CHUK HANG
WTS WONG TAI SIN
YMT YAU MA TEI
KT3 YAU TONG
NT10 YUEN LONG

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 309
Shipping Package – WebServices 7/09/2012

Appendix K- Export License Exception Codes

License exception codes may be used in lieu of an export license in Shipper Export Declaration
(SED) forms. The following table lists the defined export codes.

Code License Exception

Established for agricultural commodities to permit exports and re-exports to
Cuba that is not specifically identified on the Commerce Control List
AGR (CCL) and is classified as EAR99.
Items for export or re-export not controlled for
APR nuclear nonproliferation, missile technology or crime control.
AVS U.S. aircraft or foreign sojourn into foreign country.
BAG Individual or exporting carriers crew members baggage.
CIV National security items for civil end users.
CTP Computer and parts of.
ENC Encrypted software and hardware - financial institutions.
Export or re-export of Country Group B; controlled
GBS for national security reasons.
Gift shipments; packages to individuals, religious,
GFT charitable or education institutions, donations of basic needs.
Government shipments, covers shipments for U.S.
GOV government agencies, personnel or of cooperating foreign governments
KMI Encrypted software and hardware.
LVS Value of shipments limited.
NLR No license required.
Servicing and replacement of parts and equipment, one
RPL for one replacement parts service or replacement of equipment.
Temporary exports, export and re-export of items
TMP temporary in U.S., export and re-export of beta test software.
Software or technology outside the scope of export
TSPA regulations.
Technology and software, national security reason,
TSR Country Group B.
Technology and software shipments, of basic requirements, data supporting
prospective or actual bids, offers to sell, lease or supply an item. Software
TSU update for fixing programs, mass marketed software.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 310
Shipping Package – WebServices 7/09/2012

Appendix L- Sample Shipping and Return Labels

The following figures are examples of UPS shipping and return labels.

Figure 1. Sample Shipping Label

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 311
Shipping Package – WebServices 7/09/2012

Figure2. Sample Return Label

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 312
Shipping Package – WebServices 7/09/2012

Appendix M- Shipping and Tracking Numbers for Testing

UPS has set aside several shipping identification 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 table lists those special numbers and describes the results that
developers should expect when attempting a VoidShipmentRequest. For each test case, the first
number listed is a shipment identification number; additional numbers, if present, are tracking
numbers.

Note that only these numbers may be used in the Customer Integration Environment when voiding
shipments.
NUMBER(S) EXPECTED RESULT

1ZISDE016691676846 A successful XML response will be returned for a

shipment level void request.
1Z2220060290602143 A successful XML response will be returned for a
shipment level void request.

1Z2220060294314162 and Tracking Number A successful XML response will be returned for a
1Z2220060291994175 package level void request. The request will void the
package in the shipment.

1Z2220060292690189 and Tracking Number A successful XML response will be returned for a
1Z2220060292002190 package level void request. The request will void the
package in the shipment.

1ZISDE016691609089 with Tracking Numbers A successful XML response will be returned for a
1ZISDE016694068891 and 1ZISDE016690889305 package level void request. The request will void all the
packages

1Z2220060290530202 with Tracking Number A successful XML response will be returned with a
1Z2220060293874210 and 1Z2220060292634221 partial void for a package level void request. The request
will void package 1Z2220060293874210 but package
1Z2220060292634221 cannot be voided.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 313
Shipping Package – WebServices 7/09/2012

Appendix N- Valid Language-Dialect combination for

PreAlertNotification

Valid Language Dialect

DAN 97
DEU 97
ENG GB
ENG US
FIN 97
FRA 97
FRA CA
ITA 97
NLD 97
POR 97
SPA 97
SWE 97
ENG CA
NOR 97
POL 97
CES 97
ELL 97
ENG CA
HEB 97
HUN 97
NLD 97
NOR 97
RUS 97
SLK 97
TUR 97
VIE 97
ZHO TW
RON RO
SPA PR

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 314
Shipping Package – WebServices 7/09/2012

Appendix O – Valid Origin/Destination Combinations: for DC, DC-

SR, and DC-ASR Accessorials

Origin Destination DC DC-SR DC-ASR

US50 US50, PR P P P
CA, VI -- S S
Intl (not CA, PR, VI) -- S S
CA CA P P P
US50, PR, VI -- S S
Intl (not US, PR, VI) -- S S
PR PR, US50 P P P
CA, VI -- S S
Intl (not US, CA, VI) -- S S
Intl RAVE-supported origin countries Intl (natl, transborder, -- S S
(not US, PR, CA, VI; see list below) worldwide) – per Mktg
validation tables

S = shipment-level accessorial; P= package-level accessorial. All the origin/destination pairs

valid for forward shipments only.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 315
Shipping Package – WebServices 7/09/2012

Appendix P- Paperless Invoice Supported Countries

The following table lists those countries that support paperless (electronic submission) invoices. NOTE:
Although a country may be prepared to accept Paperless Invoices, it is not guaranteed that all origins
are allowed to send Paperless Invoices to such a country.
Paperless Invoice countries are updated quarterly however guides are updated semi-annually in January and
July. Changes may occur between releases of the guide.

Country
Australia
Austria
Belgium
Canada
China
Czech Republic
Denmark
Estonia
Finland
France
Germany
Guernsey
Great Britain
Hong Kong
Hungary
India
Indonesia
Ireland
Israel
Italy
Japan
Jersey
Latvia
Lithuania
Luxembourg
Macau
Malaysia
Malta
Netherlands
New Zealand
Norway
Philippines
Poland
Portugal
Puerto Rico
Romania
Scotland
Singapore
Slovenia
South Korea
Spain
Sweden
Switzerland
Tai wan

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 316
Shipping Package – WebServices 7/09/2012

Country
Thailand
United States
Vietnam

Appendix Q- Paperless NAFTA Supported Countries

The following table lists those countries that support paperless (electronic submission) NAFTA.
NOTE: Although a country may be prepared to accept Paperless NAFTA, it is not guaranteed that all
origins are allowed to send Paperless Invoices to such a country.
Paperless Invoice countries are updated quarterly however guides are updated semi-annually in January and
July. Changes may occur between releases of the guide.

Mexico as an origin is not currently supported

Origin Destination
US CA
US MX
CA US
CA PR
CA MX
PR CA
PR MX

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 317
Shipping Package – WebServices 7/09/2012

Appendix R- License exception code Possible values: Shipping API –

Package
Values Description
AGR Established for agricultural commodities to permit exports and re-exports to Cuba that is not
specifically identified on the Commerce Control List (CCL) and is classified as EAR99.
APR Items for export or re-export not controlled for nuclear nonproliferation, missile technology
or crime control.
AVS U.S. aircraft or foreign sojourn into foreign country.
BAG Individual or exporting carrier's crew member's baggage.
CIV National security items for civil end users.
CTP Computer and parts of.
ENC Encrypted software and hardware - financial institutions.
GBS Export or re-export of Country Group B; controlled for national security reasons.
GFT Gift shipments; packages to individuals, religious, charitable or education institutions,
donations of basic needs.
GOV Government shipments, covers shipments for U.S. government agencies, personnel or of
cooperating foreign governments.
KMI Encrypted software and hardware.
LVS Value of shipments limited.
NLR No license required.
RPL Servicing and replacement of parts and equipment, one for one replacement parts service or
replacement of equipment.
TMP Temporary exports, export and re-export of items temporary in U.S., export and re-export of
beta test software.
TSPA Software or technology outside the scope of export regulations.
TSR Technology and software, national security reason, Country Group B.
TSU Technology and software shipments, of basic requirements, data supporting prospective or
actual bids, offers to sell, lease or supply an item. Software update for fixing programs, mass
marketed software

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 318
Shipping Package – WebServices 7/09/2012

Appendix S - Frequently Asked Questions: Shipping API – Package

API Category Question Answer

Shipping Account Based Do the Developer
Rates (ABR) or APIs support ABR
Negotiated Rates also known as Yes. Shipping and Rating APIs both XML & Web Services
Negotiated Rates? support Negotiated Rates
Shipping Negotiated Rates How do get access To streamline your ability to view your negotiated rates through the
to negotiated [Shipping/Rating] API UPS has implemented a new process that no
Package rates? longer requires you to wait for a UPS Sales Person to activate your
account. Simply add a UPS Account to your myUPS ID Account
Summary as you previously would and your account will be
activated within 48 hours for negotiated rates provided you have a
contract with UPS. Remember to select the “Negotiated Rates
Indicator” within the XML Request to have your negotiated rates
returned within the response.
Shipping Negotiated Rates What flags are Use the NegotiatedRatesIndicator within the API request to view
needed to return your Negotiated rates and the customer was set up by their UPS
Negotiated rates in Account Rep for negotiated (Account Base rates).
the request
Shipping Ground Freight Are dimensions Currently dimensions are not applicable to Ground Freight Pricing
Pricing (GFP) required for GFP
Shipping Duty & Taxes How do you bill a In order to bill a 3rd Party for D&T, use the noted tags in your
3rd Party for Duty request:
& Taxes? <ShipmentCharge>
<Type>01</Type>
<BillShipper>
<AccountNumber>XXXXXX</AccountNumber>
</BillShipper>
</ShipmentCharge>
<ShipmentCharge>
<Type>02</Type>
<BillThirdParty>
<AccountNumber>XXXXXX</AccountNumber>
<ThirdParty>
<Address>
<PostalCode>XXXXX</PostalCode>
<CountryCode>XX</CountryCode>
</Address>
</ThirdParty>
</BillThirdParty>
</ShipmentCharge>

Shipping Scan-based Does the Shipping Yes, it is supported by default meaning if they are not tendered to
Billing API support Scan- UPS they are not billed.
Based Billing

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 319
Shipping Package – WebServices 7/09/2012

API Category Question Answer

Shipping Third Does the Ship API Yes, it validates if the account is active, valid for Manage Inbound
Party/Freight validate account charges and the postal code of the account billed
Collect Shipment numbers when
shipping Third
Party and Freight
Collect?
Shipping Address How do I turn off The value within the "ShipmentRequest/Request/RequestOption"
Validation validation of tag of the request needs to be "nonvalidate".
addresses with the
Shipping API?
Shipping Address Will the Shipping
Validation API provide
validation for
Japanese No, the postal code must be included for validation.
addresses with
City and Country
and no zip code?
Shipping Address What validation is
Validation the Shipping API Shipping API does not do ANY address validation at the street
using to validate level. Only regional validation; city, state, country (postal code
addresses for US optional).
and International
addresses?
Shipping Rural & Super Does the Shipping
Rural API - Package Yes the Shipping API will return rural and super rural charges.
return Rural and These charges will automatically be applied to the transportation
Super Rural charge portion of the rate
charges?

Shipping UPS Account How do I add a

UPS account to
myUPS ID As a means of securing customer information, when adding an
account summary? account to their My UPS profile or enroll for electronic billing
It is stating that I options or Quantum View, customers are currently prompted to
have to have an authenticate their account by entering an invoice number, invoice
invoice # and amount, and the invoice date from one of their last three billing
control ID. cycles along with the Control ID printed just below the shipper
number on their invoice. This provides is an additional layer of
security to protect our customer’s information. The Control ID is
currently included in the following U.S. and Canada Invoice Media
types:• Online PDF Images• EDI Domestic and Import• Hard Copy
Invoices
Shipping International Is there a limit of Yes, when using international forms only 50 line items
Commodities the number of line (commodities) can be associated per shipment using the Shipping
items for the API.
Commercial
Invoice?

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 320
Shipping Package – WebServices 7/09/2012

API Category Question Answer

Shipping HazMat - Dry Ice Does the Shipping Yes, effective with the July 2011 release, the Shipping API will
API for Package support Dry Ice, as long as; it does not include any other Hazmat
support the Dry materials in the shipment and meets the requirements. Please refer
Ice indicator? to UPS.com for more information.
Shipping 99 Account How do I
Number associate more 99 accounts is currently the maximum number available. If the user
Limitation than 99 account has more than 99 accounts they must be spread across multiple
numbers for use UserIds.
with the Shipping
APIs?
Shipping Proactive Is Proactive No, the Shipping API does not support Proactive Response
Response Response
Supported?
Shipping Delivery Is UPS Delivery
Intercept Intercept available No, it is not currently supported.
through the
Shipping API?
Shipping Shipper Release Is Shipper Release
available with the Yes.
Shipping API?
Shipping Resi/Comm Does the Shipping
Indicator API classify The Shipping API will classify an address based on UPS” history
addresses as for that address and the appropriate rate will be returned in the
residential or response
commercial?
Shipping Returns Is there a URL
ONLY capability No.
for returns within
the Shipping API?
Shipping Returns Can a Return be A customer can void an RS label up to 2am/3am Eastern Time the
voided? If yes, following night (e.g. Monday request, Tuesday 2am/3am void
what is the cutoff cutoff). This is based on when our batch process starts sending
timing to void a RS1/RS3 labels to the centers. After the cutoff, the customer will
return? not be able to void, and the UPS agent is also not able to void. If
the void is completed by the cutoff time then the customer will not
be charged.

For ERL and PRL, the labels can be voided up to 30 days after
generation. Please note that the Label generation fee, if applied is
not voidable and that unused labels will not be billed transportation
charges.
Shipping Returns Does the Shipping
API support
international Yes. Please see the UPS Developer’s Guide for the specific
returns and returns countries supported
in international
countries where
the Shipping API
is supported?

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 321
Shipping Package – WebServices 7/09/2012

API Category Question Answer

Shipping Print Return For the print
Labels return label UPS does not provide a mechanism to "reprint" a Print Return
option, if a Yahoo Label (PRL) the vendor must save the label locally if they wish to
merchant needs to reprint. Only the ERL (Electronic Return Label) option provides
reprint the return that capability.
label, how much
time does he
have? Is it 10
days after the
initial request?
Shipping UPS Return Does UPS charge Yes, the customer will be charged the accessorial fee once they
Labels the accessorial fee request a return label.
for a return label
when using the
API?
Shipping Returns Does the Shipping
API - Package Yes.
support Returns
capabilities?
Shipping Electronic Return Does the customer
Label Days have to utilize the Yes, effective with the July 2010 Release, the time limit for
Available label recovery retrieving an Electronic Return Label has been extended to 30 days.
capability within The prior limit was 10 days. This is noted in the latest Shipping
the Ship API to Developers Guide. An Electronic Return Label is specified by
reprint an using Shipment/ReturnService/Code “8” in the Shipment Confirm
electronic return Request. The ERL email will contain a link to the label so the
label? Either way, recipient can print the label to attach to a package.
how many days is
the label available
to reprint?
Shipping Returns Are the Returns
capabilities the
same within the
Web Service Yes. The Returns capabilities are the same.
versus XML
versions of the
Shipping API -
Package?
Shipping 128 Reference Can the Shipping
Number Barcode API - Package Yes. A 128 Reference number barcode can be generated below the
generate a 128 1z number, as the Shipping API can print a barcode in reference
Reference number field 1. The Shipping API - Package does not create a PDF417 as
barcode below the they are not required. The purpose of the PDF417 was as a backup
1Z? Can it in case the PLD did not transmit from a shipping system. That is
generate a not possible with the Shipping API - Package because a label is
PDF417 only returned after the receipt of PLD.
Reference number
barcode below the
1Z?

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 322
Shipping Package – WebServices 7/09/2012

API Category Question Answer

Shipping Currency Does the Shipping
Conversion API - Package
support No. The Shipping API - Package does not support currency
conversion of conversions.
Japanese Yen to
US Dollars?
Shipping From Suite/Apt# How does a
on Label customer include
the Suite/Apt# The customer needs to include the suite/apt # in delivery address
within "From" lines 2 or 3 within the request.
address on the
label returned for
the Shipping API -
Package?
Shipping High Value How does the
Report Shipping API - The High Value Report is returned in the response in one of the
Package work supported formats specified by the developer. In each case it will
with High Values? be a Base64 encoded file that must be decoded and printed. 2
Does the copies should be printed, both will be signed by the driver and the
paperwork driver will leave one copy as a receipt. The file, once decoded is a
comeback as a simple HTML file that can be printed locally
GIF image and get
printed on a
thermal printer?
Or, does the
customer need to
produce these
themselves?
Shipping Pickup request Can a Pickup be No. All pickup requests must be made through the Pickup web
requested through service. Details are available at the Developer resource center on
the Shipping API - ups.com at: https://www.ups.com/upsdeveloperkit.
Package?
For customers who implemented the Shipping API - Package prior
to January 2010 can continue to request a pickup through the
Shipping API as part of their shipping request. Please not the
billing of pickups changed in January 2010 and the customer will
be charged for each request regardless of the service type shipped.
Please review the Rate & Service Guide for more details about
pickup charges and services.
Shipping Label/Receipt Does the Shipping
API - Package The output of the Shipping API is a label. There is no receipt
provide a label provided. In addition, Ship API only provides the ability to have
and receipt but the label emailed with the ERL (Electronic Return Label) service
does not email a and not for forward shipments
receipt for the user
nor provide a
confirmation
number?

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 323
Shipping Package – WebServices 7/09/2012

API Category Question Answer

Shipping Commerical Can a API The API will return a commercial invoice as part of the response
Invoice customer export file. Therefore, the customer must save the image from the
shipments to print response file to retrieve it later. If they didn’t save the response
a copy of the then the API does not store it for retrieval.
commercial
invoice after the
fact?
Shipping Reprinting Labels Can a customer
using the Shipping
API reprint a
label? No, at this time the Shipping API does not provide the ability to
reprint labels.
Shipping Oracle Are there any UPS is not aware of any issues customers have implementing the
known issues with Shipping API - Package using Oracle at this time. The UPS
implementing Developer APIs are designed so that they can be implemented in
Oracle with the almost any environment as long as the customer application can
Shipping API - open a secure connection of SSL and perform an HTTP Post.
Package?
Shipping Trade Direct Does the Shipping No, the Shipping API does not support Trade Direct shipments.
API support Trade
Direct?

Shipping Paperless Invoice Does the Shipping Yes. The developer guide for the Shipping API - Package lists the
API - Package valid countries for paperless invoice. See the
support Paperless AdditionalDocumentIndicator Element within the Interface Spec
Invoice? within the developer guide. Once the shipment is processed an
EDI (paperless invoice) or EDI PULL (paperless invoice and
additional export document indicator) will appear on the bottom
right corner of the label image returned in the ShipAcceptResponse
label digest. This indicates that Paperless Invoicing has been
requested.
Shipping Paperless Invoice Can a Paperless Yes a Paperless Invoice shipment can be voided via the Shipping
voids Invoice shipment API - Package. If a shipment is voided and consequently the
be voided through package is never tendered to UPS, then the paperless invoice data
the Shipping API - that was uploaded with the shipment is not used to create an
Package? If yes, invoice image and it is eventually purged.
what happens to
the invoice
information?
Shipping Paperless Invoice How does Those customers setup for paperless invoicing shipping
Shipment Paperless Invoice internationally to a paperless supported country with the necessary
work in terms of data for paperless will have the invoice automatically sent to
the documentation brokerage.
being forwarded?

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 324
Shipping Package – WebServices 7/09/2012

API Category Question Answer

Shipping Paperless Invoice What are the pre- The process to support Paperless Invoice using the Shipping API
Conditions conditions are listed below:
required for a 1. The Sold To country must be the same as the Ship To country.
customer to be set 2. The customer must have a paperless invoice contract and be set
up on Paperless up in UPS back end systems. (The UPS Account Manager should
Invoice? set this up.)
3. The shipment is a non-document package forward shipment
requiring a commercial invoice.
4. The destination country is a valid paperless invoice destination.
(A list of those destinations is available in the Developer’s Guide.)
5. If additional export documents are required for the movement,
the customer must specify an <AddtionalDocumentIndicator/> in
the XML request.
If the above conditions have been met an EDI (paperless invoice)
or EDI PULL (paperless invoice and additional export document
indicator) will appear on the bottom right corner of the label which
is returned in the ShipAcceptResponse XML. This indicates that
Paperless Invoicing has been requested.
To implement paperless invoicing an <InternationalForms>
container must be present in the XML to provide the information
necessary to replace a paper invoice with a paperless (electronic)
invoice. There is a section devoted to International Forms in the
Developer’s Guide which provides the XML structure for
Certificate of Origin (CO), Invoice, North American Free Trade
Agreement Certificate of Origin (NAFTA CO), or Shipper's Export
Declaration (SED) as appropriate. The shipper needs to add the
container along with the necessary international forms information
for the shipment.
Shipping Ref Number 1 - Can a customer
Text Values on implementing the No, The reference field descriptions cannot be modified at this
Label Shipping API - time. You must use one of the values provided in the Developer’s
Package "rename" Guide.
reference value
one through the
API
Shipping Batch Processing Does the Shipping No, the Shipping API only supports transactional requests.
API support
Batch?
Shipping Resi/Comm How do you Use the ResidentialAddress element outlined within the Shipping
Indicator indicate the "Ship API - Package developer guide.
TO" as
residential?
Shipping Voids How are voids
processed? For forward and return movements send a VoidShipmentRequest
element and UPS will return a VoidShipmentResponse. Forward
movements must be voided within 28 days of creating the label.
Return shipments must be voided within 24 hours.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 325
Shipping Package – WebServices 7/09/2012

API Category Question Answer

Shipping Tracking Can a customer No…a customer cannot create their own tracking numbers using
Numbers create their own the Shipping API - Package. The tracking numbers will be
tracking numbers automatically created and returned in the response
using the Shipping
API - Package?
Shipping UPS World Ease Does the Shipping
API - Package No…the Shipping API - Package does not support UPS World
support UPS Ease at this time.
World Ease?
Shipping International Does the Shipping
Forms API - Package Yes.
support
international
forms?
Shipping Shipper's Export Does the customer Yes, the customer has to complete their own filing and you can
Declaration has to complete identify it has been filed in your request but the Shipping API does
(SED) their SED filing or not provide an option UPS to file a customer's SED.
is there an option
for UPS to do that
for the customer
via the Shipping
API?
Shipping Label Does the Web
Services version The Web Services Shipping API - Package behaves similarly as the
of the Shipping XML Shipping API - Package in that the label elements returned in
API - Package the Shipment Accept response consist of two parts, both of which
behave differently are base64 encoded data which must be decoded. Part one consists
in rendering a of the label image and part two contains the HTML which is used
label than the to properly size the label image in a browser for display and
XML version of printing. When the two parts are combined they form a unit which
the Shipping API - will satisfy the requirements for printing a proper label to apply to
Package? a package. This ensures the label will meet the standards necessary
for UPS to scan and process the label within the shipping system.
Shipping Maximum Is there a
Packages within difference
a shipment between the There is no difference between the Shipping XML Tool and Web
Shipping API - Service Tool regarding the maximum number of packages allowed
Package Web for forward movements. The Web Service Developer Guide
Service versus indicates 200 is the maximum.
XML versions in
the number of
packages that can
be included within
a forward
movement?
Shipping CWT and Is there a solution
Shipping API using the ship API No, there is no solution in place for the Ship API.
(or other solution) In order to obtain the CWT price with the Ship API, the pkgs.
that would prompt would have to be processed as one shipment, the UserId being used

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 326
Shipping Package – WebServices 7/09/2012

API Category Question Answer

UPS billing or must be ABR enabled and you must include the
PLD upload or <NegotiatedRatesIndicator> tags to receive the Hundredweight
other to aggregate rates.
single piece
packages into
hundredweight
pricing (shipment)
after the package
has been
processed?
Shipping Reference What does the Supports Two Shipment Level Reference Numbers or two package
Number Rules Shipping API - level reference numbers You cannot use the Shipment Level and
Package support Package Level Reference numbers at the same time within a SHIP
in terms of API shipment.
Reference Shipment Level Reference Numbers are only allowed for
Numbers? shipments that are not US to US (origin\destination) or PR to PR
(origin\destination)
Package Level Reference Numbers are only allowed for shipments
that are US to US (origin\destination) or PR to PR
(origin\destination).
Reference Number Propagation
1. In a Ship API Shipment, if there is no Package Level. Ref# on
the 1st package of the shipment, the Shipment Level. Reference
number(s) will be propagated to all packages.
Reference Number Propagation
In a Ship API Shipment, if there is no Shipment level reference
number and there is Package Level. Reference number on the 1st
package, the 1st package's reference number will be propagated up
to the Shipment Level.
Shipping Labeling Does the Shipping The Ship API does not support ASC BIO on the label it is a
API support ASC contract service that is not supported by the Shipping
BIO labels like
WorldShip does?
Shipping Label Reference Can any of the At this time we are unaware of a facility which suppresses
Number reference fields be reference number printing on the label when they are included in
blocked from the shipment data. However, please note that reference numbers are
printing on the not required and may be omitted if there is no need for them.
label through a
Shipping API?
Shipping Certification What is required Please review the Customer Integration Environment section of
to certify for the UPS Developer’s Guide for certification requirements. Essentially
Shipping API - UPS needs to see the source XML and copies of your labels to
Package? certify you.
Shipping Signature Does the Shipping
Required API - Package Yes.
support Signature
Required service?

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 327
Shipping Package – WebServices 7/09/2012

API Category Question Answer

Shipping Future Date Is there a future
Shipping date shipping No. We do not support future date shipping. All packages are
capability within considered tendered on the date of their transaction.
the Shipping API -
Package?
Shipping Security for Please describe Yes, we use 128 bit encryption for all aspects of the APIs. In
Credit cards the security on the addition credit card information is “tokenized” once we receive it,
UPS web server? so we never store it in plain text
Is the credit card
information
submitted over an
encrypted (secure)
connection?

All General - security Does UPS support

chained or Yes, we support chained digital certificates.
unchained digital
certificates?
All API availability Within what
countries are the The Developer APIs are available in the countries listed at ups.com
Developer APIs by API and by country under the UPS Developer Resource center
available? located at: https://www.ups.com/upsdeveloperkit
All Mail Innovations Is Mail
Innovations
available within
any of the
Developer APIs? No, Mail Innovations is not available within a Developer API.
All UPS Logos High How do I get
Resolution access to higher Customers are not routinely provided these UPS shield graphics
resolution logos without having a design/layout submitted to UPS Brand
than what are Management for approval.
available within The customer needs to visit:
the downloads for https://www.upsbrandexchange.com/brandHome.awsp
the UPS This site will take them through the process for downloading a
Developer Kit - limited set of sample images for layout, and how to secure an
Developer APIs? approval for customer use, as well as the high-resolution graphics.
All Technical Is XPCI a required
Support email field within the
form email support
form? No. it is not required.
All Technical How do I get Go to the Developer Resource Center and select email support
Support technical support under the UPS Developer Kit Support Column (link noted):
for the APIs at http://www.ups.com/content/us/en/resources/techsupport/developer
ups.com? center.html
All Characters Can Japanese
Kanji character be
recognized by
UPS Developer
APIs? No.

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 328
Shipping Package – WebServices 7/09/2012

API Category Question Answer

All Basic Do any of the
Developer APIs
support Basic
service? No. Basic is not supported within the Shipping API.
All ASMX Are the Web
Services versions
of the APIs No. All Web Services are XML based. This is described in the
ASMX based? section 'UPS OnLine API Technologies' of every developer's guide
All Pointing to the I keep getting, The "XML document is well formed but the document is not valid"
wrong URL for "XML document error message is generally returned when an element in the XML
API is well formed but request does not adhere to the formatting defined within the Xpath
the document is section of that API's developer guide. When the API returns this
not valid." error error it indicates the field which is not valid in the
message. What ErrorLocationElementName element in the XML response. When
am I doing we test the XML provided by you earlier in this email chain we are
wrong? able to receive a successful response.

Most likely 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 DOESN’T MATCH EXPECTED
FORMAT</ErrorLocationElementName>

All Phone Support Is phone support Yes. Phone support is provided for basic API questions. This
provided for the includes integration questions and production questions. However,
UPS Developer customer's questions that cannot be answered verbally will be
Kit - Developer directed to the email support form at ups.com.
APIs? If so, what Phone Support Hours:
is the number and M-F 730am- 9pm EST
what are the hours Sa-Su 9am - 6pm EST
of operation? 800-247-9035
All Examples of API Are there any
Implementations examples of
implementations
that we can review
to understand how
best to utilize the
APIs? No, we do not provide implementation examples.
All Code languages Do the APIs
supported support PHP or
Perl with code
sample within the
Developer Guides
or the developer
kit zip files? Yes, We currently support PHP or Perl with sample code.
All Password Are there new
changes login password
requirements? Yes, for new or updated passwords the following rules apply:

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 329
Shipping Package – WebServices 7/09/2012

API Category Question Answer

 Must be 8 to 26 characters long

 Must include 3 of the following categories:
o Lowercase letter
o Uppercase letter
o Number
o Special character (#, %, @,*)
o Space
 Must not contain any of the following information:
o User ID
o Name
o E-mail address

Note: (must be at least 8 characters), at the minimum it

must also include upper and lower case letters and a
number.
For example: PaSSword22

© 2012 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary Page 330