Shipping Package WebServices Developers Guide

Transcription

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
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
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
Page 3
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
Page 4
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.
Page 5
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:
Page 6
Release
7/09/2012
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
Page 7
Release
7/09/2012
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
Page 8
Release
7/09/2012
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.
Page 9
Release
7/09/2012
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.
Page 10
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
Page 11
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.
Page 12
7/09/2012
Page 13
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.
Page 14
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.
Page 15
7/09/2012
Figure 5: The Eclipse Web Tools Platform (WTP) project provides support for Web Services in a Java
development environment.
Page 16
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.
Page 17
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.
Page 18
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.
Page 19
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
Page 20
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.
Page 21
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/
Page 22
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
Page 23
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>
Page 24
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.
Page 25
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
Page 26
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-certificatessupport/index?page=content&id=SO7154&actp=search&viewlocale=en_US&searchid=1308235124970
https://knowledge.verisign.com/support/ssl-certificatessupport/index?page=content&actp=CROSSLINK&id=AR1553
https://knowledge.verisign.com/support/ssl-certificatessupport/index?page=content&id=SO4785&actp=LIST
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>
Page 27
7/09/2012
</env:Header>
<env:Body>

</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
Page 28
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.
Page 29
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
API
ShipConfirmResponse
3
Client
Application
ShipAcceptRequest
ShipAcceptRequest
4
ShipAcceptResponse
Figure 1. Forward and return shipments may use four separate messages to complete the
shipment processing.
Page 30
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.
1
Shipping
API
Shipment
Request
Internet
2
Client
Application
t Shipment
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.
Page 31
7/09/2012
VoidShipment
Request
1
Shipping
API
Internet
2
Client
Application
VoidShipment
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.
Page 32
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.
Page 33
7/09/2012
TransactionReference
identifies transactions
between client and server.
Values blank, validate, or
nonvalidate.
N/A
Page 34
Partial IV
EEI
Invoice
N/A
Nafta CO
Request Container
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 avoid an
address correction fee.
CO
Validation Rules
Return Only
Description
Shipment Only
Length
N/A
N/A
1...15
Type
Container
container
string
N/A
Container
Max Allowed
/ShipmentRequest/Request/TransactionRefer
ence
One
/ShipmentRequest/Request/RequestOption
One
RequestOption
One
/ShipmentRequest/Request
One
Request
Yes
/ShipmentRequest
Yes
ShipmentRequest
Yes
XPath
No
Name
Required
1.8.2 Shipping Web Services Schema
Page 35
Partial IV
N/A
EEI
Type of Return service.
When this container exists,
the shipment is a return
shipment.
Invoice
The Description of Goods for
the shipment. Applies to
international shipments only.
Provide a detailed
description of items being
shipped for documents and
non-documents. Provide
specific descriptions, such
as annual reports and 9 mm
steel screws.
Required if all of the listed
conditions are true:
ShipFrom and ShipTo
countries are not the
same; The packaging
type is not UPS Letter;
The ShipFrom and or
ShipTo countries are not
in the European Union or
the ShipFrom and ShipTo
countries are both in the
European Union and the
shipments service type is
not UPS Standard.
Nafta CO
Shipment Container
Refer to the Shipment
container table for the
elements under Shipment
container.
CO
N/A
Validation Rules
Return Only
Length
1...512
Description
The client uses
CustomerContext to
synchronize
request/response pairs. The
client establishes
CustomerContext, which can
contain any information you
want, as along as it is valid
XML; it is echoed back by
the server.
Shipment Only
Type
string
container
1...35
N/A
Max Allowed
One
One
String
/ShipmentRequest/Shipment/ReturnService
N/A
ReturnService
/ShipmentRequest/Shipment/Description
Container
Description
One
/ShipmentRequest/Shipment
One
Shipment
Required
/ShipmentRequest/Request/TransactionRefer
ence/CustomerContext
Yes
CustomerContext
Cond
XPath
No
Name
7/09/2012
No
Page 36
Partial IV
EEI
Invoice
N/A
Nafta CO
Return Service description
CO
N/A
Validation Rules
Return Only
Description
Return Service types:|‘2’ =
UPS Print and Mail (PNM)|‘3’
= UPS Return Service 1Attempt (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 1Attempt Box 2|‘13 = UPS
Pack & Collect Service 1Attempt Box 3|‘14’ = UPS
Pack & Collect Service 3Attempt Box 5
Shipment Only
Length
Type
1...35
1
string
String
/ShipmentRequest/Shipment/ReturnService/D
escription
Max Allowed
Description
One
/ShipmentRequest/Shipment/ReturnService/C
ode
One
Code
Required
XPath
Yes*
Name
7/09/2012
No
/ShipmentRequest/Shipment/Shipper/TaxIden
tificationNumber
Empty Tag. Valid only for
shipments with different
origin and destination
countries. The origin
country is not US, and the
destination country is not
CA, PR or MX.
Container tag for Shipper's
information
N/A
Shipper's company name.
For forward Shipment 35
characters are accepted, but
only 30 characters will be
printed on the label.
N/A
Shipper's Attention Name.
For forward Shipment 35
Required if destination is
international. Required if
Invoice and Co
International forms are
requested and the
ShipFrom address is not
present.
Shipper's Tax Identification
Number
Conditionally required if
SED form (International
forms) is requested and
ship From is not
mentioned.
Page 37
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Indicates a shipment
contains written, typed, or
printed communication of no
commercial value. If
DocumentsOnly is not
specified then it implies that
the shipment contains non
documents or documents of
commercial value. Default is
a shipment contains nondocuments or documents of
commercial value.
Shipment Only
Length
Type
string
Container
N/A
1...35
string
One
One
One
string
1...35
1...15
TaxIdentificationNumber
/ShipmentRequest/Shipment/Shipper/Attentio
nName
string
AttentionName
One
/ShipmentRequest/Shipment/Shipper/Name
One
Name
No
/ShipmentRequest/Shipment/Shipper
Yes
Shipper
Cond
/ShipmentRequest/Shipment/DocumentsOnlyI
ndicator
Cond
DocumentsOnlyIndicator
Yes
0
XPath
Max Allowed
Name
7/09/2012
Required
N/A
Page 38
Partial IV
Shipper's phone extension.
EEI
Shipper's phone Number.
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
phone number is required
if destination is
international.
Invoice
N/A
Nafta CO
Container tag for Phone
Number
CO
Validation Rules
Return Only
Length
N/A
Description
Shipment Only
Type
Container
1...15
Max Allowed
One
String
/ShipmentRequest/Shipment/Shipper/Phone/
Extension
1...4
Extension
String
/ShipmentRequest/Shipment/Shipper/Phone/
Number
One
Number
One
/ShipmentRequest/Shipment/Shipper/Phone
Required
Phone
Yes*
XPath
No
Name
7/09/2012
Cond
ShipperNumber
/ShipmentRequest/Shipment/Shipper/Shipper
Number
Yes
One
string
FaxNumber
/ShipmentRequest/Shipment/Shipper/FaxNum
ber
No
One
String
1...14
EMailAddress
/ShipmentRequest/Shipment/Shipper/EMailAd
dress
No
One
string
1...50
Page 39
Partial IV
N/A
EEI
Shipper's email address.
Invoice
N/A
Nafta CO
Shipper's Fax Number.
CO
Shipper's six digit account
number.
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
daily pickup account, or
an occasional account.
Return Only
Validation Rules
Shipment Only
Length
Type
Description
6
XPath
Max Allowed
Name
7/09/2012
Required
Address tag Container.
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
for the first occurrence, only
30 characters will be printed
on the label for return
shipments, and for RFA
Shipments only 20
characters are printed on
Label.
The shipper's City. For
forward Shipment 30
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
address is used as the
ShipFrom the shipment
will be rated from this
origin address.
Maximum Occurrence
should be three.
N/A
Page 40
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
N/A
Type
Container
1...35
Max Allowed
string
1...30
/ShipmentRequest/Shipment/Shipper/Address
/City
string
City
One
/AddressLine
Three
AddressLine
One
Yes
Address
Yes
XPath
Yes
Name
7/09/2012
Required
Shipper's state or province
code. For forward Shipment
5 characters are accepted,
but only 2 characters will be
Shipper's postal code.
Page 41
Partial IV
EEI
Invoice
Nafta CO
CO
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
US State/ Canadian
Province code. If the
country is Ireland, the
StateProvinceCode will
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
than 9 alphanumeric
characters long.
Return Only
Description
Shipment Only
Length
2...5
Type
string
Max Allowed
1...9
/PostalCode
string
PostalCode
One
/StateProvinceCode
One
StateProvinceCode
Cond
XPath
Cond
Name
7/09/2012
Required
string
Container
N/A
One
One
string
1...35
1...35
/ShipmentRequest/Shipment/ShipTo/Attention
Name
string
AttentionName
One
/ShipmentRequest/Shipment/ShipTo/Name
One
Name
Yes
/ShipmentRequest/Shipment/ShipTo
Yes
ShipTo
Yes
/CountryCode
Cond
CountryCode
Consignee’s company
name. For RFA Shipment 35
Contact name at the
consignee’s location. For
RFA Shipment 35 characters
are accepted, but only 25
characters will be printed on
the label.
N/A
Required for: UPS Next
Day Air Early A.M.
service, and when ShipTo
country is different than
ShipFrom country.
Required if Invoice
International form is
requested
Page 42
Partial IV
EEI
Invoice
Nafta CO
N/A
CO
Ship To Container
Return Only
Shipper’s country
code.Refer to Origin Country
Information table for valid
origin countries and their
UPS Billing codes.
Validation Rules
Must be a valid UPS
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,
If any of the two following
country codes: ShipTo/
ShipFrom/ Shipper are
members in EU otherwise
check if the shipper has
Third Country Contract.
Shipment Only
Length
Type
Description
2
XPath
Max Allowed
Name
7/09/2012
Required
Consignee’s phone Number.
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
area code, 7 digit
extension number;
number; for other
countries, the layout is
CountryCode, area code,
7 digit number.
Consignee’s phone
extension.
N/A
Consignee’s fax number.
If ShipTo country is US
10 digits allowed,
otherwise 1-15 digits
allowed.
Consignee’s email address.
N/A
Page 43
Partial IV
N/A
EEI
Container for Phone Number
Invoice
N/A
Nafta CO
Consignee’s tax
identification number.
CO
Validation Rules
Return Only
Length
1...15
N/A
/ShipmentRequest/Shipment/ShipTo/EMailAd
dress
Description
Shipment Only
Type
String
Container
1...15
1...15
String
String
EMailAddress
1...50
1...4
/ShipmentRequest/Shipment/ShipTo/FaxNum
ber
string
String
Max Allowed
One
One
FaxNumber
One
/ShipmentRequest/Shipment/ShipTo/Phone/E
xtension
One
Extension
No
/ShipmentRequest/Shipment/ShipTo/Phone/N
umber
No
Number
One
/ShipmentRequest/Shipment/ShipTo/Phone
One
Phone
Required
/ShipmentRequest/Shipment/ShipTo/TaxIdent
ificationNumber
No
Yes*
XPath
No
Name
7/09/2012
Cond
1...35
One
string
1...30
string
One
Cond
StateProvinceCode
/ShipmentRequest/Shipment/ShipTo/Address/
StateProvinceCode
Consignee’s state or
province code. Required for
US or Canada.
N/A
If destination is US or CA,
then the value must be a
valid US State/ Canadian
contain the county.
Page 44
Partial IV
N/A
String
City
EEI
Container
Three
City
Max Occurrence can be
3.
Invoice
Length
One
AddressLine
N/A
Nafta CO
Type
Yes
AddressLine
Address Container.
Address Line of the
consignee. For RFA
Shipment 35 characters are
accepted, but only 25
the label from AddressLine
elements.
Consignee’s city. For RFA
Shipment 30 characters are
accepted, but only 16
the label. For Shipment
other than RFA 30
only 15 are accepted.
CO
Max Allowed
/ShipmentRequest/Shipment/ShipTo/Address
Validation Rules
Return Only
Required
Address
Description
Shipment Only
XPath
2
Name
Yes
7/09/2012
Yes
Consignee’s country code.
Page 45
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
1...9
Consignee’s postal code.
Validation Rules
If the ShipTo country is
US or Puerto Rico, 5 or 9
digits. If the ShipTo
and must be 6
letter and # is a digit.
Otherwise optional. For
and must be no more
than 9 alphanumeric
characters long.
Must be a valid UPS
Return Shipment the
the following conditions:
1) At least two of the
ShipFrom, and Shipper.
2) None of the following
of the EU: ShipTo,
3) If any of the two
following country codes:
ShipTo/ ShipFrom/
Shipper are members in
EU otherwise check if the
shipper has Third Country
Contract.
Shipment Only
Type
string
Description
2
string
CountryCode
Max Allowed
CountryCode
One
PostalCode
One
PostalCode
Required
XPath
Cond
Name
7/09/2012
Yes
One
Ship From Container
Required for return
shipment. Required if
pickup location is different
from the shipper's
address.
The ship from location’s
name or company name. 35
for return Shipment only 30
the label, and for RFA
Shipment only 20 characters
are printed on Label.
Required if ShipFrom tag
is in the XML.
The ship from Attention
name. 35 characters are
accepted, but for return
will be printed on the label,
and for RFA Shipment only
20 characters are printed on
Label.
is in the XML and Invoice
or CO International forms
is requested. If not
present, will default to the
Shipper Attention Name.
Company’s Tax Identification
Number at the pick up
location
forms) is requested
Page 46
Partial IV
Location ID must be
All letters must be
capitalized.
EEI
Location ID is a unique
identifier referring to a
specific shipping/receiving
location.
Invoice
Empty Tag.
Nafta CO
This field is a flag to indicate
if the receiver is a residential
location.True if
ResidentialAddressIndicator
tag exists; false otherwise
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
String
String
3...10
N/A
container
string
No
One
One
One
1...35
1...35
string
/ShipmentRequest/Shipment/ShipFrom/TaxId
entificationNumber
1...15
/ShipmentRequest/Shipment/ShipFrom/Attenti
onName
string
AttentionName
One
/ShipmentRequest/Shipment/ShipFrom/Name
One
Name
Cond
/ShipmentRequest/Shipment/ShipFrom
Yes*
ShipFrom
/ShipmentRequest/Shipment/ShipTo/LocationI
D
Cond
LocationID
Cond
No
0
XPath
Max Allowed
Name
7/09/2012
Required
One
Container
N/A
/ShipmentRequest/Shipment/ShipFrom/Phone
/Number
One
String
1...15
Extension
/Extension
One
String
1...4
FaxNumber
/ShipmentRequest/Shipment/ShipFrom/FaxN
umber
One
String
1...15
Address
/ShipmentRequest/Shipment/ShipFrom/Addre
ss
One
container
N/A
The Ship from phone
extension.
The Ship from fax number.
Ship from Address
Container.
N/A
If Ship from country is US
10 digits allowed,
allowed.
The package will be
originating from or being
shipped from this
address. The shipment
origin address to the
destination ship to
address.
Page 47
Partial IV
EEI
N/A
Invoice
The Ship from phone
Number.
Nafta CO
If ShipFrom country is
US, PR, CA, and VI, the
digit phone number or
area code, 7 digit phone
number, 4 digit extension
number; for other
7 digit number. Required
if ShipFrom tag is in the
XML and International
forms is requested
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Cond
Number
Yes*
Type
No
Max Allowed
Phone
No
XPath
Yes
Name
7/09/2012
Required
1...35
One
string
1...30
StateProvinceCode
ss/StateProvinceCode
string
35 characters are accepted,
but for return Shipment only
30 characters will be printed
on the label, and for RFA
The Ship from city. 30
for return Shipment only 15
the label, and for RFA
Origin location's state or
province code.
Max Occurrence can be 3
is in the XML.
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,
the StateProvinceCode
will contain the county.
Page 48
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
string
ss/City
One
Type
Three
City
Description
2
ss/AddressLine
Yes
Max Allowed
AddressLine
Yes
XPath
Cond
Name
7/09/2012
Required
The ship from location's
postal code. 9 characters
are accepted, but for RFA
shipment only 5 characters
are printed on the label.
Origin location's country
code.
Page 49
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
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
long.
is in the XML. For Return
Shipment the country
code must meet the
following conditions: 1) At
least two of the following
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
shipper has Third Country
Contract.
Shipment Only
Type
Length
1...9
string
Max Allowed
Description
2
ss/CountryCode
string
CountryCode
One
ss/PostalCode
One
PostalCode
Cond
XPath
Yes
Name
7/09/2012
Required
Shipment charge container
string
One
Yes
Values are
01 = Transportation,
Duties and Taxes
02 =
It is required for nonGround Freight Pricing
shipments only.
If Duty and Tax charges
are applicable to a
shipment and a payer is
not specified, the default
payer of Duty and Tax
charges is Bill to
Receiver.
A shipment charge type
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
present5) The origin and
destination IATA code is
the same
Page 50
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
N/A
N/A
Length
Type
container
Container
Description
Payment information
container for detailed
shipment charges. The two
shipment charges that are
available for specification
are Transportation charges
and Duties and Taxes.
2
Type
/ShipmentRequest/Shipment/PaymentInforma
tion/ShipmentCharge/Type
Max Allowed
tion/ShipmentCharge
One
ShipmentCharge
Two
PaymentInformation
tion
Required
XPath
Cond
Name
7/09/2012
Yes
Container
string
string
One
Yes*
Page 51
Partial IV
Valid month values are
01-12 and valid year
values are Present Year (Present Year + 10 years)
EEI
Format is MMYYYY where
MM is the 2 digit month and
YYYY is the 4 digit year.
9...16
ExpirationDate
tion/ShipmentCharge/BillShipper/CreditCard/E
xpirationDate
Invoice
N/A
Nafta CO
Credit Card number
CO
Valid values are: 01, 03,
04 and 06. For Discover
card the ShipFrom
country has to be US
6
string
One
One
Number
tion/ShipmentCharge/BillShipper/CreditCard/
Number
One
Cond
Type
tion/ShipmentCharge/BillShipper/CreditCard/T
ype
Yes*
tion/ShipmentCharge/BillShipper/CreditCard
Yes*
CreditCard
Return Only
Values are 01 = American
Express, 03 = Discover, 04 =
MasterCard, 05 = Optima,
06 = VISA, 07 = Bravo, and
08 = Diners Club
Container for the BillShipper
billing option. The two
payment methods that are
available for the Bill Shipper
billing option are account
number or credit card.
Shipment Only
Length
Type
Credit card information
container
Required if
/ShipmentRequest/Shipm
ent/PaymentInformation
/ShipmentCharge/BillShip
per/AccountNumber is not
present. Credit card
payment is valid for
shipments without return
service only.
N/A
Container
Description
6
string
UPS account number
N/A
One
AccountNumber
tion/ShipmentCharge/BillShipper/AccountNum
ber
Validation Rules
This element or its sibling
element, BillReceiver,
BillThirdParty or
ConsigneeBilledIndicator,
must be present but no
more than one can be
present.
Must be the same UPS
account number as the
one provided in
Shipper/ShipperNumber.
Either this element or the
sibling element
CreditCard must be
provided, but both may
not be provided.
2
tion/ShipmentCharge/BillShipper
One
Max Allowed
BillShipper
No
XPath
Cond
Name
7/09/2012
Required
1...30
string
2...5
PostalCode
tion/ShipmentCharge/BillShipper/CreditCard/A
ddress/PostalCode
string
1...9
CountryCode
ddress/CountryCode
2
Credit card billing addressee
postal code.
Credit card billing address
country code.
N/A
Must be a valid UPS
Discover card it should be
US
Page 52
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
Length
Type
1...35
string
StateProvinceCode
ddress/StateProvinceCode
string
3...4
string
N/A
string
One
Container
Max Allowed
One
Three
City
ddress/City
One
N/A
Address Line 1 of the credit
card billing address. Usually
Street address information.
One
State or province code of the
credit card billing address.
AddressLine
ddress/AddressLine
One
N/A
Cond
City of the credit card billing
address
Container to hold the Credit
card Billing Address.
Yes*
Max of three AddressLine
can be provided.
Address
ddress
Yes*
It is required to provide
billing address if credit
card information is
provided and when the
US, PR, and CA.
Yes*
Three or four digits that can
be found either on top of
credit card number or on the
back of credit card. Number
of digits varies for different
type of credit card.
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.
Argentina Bahamas
Costa Rica
Dominican Rep
Guatemala
Panama Puerto Rico
Russia
Yes*
Description
Yes*
SecurityCode
tion/ShipmentCharge/BillShipper/CreditCard/S
ecurityCode
One
XPath
Yes*
Name
7/09/2012
Required
string
N/A
container
Yes*
One
tion/ShipmentCharge/BillReceiver/Address
One
Address
No
AccountNumber
tion/ShipmentCharge/BillReceiver/AccountNu
mber
Page 53
Partial IV
EEI
Invoice
N/A
Nafta CO
Container for additional
information for the bill
receiver’s UPS accounts
address.
CO
The UPS account number.
The account must be a
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
drop shipper account, or
a non-shipping account
Return Only
Length
N/A
Container for the
BillReceiver billing option.
Validation Rules
element, BillShipper,
BillThirdParty or
Consignee Billed, must
be present but no more
than one can be present.
For a return shipment, Bill
Receiver is invalid for
Transportation charges.
Shipment Only
Type
container
Description
6
tion/ShipmentCharge/BillReceiver
Max Allowed
BillReceiver
One
XPath
Required
Name
7/09/2012
Cond
string
One
Yes*
AccountNumber
tion/ShipmentCharge/BillThirdParty/AccountN
umber
Page 54
Partial IV
EEI
Invoice
Nafta CO
CO
The UPS account number of
the third party shipper.
valid UPS account
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
a non-shipping account.
The postal code for the UPS
account's pickup address.
The pickup postal code was
entered in the UPS system
when the account was setup.
Return Only
Container for the third party
billing option.
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
is CA, the postal code is 6
BillReceiver or Consignee
Billed, must be present
but no more than one can
be present.
Shipment Only
Length
0...9
N/A
Type
string
container
Max Allowed
Description
6
tion/ShipmentCharge/BillThirdParty
One
BillThirdParty
One
PostalCode
tion/ShipmentCharge/BillReceiver/Address/Po
stalCode
Cond
XPath
Cond
Name
7/09/2012
Required
information for the third party
UPS accounts address.
account's pickup address.
N/A
the same as the UPS
United States and
The country code for the
UPS account's pickup
address.
N/A
string
One
Yes
Page 55
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
container
N/A
0...9
Max Allowed
One
string
CountryCode
tion/ShipmentCharge/BillThirdParty/Address/
CountryCode
Description
2
PostalCode
tion/ShipmentCharge/BillThirdParty/Address/P
ostalCode
One
Address
tion/ShipmentCharge/BillThirdParty/Address
Yes
XPath
Cond
Name
7/09/2012
Required
string
String
N/A
N/A
Container
String
Empty Tag. The payment
method for Transportation
charges must be UPS
account. The UPS
account must be a daily
pickup account or an
occasional account.
Container to hold the
Payment information for the
Ground Freight Pricing
Shipments
Required for Ground
Freight Pricing
Shipments only
payment type information
It is required if the request
has Ground Freight
Pricing shipment
indicator
Valid codes:
01=Prepaid
02=FreightCollect
03=PrepaidThirdParty
No
50
String
Description
/ShipmentRequest/Shipment/FRSPaymentInf
ormation/Type/Description
One
ormation/Type/Code
One
Code
Yes
2
No
One
ormation/Type
Type
One
ormation
One
Containe
r
FRSPaymentInformation
tion/SplitDutyVATIndicator
Cond
SplitDutyVATIndicator
Yes
0
One
Cond
ConsigneeBilledIndicator
tion/ShipmentCharge/ConsigneeBilledIndicato
r
Consignee Billing payment
option indicator. The
presence indicates
consignee billing option is
selected. The absence
indicates one of the other
payment options is selected.
Split Duty VAT Indicator.The
presence indicates the payer
specified for Transportation
Charges will pay
transportation charges and
any duties that apply to the
shipment.The payer
specified for Duties and
Taxes will pay the VAT
(Value-Added Tax) only.
Specifies the description for
payment type
Page 56
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Empty Tag. This element
or its sibling element,
BillShipper, BillReceiver
or BillThirdParty, must be
present but no more than
one can be present. This
billing option is valid for a
shipment charge type of
Transportation only. Only
applies to US/PR and
PR/US shipment origins
and destination.
Shipment Only
Length
Type
Description
0
XPath
Max Allowed
Name
7/09/2012
Required
Cond
N/A
0...9
String
String
The postal code for the
payment information
address.
payment information
address.
string
N/A
container
/ShipmentRequest/Shipment/ShipmentRating
Options
One
ShipmentRatingOptions
One
/ShipmentRequest/Shipment/GoodsNotInFree
CirculationIndicator
No
GoodsNotInFreeCirculationIndica
tor
No
0
ormation/Address/CountryCode
One
CountryCode
Yes
2
ormation/Address/PostalCode
One
PostalCode
Cond
ormation/Address
Address
Goods Not In Free
Circulation indicator.
Empty Tag. This indicator
is invalid for a package
type of UPS Letter and
DocumentsOnly.
container
N/A
Page 57
Partial IV
EEI
Invoice
Nafta CO
Note: The Address is
required only when the
billing option is Freight
collect or ThirdParty.
CO
information for the
FreightCollect and
PrepaidThirdParty Address.
Return Only
Validation Rules
If the Ground Freight
Pricing indicator is
present in the request,
This account number
must be validated to
check if it is Ground
Freight Pricing enabled.
Shipment Only
Length
Type
String
Container
Description
6
Max Allowed
ormation/AccountNumber
One
AccountNumber
One
XPath
Required
Name
7/09/2012
Yes
String
String
Options/FRSShipmentIndicator
One
FRSShipmentIndicator
No
0
One
Options/NegotiatedRatesIndicator
No
NegotiatedRatesIndicator
Negotiated Rates option
indicator. If the indicator is
present and the Shipper is
authorized then Negotiated
Rates should be returned in
the response.
Rates option indicator. If the
Shipment indicator is
enabled and Shipper
number is authorized then
Ground Freight Pricing rates
should be returned in the
response
Page 58
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Negotiated Rates are of
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
returned in the response.
As per discount eligibility
of user, negotiated rates
in the response may
contain ABR or Web
discount rates.
The Shipper account
number must be qualified
to receive Ground Freight
Pricing Shipment rates.
Only the Shipper account
number taken from
/ShipmentRequest/Shipm
ent/
FRSPaymentInformation/
AccountNumber is used
when checking
qualification for Ground
Freight Pricing rates.
Shipment Only
Length
Type
Description
0
XPath
Max Allowed
Name
7/09/2012
Required
Movement Reference
Number (MRN) information
container
N/A
container
string
One
string
string
1...35
container
N/A
/ShipmentRequest/Shipment/Service
One
Service
One
Value
/ShipmentRequest/Shipment/ReferenceNumb
er/Value
No
er/Code
Yes*
Code
Yes
2
er/BarCodeIndicator
One
BarCodeIndicator
No
0
No
Reference Number
information container.
If the indicator is present
then the reference numbers
value will be bar coded on
the label.
Shipment Reference number
type code. The code
specifies the Reference
name. Refer to the
Reference Number Code
table.
N/A
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
or 24 numeric characters
and cannot contain
spaces.
Valid if the
origin/destination pair is
not US/US or PR/PR2
character alpha-numeric.
Customer supplied reference
number.
Valid if the
not US/US or PR/PR
UPS service type
N/A
Page 59
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
String
String
er
Max Allowed
ReferenceNumber
1
MovementReferenceNumber
/ShipmentRequest/Shipment/MovementRefer
enceNumber
1
Options/RateChartIndicator
Description
2
RateChartIndicator
No
XPath
No
Name
7/09/2012
Required
The following Services
are not available to return
shipment: 13 - Next Day
Air Saver, 14 - Next Day
Air Early AM, 59 - 2nd
Day Air A.M., 82 = UPS
Today Standard, 83 =
UPS Today Dedicated
Courier, 84 = UPS Today
Intercity, 85 = UPS Today
Express, 86 = UPS Today
Express Saver.
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
OTHER DESTINATIONS
the InvoiceLineTotal in
the International Forms
Container must be used.
1...19
Invoice Line Total currency
type.
Invoice Line Total amount
for the entire shipment.
Valid values are from 1 to
99999999
Page 60
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
Length
Type
1...35
String
string
N/A
Validation Rules
3
Container
One
string
/ShipmentRequest/Shipment/InvoiceLineTotal
/MonetaryValue
string
MonetaryValue
One
/CurrencyCode
One
CurrencyCode
Container to hold
InvoiceLineTotal Information.
One
One
InvoiceLineTotal
No
/ShipmentRequest/Shipment/Service/Descripti
on
Cond
Description
Description of the service
code. Examples are Next
Day Air, Worldwide Express,
and Ground.
Yes*
/ShipmentRequest/Shipment/Service/Code
Description
Values are: 01 = Next Day
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
= Express Plus, 59 = 2nd
Saver, 82 = UPS Today
Standard, 83 = UPS Today
Dedicated Courier, 84 =
UPS Today Intercity, 85 =
UPS Today Express, 86 =
UPS Today Express Saver.
Note: Only service code 03
is used for Ground Freight
Pricing shipments
Yes*
Code
Yes
2
XPath
Max Allowed
Name
7/09/2012
Required
N/A
COD Amount Container.
N/A
COD amount currency code
type.
N/A
1...8
COD Amount monetary
value.
Page 61
Partial IV
Container
1
String
N/A
Container
N/A
3
string
string
Values are: 1 = cash; 9 =
check, cashiers check or
money order - no cash
allowed.
EEI
One
One
/ShipmentRequest/Shipment/ShipmentServic
eOptions/COD/CODAmount/MonetaryValue
One
MonetaryValue
One
eOptions/COD/CODAmount/CurrencyCode
One
CurrencyCode
Yes*
eOptions/COD/CODAmount
Yes*
CODAmount
Yes*
eOptions/COD/CODFundsCode
Yes*
CODFundsCode
COD container
Invoice
N/A
String
eOptions/COD
Empty Tag.
Indicates COD is
requested. Shipment
COD is only available for
EU origin countries and
for shipper's account type
Daily Pickup and Drop
Shipping. Not available
to shipment with return
service.
Nafta CO
Container
One
COD
N/A
CO
Length
One
eOptions/SaturdayDeliveryIndicator
Return Only
Type
No
SaturdayDeliveryIndicator
Container for Shipment
Service Option
Saturday delivery indicator.
The presence indicates
Saturday delivery; the
absence indicates not
Saturday delivery.
X
Max Allowed
eOptions
Validation Rules
Shipment Only
Required
ShipmentServiceOptions
Description
X
XPath
0
Name
No
7/09/2012
No
1...50
String
One
Yes to
No
UndeliverableEMailAddress
eOptions/Notification/EMail/UndeliverableEMa
ilAddress
N/A
Return Notification or
Label Creation
Notification is allowed for
return shipments only.
QV In-transit Notification
is allowed for return
shipments only. QV Ship
Notification is allowed for
forward moving
shipments only
Email address where the
notification is sent
N/A
Up to five email
addresses are allowed for
each type of Quantum
View TM shipment
notification. Up to two
email address for return
notification.
The address where an
undeliverable eMail
message is sent if the eMail
with the notification is
undeliverable.
There can be only one
UndeliverableEMailAddre
ss for each type of
Quantum View Shipment
Notifications.
Page 62
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
N/A
N/A
1...50
Container for Email
Information
Validation Rules
Shipment Only
Type
Container
String
Container
String
eOptions/Notification/EMail/EMailAddress
One
EMailAddress
One
eOptions/Notification/EMail
One
EMail
Yes*
eOptions/Notification/NotificationCode
Description
Container for the Quantum
View Notification (QVN) is
valid for all shipments
including Return service,
Import Control and Returns
Flexible Access. Valid return
service types are: ERL, PRL,
PNM, RS1, or RS3.
The type of notification
requested. Valid Value: 2 Return Notification or Label
Creation Notification 5 - QV
In-transit Notification 6 - QV
Ship Notification 7 - QV
Exception Notification 8 QV Delivery Notification
Note:QVN Exception
notification and return
notification are not
applicable to GFP.
Five
NotificationCode
Yes*
1
eOptions/Notification
Max Allowed
Notification
One
XPath
Required
Name
7/09/2012
No
string
One
eOptions/Notification/EMail/SubjectCode
No
SubjectCode
User defined text that will be
included in the eMail.
The Memo must occur
only once for each type of
Notifications.
The eMail's subject. Defaults
to text provided by UPS
Specifies a reference code
and reference number to
display in the subject of the
Notification. The valid
subject codes are: 01 Shipment Reference
Number 1 02 - Shipment
Reference Number 2 03 package Reference Number
1 04 - package Reference
Number 2 08 - Subject
Text (Return Notification
only) If a subject code is not
provided or provided that
refers to a nonexistent
reference number, the
subject will default to
shipment Identification
Number
Return Notification only.
For return notification: 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
text is provided and the
subject code tag exists,
then the subject code
value must be 08. If
Subject code is 08,
subject text must exist.
Page 63
Partial IV
The FromName must
occur only once for each
type of Quantum View
Shipment Notifications.
EEI
The name the email will
appear to be from. Defaults
to the Shipper Name.
Invoice
Nafta CO
The e-mail address specifies
the Reply To E-mail
address. The From field of
the message header
contains [email protected].
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
String
1...50
1...35
1...150
string
Max Allowed
One
One
Cond
string
eOptions/Notification/EMail/Subject
1...75
Subject
string
eOptions/Notification/EMail/Memo
2
Memo
One
eOptions/Notification/EMail/FromName
One
FromName
No
FromEMailAddress
eOptions/Notification/EMail/FromEMailAddres
s
No
XPath
No
Name
7/09/2012
Required
The name notification will
to the Shipper Name
N/A
N/A
Page 64
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
X
X
X
X
Defaults to
FromEMailAddress.
X
undeliverable email
message is sent if the Label
Delivery email is
undeliverable.
the Reply To E-mail
the message header
X
1...50
FromName
eOptions/LabelDelivery/EMail/FromName
Shipment Only
N/A
N/A
Length
Type
Container
container
1...50
string
1...50
string
FromEMailAddress
eOptions/LabelDelivery/EMail/FromEMailAddr
ess
1...35
String
N/A
One
string
Max Allowed
One
One
Valid for shipments with a
Electronic Return Label
Return Service.
The destination eMail
address for the Label
Delivery.
One
One
Validation Rules
N/A
eOptions/LabelDelivery/EMail/UndeliverableE
MailAddress
No
Description
Container for the Label
Delivery accessorial|Note:
Currently Label delivery
accessorial is not applicable
to GFP Required for
shipments with either
Return Service or
ImportControl Electronic
LabelMethod type. If this
container is present, either
of the LabelLinksIndicator or
Email container should be
provided.
Container for the email
message.
One
EMailAddress
eOptions/LabelDelivery/EMail/EMailAddress
Required
eOptions/LabelDelivery/EMail
No
EMail
Yes*
LabelDelivery
eOptions/LabelDelivery
No
XPath
Yes*
Name
7/09/2012
No
string
eOptions/InternationalForms
One
Container
N/A
International Forms
information
Page 65
Partial IV
EEI
Invoice
Nafta CO
1...75
One
InternationalForms
CO
string
No
string
eOptions/LabelDelivery/LabelLinksIndicator
0
No
LabelLinksIndicator
Return Only
1...150
One
eOptions/LabelDelivery/EMail/SubjectCode
No
One
SubjectCode
Label Delivery notification.
When the subject code is
provided, the subject will
contain the following: UPS
Label Delivery. The
reference code (the
reference code will be
mapped to the
corresponding ANSI value)
Plus the reference number.
Indicates the Label and
Receipt URL's are to be
returned in the XML
response. Applicable for
Labels or for ReturnService
Electronic Labels
N/A
If the subject code tag is
the subject of the
text is provided, and the
value must be 08;If
Subject code is 08,
subject text must exist. If
a subject code is provided
that refers to a
nonexistent reference
number, the subject will
default to the shipment
X
Length
string
eOptions/LabelDelivery/EMail/Subject
N/A
X
Type
One
Subject
included in the email.
to the Label Delivery
Notification plus the
shipment ID. Defaults to text
provided by UPS
X
Max Allowed
eOptions/LabelDelivery/EMail/Memo
Validation Rules
X
Required
Memo
Description
Shipment Only
XPath
2
Name
No
7/09/2012
No
UserCreatedForm
eOptions/InternationalForms/UserCreatedFor
m
Yes*
N/A
Data container for
DocumentID(s).
Page 66
CO
Nafta CO
Invoice
EEI
Partial IV
Req
Req
Req
Req
Return Only
Req
Indicates the name of the
International form requested.
Validation Rules
Possible Values are: 01 Invoice; 02 - SED03 CO; 04 - NAFTA CO; 05
- Partial Invoice;
06 - Packinglist, 07 Customer Generated
Forms
. For shipment with
return service, 01 or 05
are the only valid values.
Note: 01 and 05 are
mutually exclusive and 05
is only valid for return
shipments only.
Shipment Only
Length
Type
string
Container
Description
2
Max Allowed
eOptions/InternationalForms/FormType
One
FormType
1
XPath
Required
Name
7/09/2012
*Yes to Six
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
26
Max Allowed
DocumentID
eOptions/InternationalForms/UserCreatedFor
m/DocumentID
Unbounded
XPath
Required
Name
7/09/2012
Yes
Page 67
Opt
Opt
Opt
0
N/A
N/A
N/A
N/A
string
string
Opt
One
One
Presence of the indicator
means user will supply
additional document, such
as SED, NAFTA_CO or CO.
Contains description text
which identifies the group of
International forms. This
element does not appear on
the forms.
This indicator should be
set when the shipper
intends to utilize UPS
paperless invoice
functionality AND the
shipper has SELFPREPARED 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
invoice. 4. Invoice data is
supplied by the client and
the data passes
validation.
N/A
No
FormGroupIdName
eOptions/InternationalForms/FormGroupIdNa
me
50
AdditionalDocumentIndicator
eOptions/InternationalForms/AdditionalDocum
entIndicator
No
0
String
DocumentID represents a
document uploaded to
Forms History.
Page 68
N/A
Cond Req
Sec 5a
Sec 5a
N/A
Sec Sec
Sec 5a
N/A
N/A
N/A
N/A
N/A
N/A
Partial IV
N/A
N/A
N/A
Sec 5a
N/A
Max Occurrence must be
3
N/A
Sec 5a
Address line of the
Forwarding agent.
N/A
EEI
Applicable for SED form
only.
N/A
Address information of the
Forwarding agent.
N/A
Req
Invoice
only.
N/A
Tax ID of the Forwarding
agent.
N/A
N/A
Nafta CO
only.
N/A
N/A
Company Name or the
Individual name of the
Forwarding agent.
N/A
only.
N/A
Return Only
CO
N/A
The forwarding agent is the
company or person acting as
agent in the trans-shipping
of freight to the destination
country.
N/A
Holds the contact
information of various
parties.
and NAFTA CO only.
Required for NAFTA CO
and SED. Ultimate
consignee contact
information is required for
SED. Producer contact
NAFTA CO
N/A
1...35
and is required. Valid
values is: 01 - Shipper
filing SED
N/A
1...15
N/A
string
Validation Rules
N/A
1...35
string
Container
Three
Description
Indicates the SED filing
option. If UPS files SED on
shipper's behalf, there is
additional $10 charge to the
shipper
Shipment Only
Length
Type
string
string
One
One
AddressLine
eOptions/InternationalForms/Contacts/Forwar
dAgent/Address/AddressLine
N/A
One
*Yes
Address
dAgent/Address
*Yes
N/A
Container
One
*Yes
dAgent/TaxIdentificationNumber
One
CompanyName
dAgent/CompanyName
No
ForwardAgent
dAgent
*Yes
Contacts
Container
eOptions/InternationalForms/Contacts
One
eOptions/InternationalForms/SEDFilingOption
Cond
SEDFilingOption
Cond
2
XPath
Max Allowed
Name
7/09/2012
Required
Partial IV
N/A
N/A
N/A
N/A
EEI
Sec 5a
Sec 5a
Sec 5a
Sec 5a
Invoice
N/A
N/A
N/A
Nafta CO
N/A
N/A
N/A
Sec 4a
N/A
only.
Sec 4a
N/A
N/A
Sec 5a
N/A
N/A
Ultimate consignee.
N/A
N/A
Req Sec 4a
Sec 4a
N/A
only.
N/A
N/A
N/A
Company Name or the
Ultimate consignee.
N/A
only. Required when the
form requested is SED.
N/A
only.
N/A
Country code of the
Forwarding agent.
The ultimate consignee is
the person or company who
receives the goods for enduse or the person or
company listed on the export
license. This is the end-user
of the goods.
N/A
1...35
Cond
2
Postal code of the
Forwarding agent.
N/A
only. Required for certain
countries. The length of
the postal code depends
on the country code.
N/A
Town of the Forwarding
Agent
N/A
CO
countries.
Return Only
State of the Forwarding
agent.
N/A
only.
N/A
City of the Forwarding agent.
N/A
Validation Rules
N/A
Length
1...30
1...5
Description
Shipment Only
Type
string
string
1...30
1...35
1...50
String
string
Address
eOptions/InternationalForms/Contacts/Ultimat
eConsignee/Address
1...9
string
string
Container
CompanyName
eConsignee/CompanyName
Container
Max Allowed
One
One
UltimateConsignee
eConsignee
One
One
One
CountryCode
dAgent/Address/CountryCode
One
One
PostalCode
dAgent/Address/PostalCode
One
Required
*Yes
Town
dAgent/Address/Town
Cond
StateProvinceCode
dAgent/Address/StateProvinceCode
*Yes
City
dAgent/Address/City
*Yes
XPath
*Yes
Name
Cond
7/09/2012
No
Page 69
Partial IV
N/A
N/A
N/A
N/A
N/A
N/A
EEI
Sec 4a
Sec 4a
Sec 4a
Sec 4a
Invoice
N/A
N/A
N/A
N/A
N/A
N/A
Sec 4a
only.
Sec 4a
N/A
Company Name or the
Intermediate consignee.
N/A
only.
N/A
The intermediate consignee
is the person or company in
the importing country that
makes final delivery to the
ultimate consignee.
N/A
N/A
Opt Sec Connd Opt Sec 4b
Cond Req 4b
Opt Sec 4b
Nafta CO
N/A
N/A
N/A
only.
N/A
Country code of the Ultimate
consignee.
N/A
Postal code of the Ultimate
consignee.
N/A
Town of the Ultimate
consignee
N/A
CO
countries
Return Only
State of the Ultimate
consignee.
N/A
only.
N/A
City of the Ultimate
consignee.
N/A
3
N/A
Address line of the Ultimate
consignee.
N/A
Length
1...35
1...30
1...5
1...30
Validation Rules
Shipment Only
Type
string
string
string
String
Description
Page 70
N/A
Container
1...35
1...35
string
One
One
CompanyName
eOptions/InternationalForms/Contacts/Interme
diateConsignee/CompanyName
*Yes
IntermediateConsignee
diateConsignee
No
N/A
N/A
2
CountryCode
eConsignee/Address/CountryCode
1...9
One
PostalCode
eConsignee/Address/PostalCode
String
One
One
Town
eConsignee/Address/Town
String
Max Allowed
Three
*Yes
StateProvinceCode
eConsignee/Address/StateProvinceCode
One
*Yes
City
eConsignee/Address/City
One
Required
AddressLine
eConsignee/Address/AddressLine
Cond
XPath
*Yes
Name
Cond
7/09/2012
No
Partial IV
N/A
N/A
N/A
N/A
Cond Req 4b
Cond Req 4b
N/A
N/A
N/A
EEI
Invoice
N/A
Cond Req
4b
N/A
N/A
Cond Req
4b
N/A
N/A
Cond
Req 4b
Nafta CO
N/A
N/A
N/A
N/A
N/A
Cond
Req 4b
only.
N/A
Cond
Req 4b
Country code of the
Intermediate Consignee.
N/A
Postal code of the
N/A
Town of the Intermediate
consignee
N/A
CO
countries.
Return Only
State of the Intermediate
Consignee.
N/A
only.
N/A
City of the Intermediate
Consignee.
N/A
3
N/A
Address line of the
N/A
only.
N/A
1...30
N/A
Length
1...50
1...35
1...30
1...5
String
Validation Rules
2
CountryCode
diateConsignee/Address/CountryCode
Description
Shipment Only
Type
Container
string
string
string
One
PostalCode
diateConsignee/Address/PostalCode
1...9
One
One
Town
diateConsignee/Address/Town
string
Three
*Yes
StateProvinceCode
diateConsignee/Address/StateProvinceCode
string
Max Allowed
One
*Yes
City
diateConsignee/Address/City
One
*Yes
AddressLine
diateConsignee/Address/AddressLine
One
Required
Address
diateConsignee/Address
Cond
XPath
*Yes
Name
Cond
7/09/2012
No
Page 71
Page 72
Partial IV
N/A
N/A
N/A
N/A
EEI
N/A
N/A
N/A
N/A
Invoice
N/A
N/A
N/A
N/A
Nafta CO
N/A
N/A
Return Only
CO
N/A
N/A
Tax ID of the Producer.
Applies to NAFTA CO.
Only applicable when
producer option is empty
or not present
N/A
Company Name or the
Producer.
Possible Values are:01:
AVAILABLE TO
CUSTOMS UPON
REQUEST02: SAME AS
EXPORTER03:
ATTACHED LIST04:
UNKNOWN
or not present.
Conditionally required for:
NAFTA CO, when
Producer option is not
specified.
N/A
forms
N/A
Validation Rules
N/A
Description
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
dated by the producer. The
date must be the date the
Certificate was completed
and signed.
The text associated with the
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
list of additional producers,
including the legal name,
address (including country),
and legal tax identification
number, cross-referenced to
the goods described in the
Description of Goods field.
Shipment Only
Length
Type
1...35
Container
string
string
1...35
1...15
string
One
One
One
eOptions/InternationalForms/Contacts/Produc
er/TaxIdentificationNumber
Cond
CompanyName
er/CompanyName
No
Option
er/Option
No
2
Max Allowed
Producer
er
One
XPath
Cond
Name
7/09/2012
Required
Contact name at the
Producer location.
Page 73
Partial IV
N/A
N/A
N/A
N/A
N/A
N/A
N/A
EEI
N/A
N/A
N/A
N/A
N/A
N/A
N/A
Invoice
N/A
N/A
N/A
N/A
N/A
N/A
Nafta CO
N/A
N/A
N/A
N/A
N/A
Applies to NAFTA CO
N/A
Country code of the
Producer.
N/A
Postal code of the Producer.
Required for certain
N/A
Town of the Producer
N/A
Return Only
CO
N/A
State of the Producer.
countries
N/A
City of the Producer.
NAFTA CO, when
specified.
N/A
3
N/A
Address line of the
Producer.
N/A
Producer.
Validation Rules
Only applicable if
or not present.
NAFTA CO, when
specified.
N/A
Length
1...50
1...35
1...9
1...2
No
Description
Shipment Only
Type
Container
string
string
string
1...30
1...5
1...30
One
One
AttentionName
er/AttentionName
String
Cond
CountryCode
er/Address/CountryCode
1
PostalCode
er/Address/PostalCode
*Yes
string
string
String
Max Allowed
One
Three
Town
er/Address/Town
One
StateProvinceCode
er/Address/StateProvinceCode
*Yes
City
er/Address/City
One
AddressLine
er/Address/AddressLine
One
Required
Address
er/Address
Cond
XPath
No
Name
Cond
7/09/2012
*Yes
container
N/A
One
string
1...35
One
string
1...35
eOptions/InternationalForms/Contacts/SoldTo
/TaxIdentificationNumber
One
string
1...15
Phone
/Phone
One
container
N/A
Container
String
String
1
1
String
1
Company Name.
Sold to contact name.
SoldTo Tax Identification
Number
Phone Container
Page 74
Partial IV
One
Yes*
AttentionName
/AttentionName
SoldTo Container.
EEI
No
Name
/Name
Producer email address.
Invoice
The location's phone
extension of the Producer
Nafta CO
No
SoldTo
The location's phone number
of the Producer
CO
No
EMailAddress
er/EMailAddress
Validation Rules
Return Only
Yes
Extension
er/Phone/Extension
Description
Shipment Only
No
Number
er/Phone/Number
Yes*
Length
Phone
er/Phone
No
Type
XPath
1
Name
No
Max Allowed
7/09/2012
Required
Sold To contact's phone
number
Sold To contact's phone
extension
sold to section of the NAFTA
CO form. the values
indicate the following 01 –
Unknown
Applies to NAFTA CO
form. Possible Values
are 01 and 02
Address Container.
3
30
SoldTo location’s street
address.
5
SoldTo location’s city.
?
SoldTo location’s state or
province code.
countries.
SoldTo location’s town code.
Page 75
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
Validation Rules
35
N/A
Description
Shipment Only
Type
string
string
Town
/Address/Town
string
1...15
string
One
StateProvinceCode
/Address/StateProvinceCode
One
string
string
container
Three
City
/Address/City
?
One
One
AddressLine
/Address/AddressLine
One
string
No
Address
/Address
2
Option
/Option
Yes*
Max Allowed
Extension
/Phone/Extension
Yes
One
Number
/Phone/Number
Yes
One
XPath
Cond
Required
Name
No
Yes*
7/09/2012
No
Partial IV
EEI
Invoice
Nafta CO
string
string
CO
Type
One
One
EMailAddress
/EMailAddress
Validation Rules
Return Only
Max Allowed
Cond
CountryCode
/Address/CountryCode
Description
Shipment Only
Required
PostalCode
/Address/PostalCode
Length
XPath
10
Name
Yes
7/09/2012
No
String
Page 76
Opt
Opt
Opt
Opt
Req
N/A
N/A
Req
Req
N/A
N/A
Req
Req
N/A
N/A
Req
Req
Required for Invoice
forms and optional for
Partial Invoice.
Partial Invoice. Must be
numeric. Valid characters
are 0-9.
Req
1...50
1...35
N/A
1...7
Container tag for the unit's
information of each product.
(also called as commodity)
Total quantity of each
commodity to be shipped,
measured in the units
specified in the Unit of
Measure field
Contains the commodity/
product information
N/A
Container
string
Container
string
Description of the product.
Applies to SED, Invoice,
Partial Invoice, CO and
NAFTA CO. When any
requested Product must
be present at least once
but no more than 50.
Note: For Partial Invoice
this container is optional.
Applies to all International
Forms. Optional for
present at least once and
can occur for a maximum
of 3 times
N/A
One
One
One
One
Number
eOptions/InternationalForms/Product/Unit/Nu
mber
SoldTo email address.
*Yes to fifty
Unit
eOptions/InternationalForms/Product/Unit
SoldTo location’s country
code.
*Yes
Description
eOptions/InternationalForms/Product/Descripti
on
Cond
eOptions/InternationalForms/Product
*Yes
Product
1
2
SoldTo location’s postal
code.
Page 77
Opt
Opt
Partial IV
N/A
N/A
N/A
EEI
Invoice
N/A
N/A
N/A
Nafta CO
N/A
N/A
N/A
Return Only
CO
N/A
The Unit of Measure if OTH
(Other) is entered as the
UnitOfMeasurement code.
N/A
Code for the Unit of
measurement of the
commodity units.
N/A
Container tag for the Unit of
measurement for the
commodity.
Shipment Only
Length
Type
Partial Invoice.
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,
SYD = Square Yards, TU
= Tube, YD = Yard, OTH
= Other.
Applies to Invoice and
Partial Invoice forms.
Conditionally Required for
the Invoice and Partial
Invoice form if OTH is
entered as the units
UnitOfMeasurement
Code
N/A
Container
Validation Rules
1... 3
string
string
Description
1...3
Max Allowed
One
One
Description
eOptions/InternationalForms/Product/Unit/Unit
OfMeasurement/Description
One
Code
OfMeasurement/Code
*Yes
UnitOfMeasurement
OfMeasurement
*Yes
XPath
Cond
Name
7/09/2012
Required
Page 78
Nafta CO
Invoice
EEI
Partial IV
N/A
N/A
N/A
Opt
Return Only
CO
Monetary amount used to
specify the worth or price of
the commodity. Amount
should be greater than zero
Validation Rules
Partial Invoice form.
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
of ( number*values) of all
products should not
exceed
9999999999999999.99
N/A
Description
Shipment Only
Type
Length
1...19
string
Max Allowed
Value
eOptions/InternationalForms/Product/Unit/Val
ue
One
XPath
*Yes
Name
7/09/2012
Required
Page 79
Invoice
EEI
N/A
N/A
Partial IV
Opt
Nafta CO
N/A
Partial Invoice. Required
for Invoice forms and
optional for Partial
Invoice.
CO
The part number or
reference number for the
product contained in the
invoice line, as indicated on
the customs invoice.
Return Only
6-to-15-alphanumeric
commodity code. Customs
uses this code to determine
what duties should be
assessed on the commodity.
Validation Rules
Applies to Invoice, Partial
Invoice and 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,
using the H.S. tariff
classification of the
country into whose
territory the good is
imported.
N/A
Description
Shipment Only
Length
Type
string
Max Allowed
One
6...15
1...10
string
PartNumber
eOptions/InternationalForms/Product/PartNu
mber
One
CommodityCode
eOptions/InternationalForms/Product/Commo
dityCode
Cond
XPath
No
Name
7/09/2012
Required
Partial IV
EEI
N/A
N/A
N/A
N/A
N/A
N/A
Opt
Req
N/A
Invoice
Nafta CO
Req
N/A
N/A
Return Only
CO
Req
N/A
string
One
If present, JNT will be used
as the origin of country code
on the NAFTA form and the
Product/OriginCountryCode
tag will be ignored.
For each good described in
the Description of Goods
field, where the good is
subject to a regional value
content (RVC) requirement,
indicate NC if the RVC is
calculated according to the
net cost method; otherwise,
indicate NO.
N/A
string
N/A
EMPTY
One
Cond
Cond
2
NetCostCode
eOptions/InternationalForms/Product/NetCost
Code
One
JointProductionIndicator
eOptions/InternationalForms/Product/JointPro
ductionIndicator
No
OriginCountryCode
eOptions/InternationalForms/Product/OriginC
ountryCode
The country in which the
good was manufactured,
produced, or grown. For
detailed information on
country of origin, certificate
of origin, rules of origin, and
any related matters, please
refer to the U.S. Customs
and Border Protection Web
site at www.customs.gov or
contact your country's
Customs authority.
Validation Rules
Invoice, CO and NAFTA
CO. Required for Invoice
and CO forms. Optional
for Partial Invoice.
Conditionally required for
NAFTA CO if
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
meaning of the NAFTA
Rules of Origin
Regulations, and any
subsequent processing in
the other NAFTA country
does not increase the
transaction value of the
goods by more than
seven percent; otherwise
use the
for joint production.
Shipment Only
Length
Type
Description
2
XPath
Max Allowed
Name
7/09/2012
Required
Applies to NAFTA CO
only
Applies to NAFTA CO
only. Required for NAFTA
CO. Possible Values:
NCNO
Page 80
Partial IV
N/A
N/A
N/A
N/A
EEI
N/A
N/A
N/A
N/A
Invoice
N/A
N/A
N/A
N/A
Nafta CO
N/A
N/A
Applicable for NAFTA CO
and is required. Possible
Values: ABCDEF.
N/A
N/A
CO
N/A
Return Only
Applies to NAFTA CO
only. Format is
yyyyMMdd
N/A
string
string
One
1
One
*Yes
Cond
Applies to NAFTA CO
only. Format is
yyyyMMdd
N/A
Length
N/A
If the RVC is calculated over
a period of time, it should be
identified by the begin date
(yyyyMMdd) of that period.
(Reference: Articles 402.1,
402.5).
identified by the End date
402.5).
Indicates the criterion (A
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
(certain automatic data
processing goods and their
parts).
N/A
Type
Container
Applies to NAFTA CO
only.
Shipment Only
Max Allowed
One
Date Range for regional
value content (RVC)
8
PreferenceCriteria
eOptions/InternationalForms/Product/Preferen
ceCriteria
Validation Rules
string
EndDate
DateRange/EndDate
Description
8
BeginDate
DateRange/BeginDate
One
NetCostDateRange
DateRange
Required
XPath
*Yes
Name
7/09/2012
No
Page 81
Applicable for CO and is
required. Should be
are 0 -9.
Applies to CO and SED
forms only. Required for
CO and SED forms.
forms only
Page 82
N/A
N/A
N/A
N/A
Partial IV
Invoice
N/A
EEI
Nafta CO
N/A
Return Only
CO
string
1...35
1...3
Applies to CO Only
The total number of
packages, cartons, or
containers for the commodity
The shipping weight,
including containers, for
each commodity with a
separate Harmonized Tariff
Code / Schedule B Number.
This weight does not include
carrier equipment.
Measurement of weight
Values: Yes, No[1], No[2],
and No[3]
N/A
N/A
N/A
Any special marks, codes,
and numbers that may
appear on package
Validation Rules
Opt Sec
2a
Opt Sec
2a
Opt Sec
2a
Container
Container
One
No
Cond
Description
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
Certificate for the good
voluntarily provided to the
exporter by the producer.
Shipment Only
string
One
UnitOfMeasurement
eOptions/InternationalForms/Product/Product
Weight/UnitOfMeasurement
One
Length
One
ProductWeight
Weight
Cond
Type
NumberOfPackagesPerCommodi
ty
eOptions/InternationalForms/Product/Number
OfPackagesPerCommodity
3 0r 5
MarksAndNumbers
eOptions/InternationalForms/Product/MarksA
ndNumbers
string
ProducerInfo
eOptions/InternationalForms/Product/Produce
rInfo
One
XPath
Cond
Name
*Yes
Max Allowed
7/09/2012
Required
1...5
1...25
1...20
string
string
N/A
Container
Description of the Unit of
Measure
Weight
Includes the following
information for used selfpropelled 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
self propelled vehicles for
which there are no VINs. Or
the Vehicle Title Number.
Container tag for the
schedule B information of a
commodity
forms only. Valid
characters are 0-9 and '.'
(Decimal point). Limit to 1
digit after the decimal.
The maximum length of
the field is 5 including '.'
and can hold up to 1
decimal place.
Applies to SED forms
only
only. Required for SED
form
Page 83
Partial IV
EEI
Invoice
Nafta CO
forms only. Possible
values: KGS, LBS.
CO
Code for unit of
Return Only
Validation Rules
Shipment Only
Type
string
String
Length
Max Allowed
One
One
Description
3
Required
One
ScheduleB
eOptions/InternationalForms/Product/Schedul
eB
One
VehicleID
eOptions/InternationalForms/Product/VehicleI
D
One
Weight
Weight/Weight
*Yes
Description
Weight/UnitOfMeasurement/Description
*Yes
Code
Weight/UnitOfMeasurement/Code
No
XPath
Cond
Name
7/09/2012
No
string
1...10
string
N/A
Container
One
One
One
*Yes
Cond
UnitOfMeasurement
eB/UnitOfMeasurement
*Yes
Quantity
eB/Quantity
The unit of measure
indicated on the Export
License.
only. Has to be 10
characters.
only. Conditionally
required for SED forms if
ScheduleB
UnitOfMeasurement is
not X. Should be
Numeric. Valid characters
are 0 -9.
only.
Page 84
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
A unique 10-digit commodity
classification code for the
item being exported. (To
classify a commodity access
the following Web page:
http://www.census.gov/foreig
ntrade/schedules/b/#search).
The count of how many
Schedule B units of the
current good are in the
shipment (SED only).For
example, if the Schedule B
unit of measure is dozens
and eight dozen, is being
shipped, indicate 8 in this
field.
Shipment Only
Length
Type
Number
eB/Number
10
XPath
Max Allowed
Name
7/09/2012
Required
The unit of measure
License. Enter an X if there
is no unit of measure in the
Schedule B Unit field.
Measure
Page 85
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
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
Liter, PK: Pack, PRS:
Pairs, RBA: Running
Bales, SQ: Square, T:
Ton, THS: 1,000, X: No
Quantity required.
Return Only
Description
Shipment Only
Length
1...3
1...20
Type
string
String
Max Allowed
One
Description
eB/UnitOfMeasurement/Description
One
Code
eB/UnitOfMeasurement/Code
*Yes
XPath
No
Name
7/09/2012
Required
The value of the S.E.D.
commodity contained on the
S.E.D. This amount will
always be USD.
form. Possible Values:
D: Domestic; F: Foreign;
M: Foreign Military
form. Valid characters are
0-9 and '.' (Decimal
point). Limit to 2 digit after
the decimal. The
field is 15 including '.' and
places. Note: This value
is calculated based on the
Product/Unit/Value and
/Product/Unit/Number
(Number of Units * Price
per Unit). If the total value
is incorrect it will be
replaced by the actual
calculated total value.
Page 86
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Code indicating Domestic:
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.
ForeignMilitary: Exported
merchandise that is sold
under the foreign military
sales program.
Shipment Only
Length
Type
string
1...15
string
One
One
SEDTotalValue
eOptions/InternationalForms/Product/SEDTot
alValue
Cond
ExportType
eOptions/InternationalForms/Product/ExportT
ype
Cond
1
XPath
Max Allowed
Name
7/09/2012
Required
Data Container holding
package related
information
Data Container holding
package/product related
information that will break
up the product into each
package on the packing
list
Package number the
product should be
allocated to ont he
packing list
Page 87
Partial IV
EEI
Invoice
International form requested
to NOT have product
information.
Possible Values are 04 –
NAFTA CO. Please note
that if this is used and you
DO NOT have the
corresponding form type
requested this will be
IGNORED.
Nafta CO
If this container is not
present we assume that
the DEFAULT is selected
which is "none" and all
products will appear on all
forms.
CO
Container tag for
determining whether or not
to exclude product
information from a particular
form.
Return Only
Validation Rules
Shipment Only
Length
N/A
1..2
Type
Container
String
Container
String
Max Allowed
One
unbounded
Unbounded
No
Description
String
PackageNumber
/ShipmentRequest/Shipment/ShipmentS
erviceOptions/InternationalForms/Produc
t/PackingListInfo/PackageAssociated/Pa
ckageNumber
1
PackageAssociated
t/PackingListInfo/PackageAssociated
1
PackingListInfo
t/PackingListInfo
Yes
FormType
eOptions/InternationalForms/Product/Exclude
FromForm/FormType
Yes*
ExcludeFromForm
eOptions/InternationalForms/Product/Exclude
FromForm
Yes
XPath
Yes
Name
7/09/2012
Required
PurchaseOrderNumber
eOptions/InternationalForms/PurchaseOrderN
umber
Date when the Invoice is
created. Ideally this is the
same as the ship date.
The customer's order
reference number
Partial Invoice forms only.
Commercial Invoice number
assigned by the exporter
One
string
One
string
1...35
Cond
No
Page 88
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
Type
Max Allowed
Length
1...35
InvoiceDate
eOptions/InternationalForms/InvoiceDate
string
eOptions/InternationalForms/InvoiceNumber
Validation Rules
Partial Invoice.
for Invoice form for
forward shipments. For
service, the user input will
be ignored, and the field
will be blank on the
invoice. Format is
yyyyMMdd
8
InvoiceNumber
Description
Amount of Product
associated with a
package
One
ProductAmount
t/PackingListInfo/PackageAssociated/Pro
ductAmount
Yes
XPath
No
Name
7/09/2012
Required
1...20
1...150
string
string
string
One
No
One
eOptions/InternationalForms/Comments
One
Comments
Cond
ReasonForExport
eOptions/InternationalForms/ReasonForExpor
t
No
TermsOfShipment
eOptions/InternationalForms/TermsOfShipme
nt
Page 89
Partial IV
EEI
Any extra information about
the current shipment
Invoice
forms and Optional for
Partial Invoice. No
validation
Nafta CO
reason to export the current
international shipment
Possible values: SALE,
GIFT, SAMPLE, RETURN,
REPAIR,
INTERCOMPANYDATA,
Any other reason
CO
Indicates the rights to the
seller from the buyer.
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,
FAS: Free Alongside
Ship, FCA: Free Carrier,
FOB: Free On Board.
Return Only
Validation Rules
Shipment Only
Length
Type
Description
3
XPath
Max Allowed
Name
7/09/2012
Required
Page 90
Partial IV
EEI
Invoice
Nafta CO
Container tag that holds the
discount.
On the invoice for return
shipment, the verbiage is
as follows (user input is
ignored): The exporter of
the products covered by
this document declares
that except where
otherwise clearly
indicated these products
are of EEA preferential
origin
CO
Validation Rules
Return Only
Description
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
NAFTA. I hereby certify that
the information on this
invoice is true and correct
and the contents and value
of this shipment is as stated
above. EEA statement: The
exporter of the products
covered by this document
declares that except where
otherwise clearly indicated
these products are of EEA
preferential origin.
Shipment Only
Length
1...550
Type
string
N/A
Max Allowed
Container
eOptions/InternationalForms/Discount
One
Discount
One
DeclarationStatement
eOptions/InternationalForms/DeclarationState
ment
No
XPath
No
Name
7/09/2012
Required
string
N/A
0...15
Container
string
N/A
One
One
Container
*Yes
One
InsuranceCharges
eOptions/InternationalForms/InsuranceCharg
es
One
MonetaryValue
eOptions/InternationalForms/FreightCharges/
MonetaryValue
No
eOptions/InternationalForms/FreightCharges
*Yes
FreightCharges
No
MonetaryValue
eOptions/InternationalForms/Discount/Moneta
ryValue
Page 91
Partial IV
Insurance Charges
EEI
Cost to transport the
shipment
decimal places.
Invoice
Nafta CO
Freight Charges
CO
The discount to be
subtracted from the sum of
the total value on the
invoice.
decimal places. This
value should be greater
than or equal to zero or
less than or equal to the
value of all goods listed
on the invoice.
Return Only
Validation Rules
Shipment Only
Length
Type
Description
15
XPath
Max Allowed
Name
7/09/2012
Required
Currency code for all the
monetary values of the
Invoice form
string
One
Cond
Page 92
Partial IV
Description of what the other
charges are for.
Required for Complete
Invoice and Optional for
EEI
The Monetary value of Other
Charges
decimal places.
Invoice
Nafta CO
information of amount that
covers additional charges
not already listed on the
invoice
CO
The amount the shipper or
receiver pays to cover the
cost of replacing the
shipment if it is lost or
damaged
decimal places.
Return Only
Validation Rules
Shipment Only
Length
Max Allowed
Type
string
0...15
N/A
*Yes
One
One
Container
string
0...15
1...10
CurrencyCode
eOptions/InternationalForms/CurrencyCode
Description
3
Description
eOptions/InternationalForms/OtherCharges/D
escription
string
eOptions/InternationalForms/OtherCharges/M
onetaryValue
One
MonetaryValue
eOptions/InternationalForms/OtherCharges
One
OtherCharges
No
MonetaryValue
eOptions/InternationalForms/InsuranceCharg
es/MonetaryValue
*Yes
XPath
*Yes
Name
7/09/2012
Required
string
string
Applies to NAFTA CO
form only. Required for
NAFTA CO. This is not
valid for a paperless
shipment.
End Date of the blanket
period. It is the date upon
which the blanket period
expires.
The date the goods will be
exiting the country
CO and SED forms.
Format is yyyyMMdd
The name of the carrier that
is exporting the shipment.
The vessels flag number
should also be entered, if the
carrier is a vessel.
CO and SED forms.
One
string
1...35
string
eOptions/InternationalForms/ExportingCarrier
One
ExportingCarrier
eOptions/InternationalForms/ExportDate
Cond
ExportDate
Cond
8
One
*Yes
Page 93
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Applies to NAFTA CO
NAFTA CO. Format is
yyyyMMdd. This is not
shipment.
Applies to NAFTA CO
NAFTA CO. Format is
yyyyMMdd. This is not
shipment.
8
One
EndDate
eOptions/InternationalForms/BlanketPeriod/E
ndDate
*Yes
BeginDate
eOptions/InternationalForms/BlanketPeriod/B
eginDate
Description
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
which preferential treatment
is claimed based on this
certificate must occur
between these dates.
Begin date of the blanket
which the Certificate
becomes applicable to the
good covered by the blanket
Certificate (it may be prior to
the date of signing this
Certificate).
Shipment Only
Type
Max Allowed
Length
N/A
Container
eOptions/InternationalForms/BlanketPeriod
8
BlanketPeriod
One
XPath
Cond
Name
7/09/2012
Required
1...25
The Import Entry Number
when the export transaction
is used as proof of export for
import transactions
(examples: In Bond,
Temporary Import Bond or
Drawbacks)
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
goods were shipped from
Puerto Rico, enter PR.
only. Conditionally
Required for SED forms
when In bond code value
is other than 70(Not In
Bond)
Page 94
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
1...17
string
string
One
Cond
1...5
eOptions/InternationalForms/PointOfOrigin
string
PointOfOrigin
One
eOptions/InternationalForms/EntryNumber
One
EntryNumber
only. No Validations.
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:
IE from a FTZ; 68: T and
E from a FTZ
The two-character In Bond
Code
Cond
eOptions/InternationalForms/InBondCode
Cond
InBondCode
Validation Rules
Shipment Only
Type
string
Description
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
Transport Association (IATA)
code
2
eOptions/InternationalForms/CarrierID
Max Allowed
CarrierID
One
XPath
Required
Name
7/09/2012
No
only. Required for SED.
Only allowed values can
be entered. Only 10
Characters can appear on
the form. Anything greater
than 10 characters will be
truncated on the form.
only. No validation.
The country and the port
where the goods will be
unloaded from the exporting
carrier. For vessel and air
shipments only.
Pier where goods are
loaded. For vessel
shipments only
Page 95
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Mode of transport by which
the goods are exported.
Possible values: Air,
AirContainerized, Auto,
FixedTransportInstallations,
Mail,
PassengerHandcarried,
Pedestrian, Rail, Rail,
Containerized, RoadOther,
SeaBarge,
SeaContainerized,
SeaNoncontainerized,
Truck, TruckContainerized
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.
Postal Office from where the
goods are mailed
Shipment Only
Length
1...35
Type
string
1...35
1...35
string
string
Max Allowed
One
One
1...35
LoadingPier
eOptions/InternationalForms/LoadingPier
string
eOptions/InternationalForms/PortOfUnloading
One
PortOfUnloading
One
eOptions/InternationalForms/PortOfExport
Cond
PortOfExport
No
ModeOfTransport
eOptions/InternationalForms/ModeOfTranspor
t
No
XPath
No
Name
7/09/2012
Required
N/A
string
EMPTY
N/A
N/A
Container
One
One
Cond
One
EMPT
Y
One
License
eOptions/InternationalForms/License
No
ContainerizedIndicator
eOptions/InternationalForms/ContainerizedInd
icator
No
eOptions/InternationalForms/RoutedExportTra
nsactionIndicator
Cond
RoutedExportTransactionIndicato
r
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
(or other) agent to export the
merchandise outside the
U.S.
If present indicates that the
goods are containerized.
This applies to vessel
shipments only
Container for License
information. If the product is
not licensable, a valid
license exception code
needs to be entered. If
shipping different products
that are covered under
different licenses or license
exceptions, then separate
SEDs must be created.
only. Valid values are: R
- Related, N - Non-related
only
only
forms.
Page 96
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
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
fiscal year. If unincorporated,
then an equivalent interest in
the business.
Shipment Only
Length
Type
PartiesToTransaction
eOptions/InternationalForms/PartiesToTransa
ction
1
XPath
Max Allowed
Name
7/09/2012
Required
Page 97
Partial IV
EEI
only. ECCN is required
one of the following
License Exception Codes
is entered: CIV, CTP,
ENC, or KMI LVS
Invoice
Export Control Classification
Number. This number
identifies categories, product
groups, strategic level of
control, and country groups.
Some products have an
ECCN number.
Nafta CO
Please refer to Appendix Q
for values and descriptions.
only. Either License
number or License
exception code should be
present for SED form,
both License number and
License Exception code
cannot be present for
SED form. Validated for
possible values
The license number that
authorizes ship product.
CO
License Date
Validation Rules
number or License
SED form.
only. Conditionally
there is a license number.
License Number is
provided. Format
yyyyMMdd
Return Only
Length
1...35
1...8
Description
Shipment Only
Type
string
string
1...4
string
Max Allowed
string
eOptions/InternationalForms/ECCNNumber
One
ECCNNumber
Cond
8
ExceptionCode
eOptions/InternationalForms/License/Exceptio
nCode
One
eOptions/InternationalForms/License/Date
One
Date
One
eOptions/InternationalForms/License/Number
Required
Number
Cond
XPath
Cond
Name
7/09/2012
Cond
String
String
Text for the shipper to add
additional information
For a list of valid
origin/destination countries
please refer to the table in
Appendix N
Forwards Only
Type of delivery confirmation
Valid values are: 1 Delivery Confirmation
Signature Required 2 Delivery Confirmation
Adult Signature Required.
Forwards Only
DCIS Number
The flag indicates the
ReturnOfDocument
accessorial has been
requested
Valid for Poland to Poland
without return service
only.
No
Indicates that the Shipment
is an ImportControl
shipment.
Page 98
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
0
One
One
ImportControlIndicator
eOptions/ImportControlIndicator
No
ReturnOfDocumentIndicator
eOptions/ReturnOfDocumentIndicator
Description
The application will
automatically provide a copy
of the invoice or NAFTA/CO
with each response
regardless of whether the
user has enabled Paperless
account. The user now has
the option to print or ignore
the copy provided.
Shipment Only
Length
Type
String
300
String
N/A
1
container
Max Allowed
1
1
One
Required
string
eOptions/DeliveryConfirmation/DCISNumber
1...20
DCISNumber
String
eOptions/DeliveryConfirmation/DCISType
0
DCISType
One
eOptions/DeliveryConfirmation
One
DeliveryConfirmation
No
ShipperMemo
eOptions/InternationalForms/ShipperMemo
No
OverridePaperlessIndicator
eOptions/InternationalForms/OverridePaperle
ssIndicator
Yes*
XPath
No
Name
7/09/2012
No
One
String
eOptions/LabelMethod/Description
No
One
String
CommercialInvoiceRemovalIndic
ator
eOptions/CommercialInvoiceRemovalIndicato
r
One
String
LabelMethod types:'01' =
ImportControl Print and
Mail'02' = ImportControl
One-Attempt'03' =
ImportControl ThreeAttempt'04' = ImportControl
Electronic Label'05' =
ImportControl Print Label
String
This container is used for
providing Pre-Alert
Notifications to the
consignee for UPS
Exchange movements and
Pack & Collect shipments.
N/A
One
UPS carbon neutral indicator
presence at shipment level
is required to create carbon
neutral Shipments.
Container
eOptions/PreAlertNotification
unbounded
PreAlertNotification
eOptions/UPScarbonneutralIndicator
No
UPScarbonneutralIndicator
No
0
LabelMethod description
CommercialInvoiceRemovalI
ndicator allows a shipper to
dictate that UPS remove the
Commercial Invoice from the
user's shipment before the
shipment is delivered to the
ultimate consignee.
Page 99
Partial IV
EEI
Invoice
This container is
applicable only for
ImportControl shipments.
Nafta CO
Type of ImportControl
Label.|This container is
applicable only for
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
N/A
Container
Yes*
Description
1...35
eOptions/LabelMethod/Code
0
Code
No
2
Max Allowed
LabelMethod
eOptions/LabelMethod
One
XPath
No
Name
7/09/2012
Required
Container
N/A
String
1…15
No
PhoneNumber
eOptions/PreAlertNotification/VoiceMessage/
PhoneNumber
Yes
EMailAddress where
PreAlertNotification is sent.
This is used for notification
when EMailAddress for
PreAlertNotification is
undeliverable.
VoiceMessage container is
used for specifying phone
number for receiving voice
preAlertNotification
Phone number for receiving
Voice PreAlertNotification.
TextMessage container is
used for specifying phone
number for receiving text
preAlertNotification
Phone number for receiving
Text PreAlertNotification.
Page 100
Partial IV
EEI
Invoice
Nafta CO
1…50
N/A
1…15
One
One
eOptions/PreAlertNotification/VoiceMessage
Populating EMailMessage
details for
CO
N/A
String
String
Container
String
No
PhoneNumber
eOptions/PreAlertNotification/TextMessage/P
honeNumber
Yes
1…50
One
One
One
eOptions/PreAlertNotification/TextMessage
No
TextMessage
VoiceMessage
Validation Rules
Return Only
Container
One
eOptions/PreAlertNotification/EMailMessage/
Description
Shipment Only
Type
One
EMailAddress
eOptions/PreAlertNotification/EMailMessage/
EMailAddress
XPath
Length
Max Allowed
eOptions/PreAlertNotification/EMailMessage
Name
Required
EMailMessage
No
7/09/2012
Yes
providing Language and
dialect details for
PreAlertNotifications.
String
Valid Language
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|
NOR97| RUS97| SLK97|
TUR97| VIE97| ZHOTW|
RONRO| SPAPR
Valid Dialect
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|
NOR97| RUS97| SLK97|
TUR97| VIE97| ZHOTW|
RONRO| SPAPR
Exchange forward indicator
is required to create
exchange forward
Shipments.
In the label routing
Instruction text by default
will be EXCHANGE-LIKE
ITEM ONLY
String
String
eOptions/ExchangeForwardIndicator
One
ExchangeForwardIndicator
No
0
One
eOptions/PreAlertNotification/Locale/Dialect
Dialect
Yes
2
One
Language
Yes
eOptions/PreAlertNotification/Locale/Languag
e
Page 101
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
N/A
Container
Description
3
Max Allowed
eOptions/PreAlertNotification/Locale
Locale
One
XPath
Yes
Name
7/09/2012
Required
Package type 24, or 25
or 30 is only allowed for
shipment without return
service. Packaging type
must be valid for all the
following: ShipTo
country, ShipFrom
country, a shipment going
from ShipTo country to
ShipFrom country, all
Accessorials at both the
shipment and package
level, and the shipment
service type.
One
Yes*
string
1...35
String
/ShipmentRequest/Shipment/Package/Packag
ing/Description
One
Description
No
ing/Code
Code
Description of packaging
type. Examples are letter,
customer supplied, express
box.
N/A
Page 102
Partial IV
Package types. Values are:
01 = UPS Letter, 02 =
Customer Supplied
Package, 03 = Tube, 04 =
PAK, 21 = UPS Express
Box, 24 = UPS 25KG Box,
25 = UPS 10KG Box, 30 =
Pallet, 2a = Small Express
Box, 2b = Medium Express
Box, 2c = Large Express
Box. Note: Only packaging
type code 02 is applicable to
EEI
Packaging Container
Packaging type is
required for Ground
Freight Pricing
Shipments only
Invoice
Required for shipment
with return service
Nafta CO
Merchandise description of
package.
CO
Package Information
container.
For Return Shipments up
to and including 20
packages are allowed.
US/PR origin return
movements are limited to
only one package.
Return Only
Validation Rules
Shipment Only
Length
N/A
ing
Description
2
Packaging
Type
Container
1...35
/ShipmentRequest/Shipment/Package/Descri
ption
N/A
string
Max Allowed
container
Description
Cond
/ShipmentRequest/Shipment/Package
Cond
Package
Yes
##
One
XPath
One
Name
7/09/2012
Required
/ShipmentRequest/Shipment/Package/Dimen
sions/Length
Width
sions/Width
Height
sions/Height
PackageWeight
eWeight
string
string
1...35
3
string
string
Container
N/A
One
One
3
One
3
string
One
One
One
Yes
No
Yes*
Yes*
Yes*
Cond
UnitOfMeasurement
container
Package dimensions
measurement code. Codes
are: IN = Inches, CM =
Centimeters, 00 = Metric
Units Of Measurement, 01 =
English Units of
Measurement.
N/A
The unit of measurement
must be valid for the
Shipper country.
Description of the package
dimensions measurement
units.
Package length. Refer to
Universal Rules table for
additional information.Length
must be the longest
dimension of the container.
N/A
Valid values are 0 to 108
IN and 0 to 270 CM.
Package width. Refer to
additional information.
N/A
Package height. Refer to
N/A
Container to hold package
weight information.
Package weight is a
required field for Ground
Freight Pricing shipments
Page 103
Partial IV
EEI
Invoice
Nafta CO
Dimensions information
container. Note: Currently
dimensions are not
applicable to Ground Freight
Pricing
Length + 2*(Width +
Height) must be less than
or equal to 130 IN or 330
CM. Dimensions are
required for GB to GB
and Poland to Poland
Shipments.
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
Max Allowed
N/A
Length
container
Description
sions/UnitOfMeasurement/Description
N/A
Code
sions/UnitOfMeasurement/Code
container
sions/UnitOfMeasurement
2
UnitOfMeasurement
One
sions
One
Dimensions
Cond
XPath
Yes
Name
7/09/2012
Required
string
container
N/A
One
One
Package weight unit of
are: LBS = Pounds, KGS =
Kilograms.
weight measurement units.
Packages weight. Weight
accepted for
letters/envelopes.
N/A
Only {Average}package
weight is required for
Shipment
mentions that the package is
Large Package.
Empty Tag.
Package reference number
information container
string
One
/ShipmentRequest/Shipment/Package/Refere
nceNumber/BarCodeIndicator
No
BarCodeIndicator
the label.
N/A
shipment-level or
barcode a reference
no longer than 14
and cannot contain
spaces.
Page 104
Partial IV
EEI
Invoice
Nafta CO
N/A
CO
Container to hold
UnitOfMeasurement
information.
Return Only
Validation Rules
0
No
No
Description
Shipment Only
Length
Type
N/A
Container
string
string
1...35
1...5
nceNumber
string
ReferenceNumber
0
LargePackageIndicator
/ShipmentRequest/Shipment/Package/LargeP
ackageIndicator
One
Weight
eWeight/Weight
One
eWeight/UnitOfMeasurement/Description
One
Description
Yes
eWeight/UnitOfMeasurement/Code
Yes*
Code
No
3
Max Allowed
UnitOfMeasurement
eWeight/UnitOfMeasurement
One
XPath
Yes
Name
7/09/2012
Required
Reference number type
code, for the entire
shipment. The code
name. Refer to the
table.
number.
Valid if the
US/US or PR/PR.2
Valid if the
US/US or PR/PR.
Supports up to 2
customer supplied
combinations of
Reference code- value
combinations.
Additional Handling
Required.The presence
indicates additional handling
is required, the absence
indicates no additional
handling is required.
Empty Tag.
PackageServiceOtioncontain
er
N/A
For a list of valid
Appendix N
Forwards Only
Valid values are: 1 Delivery Confirmation 2
- Delivery Confirmation
Forwards Only
Page 105
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
string
1...35
string
string
N/A
container
N/A
container
DCISType
eServiceOptions/DeliveryConfirmation/DCIST
ype
Description
1
eServiceOptions/DeliveryConfirmation
string
One
One
One
One
eServiceOptions
No
PackageServiceOptions
No
/ShipmentRequest/Shipment/Package/Additio
nalHandlingIndicator
Yes*
AdditionalHandlingIndicator
No
0
nceNumber/Value
One
Value
One
nceNumber/Code
No
Code
Yes*
2
XPath
Max Allowed
Name
7/09/2012
Required
N/A
Container for Declared
Value Type
Declared value type. Valid
value are 01=EVS, 02=DVS.
Defaults to 01 i.e. EVS if
declared value type is not
provided.
N/A
The user cannot specify
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
Shipper Declared Value is
applicable for forward
shipments when the
billing option is freight
collect or third party
string
1...35
string
string
string
MonetaryValue
eServiceOptions/DeclaredValue/MonetaryVal
ue
1...19
3
One
One
CurrencyCode
eServiceOptions/DeclaredValue/CurrencyCod
e
One
One
Description
eServiceOptions/DeclaredValue/Type/Descrip
tion
Yes*
*Yes
eServiceOptions/DeclaredValue/Type/Code
Yes*
No
Code
Declared value Description
N/A
Declared value amount
currency type. Defaults to
the non-Euro currency used
in the shipper's country.
Code must represent a
currency that is a valid for
Shipper country.
Declared value amount.
Page 106
Partial IV
container
N/A
EEI
N/A
One
Container for DeclaredValue
Invoice
container
eServiceOptions/DeclaredValue/Type
Forwards Only
Nafta CO
1...11
One
Type
Delivery Confirmation
Control number associated
with the delivery
confirmation for the package
CO
string
eServiceOptions/DeclaredValue
Validation Rules
Return Only
One
DeclaredValue
Description
Shipment Only
No
Length
DCISNumber
eServiceOptions/DeliveryConfirmation/DCISN
umber
No
Type
XPath
2
Name
No
Max Allowed
7/09/2012
Required
container
Yes*
One
string
CODAmount
eServiceOptions/COD/CODAmount
Yes*
One
container
CurrencyCode
eServiceOptions/COD/CODAmount/Currency
Code
One
string
MonetaryValue
eServiceOptions/COD/CODAmount/Monetary
Value
One
string
VerbalConfirmation
eServiceOptions/VerbalConfirmation
One
Container
Indicates COD is
requested. Package level
COD is available for
service from US/PR to
US/PR, CA to CA, and
CA to US.CA to US COD
is not allowed for package
Letter/ Envelope. COD is
not valid for return service
movements.
COD container
Values are: 0 = check,
cashiers check or money
order - no cash allowed, 8 =
order - no cash allowed.
N/A
CODAmount container
N/A
type.
N/A
COD Amount.
Valid values: 0.01 USD 50000.00 USD
Verbal Confirmation Info.
Allowed for shipment
without return service.
5
N/A
Page 107
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
3
N/A
Description
Shipment Only
Length
Type
One
eServiceOptions/COD/CODFundsCode
N/A
No
CODFundsCode
1
eServiceOptions/COD
Yes
Max Allowed
COD
Yes
XPath
No
Name
7/09/2012
Required
No
One
String
Notification
eServiceOptions/Notification
No
One
Container
N/A
Contact Phone Extension
The presence indicates that
the package may be
released by driver without a
signature from the
consignee
N/A
Empty Tag. Only
available for US50/PR to
US50/PR packages
Applicable for Shipment
with returned service.
Page 108
Partial IV
Contact Phone Number
EEI
N/A
Invoice
Phone Container
Nafta CO
Name of the person to be
contacted for confirmation.
Defaults to Shipper
AttentionName if given.
Optional if Shipper/
AttentionName is given
and that is the name of
the person to be
contacted else required
for verbal confirmation.
CO
N/A
Receiver Return Notification
Validation Rules
Return Only
Length
eServiceOptions/ShipperReleaseIndicator
N/A
ShipperReleaseIndicator
Description
Optional if the Shipper's
AttentionName,
PhoneNumber, and
PhoneExtension(optional)
are given and are the
desired name, phone
number and extension,
respectively, to be used for
verbal confirmation.
Shipment Only
Type
1...4
N/A
1...35
N/A
1...15
String
Container
string
Container
String
Extension
eServiceOptions/VerbalConfirmation/ContactI
nfo/Phone/Extension
0
One
Number
nfo/Phone/Number
One
Max Allowed
One
Phone
nfo/Phone
One
One
Cond
Required
Name
nfo/Name
No
ContactInfo
nfo
Yes*
XPath
No
Name
7/09/2012
Cond
Defaults to
FromEMailAddress. Only
allowed at the first
package.
The email address listed in
the Reply To field of the
message header, includes
name and e-mail address of
sender. The From field of
the message header
Only allowed at the first
package.
The name the receiver
return notification will appear
to be from.
Defaults to the Shipper
Name. Only allowed at
the first package.
package.
1...50
1...35
1...150
String
String
String
String
1...50
One
One
Yes*
No
One
eServiceOptions/Notification/EMail/Memo
One
Memo
No
FromName
eServiceOptions/Notification/EMail/FromNam
e
No
FromEMailAddress
eServiceOptions/Notification/EMail/FromEMail
Address
No
eServiceOptions/Notification/EMail/Undelivera
bleEMailAddress
Page 109
Partial IV
The e-mail address where
an undeliverable email
message is sent if the
email is undeliverable.
EEI
N/A
Invoice
The destination email
address of the receiver
returns notification email.
Nafta CO
N/A
CO
Container for the e-mail
Message.
Return Only
3 - Receiver Return
Notification
Shipment Only
Length
Type
Notification Code
1
String
Validation Rules
N/A
Container
Description
1...50
String
EMailAddress
eServiceOptions/Notification/EMail/EMailAddr
ess
Max Allowed
eServiceOptions/Notification/EMail
One
EMail
One
eServiceOptions/Notification/NotificationCode
One
NotificationCode
Required
XPath
Yes*
Name
7/09/2012
Yes*
String
No
DryIce
eServiceOptions/DryIce
String
MAximum of 1. Cannot be
combined with <Hazmat>
Cannot be used when the
package also contains
Hazmat
Page 110
X
N/A
Container
No
1
One
0
No
ReturnsFlexibleAccessIndicator
eServiceOptions/ReturnsFlexibleAccessIndica
tor
One
SubjectCode
eServiceOptions/Notification/EMail/SubjectCo
de
Receiver Return Notification.
The reference code (the
mapped to the
Returns Flexible Access
Indicator presence at
package level is required for
UPS Returns Flexible
Access Shipments. All
packages in the shipment
must have the Returns
Flexible Access Indicator if
one package has it.
the subject of the
text is provided, and
value must be 08;If the
subject code is 08, the
that refers to a
default to the tracking
number. Only allowed at
the first package.
Partial IV
EEI
Invoice
Nafta CO
package
CO
to the UPS Receiver Return
shipment ID.
Return Only
Validation Rules
Shipment Only
Type
Length
1...75
Max Allowed
Description
2
String
eServiceOptions/Notification/EMail/Subject
Subject
One
XPath
No
Name
7/09/2012
Required
UnitOfMeasurement
eServiceOptions/DryIce/DryIceWeight/UnitOf
Measurement
3..4
eServiceOptions/DryIce/DryIceWeight
String
DryIceWeight
N/A
N/A
X
Container
Container
X
X
Weight
X
2..3
1…5
String
eServiceOptions/DryIce/DryIceWeight/Weight
Cannot be more than
package weight. Should
be more than 0.0. Valid
characters are 0-9 and
.(Decimal point). Limit to
1 digit after the decimal.
the field is 5 including .
decimal place.
Page 111
X
String
0..20
1
String
1
Weight
Yes
1
Short description for
UnitOfMeasurement
Partial IV
EEI
Invoice
The following values are
valid : 00 , 01, KG , KGS ,
LBS
1
Yes
Yes
Yes
Description
Measurement/Description
No
Code
Measurement/Code
Nafta CO
DryIce weight unit of
measurement code. Valid
values are: 00 = KG(Metric
Unit of Measurements), 01 =
LB(English Unit of
Measurements), KG, LB,
KGS, LBS
CO
valid: IATA,CFR
Return Only
Regulation set for dryIce
Shipment. Valid values are :
CFR = HazMat regulated by
US Dept of Transportation
within the U.S. or ground
shipments to Canada,
IATA= Worldwide Air
movement
Shipment Only
Validation Rules
1
eServiceOptions/DryIce/RegulationSet
Yes
RegulationSet
Description
X
Length
Type
Max Allowed
XPath
1
Name
7/09/2012
Required
One
String
NMFC
/ShipmentRequest/Shipment/Package/Comm
odity/NMFC
One
Container
N/A
Container to hold the NMFC
codes
PrimeCode
odity/NMFC/PrimeCode
One
String
4..6
Specifies the Commodity's
NMFC prime code
SubCode
odity/NMFC/SubCode
One
String
2
FreightClass
Yes
Required for Ground
Freight Pricing
Shipments only
No
Freight Classification.
Freight class partially
determines the freight rate
for the article.
Yes
Commodity information
It is required if the Ground
Freight Pricing Shipment
indicator is present in the
request.
odity/FreightClass
NMFC sub code
Required if NMFC
Container is Present
Needs to be provided
when the SubCode
associated with the
PrimeCode is other than
00. Backend defaults the
sub value to 00 if not
provided. If provided the
Sub Code should be
associated with the
PrimeCode of the NMFC.
Page 112
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
Validation Rules
X
Length
Type
String
Container
Description
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
rates are adjusted for dryIce
weight more than 2.5 Kgs or
5.7 LBs
No
10
One
No
odity
Cond
Commodity
0
eServiceOptions/DryIce/MedicalUseIndicator
N/A
MedicalUseIndicator
Max Allowed
XPath
1
Name
7/09/2012
Required
Browser HTTPUserAgent
String. This is the preferred
way of identifying GIF image
type to be generated
Container for the EPL2, ZPL,
STARPL or SPL label size
For shipments without
return service the valid
value is GIF, ZPL, EPL
and SPL. For shipments
with PRL return service,
the valid values are EPL,
ZPL, SPL, STARPL and
GIF.
N/A
Required if
/ShipmentRequest/Label
SpecificationLabelSpecifi
cation/LabelImageFormat
/Code = Gif. Default to
Mozilla/4.5 if this field is
missing or has invalid
value.
For EPL2, ZPL, STARPL
and SPL Labels.
Page 113
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
N/A
X
N/A
N/A
Length
Type
Container
Container
String
1...35
String
1...64
One
One
String
/ShipmentRequest/LabelSpecification/LabelSt
ockSize
Description of the label
image format code.
N/A
LabelStockSize
LabelImageFormat
Container
Label print method code that
the Labels are to be
generated for EPL2
formatted Labels use EPL,
for SPL formatted Labels
use SPL, for ZPL formatted
Labels use ZPL and for
image formats use GIF, for
Star Printer format formatted
Labels use STARPL.
Container
/ShipmentRequest/LabelSpecification/HTTPU
serAgent
without return service, or
shipment with PRL return
service.
One
HTTPUserAgent
Container used to define the
properties required by the
user to print and/or display
the UPS shipping label.
One
/ShipmentRequest/LabelSpecification/LabelIm
ageFormat/Description
Yes
Description
Validation Rules
Cond
ageFormat/Code
Description
Yes
Code
No
3
ageFormat
Max Allowed
LabelImageFormat
One
/ShipmentRequest/LabelSpecification
One
LabelSpecification
Required
XPath
Cond
Name
7/09/2012
Yes
Instruction code.
Container
/ShipmentRequest/ReceiptSpecification
No
ReceiptSpecification
Container used to allow the
user a to choose to print a
thermal receipt.
Page 114
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
X
X
Type
Length
1...3
1...3
N/A
String
String
Container
Width of the label image. For
IN, use whole inches.
and SPL Labels. Valid
value is 4. Note: Label
Image will only scale up
to 4 X 6, even when
requesting 4 X 8.
2
Max Allowed
One
One
Yes
String
/ShipmentRequest/LabelSpecification/Instructi
on/Description
Height of the label image.
For IN, use whole inches.
and SPL Labels. Only
valid values are 6 or 8.
Note: Label Image will
only scale up to 4 X 6,
even when requesting 4 X
8.
For Exchange Forward
Shipment, by default Label
will have Exchange Routing
instruction Text as
EXCHANGE-LIKE ITEM
ONLY. |If code value is :|01EXCHANGE-LIKE ITEM
ONLY. |02- EXCHANGEDRIVER INSTRUCTIONS
INSIDE
1…35
Description
Validation Rules
Routing Instruction
Container
String
on/Code
Description
1
Code
unbounded
on
One
Instruction
One
ockSize/Width
Yes
Width
No
ockSize/Height
Height
Yes
XPath
No
Name
7/09/2012
Required
Request
/ShipConfirmRequest/Request
RequestOption
/ShipConfirmRequest/Request/RequestOption
Container
String
1
String
1
One
container
N/A
One
container
N/A
One
string
1...15
No
Yes
Yes
Yes
Request Container
N/A
Request Container
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
avoid an address correction
fee.
N/A
nonvalidate.
Page 115
Partial IV
/ShipConfirmRequest
EEI
ShipConfirmRequest
Description of the receipt
format code.
Invoice
/ShipmentRequest/ReceiptSpecification/Imag
eFormat/Description
Print code that determines
the receipt format.
Nafta CO
Yes
Description
ImageFormat Container
CO
eFormat/Code
Validation Rules
Return Only
Yes
Code
Description
Shipment Only
eFormat
Length
ImageFormat
Type
XPath
1
Name
Max Allowed
7/09/2012
Required
Shipment Container
Refer to the Shipment
container table for the
elements under Shipment
container.
The Description of Goods for
the shipment. Applies to
international shipments only.
Provide a detailed
description of items being
shipped for documents and
non-documents. Provide
specific descriptions, such
as "annual reports" and "9
mm steel screws".
Required if all of the listed
conditions are true:
ShipFrom and ShipTo
countries are not the
same; The packaging
type is not UPS Letter;
The ShipFrom and or
ShipTo countries are not
in the European Union or
the ShipFrom and ShipTo
countries are both in the
European Union and the
shipments service type is
not UPS Standard.
Page 116
Partial IV
N/A
EEI
The client uses
CustomerContext to
synchronize
request/responsepairs. The
client
establishesCustomerContext
, which can contain any
information you want, as
along as it is valid XML; it is
echoed back by the server.
Invoice
N/A
Nafta CO
between client andserver.
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
Container
N/A
1...512
string
Max Allowed
No
One
container
N/A
1...35
/ShipConfirmRequest/Shipment/Description
String
Description
One
/ShipConfirmRequest/Shipment
One
Shipment
/ShipConfirmRequest/Request/TransactionRe
ference/CustomerContext
One
CustomerContext
No
/ShipConfirmRequest/Request/TransactionRe
ference
Yes
XPath
Cond
Name
7/09/2012
Required
Type of Return service.
When this container exists,
the shipment is a return
shipment.
Return Service types:‘2’ =
UPS Print and Mail (PNM)‘3’
= UPS Return Service 1Attempt (RS1) ‘5’ = UPS
Return Service 3-Attempt
(RS3)‘8’ = UPS Electronic
Return Label (ERL)‘9’ = UPS
Print Return Label (PRL)
Return Service description
Indicates a shipment
contains written, typed, or
printed communication of no
commercial value. If
DocumentsOnly is not
specified then it implies that
the shipment contains non
documents or documents of
commercial value. Default is
a shipment contains nondocuments or documents of
commercial value.
Container tag for Shipper’s
information
N/A
N/A
N/A
Empty Tag. Valid only for
shipments with different
origin and destination
countries. The origin
country is not US, and the
destination country is not
CA, PR or MX.
N/A
Page 117
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
N/A
Container
string
N/A
Container
/ShipConfirmRequest/Shipment/Shipper
One
Shipper
One
/ShipConfirmRequest/Shipment/DocumentsO
nlyIndicator
No
DocumentsOnlyIndicator
Yes
0
1...35
1
Required
string
/ShipConfirmRequest/Shipment/ReturnServic
e/Description
String
Description
Max Allowed
e/Code
One
Code
One
e
One
ReturnService
No
XPath
Yes*
Name
7/09/2012
No
Container tag for Phone
Number
Shipper’s phone Number.
N/A
Valid values are 0 - 9.If
Shipper country is US,
PR, CA, and VI, the
area code, 7 digit
extension number; for
other countries, the layout
is CountryCode, area
code, 7 digit number
Shipper’s phone extension.
N/A
Page 118
Partial IV
EEI
Shipper’s Tax Identification
Number
forms) is requested and
ship From is not
mentioned.
Invoice
Shipper’s Attention Name
N/A
Required if destination is
international. Required if
Invoice and Co
International forms are
requested and the
ShipFrom address is not
present.
Nafta CO
Shipper’s company name.
CO
Validation Rules
Return Only
Length
1...35
Description
Shipment Only
Type
string
1...35
1...15
N/A
string
string
Container
Max Allowed
One
One
1...15
/ShipConfirmRequest/Shipment/Shipper/Phon
e/Extension
String
Extension
1...4
e/Number
String
Number
One
e
One
Phone
One
/ShipConfirmRequest/Shipment/Shipper/TaxId
entificationNumber
One
Required
/ShipConfirmRequest/Shipment/Shipper/Atten
tionName
Yes
AttentionName
Cond
/ShipConfirmRequest/Shipment/Shipper/Nam
e
Cond
Name
Yes*
XPath
No
Name
7/09/2012
Cond
1...14
One
string
1...50
N/A
6
Shipper’s email address.
Page 119
Partial IV
String
/ShipConfirmRequest/Shipment/Shipper/EMail
Address
N/A
EEI
string
One
EMailAddress
Shipper’s Fax Number.
Invoice
One
/ShipConfirmRequest/Shipment/Shipper/FaxN
umber
Nafta CO
Type
Yes
FaxNumber
Shipper’s six digit account
number.
CO
Max Allowed
/ShipConfirmRequest/Shipment/Shipper/Ship
perNumber
Validation Rules
Size must be six
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
daily pickup account, or
an occasional account.
Return Only
Required
ShipperNumber
Description
Shipment Only
XPath
Length
Name
No
7/09/2012
No
N/A
string
1...35
One
string
1...30
StateProvinceCode
/ShipConfirmRequest/Shipment/Shipper/Addr
ess/StateProvinceCode
One
string
2...5
The shipper's City
Shipper's state or province
code.
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
contain the county.
Page 120
Partial IV
Container
Three
ess/City
Maximum Occurrence
should be three.
EEI
Length
One
Yes
City
The shipper's street address,
including name and number
(when applicable).
Invoice
Type
Yes
AddressLine
ess/AddressLine
Shipper’s email address.
Nafta CO
Max Allowed
ess
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
address is used as the
ShipFrom the shipment
origin address.
CO
Required
Address
Description
Return Only
XPath
Shipment Only
Name
Yes
7/09/2012
Cond
Shipper's country code.
Page 121
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
1...9
Shipper's postal code.
Validation Rules
If Shipper country is US
or Puerto Rico, 5 or 9
digits. If the Shipper
and must be 6
letter and # is a digit. For
and must be no more
than 9 alphanumeric
characters long.
Must be a valid UPS
Forward shipments it
must also be an allowable
UPS origin country. For
Return Shipment the
the following conditions:1)
At least two of the
of the EU: ShipTo,
same and at least one of
them is not a member of
the EU, the shipper must
have Third Country
contract service: ShipTo,
Shipment Only
Type
string
Description
2
string
ess/CountryCode
Max Allowed
CountryCode
One
ess/PostalCode
One
PostalCode
Required
XPath
Cond
Name
7/09/2012
Yes
Contact name at the
consignee's location.
Day Air Early A.M.
service, and when ShipTo
country is different than
ShipFrom country.
Required if Invoice
requested
Consignee's tax
N/A
N/A
Page 122
Partial IV
N/A
EEI
Consignee's company name.
Invoice
N/A
Nafta CO
Ship To Container
CO
Validation Rules
Return Only
Length
N/A
Description
Shipment Only
Type
Container
1...35
1...35
string
string
Max Allowed
One
One
1...15
/ShipConfirmRequest/Shipment/ShipTo/Phon
e
String
Phone
N/A
/ShipConfirmRequest/Shipment/ShipTo/TaxId
entificationNumber
Container
One
/ShipConfirmRequest/Shipment/ShipTo/Attent
ionName
One
AttentionName
One
/ShipConfirmRequest/Shipment/ShipTo/Name
Required
Name
Yes
/ShipConfirmRequest/Shipment/ShipTo
Cond
ShipTo
No
XPath
Cond
Name
7/09/2012
Yes
/ShipConfirmRequest/Shipment/ShipTo/Addre
ss/AddressLine
N/A
Address Container.
N/A
Address Line of the
consignee.
Page 123
Partial IV
Consignee's email address.
EEI
Consignee's fax number.
If ShipTo country is US
10 digits allowed,
allowed.
Invoice
N/A
Nafta CO
Consignee's phone
extension.
CO
Consignee's phone Number.
Validation Rules
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
area code, 7 digit
extension number;
number; for other
7 digit number.
Return Only
Length
AddressLine
Description
Shipment Only
Type
1...15
N/A
String
1...50
ss
Container
1...4
1...15
string
Address
1...35
String
String
/ShipConfirmRequest/Shipment/ShipTo/EMail
Address
String
Max Allowed
One
EMailAddress
One
One
/ShipConfirmRequest/Shipment/ShipTo/FaxN
umber
One
One
FaxNumber
Three
Required
e/Extension
Yes*
Extension
No
e/Number
No
Number
Yes
XPath
Yes
Name
7/09/2012
No
One
string
One
string
1...9
Cond
Cond
Consignee's state or
province code. Required for
US or Canada.
Consignee's postal code.
Page 124
Partial IV
EEI
Invoice
Nafta CO
N/A
If destination is US or CA,
then the value must be a
valid US State/ Canadian
contain the county.
If the ShipTo country is
US or Puerto Rico, 5 or 9
digits. If the ShipTo
and must be 6
Otherwise optional. For
and must be no more
than 9 alphanumeric
characters long.
CO
Consignee's city.
Return Only
Length
Validation Rules
Shipment Only
Type
ss/PostalCode
1...30
PostalCode
string
StateProvinceCode
ss/StateProvinceCode
Description
2
ss/City
Max Allowed
City
One
XPath
Required
Name
7/09/2012
Yes
Location ID must be
All letters must be
capitalized.
Ship From Container
Required for return
shipment. Required if
pickup location is different
from the shipper's
address.
name or company name.
is in the XML.
Page 125
Partial IV
EEI
String
0
3...10
N/A
String
container
1...35
One
No
string
/ShipConfirmRequest/Shipment/ShipFrom/Na
me
Location ID is a unique
identifier referring to a
specific shipping/receiving
location.
Invoice
One
Name
One
/ShipConfirmRequest/Shipment/ShipFrom
One
ShipFrom
Cond
/ShipConfirmRequest/Shipment/ShipTo/Locati
onID
Yes*
LocationID
Empty Tag.
Nafta CO
string
ss/ResidentialAddressIndicator
Consignee's country code.
This field is a flag to indicate
if the receiver is a residential
location. True if
tag exists; false otherwise
CO
Type
One
Validation Rules
Must be a valid UPS
Return Shipment the
the following conditions:1)
At least two of the
of the EU: ShipTo,
same and at least one of
them is not a member of
the EU, the shipper must
have Third Country
contract service: ShipTo,
Return Only
Max Allowed
ss/CountryCode
Description
Shipment Only
Required
CountryCode
Length
XPath
2
Name
Yes
7/09/2012
No
Company's Tax Identification
Number at the pick up
location
forms) is requested
If ShipFrom country is
US, PR, CA, and VI, the
digit phone number or
area code, 7 digit phone
number, 4 digit extension
number; for other
7 digit number. Required
if ShipFrom tag is in the
XML and International
forms is requested.
The Ship from phone
Number.
N/A
The Ship from phone
extension.
N/A
The Ship from fax number.
If Ship from country is US
10 digits allowed,
allowed.
Page 126
Partial IV
EEI
Invoice
Nafta CO
The ship from Attention
name.
is in the XML and Invoice
or CO International forms
is requested.
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
1...15
N/A
1...15
1...35
string
Container
String
1...4
string
Max Allowed
One
String
1...15
/ShipConfirmRequest/Shipment/ShipFrom/Fa
xNumber
String
FaxNumber
One
/ShipConfirmRequest/Shipment/ShipFrom/Ph
one/Extension
One
Extension
One
one/Number
One
Number
One
one
Cond
Phone
Cond
/ShipConfirmRequest/Shipment/ShipFrom/Ta
xIdentificationNumber
Cond
/ShipConfirmRequest/Shipment/ShipFrom/Att
entionName
Yes*
AttentionName
No
XPath
No
Name
7/09/2012
Required
City
/ShipConfirmRequest/Shipment/ShipFrom/Ad
dress/City
string
One
dress/StateProvinceCode
Cond
StateProvinceCode
Page 127
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
Length
Type
N/A
container
1...35
2
string
Origin location's state or
province code.
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,
the StateProvinceCode
will contain the county.
AddressLine
dress/AddressLine
1...30
is in the XML.
Ship from Address
Container.
string
Max Allowed
The Ship from city.
dress
One
Address
Three
The package will be
originating from or being
shipped from this
address. The shipment
origin address to the
destination ship to
address..
One
Validation Rules
Yes
Description
Yes
XPath
Yes
Name
7/09/2012
Required
Origin location's country
code.
Page 128
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
1...9
postal code.
Validation Rules
is in the XML and 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
long.
is in the XML. For Return
Shipment the country
code must meet the
following conditions:1) At
least two of the following
same: ShipTo, ShipFrom,
and Shipper.2) None of
the following country
codes are the same and
are a member of the EU:
Shipper.3) None of the
are the same and at least
one of them is not a
member of the EU, the
shipper must have Third
Country contract service:
Shipper.
Shipment Only
Type
string
Description
2
string
dress/CountryCode
Max Allowed
CountryCode
One
dress/PostalCode
One
PostalCode
Required
XPath
Cond
Name
7/09/2012
Yes
Shipment charge container
string
One
Yes
Values are: 01 =
Transportation, 02 =
Duties and Taxes
It is required for nonGround Freight Pricing
shipments only.
If Duty and Tax charges
are applicable to a
shipment and a payer is
not specified, the default
payer of Duty and Tax
charges is Bill to
Receiver.
A shipment charge type
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
present5) The origin and
destination IATA code is
the same
Page 129
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
N/A
N/A
Length
Type
container
Container
Description
Payment information
container for detailed
shipment charges. The two
shipment charges that are
available for specification
are Transportation charges
and Duties and Taxes.
2
Type
/ShipConfirmRequest/Shipment/PaymentInfor
mation/ShipmentCharge/Type
Max Allowed
mation/ShipmentCharge
One
ShipmentCharge
One
PaymentInformation
mation
Required
XPath
Cond
Name
7/09/2012
Yes
Container
One
string
One
Container
Type
mation/ShipmentCharge/BillShipper/CreditCar
d/Type
One
string
Number
d/Number
One
string
ExpirationDate
d/ExpirationDate
Container for the BillShipper
billing option. The two
payment methods that are
available for the Bill Shipper
billing option are account
number or credit card.
Credit card information
container
Values are 01 = American
Express, 03 = Discover, 04 =
MasterCard, 05 = Optima,
06 = VISA, 07 = Bravo,
and 08 = Diners Club
string
One
Yes*
Valid values are: 01, 03,
04 and 06.For Discover
card the ShipFrom
country has to be US
Credit Card number
N/A
Format is MMYYYY where
MM is the 2 digit month and
YYYY is the 4 digit year.
Valid month values are
01-12 and valid year
values are Present Year (Present Year + 10 years)
6
9...16
2
N/A
UPS account number
Page 130
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
element, BillReceiver,
BillThirdParty or
ConsigneeBilledIndicator,
must be present but no
more than one can be
present.
Must be the same UPS
account number as the
one provided in
Shipper/ShipperNumber.
Either this element or the
sibling element
CreditCard must be
provided, but both may
not be provided.
Required if
/ShipConfirmRequest/Shi
pment/PaymentInformatio
n
/ShipmentCharge/BillShip
per/AccountNumber is not
present. Credit card
payment is valid for
shipments without return
service only.
Shipment Only
Length
Type
One
Cond
CreditCard
d
N/A
No
AccountNumber
mation/ShipmentCharge/BillShipper/AccountN
umber
Description
6
mation/ShipmentCharge/BillShipper
Cond
Max Allowed
BillShipper
Yes*
XPath
Yes*
Name
7/09/2012
Required
string
One
Yes*
2
Three or four digits that can
be found either on top of
credit card number or on the
back of credit card. Number
of digits varies for different
type of credit card.
Page 131
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Description
Shipment Only
Length
3..4
Type
string
1...30
N/A
string
CountryCode
d/Address/CountryCode
StateProvinceCode
Yes
*
2...5
Credit card billing address
country code.
Must be a valid UPS
Discover card it should be
US
string
N/A
PostalCode
d/Address/StateProvinceCode
d/Address/PostalCode
1...9
Container
Max Allowed
Credit card billing addressee
postal code.
One
N/A
One
State or province code of the
credit card billing address.
City
d/Address/City
One
N/A
AddressLine
d/Address/AddressLine
One
City of the credit card billing
address
Address
d/Address
One
strin
g
Max of three AddressLine
can be provided.
Yes*
Yes*
Thre
e
strin
g
1...3
5
Address Line 1 of the credit
card billing address. Usually
Street address information.
SecurityCode
d/SecurityCode
Cond
Container to hold the Credit
card Billing Address.
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.
Argentina
Bahamas
Costa
Rica
Dominican
Rep Guatemala
Panama
Puerto
Rico
Russia
It is required to provide
billing address if credit
card information is
provided and when the
US, PR, and CA.
Yes*
XPath
Yes*
Name
7/09/2012
Required
N/A
mation/ShipmentCharge/BillReceiver/Address
No
Address
BillThirdParty or
Consignee Billed, must
be present but no more
than one can be present.
For a return shipment, Bill
Receiver is invalid for
Transportation charges.
valid UPS account
the account must be a
customer B.I.N account,
or a dropper shipper
account. All other
a non-shipping account
information for the bill
receivers UPS accounts
address.
N/A
Container for the
BillReceiver billing option.
Page 132
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Type
Length
N/A
container
Description
6
string
container
Max Allowed
One
AccountNumber
mation/ShipmentCharge/BillReceiver/Account
Number
One
mation/ShipmentCharge/BillReceiver
One
BillReceiver
Cond
XPath
Yes*
Name
7/09/2012
Required
accounts pickup address.
Container for the third party
billing option.
The UPS account number of
the third party shipper.
Page 133
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
the same as the UPS
United States and
BillReceiver or Consignee
Billed, must be present
but no more than one can
be present.
valid UPS account
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
a non-shipping account.
Shipment Only
Length
0...9
N/A
Type
string
container
Description
6
string
Max Allowed
One
AccountNumber
mation/ShipmentCharge/BillThirdParty/Accou
ntNumber
One
mation/ShipmentCharge/BillThirdParty
One
BillThirdParty
Cond
PostalCode
mation/ShipmentCharge/BillReceiver/Address
/PostalCode
Cond
XPath
Yes*
Name
7/09/2012
Required
information for the third party
UPS accounts address.
accounts pickup address.
N/A
the same as the UPS
United States and
UPS accounts pickup
address.
N/A
string
One
Yes
Page 134
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
container
N/A
0...9
Max Allowed
One
string
CountryCode
mation/ShipmentCharge/BillThirdParty/Addres
s/CountryCode
Description
2
PostalCode
s/PostalCode
One
Address
s
Yes
XPath
Cond
Name
7/09/2012
Required
string
String
N/A
Container
N/A
Container
String
String
Empty Tag. The payment
method for Transportation
charges must be UPS
account. The UPS
account must be a daily
pickup account or an
occasional account.
Payment information for the
Shipments
Required for Ground
Freight Pricing
Shipments only
payment type information
It is required if the request
has Ground Freight
Pricing shipment
indicator
Valid codes: 01=Prepaid
02=FreightCollect
03=PrepaidThirdParty
No
50
Yes
2
One
Description
/ShipConfirmRequest/Shipment/FRSPaymentI
nformation/Type/Description
One
Code
nformation/Type/Code
One
nformation/Type
One
Type
One
nformation
Cond
FRSPaymentInformation
mation/SplitDutyVATIndicator
Yes
SplitDutyVATIndicator
No
0
One
Cond
ConsigneeBilledIndicator
mation/ShipmentCharge/ConsigneeBilledIndic
ator
Consignee Billing payment
option indicator. The
presence indicates
consignee billing option is
selected. The absence
indicates one of the other
payment options is selected.
Split Duty VAT Indicator.
The presence indicates the
payer specified for
Transportation Charges will
pay transportation charges
and any duties that apply to
the shipment. The payer
specified for Duties and
Taxes will pay the VAT
(Value-Added Tax) only.
Specifies the description for
payment type
Page 135
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Empty Tag. This element
or its sibling element,
BillShipper, BillReceiver
or BillThirdParty, must be
present but no more than
one can be present. This
billing option is valid for a
shipment charge type of
Transportation only. Only
applies to US/PR and
PR/US shipment origins
and destination.
Shipment Only
Length
Type
Description
0
XPath
Max Allowed
Name
7/09/2012
Required
String
Container
N/A
0...9
One
Yes
One
String
nformation/Address/PostalCode
The postal code for the
payment information
address.
String
string
N/A
container
/ShipConfirmRequest/Shipment/ShipmentRati
ngOptions
One
One
/ShipConfirmRequest/Shipment/GoodsNotInF
reeCirculationIndicator
No
GoodsNotInFreeCirculationIndica
tor
No
0
One
nformation/Address/CountryCode
Yes
CountryCode
payment information
address.
Goods Not In Free
Circulation indicator.
Empty Tag. This indicator
is invalid for a package
type of UPS Letter and
DocumentsOnly.
container
N/A
Page 136
Partial IV
EEI
Invoice
Note: The Address is
required only when the
billing option is Freight
collect or ThirdParty.
Nafta CO
information for the
FreightCollect and
PrepaidThirdParty Address.
2
PostalCode
One
nformation/Address
Address
Cond
nformation/AccountNumber
Cond
AccountNumber
CO
If the Ground Freight
Pricing indicator is
present in the request,
This account number
must be validated to
check if it is Ground
Freight Pricing enabled.
Return Only
Validation Rules
Shipment Only
Length
Type
Description
6
XPath
Max Allowed
Name
7/09/2012
Required
ngOptions/RateChartIndicator
String
String
No
RateChartIndicator
One
ngOptions/FRSShipmentIndicator
Rates option indicator. If the
Shipment indicator is
enabled and Shipper
number is authorized then
Ground Freight Pricing rates
should be returned in the
response
String
/ShipConfirmRequest/Shipment/MovementRef
erenceNumber
One
MovementReferenceNumber
No
18
String
1
FRSShipmentIndicator
No
0
One
ngOptions/NegotiatedRatesIndicator
No
NegotiatedRatesIndicator
Negotiated Rates option
indicator. If the indicator is
present and the Shipper is
authorized then Negotiated
Rates should be returned in
the response.
Must contain alphanumeric
characters only. Must be a
length of 18 characters. The
3rd and 4th Characters must
be the Shipper country ISO
Code.
Page 137
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
The Shipper account and
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
taken from
pment/Shipper/ShipperNu
mber is used when
checking qualification for
Negotiated rates.
The Shipper account
number must be qualified
to receive Ground Freight
Pricing Shipment rates.
Only the Shipper account
number taken from
pment/ Ground Freight
Pricing
PaymentInformation/Acco
untNumber is used when
checking qualification for
rates.
Shipment Only
Length
Type
Description
0
XPath
Max Allowed
Name
7/09/2012
Required
string
One
string
One
string
1...35
container
N/A
/ShipConfirmRequest/Shipment/Service
One
Service
No
Value
/ShipConfirmRequest/Shipment/ReferenceNu
mber/Value
Yes*
mber/Code
Yes
Code
number.
Valid if the
not US/US or PR/PR
UPS service type
N/A
Page 138
Partial IV
Valid if the
not US/US or PR/PR2
EEI
Shipment Reference number
type code. The code
name. Refer to the
table.
2
One
mber/BarCodeIndicator
No
BarCodeIndicator
Invoice
the label.
shipment-level or
barcode a reference
no longer than 14
and cannot contain
spaces.
Nafta CO
N/A
CO
Reference Number
information container.
Return Only
Length
N/A
Validation Rules
Shipment Only
Type
container
Description
0
mber
Max Allowed
ReferenceNumber
One
XPath
Required
Name
7/09/2012
No
The following Services
are not available to return
shipment:13 - Next Day
Air Saver, 14 - Next Day
Air Early AM, 59 - 2nd
Today Standard, 83 =
UPS Today Dedicated
Courier, 84 = UPS Today
Intercity, 85 = UPS Today
Express, 86 = UPS Today
Express Saver.
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
OTHER DESTINATIONS
the InvoiceLineTotal in
the International Forms
Container must be used.
Invoice Line Total currency
type.
Invoice Line Total amount
for the entire shipment.
99999999
Page 139
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
1...35
N/A
3
String
string
Container
string
One
1...19
/ShipConfirmRequest/Shipment/InvoiceLineTo
tal/MonetaryValue
string
MonetaryValue
One
tal/CurrencyCode
One
CurrencyCode
Container to hold
InvoiceLineTotal Information.
One
tal
One
InvoiceLineTotal
No
/ShipConfirmRequest/Shipment/Service/Descr
iption
Cond
Description
Description of the service
code. Examples are Next
Day Air, Worldwide Express,
and Ground.
Yes*
/ShipConfirmRequest/Shipment/Service/Code
Description
Values are: 01 = Next Day
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
= Express Plus, 59 = 2nd
Saver, 82 = UPS Today
Standard, 83 = UPS Today
Dedicated Courier, 84 =
UPS Today Intercity, 85 =
UPS Today Express, 86 =
UPS Today Express Saver.
Note: Only service code 03
is used for Ground Freight
Pricing shipments
Yes*
Code
Yes
2
XPath
Max Allowed
Name
7/09/2012
Required
N/A
type.
N/A
1
String
N/A
Container
string
Page 140
Partial IV
COD Amount Container.
EEI
N/A
3
One
/ShipConfirmRequest/Shipment/ShipmentSer
viceOptions/COD/CODAmount/CurrencyCode
One
CurrencyCode
One
viceOptions/COD/CODAmount
Yes*
CODAmount
Yes*
viceOptions/COD/CODFundsCode
Yes*
CODFundsCode
Invoice
Values are: 1 = cash; 9 =
check, cashiers check or
money order - no cash
allowed.
Nafta CO
COD container
Indicates COD is
requested. Shipment
COD is only available for
EU origin countries and
for shipper's account type
Daily Pickup and Drop
Shipping. Not available
to shipment with return
service.
CO
Empty Tag.
Return Only
Length
N/A
N/A
Saturday delivery indicator.
The presence indicates
Saturday delivery; the
absence indicates not
Saturday delivery.
Shipment Only
Type
Container
Container for Shipment
Service Option
String
Validation Rules
0
Max Allowed
One
Description
N/A
viceOptions/COD
COD
Container
viceOptions/SaturdayDeliveryIndicator
One
SaturdayDeliveryIndicator
One
viceOptions
Required
ShipmentServiceOptions
No
XPath
No
Name
7/09/2012
No
COD Amount monetary
value.
Container for the Quantum
ViewTM notifications (QVN)
or Return Notification (aka
Label Creation Notification).
The type of notification
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
notification are not
applicable to GFP QV Intransit and Return
Notifications are only valid
for ImportControl and Return
shipments
N/A
Quantum View TM
Notification (QVN) is only
allowed for shipment
without return service;
Return Notification is only
for allowed return service
1-Attempt and 3-Attempt
Container for Email
Information
N/A
Email address where the
notification is sent
Up to five email
addresses are allowed for
each type of Quantum
View TM shipment
notification. Up to two
email address for return
notification.
Page 141
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Length
1...8
String
Container
Description
Shipment Only
Type
string
Container
One
N/A
1...50
viceOptions/Notification/EMail/EMailAddress
String
EMailAddress
One
viceOptions/Notification/EMail
One
EMail
Yes*
viceOptions/Notification/NotificationCode
Yes
NotificationCode
Yes*
1
N/A
Max Allowed
viceOptions/Notification
One
Notification
One
MonetaryValue
viceOptions/COD/CODAmount/MonetaryValu
e
Required
XPath
No
Name
7/09/2012
Yes*
The FromName must
occur only once for each
type of Quantum View
Shipment Notifications.
The Memo must occur
only once for each type of
Notifications.
The name the email will
to the Shipper Name.
included in the eMail.
to text provided by UPS
Notification. The valid
subject codes are: 01 Shipment Reference
Number 1 02 - Shipment
Reference Number 2 03 package Reference Number
1 04 - package Reference
Number 2 08 - Subject
Text (Return Notification
only) If a subject code is not
provided or provided that
refers to a nonexistent
reference number, the
subject will default to
shipment Identification
Number
For return notification: If
the subject code tag is
the subject of the
text is provided and the
value must be 08. If
Subject code is 08,
subject text must exist.
Page 142
Partial IV
EEI
Invoice
There can be only one
UndeliverableEMailAddre
ss for each type of
Notifications.
Nafta CO
undeliverable eMail
message is sent if the eMail
with the notification is
undeliverable.
the Reply To E-mail
the message header
CO
Validation Rules
Return Only
Description
Shipment Only
Length
1...50
Type
String
1...35
1...150
1...50
string
string
1...75
string
viceOptions/Notification/EMail/SubjectCode
One
SubjectCode
No
2
viceOptions/Notification/EMail/Subject
string
String
Max Allowed
One
One
Subject
One
viceOptions/Notification/EMail/Memo
One
Memo
One
viceOptions/Notification/EMail/FromName
No
FromName
No
FromEMailAddress
viceOptions/Notification/EMail/FromEMailAddr
ess
No
viceOptions/Notification/EMail/UndeliverableE
MailAddress
No
XPath
Cond
Name
7/09/2012
Required
1...50
FromName
viceOptions/LabelDelivery/EMail/FromName
undeliverable email
message is sent if the Label
Delivery email is
undeliverable.
the Reply To E-mail
the message header
N/A
The name notification will
to the Shipper Name
N/A
Defaults to
FromEMailAddress.
Page 143
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
N/A
N/A
Length
Type
Container
container
1...50
string
1...50
string
FromEMailAddress
viceOptions/LabelDelivery/EMail/FromEMailA
ddress
1...35
String
N/A
One
string
Max Allowed
One
One
Return Service.
The destination eMail
address for the Label
Delivery.
One
One
Validation Rules
N/A
viceOptions/LabelDelivery/EMail/Undeliverabl
eEMailAddress
No
Description
Container for the Label
Delivery accessorial.Note:
Currently Label delivery
accessorial is not applicable
to GFP Required for
shipments with either
Return Service or
LabelMethod type. If this
container is present, either
of the LabelLinksIndicator or
Email container should be
provided.
Container for the email
message.
One
EMailAddress
viceOptions/LabelDelivery/EMail/EMailAddres
s
Required
viceOptions/LabelDelivery/EMail
No
EMail
Yes*
LabelDelivery
viceOptions/LabelDelivery
No
XPath
Yes*
Name
7/09/2012
No
string
string
One
LabelLinksIndicator
viceOptions/LabelDelivery/LabelLinksIndicator
No
0
One
viceOptions/LabelDelivery/EMail/SubjectCode
No
SubjectCode
Indicates the Label and
Receipt URL's are to be
returned in the XML
response. Applicable for
Labels or for ReturnService
Electronic Labels
Return Service.
Page 144
Partial IV
Label Delivery notification.
Label Delivery. The
reference code (the
mapped to the
the subject of the
text is provided, and the
value must be 08;If
Subject code is 08,
that refers to a
default to the shipment
EEI
N/A
Invoice
to the Label Delivery
shipment ID. Defaults to text
provided by UPS
Nafta CO
N/A
CO
Return Only
Length
1..150
Validation Rules
Shipment Only
Type
string
Description
2
1...75
Max Allowed
string
viceOptions/LabelDelivery/EMail/Subject
Subject
One
viceOptions/LabelDelivery/EMail/Memo
One
Memo
Required
XPath
No
Name
7/09/2012
No
string
International form requested.
string
One
No
0
AdditionalDocumentIndicator
viceOptions/InternationalForms/AdditionalDoc
umentIndicator
One
viceOptions/InternationalForms/FormType
*Yes to Four
FormType
means user will supply
additional document, such
as SED, NAFTA_CO or CO.
Possible Values are: 01
- Invoice 02 - SED03 CO 04 - NAFTA CO 05
- Partial Invoice. For
service, 01 or 05 are the
only valid values. Note:
01 and 05 are mutually
exclusive and 05 is only
valid for return shipments
only.
This indicator should be
set when the shipper
intends to utilize UPS
paperless invoice
functionality AND the
shipper has SELFPREPARED 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 invoice. 4.
Invoice data is supplied
by the client and the data
passes validation.
Page 145
Partial IV
EEI
Invoice
Nafta CO
CO
International Forms
information
REFER TO
InternationalForms
Interface Spec for the
expansion of this node.
Return Only
Validation Rules
Shipment Only
Length
Type
N/A
Container
Description
2
viceOptions/InternationalForms
Max Allowed
InternationalForms
One
XPath
No
Name
7/09/2012
Required
the forms.
string
string
1...35
string
1...15
One
Container
N/A
N/A
Container
One
One
Address
viceOptions/InternationalForms/Contacts/For
wardAgent/Address
N/A
*Yes
wardAgent/TaxIdentificationNumber
One
CompanyName
wardAgent/CompanyName
*Yes
Container
One
One
Cond
ForwardAgent
*Yes
Cond
The forwarding agent is the
company or person acting as
agent in the trans-shipping
of freight to the destination
country.
only.
Company Name or the
Forwarding agent.
only.
Tax ID of the Forwarding
agent.
only.
Forwarding agent.
only.
Indicates the SED filing
option
wardAgent
No
Holds the contact
information of various
parties.
and is required. Valid
values is:01 - Shipper
filing SED
and NAFTA CO only.
and SED. Ultimate
consignee contact
SED. Producer contact
NAFTA CO
Page 146
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
string
Contacts
viceOptions/InternationalForms/Contacts
Description
2
SEDFilingOption
viceOptions/InternationalForms/SEDFilingOpti
on
One
FormGroupIdName
viceOptions/InternationalForms/FormGroupId
Name
No
50
XPath
Max Allowed
Name
7/09/2012
Required
countries.
Town of the Forwarding
agent
Postal code of the
Forwarding agent.
Country code of the
Forwarding agent.
only.
The ultimate consignee is
the person or company who
receives the goods for enduse or the person or
company listed on the export
license. This is the end-user
of the goods.
Container
N/A
1...35
string
One
One
Cond
CompanyName
viceOptions/InternationalForms/Contacts/Ulti
mateConsignee/CompanyName
*Yes
UltimateConsignee
mateConsignee
only. Required when the
form requested is SED.
Company Name or the
Ultimate consignee.
only.
Page 147
Partial IV
State of the Forwarding
agent.
EEI
only.
Invoice
City of the Forwarding agent.
Nafta CO
3
CO
Address line of the
Forwarding agent.
Return Only
Length
1...35
1...30
1...5
1...30
Validation Rules
Shipment Only
Type
string
string
string
String
Description
2
CountryCode
wardAgent/Address/CountryCode
1...9
One
PostalCode
wardAgent/Address/PostalCode
string
One
One
Town
wardAgent/Address/Town
string
Max Allowed
Three
*Yes
StateProvinceCode
wardAgent/Address/StateProvinceCode
One
*Yes
City
wardAgent/Address/City
One
Required
AddressLine
wardAgent/Address/AddressLine
Cond
XPath
*Yes
Name
Cond
7/09/2012
No
only.
State of the Ultimate
consignee.
countries
Town of the Ultimate
consignee
Postal code of the Ultimate
consignee.
Country code of the Ultimate
consignee.
only.
Page 148
Partial IV
City of the Ultimate
consignee.
EEI
3
Invoice
Address line of the Ultimate
consignee.
Nafta CO
only.
CO
1...30
Ultimate consignee.
Return Only
Length
N/A
1...35
1...30
1...5
String
Validation Rules
2
CountryCode
mateConsignee/Address/CountryCode
Description
Shipment Only
Type
Container
string
string
string
One
PostalCode
mateConsignee/Address/PostalCode
1...9
One
One
Town
mateConsignee/Address/Town
String
Three
*Yes
StateProvinceCode
mateConsignee/Address/StateProvinceCode
String
Max Allowed
One
*Yes
City
mateConsignee/Address/City
One
*Yes
AddressLine
mateConsignee/Address/AddressLine
One
Required
Address
mateConsignee/Address
Cond
XPath
*Yes
Name
Cond
7/09/2012
No
1...35
1...30
string
1...5
String
1...30
1...9
One
Cond
PostalCode
viceOptions/InternationalForms/Contacts/Inter
mediateConsignee/Address/PostalCode
only.
Address line of the
3
City of the Intermediate
Consignee.
only.
State of the Intermediate
Consignee.
countries.
Town of the Intermediate
consignee
Postal code of the
Page 149
Partial IV
only.
EEI
Company Name or the
Intermediate consignee.
Invoice
only.
Nafta CO
The intermediate consignee
is the person or company in
the importing country that
makes final delivery to the
ultimate consignee.
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
1...50
string
string
One
Town
mediateConsignee/Address/Town
1...35
1...35
Container
Three
One
StateProvinceCode
mediateConsignee/Address/StateProvinceCo
de
One
Container
string
One
*Yes
City
mediateConsignee/Address/City
string
One
*Yes
AddressLine
mediateConsignee/Address/AddressLine
*Yes
Max Allowed
*Yes
Address
mediateConsignee/Address
One
CompanyName
mediateConsignee/CompanyName
No
IntermediateConsignee
mediateConsignee
Cond
XPath
No
Name
7/09/2012
Required
1...35
string
1...35
string
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
dated by the producer. The
date must be the date the
Certificate was completed
and signed.
producer section instead of
producer contact
information. Use attached
List if more than one
producers good is included
on the Certificate, attach a
list of additional producers,
including the legal name,
address (including country),
and legal tax identification
number, cross-referenced to
the goods described in the
Description of Goods field.
Company Name or the
Producer.
forms
Possible Values are:01:
AVAILABLE TO
CUSTOMS UPON
REQUEST, 02: SAME AS
EXPORTER, 03:
ATTACHED LIST, 04:
UNKNOWN
or not present.
NAFTA CO, when
specified.
Page 150
Partial IV
EEI
Invoice
Nafta CO
only.
CO
Country code of the
Return Only
Validation Rules
Shipment Only
Length
Type
string
Description
2
Max Allowed
One
One
One
CompanyName
viceOptions/InternationalForms/Contacts/Prod
ucer/CompanyName
Cond
Option
ucer/Option
No
2
Producer
Container
ucer
One
CountryCode
mediateConsignee/Address/CountryCode
Required
XPath
Cond
Name
7/09/2012
*Yes
Producer.
or not present
Only applicable if
or not present.
NAFTA CO, when
specified.
Address line of the
Producer.
3
City of the Producer.
Conditionally required
for: NAFTA CO, when
specified.
State of the Producer.
countries
Tax ID of the Producer.
Town of the Producer
Postal code of the Producer.
Page 151
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
1...15
1...50
1...35
Type
string
Container
string
1...30
1...5
1...9
string
One
Cond
PostalCode
ucer/Address/PostalCode
string
string
1...30
One
Three
Town
ucer/Address/Town
One
StateProvinceCode
ucer/Address/StateProvinceCode
*Yes
City
ucer/Address/City
String
One
Cond
AddressLine
ucer/Address/AddressLine
One
No
Address
ucer/Address
One
ucer/TaxIdentificationNumber
Cond
XPath
No
Name
*Yes
Max Allowed
7/09/2012
Required
SoldTo
viceOptions/InternationalForms/Contacts/Sold
To
String
Container
1
String
1
Producer contact's Phone
Extension
Producer contact's email
Address.
N/A
container
One
String
1
No
String
1
Producer contact's Phone
Number
SoldTo Container.
Page 152
Partial IV
EMailAddress
ucer/EMailAddress
Phone Container
EEI
1...2
Yes
Extension
ucer/Phone/Extension
Producer Contact Name
Invoice
Length
string
No
Number
ucer/Phone/Number
Applies to NAFTA CO
Nafta CO
Type
One
No
Phone
ucer/Phone
Country code of the
Producer.
CO
Max Allowed
*Yes
AttentionName
ucer/AttentionName
Validation Rules
Return Only
Required
CountryCode
ucer/Address/CountryCode
Description
Shipment Only
XPath
1
Name
No
7/09/2012
No
1..15
container
N/A
string
1..15
One
string
Option
To/Option
2
string
One
No
Sold To contacts phone
number.
Sold To contacts phone
extension.
sold to section of the NAFTA
CO form. The values
indicate the following 01 Unknown; 02 - Various
Applies to NAFTA CO
form. Possible Values
are 01 and 02
Page 153
Partial IV
1..35
string
One
One
Extension
To/Phone/Extension
Phone Container
EEI
1..35
string
One
No
Number
To/Phone/Number
SoldTo Tax Identification
Number
Invoice
Length
string
One
No
Phone
To/Phone
Contact Name.
Nafta CO
Type
One
Yes*
To/TaxIdentificationNumber
Company Name.
CO
Max Allowed
Yes*
AttentionName
To/AttentionName
Validation Rules
Return Only
Required
Name
To/Name
Description
Shipment Only
XPath
?
Name
Yes*
7/09/2012
No
string
One
string
One
string
CountryCode
To/Address/CountryCode
One
string
30
5
countries.
SoldTo location's town code.
10
?
SoldTo location's state or
province code.
2
SoldTo location's postal
code.
SoldTo location's country
code.
Page 154
Partial IV
string
One
No
PostalCode
To/Address/PostalCode
SoldTo location's city.
EEI
N/A
string
One
Cond
Town
To/Address/Town
3
Invoice
Length
container
Three
Yes
StateProvinceCode
To/Address/StateProvinceCode
SoldTo location's street
address.
Nafta CO
Type
One
Yes
City
To/Address/City
Address Container.
CO
Max Allowed
Yes*
AddressLine
To/Address/AddressLine
Validation Rules
Return Only
Required
Address
To/Address
Description
Shipment Only
XPath
35
Name
Cond
7/09/2012
Yes
String
Container
1...50
1...35
string
Container
1...20
1...7
string
Container
1...20
One
One
One
*Yes
*Yes to fifty
No
One
UnitOfMeasurement
viceOptions/InternationalForms/Product/Unit/
UnitOfMeasurement
One
Number
Number
Cond
Unit
viceOptions/InternationalForms/Product/Unit
*Yes
Description
viceOptions/InternationalForms/Product/Descr
iption
*Yes
viceOptions/InternationalForms/Product
Product
Sold To contact's email
address.
Contains the commodity/
product information
Applies to SED, Invoice,
Partial Invoice, CO and
NAFTA CO. When any
requested Product must
be present at least once
but no more than 50.
Note: For Partial Invoice
this container is optional.
Description of the product.
Applies to all International
Forms. Optional for
present at least once and
can occur for a maximum
of 3 times
Container tag for the unit's
information of each product.
(also called as commodity)
Partial Invoice.
Total quantity of each
commodity to be shipped,
measured in the units
specified in the Unit of
Measure field
are 0-9.
measurement for the
commodity.
Partial Invoice.
Page 155
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
EMailAddress
To/EMailAddress
Max Allowed
XPath
1
Name
7/09/2012
Required
Page 156
Partial IV
EEI
Invoice
Nafta CO
The Unit of Measure if OTH
(Other) is entered as the
UnitOfMeasurement code.
Conditionally Required for
the Invoice and Partial
Invoice form if OTH is
entered as the units
UnitOfMeasurement code
CO
Code for the Unit of
measurement of the
commodity units.
Validation Rules
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,
SYD = Square Yards, TU
= Tube, YD = Yard, OTH
= Other.
Return Only
Description
Shipment Only
Length
Type
string
Max Allowed
One
1... 3
1..3
string
Description
UnitOfMeasurement/Description
One
Code
UnitOfMeasurement/Code
*Yes
XPath
Cond
Name
7/09/2012
Required
Monetary amount used to
specify the worth or price of
the commodity. Amount
should be greater than zero
Page 157
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Partial Invoice form.
Partial Invoice. Amount
should be greater than
zero. Valid characters
are 0-9 and .(Decimal
point). Limit to 6 digits
after the decimal. The
field is 12 including . and
places.(#####.######,
######.#####,
#######.####,
########.###,
#########.##,########
##.#,############)The
value of this product and
the other products should
be such that the invoice
line total which is the sum
of ( number*values) of all
products should not
exceed
9999999999999999.99
Return Only
Description
Shipment Only
Type
Length
1...12
string
Max Allowed
Value
Value
One
XPath
*Yes
Name
7/09/2012
Required
Page 158
Partial IV
EEI
Invoice
for Invoice forms and
optional for Partial
Invoice.
Nafta CO
The part number or
reference number for the
product contained in the
invoice line, as indicated on
the customs invoice.
CO
6-to-15-alphanumeric
commodity code. Customs
uses this code to determine
what duties should be
assessed on the commodity.
Validation Rules
Invoice and 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,
using the H.S. tariff
classification of the
country into whose
territory the good is
imported.
Return Only
Description
Shipment Only
Length
Type
string
Max Allowed
One
6...15
1...10
string
PartNumber
viceOptions/InternationalForms/Product/PartN
umber
One
CommodityCode
viceOptions/InternationalForms/Product/Com
modityCode
Cond
XPath
No
Name
7/09/2012
Required
string
N/A
EMPTY
string
One
Cond
2
One
One
NetCostCode
viceOptions/InternationalForms/Product/NetC
ostCode
Cond
viceOptions/InternationalForms/Product/Joint
ProductionIndicator
No
OriginCountryCode
viceOptions/InternationalForms/Product/Origin
CountryCode
The country in which the
good was manufactured,
produced, or grown. For
detailed information on
country of origin, certificate
of origin, rules of origin, and
any related matters, please
refer to the U.S. Customs
and Border Protection Web
site at www.customs.gov or
contact your country's
Customs authority.
If present, JNT will be used
as the origin of country code
on the NAFTA form and the
Product/OriginCountryCode
tag will be ignored.
For each good described in
the Description of Goods
field, where the good is
subject to a regional value
content (RVC) requirement,
indicate NC if the RVC is
calculated according to the
net cost method; otherwise,
indicate NO.
Applies to NAFTA CO
only
Applies to NAFTA CO
only. Required for NAFTA
CO. Possible
Values:NCNO
Page 159
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Invoice, CO and NAFTA
CO. Required for Invoice
and CO forms. Optional
for Partial Invoice.
Conditionally required for
NAFTA CO if
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
meaning of the NAFTA
Rules of Origin
Regulations, and any
subsequent processing in
the other NAFTA country
does not increase the
transaction value of the
goods by more than
seven percent; otherwise
use the
for joint production.
Shipment Only
Length
Type
Description
2
XPath
Max Allowed
Name
7/09/2012
Required
Applies to NAFTA CO
only. Format is
yyyyMMdd
Applies to NAFTA CO
only. Format is
yyyyMMdd
Values: ABCDEF.
Page 160
Partial IV
EEI
Invoice
Applies to NAFTA CO
only.
Nafta CO
Date Range for regional
value content (RVC)
identified by the begin date
402.5).
identified by the End date
402.5).
Indicates the criterion (A
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
(certain automatic data
processing goods and their
parts).
CO
Validation Rules
Return Only
Length
string
string
string
One
1
One
8
One
*Yes
*Yes
Cond
Description
Shipment Only
Type
N/A
PreferenceCriteria
viceOptions/InternationalForms/Product/Prefe
renceCriteria
Container
EndDate
ostDateRange/EndDate
8
BeginDate
ostDateRange/BeginDate
Max Allowed
NetCostDateRange
ostDateRange
One
XPath
Required
Name
7/09/2012
Optional
string
1...35
1...3
Applies to CO Only
The total number of
packages, cartons, or
containers for the commodity
The shipping weight,
including containers, for
each commodity with a
separate Harmonized Tariff
Code / Schedule B Number.
This weight does not include
carrier equipment.
Values: Yes, No[1], No[2],
or No[3]
Applicable for CO and is
required. Should be
are 0 -9.
CO and SED forms.
forms only
Page 161
Partial IV
EEI
Invoice
Nafta CO
CO
N/A
N/A
Any special marks, codes,
and numbers that may
appear on package
Validation Rules
Return Only
Container
Container
One
No
Cond
Description
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
Certificate for the good
voluntarily provided to the
exporter by the producer.
Shipment Only
string
One
UnitOfMeasurement
viceOptions/InternationalForms/Product/Produ
ctWeight/UnitOfMeasurement
One
Length
One
ProductWeight
ctWeight
Cond
Type
NumberOfPackagesPerCommodi
ty
viceOptions/InternationalForms/Product/Numb
erOfPackagesPerCommodity
3 0r 5
MarksAndNumbers
viceOptions/InternationalForms/Product/Mark
sAndNumbers
string
ProducerInfo
cerInfo
One
XPath
Cond
Name
*Yes
Max Allowed
7/09/2012
Required
string
1...5
string
1...25
Container
1...20
One
One
One
N/A
*Yes
ScheduleB
viceOptions/InternationalForms/Product/Sche
duleB
No
VehicleID
viceOptions/InternationalForms/Product/Vehic
leID
Cond
Weight
ctWeight/Weight
Measure
Weight
Includes the following
information for used selfpropelled 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
self propelled vehicles for
which there are no VINs. Or,
The Vehicle Title Number.
schedule B information of a
commodity
forms only. Valid
decimal place.
only
form
Page 162
Partial IV
EEI
Invoice
Nafta CO
forms only. Possible
values :KGS, LBS
CO
Code for unit of
Return Only
Validation Rules
Shipment Only
Length
Type
string
String
Description
3
Max Allowed
One
Description
ctWeight/UnitOfMeasurement/Description
One
Code
ctWeight/UnitOfMeasurement/Code
Required
XPath
*Yes
Name
7/09/2012
No
string
1...10
string
N/A
Container
*Yes
One
One
UnitOfMeasurement
duleB/UnitOfMeasurement
One
Quantity
duleB/Quantity
Cond
Number
*Yes
duleB/Number
A unique 10-digit commodity
classification code for the
item being exported. (To
classify a commodity access
the following Web page:
http://www.census.gov/foreig
ntrade/schedules/b/#search).
The count of how many
Schedule B units of the
current good are in the
shipment (SED only).For
example, if the Schedule B
unit of measure is dozens
and eight dozen, is being
shipped, indicate 8 in this
field.
The unit of measure
License.
only. Has to be 10
characters.
only. Conditionally
ScheduleB
UnitOfMeasurement is
not X. Should be
Numeric. Valid characters
are 0 -9.
only.
Page 163
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
10
XPath
Max Allowed
Name
7/09/2012
Required
The unit of measure
License. Enter an X if there
is no unit of measure in the
Schedule B Unit field.
Measure
Page 164
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
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
Liter, PK: Pack, PRS:
Pairs, RBA: Running
Bales, SQ: Square, T:
Ton, THS: 1,000, X: No
Quantity required.
Return Only
Description
Shipment Only
Length
1..3
1...20
Type
string
String
Max Allowed
One
Description
duleB/UnitOfMeasurement/Description
One
Code
duleB/UnitOfMeasurement/Code
*Yes
XPath
No
Name
7/09/2012
Required
The value of the S.E.D.
commodity contained on the
S.E.D. This amount will
always be USD.
form. Possible Values:
D: Domestic, F: Foreign,
M: Foreign Military.
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
per Unit). If the total value
is incorrect it will be
replaced by the actual
calculated total value.
Page 165
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Code indicating Domestic:
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.
ForeignMilitary: Exported
merchandise that is sold
under the foreign military
sales program.
Shipment Only
Length
Type
string
1...15
string
One
One
SEDTotalValue
viceOptions/InternationalForms/Product/SEDT
otalValue
Cond
ExportType
viceOptions/InternationalForms/Product/Expor
tType
Cond
1
XPath
Max Allowed
Name
7/09/2012
Required
Date when the Invoice is
created. Ideally this is the
same as the ship date.
Partial Invoice.
for Invoice form for
forward shipments. For
service, the user input will
be ignored, and the field
will be blank on the
invoice. Format is
yyyyMMdd
The customer's order
reference number
Commercial Invoice number
assigned by the exporter
One
string
One
string
1...35
Cond
No
Page 166
Partial IV
EEI
Invoice
International form requested
to NOT have product
information.
Possible Values are 04 –
NAFTA CO. Please note
that if this is used and you
DO NOT have the
corresponding form type
requested this will be
IGNORED.
Nafta CO
If this container is not
present we assume that
the DEFAULT is selected
which is "none" and all
products will appear on all
forms.
CO
Container tag for
determining whether or not
to exclude product
information from a particular
form.
Return Only
Validation Rules
Shipment Only
Length
N/A
Type
Container
String
Max Allowed
One
unbounded
1..2
1...35
PurchaseOrderNumber
viceOptions/InternationalForms/PurchaseOrd
erNumber
string
InvoiceDate
viceOptions/InternationalForms/InvoiceDate
Description
8
InvoiceNumber
viceOptions/InternationalForms/InvoiceNumbe
r
One
FormType
viceOptions/InternationalForms/Product/Exclu
deFromForm/FormType
No
ExcludeFromForm
viceOptions/InternationalForms/Product/Exclu
deFromForm
Yes
XPath
No
Name
7/09/2012
Required
One
string
1...20
One
string
1...150
viceOptions/InternationalForms/Comments
Cond
Comments
No
ReasonForExport
viceOptions/InternationalForms/ReasonForEx
port
Page 167
Partial IV
EEI
Invoice
Any extra information about
the current shipment
Nafta CO
forms and Optional for
Partial Invoice. No
validation
CO
reason to export the current
international shipment.
Possible values: SALE,
GIFT, SAMPLE, RETURN,
REPAIR,
INTERCOMPANYDATA,
Any other reason
Return Only
Indicates the rights to the
seller from the buyer.
Validation Rules
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,
FAS: Free Alongside
Ship, FCA: Free Carrier,
FOB: Free On Board.
Shipment Only
Length
Type
string
Description
3
Max Allowed
TermsOfShipment
viceOptions/InternationalForms/TermsOfShip
ment
One
XPath
Required
Name
7/09/2012
No
Page 168
Partial IV
EEI
Invoice
Nafta CO
discount.
On the invoice for return
shipment, the verbiage is
as follows (user input is
ignored): The exporter of
the products covered by
this document declares
that except where
otherwise clearly
indicated these products
are of EEA preferential
origin
CO
Validation Rules
Return Only
Description
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
NAFTA.I hereby certify that
the information on this
invoice is true and correct
and the contents and value
of this shipment is as stated
above. EEA statement: The
exporter of the products
covered by this document
declares that except where
otherwise clearly indicated
these products are of EEA
preferential origin.
Shipment Only
Length
1...550
Type
string
N/A
Max Allowed
Container
viceOptions/InternationalForms/Discount
One
Discount
One
DeclarationStatement
viceOptions/InternationalForms/DeclarationSt
atement
No
XPath
No
Name
7/09/2012
Required
Page 169
Partial IV
EEI
N/A
Insurance Charges
Invoice
0...15
Container
Cost to transport the
shipment
decimal places.
Nafta CO
N/A
string
One
Freight Charges
CO
string
Container
One
InsuranceCharges
viceOptions/InternationalForms/InsuranceCha
rges
The discount to be
subtracted from the sum of
the total value on the
invoice.
Validation Rules
decimal places. This
value should be greater
than or equal to zero or
less than or equal to the
value of all goods listed
on the invoice.
Return Only
One
One
MonetaryValue
viceOptions/InternationalForms/FreightCharge
s/MonetaryValue
Description
Shipment Only
*Yes
FreightCharges
viceOptions/InternationalForms/FreightCharge
s
No
Length
MonetaryValue
viceOptions/InternationalForms/Discount/Mon
etaryValue
*Yes
Type
XPath
15
Name
No
Max Allowed
7/09/2012
Required
The amount the shipper or
receiver pays to cover the
cost of replacing the
shipment if it is lost or
damaged
information of amount that
covers additional charges
not already listed on the
invoice
The Monetary value of Other
Charges
decimal places.
Description of what the other
charges are for.
Required for Complete
Invoice and Optional for
Currency code for all the
monetary values of the
Invoice form
string
One
Cond
Page 170
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
decimal places.
Shipment Only
Length
Type
N/A
0...15
0...15
Container
string
1...10
CurrencyCode
viceOptions/InternationalForms/CurrencyCod
e
Description
3
Description
viceOptions/InternationalForms/OtherCharges
/Description
string
One
One
string
Max Allowed
No
MonetaryValue
/MonetaryValue
One
*Yes
OtherCharges
*Yes
MonetaryValue
viceOptions/InternationalForms/InsuranceCha
rges/MonetaryValue
One
XPath
*Yes
Name
7/09/2012
Required
string
string
1...35
string
string
8
*Yes
One
One
One
ExportingCarrier
viceOptions/InternationalForms/ExportingCarri
er
Cond
viceOptions/InternationalForms/ExportDate
Cond
ExportDate
The date the goods will be
exiting the country
The name of the carrier that
is exporting the shipment.
The vessel's flag number
should also be entered, if the
carrier is a vessel.
CO and SED forms.
Format is yyyyMMdd
CO and SED forms.
Page 171
Partial IV
EEI
Invoice
Nafta CO
Applies to NAFTA CO
NAFTA CO. Format is
yyyyMMdd
Applies to NAFTA CO
NAFTA CO. Format is
yyyyMMdd
CO
End Date of the blanket
which the blanket period
expires.
Applies to NAFTA CO
NAFTA CO.
Return Only
Validation Rules
8
One
*Yes
Description
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
which preferential treatment
is claimed based on this
certificate must occur
between these dates.
Begin date of the blanket
which the Certificate
becomes applicable to the
good covered by the blanket
Certificate (it may be prior to
the date of signing this
Certificate).
Shipment Only
Length
Type
N/A
Container
EndDate
viceOptions/InternationalForms/BlanketPeriod
/EndDate
8
BeginDate
/BeginDate
Max Allowed
BlanketPeriod
One
XPath
Cond
Name
7/09/2012
Required
only. No Validations.
One
Cond
string
1...25
string
viceOptions/InternationalForms/EntryNumber
One
EntryNumber
viceOptions/InternationalForms/InBondCode
Cond
InBondCode
The two-character In Bond
Code
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:
IE from a FTZ; 68: T and
E from a FTZ
The Import Entry Number
when the export transaction
is used as proof of export for
import transactions
(examples: In Bond,
Temporary Import Bond or
Drawbacks)
only. Conditionally
Required for SED forms
when In bond code value
is other than 70(Not In
Bond)
Page 172
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
1...17
Validation Rules
Shipment Only
Type
string
Description
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
Transport Association (IATA)
code
2
viceOptions/InternationalForms/CarrierID
Max Allowed
CarrierID
One
XPath
Required
Name
7/09/2012
No
Mode of transport by which
the goods are exported.
Possible values: Air,
AirContainerized, Auto,
FixedTransportInstallations,
Mail,
PassengerHandcarried,
Pedestrian, Rail,
RailContainerized,
RoadOther, SeaBarge,
SeaContainerized,
SeaNoncontainerized,
Truck, TruckContainerized
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.
Postal Office from where the
goods are mailed
only. Required for SED.
Only allowed values can
be entered. Only 10
Characters can appear on
the form. Anything greater
than 10 characters will be
truncated on the form.
Page 173
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Length
Description
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
goods were shipped from
Puerto Rico, enter PR.
Shipment Only
Type
1...5
1...35
string
string
Max Allowed
One
1...35
viceOptions/InternationalForms/PortOfExport
string
PortOfExport
One
ModeOfTransport
viceOptions/InternationalForms/ModeOfTrans
port
One
viceOptions/InternationalForms/PointOfOrigin
Required
PointOfOrigin
Cond
XPath
No
Name
7/09/2012
Cond
string
EMPTY
N/A
One
One
viceOptions/InternationalForms/RoutedExport
TransactionIndicator
Cond
RoutedExportTransactionIndicato
r
No
PartiesToTransaction
viceOptions/InternationalForms/PartiesToTran
saction
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
fiscal year. If unincorporated,
then an equivalent interest in
the business.
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
(or other) agent to export the
merchandise outside the
U.S.
only. Valid values are: R
- Related, N - Non-related
only
Page 174
Partial IV
EEI
Invoice
Pier where goods are
loaded. For vessel
shipments only
Nafta CO
CO
The country and the port
where the goods will be
unloaded from the exporting
carrier. For vessel and air
shipments only.
Return Only
Validation Rules
Shipment Only
Length
Type
string
1...35
1...35
Description
1
string
Max Allowed
One
LoadingPier
viceOptions/InternationalForms/LoadingPier
One
PortOfUnloading
viceOptions/InternationalForms/PortOfUnloadi
ng
No
XPath
No
Name
7/09/2012
Required
If present indicates that the
goods are containerized.
This applies to vessel
shipments only
Container for License
information. If the product is
not licensable, a valid
license exception code
needs to be entered. If
shipping different products
that are covered under
different licenses or license
exceptions, then separate
SEDs must be created.
The license number that
authorizes ship product.
License Date
only
forms.
number or License
SED form.
only. Conditionally
there is a license number.
License Number is
provided. Format
yyyyMMdd
Page 175
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Type
Length
N/A
EMPTY
1...35
N/A
string
1...8
Container
Max Allowed
One
One
string
viceOptions/InternationalForms/License/Date
One
Date
One
Number
viceOptions/InternationalForms/License/Numb
er
No
License
viceOptions/InternationalForms/License
Cond
ContainerizedIndicator
viceOptions/InternationalForms/Containerized
Indicator
Cond
XPath
Cond
Name
7/09/2012
Required
Please refer to Appendix Q
for values and descriptions.
string
One
OverridePaperlessIndicator
viceOptions/InternationalForms/OverridePape
rlessIndicator
String
N/A
container
only. ECCN is required
one of the following
License Exception Codes
is entered: CIV, CTP,
ENC, KMI, or LVS
For a list of valid
Appendix N
Forwards Only
Forwards Only
string
viceOptions/DeliveryConfirmation/DCISType
One
DCISType
Yes*
1
One
viceOptions/DeliveryConfirmation
No
No
1
viceOptions/InternationalForms/ECCNNumber
Cond
ECCNNumber
Export Control Classification
Number. This number
identifies categories, product
groups, strategic level of
control, and country groups.
Some products have an
ECCN number.
The application will
automatically provide a copy
of the invoice or NAFTA/CO
with each response
regardless of whether the
user has enabled Paperless
account. The user now has
the option to print or ignore
the copy provided.
Page 176
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
1...4
Validation Rules
number or License
SED form. Validated for
possible values
Shipment Only
Type
string
Description
8
Max Allowed
ExceptionCode
viceOptions/InternationalForms/License/Exce
ptionCode
One
XPath
Required
Name
7/09/2012
Cond
DCIS Number
String
String
Container
Valid for Poland to Poland
without return service
only.
N/A
Indicates that the Shipment
is an ImportControl
shipment.
String
1...35
String
viceOptions/LabelMethod/Description
One
Description
One
viceOptions/LabelMethod/Code
Yes*
Code
Yes*
2
No
No
0
One
One
LabelMethod
viceOptions/LabelMethod
One
ImportControlIndicator
viceOptions/ImportControlIndicator
No
ReturnOfDocumentIndicator
viceOptions/ReturnOfDocumentIndicator
The flag indicates the
ReturnOfDocument
accessorial has been
requested
Type of ImportControl Label.
This container is
applicable only for
LabelMethod types:'01' =
ImportControl Print and
Mail'02' = ImportControl
One-Attempt'03' =
ImportControl ThreeAttempt'04' = ImportControl
Electronic Label'05' =
ImportControl Print Label
LabelMethod description
Page 177
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
1...20
Validation Rules
Shipment Only
Type
String
Description
0
Max Allowed
DCISNumber
viceOptions/DeliveryConfirmation/DCISNumb
er
One
XPath
Required
Name
7/09/2012
No
No
EMailAddress
viceOptions/PreAlertNotification/EMailMessag
e/EMailAddress
String
String
1
Container
1
No
String
EMailMessage
e
UPS carbon neutral indicator
is required to create carbon
neutral Shipments.
Container
viceOptions/PreAlertNotification
One
unbounded
viceOptions/UPScarbonneutralIndicator
No
UPScarbonneutralIndicator
Yes
0
One
viceOptions/CommercialInvoiceRemovalIndic
ator
No
CommercialInvoiceRemovalIndic
ator
CommercialInvoiceRemovalI
ndicator allows a shipper to
dictate that UPS remove the
Commercial Invoice from the
user's shipment before the
shipment is delivered to the
ultimate consignee.
Page 178
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
0
XPath
Max Allowed
Name
7/09/2012
Required
String
Container
1
No
String
1
No
Container
1
Yes
String
1
No
Container
1
Yes
String
1
Yes
Yes
Page 179
Partial IV
Language
viceOptions/PreAlertNotification/Locale/Langu
age
EEI
viceOptions/PreAlertNotification/Locale
Invoice
Locale
Nafta CO
PhoneNumber
viceOptions/PreAlertNotification/TextMessage
/PhoneNumber
CO
viceOptions/PreAlertNotification/TextMessage
Validation Rules
Return Only
TextMessage
Description
Shipment Only
PhoneNumber
viceOptions/PreAlertNotification/VoiceMessag
e/PhoneNumber
Length
VoiceMessage
viceOptions/PreAlertNotification/VoiceMessag
e
Type
e/UndeliverableEMailAddress
Max Allowed
XPath
1
Name
7/09/2012
Required
String
String
1
Container
N/A
string
1...35
N/A
container
Page 180
Partial IV
Packaging Container
Packaging type is
required for Ground
Freight Pricing
Shipments only
EEI
with return service
Invoice
Merchandise description of
package.
##
/ShipConfirmRequest/Shipment/Package/Pac
kaging
One
Packaging
One
/ShipConfirmRequest/Shipment/Package/Des
cription
Yes
Description
Cond
/ShipConfirmRequest/Shipment/Package
Cond
Package
Nafta CO
Package Information
container.
For Return Shipments up
to and including 20
packages are allowed.
US/PR origin return
movements are limited to
only one package.
CO
No
Validation Rules
Return Only
viceOptions/ExchangeForwardIndicator
Description
Shipment Only
Yes
ExchangeForwardIndicator
Length
Dialect
viceOptions/PreAlertNotification/Locale/Dialec
t
Type
XPath
1
Name
Max Allowed
7/09/2012
Required
string
N/A
1...35
container
String
One
One
Yes*
N/A
/ShipConfirmRequest/Shipment/Package/Dim
ensions/UnitOfMeasurement
container
UnitOfMeasurement
One
ensions
One
Dimensions
No
kaging/Description
Cond
Description
Yes
kaging/Code
Code
UnitOfMeasurement
container
N/A
Page 181
Partial IV
Dimensions information
container. Note: Currently
dimensions are not
applicable to Ground Freight
Pricing
Length + 2*(Width +
Height) must be less than
or equal to 130 IN or 330
CM. Dimensions are
required for GB to GB
and Poland to Poland
Shipments.
EEI
N/A
Invoice
Description of packaging
type. Examples are letter,
customer supplied, express
box.
Nafta CO
Package type 24, or 25
or 30 is only allowed for
service. Packaging type
must be valid for all the
following: ShipTo
country, ShipFrom
country, a shipment going
from ShipTo country to
ShipFrom country, all
Accessorials at both the
shipment and package
level, and the shipment
service type.
CO
Package types. Values are:
01 = UPS Letter, 02 =
Customer Supplied
Package, 03 = Tube, 04 =
PAK, 21 = UPS Express
Box, 24 = UPS 25KG Box,
25 = UPS 10KG Box, 30 =
Pallet, 2a = Small Express
Box, 2b = Medium Express
Box, 2c = Large Express
Box. Note: Only packaging
type code 02 is applicable to
Return Only
Validation Rules
Shipment Only
Length
Type
Description
2
XPath
Max Allowed
Name
7/09/2012
Required
string
string
1...35
3
Package height. Refer to
N/A
N/A
string
N/A
Container to hold package
weight information.
Package weight is a
required field for Ground
Freight Pricing shipments
Container to hold
UnitOfMeasurement
information.
N/A
Yes*
One
string
One
Container
One
Container
Yes
Cond
3
Package width. Refer to
N/A
One
3
string
One
One
One
Yes
No
Yes*
Yes*
Valid values are 0 to 108
IN and 0 to 270 CM.
Page 182
Partial IV
EEI
UnitOfMeasurement
kageWeight/UnitOfMeasurement
N/A
Invoice
PackageWeight
kageWeight
dimensions measurement
units.
Package length. Refer to
additional information.Length
must be the longest
dimension of the container.
Nafta CO
Height
ensions/Height
The unit of measurement
must be valid for the
Shipper country.
CO
Width
ensions/Width
Validation Rules
Return Only
ensions/Length
Description
Package dimensions
are: IN = Inches, CM =
Centimeters, 00 = Metric
Units Of Measurement, 01 =
English Units of
Measurement.
Shipment Only
Length
Length
Description
ensions/UnitOfMeasurement/Description
Type
Code
ensions/UnitOfMeasurement/Code
2
XPath
Max Allowed
Name
7/09/2012
Required
ReferenceNumber
/ShipConfirmRequest/Shipment/Package/Ref
erenceNumber
One
string
One
string
1...35
1...5
LargePackageIndicator
/ShipConfirmRequest/Shipment/Package/Larg
ePackageIndicator
string
kageWeight/Weight
N/A
Packages weight. Set to 1.0
for package type letter.
Only {Average}package
weight is required for
Shipment
mentions that the package is
Large Package.
Empty Tag.
Package reference number
information container
N/A
One
string
One
container
N/A
No
No
0
Weight
One
kageWeight/UnitOfMeasurement/Description
Yes
Description
No
kageWeight/UnitOfMeasurement/Code
Yes*
Code
Package weight unit of
are: LBS = Pounds, KGS =
Kilograms.
Page 183
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
3
XPath
Max Allowed
Name
7/09/2012
Required
string
string
1...35
string
Reference number type
code, for the entire
shipment. The code
name. Refer to the
table.
number.
Valid if the
US/US or PR/PR.2
Valid if the
US/US or PR/PR.
Supports up to 2
customer supplied
combinations of
Reference code- value
combinations.
Additional Handling
Required.The presence
indicates additional handling
is required, the absence
indicates no additional
handling is required.
Empty Tag.
string
/ShipConfirmRequest/Shipment/Package/Addi
tionalHandlingIndicator
One
AdditionalHandlingIndicator
No
0
erenceNumber/Value
One
Value
One
erenceNumber/Code
No
Code
Yes*
2
One
erenceNumber/BarCodeIndicator
No
BarCodeIndicator
Page 184
Partial IV
EEI
Invoice
Nafta CO
CO
the label.
shipment-level or
barcode a reference
no longer than 14
and cannot contain
spaces.
Return Only
Validation Rules
Shipment Only
Length
Type
Description
0
XPath
Max Allowed
Name
7/09/2012
Required
One
string
1...11
kageServiceOptions/DeclaredValue
No
One
container
N/A
Type
kageServiceOptions/DeclaredValue/Type
No
One
container
N/A
string
No
DeclaredValue
One
DCISNumber
kageServiceOptions/DeliveryConfirmation/DCI
SNumber
Yes*
DCISType
kageServiceOptions/DeliveryConfirmation/DCI
SType
Delivery Confirmation
Control number associated
with the delivery
confirmation for the package
Forwards Only
Container for DeclaredValue
N/A
Container for Declared
Value Type
N/A
Page 185
Partial IV
Forwards Only
EEI
Forwards Only
Invoice
For a list of valid
Appendix N
Nafta CO
N/A
CO
PackageServiceOtioncontain
er
Return Only
Length
N/A
Validation Rules
Shipment Only
Type
container
N/A
container
Description
1
kageServiceOptions/DeliveryConfirmation
Max Allowed
One
kageServiceOptions
One
PackageServiceOptions
Required
XPath
No
Name
7/09/2012
No
One
string
No
One
string
CurrencyCode
kageServiceOptions/DeclaredValue/Currency
Code
Yes*
One
string
MonetaryValue
kageServiceOptions/DeclaredValue/Monetary
Value
Yes*
One
string
1...35
*Yes
Description
kageServiceOptions/DeclaredValue/Type/Des
cription
1...19
Declared value amount.
Page 186
Partial IV
EEI
Code must represent a
currency that is a valid for
Shipper country.
Invoice
Declared value amount
currency type. Defaults to
the non-Euro currency used
in the shipper's country.
Nafta CO
N/A
CO
Declared value Description
3
Code
kageServiceOptions/DeclaredValue/Type/Cod
e
Return Only
Declared value type. Valid
value are 01=EVS, 02=DVS.
Defaults to 01 i.e. EVS if
declared value type is not
provided.
Validation Rules
The user cannot specify
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
Shipper Declared Value is
applicable for forward
shipments when the
billing option is freight
collect or third party
Shipment Only
Length
Type
Description
2
XPath
Max Allowed
Name
7/09/2012
Required
Yes*
One
string
CODAmount
kageServiceOptions/COD/CODAmount
Yes*
One
container
CurrencyCode
kageServiceOptions/COD/CODAmount/Curre
ncyCode
Yes
One
string
MonetaryValue
kageServiceOptions/COD/CODAmount/Monet
aryValue
Yes
One
string
N/A
kageServiceOptions/COD/CODFundsCode
type.
N/A
COD Amount.
Valid values: 0.01 USD 50000.00 USD
5
Page 187
Partial IV
N/A
EEI
CODAmount container
Invoice
N/A
3
CODFundsCode
Nafta CO
Values are: 0 = check,
order - no cash allowed, 8 =
order - no cash allowed.
CO
COD container
Indicates COD is
requested. Package level
COD is available for
service from US/PR to
US/PR, CA to CA, and
CA to US.CA to US COD
is not allowed for package
Letter/ Envelope. COD is
not valid for return service
movements.
Return Only
Validation Rules
Shipment Only
Type
Length
N/A
Max Allowed
Description
1
container
kageServiceOptions/COD
COD
One
XPath
No
Name
7/09/2012
Required
N/A
Container
N/A
One
string
1...35
No
One
Container
N/A
Number
kageServiceOptions/VerbalConfirmation/Cont
actInfo/Phone/Number
One
String
1...15
Extension
actInfo/Phone/Extension
One
String
1...4
Phone Container
N/A
Contact Phone Number
N/A
Contact Phone Extension
N/A
Page 188
Partial IV
Container
One
Cond
Phone
actInfo/Phone
Name of the person to be
contacted for confirmation.
Defaults to Shipper
AttentionName if given.
N/A
Optional if Shipper/
AttentionName is given
and that is the name of
the person to be
contacted else required
for verbal confirmation.
EEI
Length
One
Cond
Name
actInfo/Name
Allowed for shipment
Invoice
Type
No
ContactInfo
actInfo
Verbal Confirmation Info.
Optional if the Shipper's
AttentionName,
PhoneNumber, and
PhoneExtension(optional)
are given and are the
desired name, phone
number and extension,
respectively, to be used for
verbal confirmation.
Nafta CO
Max Allowed
kageServiceOptions/VerbalConfirmation
Validation Rules
CO
Required
VerbalConfirmation
Description
Return Only
XPath
Shipment Only
Name
Yes*
7/09/2012
No
No
One
String
Notification
kageServiceOptions/Notification
No
One
Container
NotificationCode
kageServiceOptions/Notification/NotificationC
ode
Yes*
One
String
EMail
kageServiceOptions/Notification/EMail
N/A
Yes*
One
Container
EMailAddress
kageServiceOptions/Notification/EMail/EMailA
ddress
The destination email
address of the receiver
returns notification email.
N/A
The e-mail address where
an undeliverable email
message is sent if the
email is undeliverable.
One
Defaults to
FromEMailAddress. Only
allowed at the first
package.
1...50
String
String
One
Yes*
No
kageServiceOptions/Notification/EMail/Undeli
verableEMailAddress
Page 189
Partial IV
Container for the e-mail
Message.
EEI
3 - Receiver Return
Notification
Invoice
Notification Code
Nafta CO
Applicable for Shipment
with returne service.
CO
N/A
kageServiceOptions/ShipperReleaseIndicator
1
ShipperReleaseIndicator
Return Only
Empty Tag. Only
available for US50/PR to
US50/PR packages
Shipment Only
Length
The presence indicates that
the package may be
released by driver without a
signature from the
consignee
N/A
Type
Validation Rules
0
Description
1...50
XPath
Max Allowed
Name
7/09/2012
Required
package.
to the UPS Receiver Return
shipment ID.
package
Page 190
Partial IV
EEI
Defaults to the Shipper
Name. Only allowed at
the first package.
Invoice
The name the receiver
return notification will appear
to be from.
Nafta CO
package.
CO
Validation Rules
The email address listed in
the Reply To field of the
message header, includes
name and e-mail address of
sender. The From field of
the message header
Return Only
Description
Shipment Only
Length
Type
1...35
1...50
String
String
1...150
1...75
String
String
Max Allowed
One
One
Subject
kageServiceOptions/Notification/EMail/Subjec
t
One
kageServiceOptions/Notification/EMail/Memo
One
Memo
No
FromName
kageServiceOptions/Notification/EMail/FromN
ame
No
FromEMailAddress
kageServiceOptions/Notification/EMail/FromE
MailAddress
No
XPath
No
Name
7/09/2012
Required
String
No
DryIce
kageServiceOptions/DryIce
Regulation set for dryIce
Shipment. Valid values are :
CFR = HazMat regulated by
US Dept of Transportation
within the U.S. or ground
shipments to Canada,
IATA= Worldwide Air
movement
String
valid: IATA,CFR
Page 191
X
X
Cannot be used when the
package also contains
Hazmat
N/A
3..4
kageServiceOptions/DryIce/RegulationSet
String
RegulationSet
Yes
1
No
Container
1
One
0
No
ReturnsFlexibleAccessIndicator
kageServiceOptions/ReturnsFlexibleAccessIn
dicator
One
SubjectCode
kageServiceOptions/Notification/EMail/Subjec
tCode
The reference code (the
mapped to the
Returns Flexible Access
Indicator presence at
package level is required for
UPS Returns Flexible
Access Shipments. All
packages in the shipment
must have the Returns
Flexible Access Indicator if
one package has it.
the subject of the
text is provided, and
value must be 08;If the
subject code is 08, the
that refers to a
default to the tracking
number. Only allowed at
the first package.
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
2
XPath
Max Allowed
Name
7/09/2012
Required
N/A
N/A
X
Container
Container
2..3
0..20
X
String
String
1
X
1
Yes
Yes
Weight
X
Cannot be more than
package weight. Should
be more than 0.0. Valid
decimal place.
Page 192
X
1…5
String
Weight
kageServiceOptions/DryIce/DryIceWeight/Wei
ght
Yes
1
No
Short description for
UnitOfMeasurement
Partial IV
EEI
Invoice
valid : 00 , 01, KG , KGS ,
LBS
1
Description
kageServiceOptions/DryIce/DryIceWeight/Unit
OfMeasurement/Description
Yes
Code
OfMeasurement/Code
Nafta CO
DryIce weight unit of
measurement code. Valid
values are: 00 = KG(Metric
Unit of Measurements), 01 =
LB(English Unit of
Measurements), KG, LB,
KGS, LBS
CO
Validation Rules
Return Only
Description
Shipment Only
UnitOfMeasurement
OfMeasurement
Length
kageServiceOptions/DryIce/DryIceWeight
Type
DryIceWeight
Max Allowed
XPath
1
Name
7/09/2012
Required
N/A
Container
X
String
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
rates are adjusted for dryIce
weight more than 2.5 Kgs or
5.7 LBs
Commodity information
It is required if the
FRSShipment indicator is
present in the request.
Freight Classification.
Freight class partially
determines the freight rate
for the article.
Required for Ground
Freight Pricing
Shipments only
FreightClass
/ShipConfirmRequest/Shipment/Package/Co
mmodity/FreightClass
Yes
One
String
NMFC
mmodity/NMFC
No
One
Container
N/A
Container to hold the NMFC
codes
PrimeCode
mmodity/NMFC/PrimeCode
Yes
One
String
4..6
NMFC prime code
Required if NMFC
Container is Present
Page 193
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
Length
Type
Validation Rules
10
One
No
Commodity
mmodity
Cond
MedicalUseIndicator
kageServiceOptions/DryIce/MedicalUseIndica
tor
Description
0
Max Allowed
XPath
1
Name
7/09/2012
Required
/ShipConfirmRequest/LabelSpecification/Labe
lImageFormat
NMFC sub code
String
1...35
String
lImageFormat/Description
One
Description
One
lImageFormat/Code
Yes
Code
No
3
LabelImageFormat
One
/ShipConfirmRequest/LabelSpecification
Cond
LabelSpecification
Yes
2
Container used to define the
properties required by the
user to print and/or display
the UPS shipping label.
shipment with PRL return
service.
LabelImageFormat
Container
Label print method code that
the Labels are to be
generated for EPL2
formatted Labels use EPL,
for SPL formatted Labels
use SPL, for ZPL formatted
Labels use ZPL and for
image formats use GIF, for
Star Printer format formatted
Labels use STARPL.
image format code.
N/A
For shipments without
return service the valid
value is GIF, ZPL, EPL
and SPL. For shipments
with PRL return service,
the valid values are EPL,
ZPL, SPL, STARPL and
GIF.
N/A
Page 194
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
N/A
N/A
Description
Shipment Only
Type
String
Container
Container
Length
Max Allowed
mmodity/NMFC/SubCode
One
SubCode
One
XPath
Required
Name
7/09/2012
No
Page 195
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
X
X
Length
1...64
Type
String
N/A
1...3
String
Container
Max Allowed
One
Width of the label image. For
IN, use whole inches.
and SPL Labels. Valid
value is 4. Note: Label
Image will only scale up
to 4 X 6, even when
requesting 4 X 8.
One
Height of the label image.
For IN, use whole inches.
and SPL Labels. Only
valid values are 6 or 8.
Note: Label Image will
only scale up to 4 X 6,
even when requesting 4 X
8.
X
lStockSize/Width
1...3
Width
lStockSize/Height
String
Height
and SPL Labels.
Container for the EPL2, ZPL,
STARPL or SPL label size
One
lStockSize
One
LabelStockSize
Required if
/ShipConfirmRequest/Lab
elSpecificationLabelSpeci
fication/LabelImageForma
t/Code = Gif. Default to
Mozilla/4.5 if this field is
missing or has invalid
value.
Cond
/ShipConfirmRequest/LabelSpecification/HTT
PUserAgent
Validation Rules
Yes
HTTPUserAgent
Description
Browser HTTPUserAgent
String. This is the preferred
way of identifying GIF image
type to be generated
Yes
XPath
Yes
Name
7/09/2012
Required
String
String
1
/ShipConfirmRequest/ReceiptSpecification
ImageFormat
/ShipConfirmRequest/ReceiptSpecification/Im
ageFormat
Yes
Code
ageFormat/Code
Description
ageFormat/Description
Container used to allow the
user a to choose to print a
thermal receipt.
ImageFormat Container
Print code that determines
the receipt format.
String
No
1
String
1
Container
1
ReceiptSpecification
Yes
No
Container
1
No
Instruction code.
Description of the receipt
format code.
Page 196
Partial IV
EEI
/ShipConfirmRequest/LabelSpecification/Instr
uction/Description
Invoice
Description
For Exchange Forward
Shipment
Nafta CO
Container
uction/Code
Routing Instruction
Container
CO
Type
unbounded
Code
Validation Rules
Return Only
Max Allowed
uction
Description
Shipment Only
Required
Instruction
Length
XPath
1
Name
No
7/09/2012
Yes
CustomerContext
/ShipAcceptRequest/Request/TransactionRef
erence/CustomerContext
nonvalidate.
between client and server.
The client uses
CustomerContext to
synchronize
request/response pairs. The
client establishes
contain any information you
want, as along as it is valid
XML; it is echoed back by
the server.
N/A
N/A
Page 197
Partial IV
/ShipAcceptRequest/Request/TransactionRef
erence
N/A
EEI
/ShipAcceptRequest/Request/RequestOption
Request Container
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 avoid an
address correction fee.
Invoice
RequestOption
N/A
Nafta CO
/ShipAcceptRequest/Request
Request Container
CO
Length
N/A
N/A
1...15
N/A
1...512
Request
Validation Rules
Return Only
Type
container
container
string
Container
string
/ShipAcceptRequest
Description
Shipment Only
Max Allowed
One
One
One
One
ShipAcceptRequest
One
Required
XPath
No
Yes
Name
No
Yes
7/09/2012
Yes
Shipment Response
Container
Response Container.
Response Status Container.
string
N/A
1...35
string
container
One
One
Yes
Yes
Describes Response Status
Code. Returns text of
Success.
One
/ShipmentResponse/Response/Alert
No
Alert
Identifies the success or
failure of the transaction. 1 =
Successful
Alert Container. There can
be zero to many alert
containers with code and
description.
Page 198
Partial IV
EEI
Invoice
Nafta CO
Base 64 Encoded
CO
Encoded shipment
parameters required to be
passed in the accept phase.
Return Only
Length
unbounded
N/A
Validation Rules
Shipment Only
Type
String
container
N/A
Required
container
Description
/ShipmentResponse/Response/ResponseStat
us/Description
N/A
Code
us/Code
container
us
Description
1
ResponseStatus
Max Allowed
/ShipmentResponse/Response
One
Response
One
/ShipmentResponse
One
ShipmentResponse
One
/ShipAcceptRequest/ShipmentDigest
Yes
ShipmentDigest
Yes
XPath
Yes
Name
7/09/2012
Yes
Warning code returned by
the system.
Warning messages returned
by the system.
Transaction Reference
Container.
The CustomerContext
Information which will be
echoed during response.
Refer to the
ShipmentResults container
table for the elements under
ShipmentResults container.
Page 199
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Length
1...10
1...150
N/A
Description
Shipment Only
Type
string
string
container
1...512
Max Allowed
One
string
N/A
/ShipmentResponse/ShipmentResults
container
ShipmentResults
One
CustomerContext
/ShipmentResponse/Response/TransactionR
eference/CustomerContext
One
/ShipmentResponse/Response/TransactionR
eference
One
One
/ShipmentResponse/Response/Alert/Descripti
on
Required
Description
Yes*
/ShipmentResponse/Response/Alert/Code
Yes*
Code
No
XPath
Yes
Name
7/09/2012
No
TransportationCharges
/ShipmentResponse/ShipmentResults/Shipme
ntCharges/TransportationCharges
Shipment charges
Container. Shipment
charges info. Shipment
charges are only guaranteed
to be returned for shipments
whose origin country is US
or Puerto Rico.
String
N/A
container
string
Transportation charges
currency code type. The
currency code used in the
Shipment request is
returned.
1...19
string
One
One
MonetaryValue
ntCharges/TransportationCharges/MonetaryV
alue
Yes
CurrencyCode
ntCharges/TransportationCharges/CurrencyC
ode
Yes
3
One
Transport Charges
container.
Transportation and
surcharges value amount.
99999999999999.99
Page 200
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Type
Max Allowed
Length
N/A
ntCharges/RateChart
container
RateChart
Description
1
ntCharges
One
Cond
ShipmentCharges
No
XPath
Yes
Name
7/09/2012
Required
Service Option Charges
container.
1...19
string
string
N/A
Accessorial charges value
amount. Valid values are
from 0 to
99999999999999.99
Total charges container.
string
Total charges value amount.
99999999999999.99
1...19
Total charges currency code
type. The currency code
used in the Shipment
request is returned.
string
One
MonetaryValue
ntCharges/TotalCharges/MonetaryValue
One
ntCharges/TotalCharges/CurrencyCode
Yes
CurrencyCode
Yes
3
container
One
One
One
ntCharges/TotalCharges
Yes
TotalCharges
Yes
MonetaryValue
ntCharges/ServiceOptionsCharges/Monetary
Value
Yes
CurrencyCode
ntCharges/ServiceOptionsCharges/CurrencyC
ode
Accessorial charges
Shipment request is
returned.
Page 201
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
N/A
Validation Rules
Shipment Only
Type
container
Description
3
ntCharges/ServiceOptionsCharges
Max Allowed
ServiceOptionsCharges
One
XPath
Required
Name
7/09/2012
Yes
Negotiated Rates Charge
Container.
Account Based Rates info.
Total charges are only
returned for ABR eligible
shipper account/UserId
combinations when the user
includes the
NegotiatedRatesIndicator in
the request.
string
1..19
N/A
Container
Yes
One
One
/ShipmentResponse/ShipmentResults/FRSSh
ipmentData
Cond
FRSShipmentData
Total charges currency
code.
Total charges monetary
value. Valid values are from
0 to 9999999999999999.99
Shipment data container.
shipment data is only
guaranteed to be returned
for Ground Freight Pricing
shipments only.
Page 202
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
N/A
Validation Rules
Shipment Only
Type
container
MonetaryValue
/ShipmentResponse/ShipmentResults/Negoti
atedRateCharges/TotalCharge/MonetaryValu
e
N/A
container
atedRateCharges/TotalCharge/CurrencyCode
Description
3
CurrencyCode
string
Max Allowed
atedRateCharges/TotalCharge
One
One
TotalCharge
One
atedRateCharges
Required
NegotiatedRateCharges
No
XPath
Yes
Name
7/09/2012
No
Gross Charges container. It
indicates the shipment level
gross Ground Freight Pricing
transportation charges.
1..19
N/A
Container
One
Yes
Yes
DiscountAmount
ipmentData/TransportationCharges/DiscountA
mount
Gross charges currency
code
Gross charges monetary
0 to 9999999999999999.99
Discount Amount container.
It indicates the shipment
level Ground Freight Pricing
discount amount for
Page 203
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
N/A
Validation Rules
Shipment Only
Type
Container
String
MonetaryValue
ipmentData/TransportationCharges/GrossCha
rge/MonetaryValue
N/A
CurrencyCode
rge/CurrencyCode
String
Container
GrossCharge
rge
Description
container. Ground Freight
Pricing transportation
charges. These are only
returned for Ground Freight
Pricing enabled shipper
account number when the
user includes the
FRSShipmentIndicator in the
request.
3
ipmentData/TransportationCharges
One
Max Allowed
One
One
XPath
Yes
One
Name
Yes
Required
7/09/2012
Cond
1..19
Discount amount monetary
0 to 9999999999999999.99
1..5
level discount percentage for
1..19
Yes
Yes
Yes
Discount Amount currency
code.
Net Charges container. It
net Ground Freight Pricing
Net Charge currency code.
Net charges monetary value.
9999999999999999.99
Page 204
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
N/A
MonetaryValue
ipmentData/TransportationCharges/NetCharg
e/MonetaryValue
Validation Rules
Shipment Only
N/A
String
Length
Container
CurrencyCode
e/CurrencyCode
String
Type
String
NetCharge
e
Description
3
One
String
DiscountPercentage
ipmentData/TransportationCharges/DiscountP
ercentage
One
String
MonetaryValue
mount/MonetaryValue
One
Max Allowed
CurrencyCode
mount/CurrencyCode
One
One
XPath
Yes
One
Name
Yes
Required
7/09/2012
Yes
Description
/ShipmentResponse/ShipmentResults/Billing
Weight/UnitOfMeasurement/Description
Billing weight unit of
measurement code. The
unit of measurement used in
Shipment request is
returned.
string
string
1...35
One
One
Description of the billing
string
Billing weight. Higher of the
actual shipment weight
versus the shipment
dimensional weight.
string
ntIdentificationNumber
One
ShipmentIdentificationNumber
Yes
18
One
Weight/Weight
Weight
Yes
8
Yes
No
Code of the billing weight
measurement units. Values
are: KGS or LBS.
Returned UPS shipment ID
number.1Z Number of the
first package in the
shipment.
Page 205
Partial IV
EEI
Invoice
Nafta CO
CO
Length
N/A
Billing Weight container.
Return Only
Type
container
Validation Rules
Shipment Only
Max Allowed
N/A
Code
Weight/UnitOfMeasurement/Code
container
Weight/UnitOfMeasurement
Description
3
UnitOfMeasurement
One
Weight
One
BillingWeight
Required
XPath
Yes
Name
7/09/2012
Yes
Encoded shipment
Applicable only for
ShipConfirmResponse.
Returned Package
Information. Applicable only
for ShipmentResponse and
ShipAcceptResponse.
string
N/A
Container
3
string
One
One
CurrencyCode
/ShipmentResponse/ShipmentResults/Packag
eResults/ServiceOptionsCharges/CurrencyCo
de
One
eResults/ServiceOptionsCharges
Yes
Cond
eResults/TrackingNumber
Yes
TrackingNumber
Package 1Z number.
Applicable only for
ShipmentResponse and
ShipAcceptResponse.
Shipment charges info.
Shipment charges are only
for shipments whose origin
country is US or Puerto
Rico. Applicable only for
ShipAcceptResponse.
Package accessorial
charges currency code type.
The currency code used in
the Shipment request is
returned. Applicable only for
ShipAcceptResponse.
Page 206
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
unbounded
Validation Rules
Shipment Only
Type
string
N/A
Max Allowed
Description
18
eResults
No
PackageResults
container
ntDigest
##
ShipmentDigest
One
XPath
Cond
Name
7/09/2012
Required
One
string
One
string
1...35
Yes
No
The container image format.
Applicable only for
ShipAcceptResponse.
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
ShipAcceptResponse.
image format code.
Applicable only for
ShipAcceptResponse.
Page 207
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Package accessorial
charges value amount. Valid
values are from 0 to
99999999999999.99Applica
ble only for
ShipAcceptResponse.
The container for UPS
shipping label. Shipment
with PRL return service.
Applicable only for
ShipAcceptResponse.
Shipment Only
Length
1...19
Type
string
N/A
Max Allowed
container
Description
eResults/ShippingLabel/ImageFormat/Descrip
tion
N/A
eResults/ShippingLabel/ImageFormat/Code
container
Code
3
eResults/ShippingLabel/ImageFormat
One
ImageFormat
One
eResults/ShippingLabel
One
ShippingLabel
Yes
MonetaryValue
eResults/ServiceOptionsCharges/MonetaryVa
lue
Cond
XPath
Yes
Name
7/09/2012
Required
Base 64 encoded graphic
image. Applicable only for
ShipAcceptResponse.
image of the Warsaw text
and signature box.EPL2,
ZPL and SPL labels. The
image will be returned for
non-US based shipments.
One image will be given per
shipment and it will be in the
first PackageResults
container. Applicable only for
ShipAcceptResponse.
Base 64 encoded html
browser image rendering
software. This is only
returned for gif and png
image formats. Applicable
only for ShipmentResponse
and ShipAcceptResponse.
Page 208
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Length
unbounded
Description
Shipment Only
Type
Base 64 Encoded
unbounded
unbounded
Base 64 Encoded
Max Allowed
One
Base 64 Encoded
eResults/ShippingLabel/HTMLImage
One
HTMLImage
eResults/ShippingLabel/InternationalSignatur
eGraphicImage
One
InternationalSignatureGraphicIma
ge
eResults/ShippingLabel/GraphicImage
Yes
GraphicImage
Cond
XPath
Cond
Name
7/09/2012
Required
PDF-417 is a twodimensional 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
returned if the
LabelImageFormat code is
GIF. Shipment with PRL
return service only.
Applicable only for
ShipAcceptResponse.
Container for the receipt of a
return shipment. Not
supported for ERL or PRL
shipments. Applicable only
ShipAcceptResponse.
Container for a Image
Format. Applicable only for
ShipAcceptResponse.
string
One
eResults/ShippingReceipt/ImageFormat/Code
Yes
Code
Code representing the
format in which a receipt.
Valid values: HTML = HTML
format. Applicable only for
ShipAcceptResponse.
Page 209
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Base 64 Encoded
unbounded
N/A
container
container
N/A
Max Allowed
One
Description
4
eResults/ShippingReceipt/ImageFormat
One
ImageFormat
eResults/ShippingReceipt
One
ShippingReceipt
Cond
eResults/ShippingLabel/PDF417
PDF417
Cond
XPath
Yes
Name
7/09/2012
Required
Page 210
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
Length
1...35
unbounded
Type
string
Base 64 Encoded
unbounded
Max Allowed
string
No
N/A
/ShipmentResponse/ShipmentResults/Control
LogReceipt
USPSPICNumber is USPS
Package Identification code
which is returned at package
level for UPS Returns
Flexible Access Shipments.
Container for the High Value
reports When forward
shipments declared value
between $999 and $50,000
USD. Two copies of high
value report needs to be
pointed out. Applicable only
ShipAcceptResponse.
container
ControlLogReceipt
One
eResults/USPSPICNumber
One
USPSPICNumber
Validation Rules
Base 64 encoded PRL
receipt in HTML format.
Applicable only for
ShipAcceptResponse.
One
eResults/ShippingReceipt/GraphicImage
Description
Description of the image
format code. Applicable only
ShipAcceptResponse.
One
GraphicImage
Yes
Description
eResults/ShippingReceipt/ImageFormat/Desc
ription
Cond
XPath
Cond
Name
7/09/2012
Required
1..35
unbounded
string
string
Base 64 Encoded
N/A
One
Yes
container
/ShipmentResponse/ShipmentResults/Form
One
Form
One
LogReceipt/GraphicImage
One
GraphicImage
No
LogReceipt/ImageFormat/Description
Yes
Description
Cond
LogReceipt/ImageFormat/Code
Code
report format, required if
parent exist. Applicable only
ShipAcceptResponse.
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
ShipAcceptResponse.
Description of the format
code. Applicable only for
ShipAcceptResponse.
Base 64 encoded html,
EPL2, ZPL or SPL image.
Applicable only for
ShipAcceptResponse.
International forms image.
Applicable only for
ShipAcceptResponse.
Page 211
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Type
Max Allowed
Length
N/A
container
LogReceipt/ImageFormat
4
ImageFormat
One
XPath
Yes
Name
7/09/2012
Required
string
N/A
1...35
container
string
One
One
Yes
N/A
/ShipmentResponse/ShipmentResults/Form/I
mage/ImageFormat
container
ImageFormat
One
mage
One
Image
Yes
/ShipmentResponse/ShipmentResults/Form/D
escription
Cond
Description
Cond
/ShipmentResponse/ShipmentResults/Form/C
ode
Code
Code that indicates the type
of form. Possible Values01 All Requested International
Forms. Applicable only for
ShipAcceptResponse.
Description that indicates the
type of form. Possible
Values. All Requested
International Forms.
Applicable only for
ShipAcceptResponse.
Applicable only for
ShipAcceptResponse.
International forms image
format information.
Applicable only for
ShipAcceptResponse.
Page 212
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
2
XPath
Max Allowed
Name
7/09/2012
Required
1..35
unbounded
string
string
Base 64 Encoded
One
One
Cond
No
One
1...26
/ShipmentResponse/ShipmentResults/Form/F
ormGroupId
string
FormGroupId
mage/GraphicImage
One
GraphicImage
mage/ImageFormat/Description
Cond
Description
Cond
mage/ImageFormat/Code
Code
format in which the forms
are generated. Possible
Values: PDF = pdfOnly.
PDF is supported currently.
Applicable only for
ShipAcceptResponse.
Description of the form
image format code.
Applicable only for
ShipAcceptResponse.
Base 64 encoded
Applicable only for
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
ShipAcceptResponse.
Page 213
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
3
XPath
Max Allowed
Name
7/09/2012
Required
/ShipmentResponse/ShipmentResults/CODTu
rnInPage/Image/ImageFormat
element is part of both
request and response. This
the forms. Applicable only
ShipAcceptResponse.
The container of the COD
Turn In Page. Applicable
The container of the image
for COD Turn In Page.
Applicable only for
ShipAcceptResponse.
The container for format of
COD Turn In Page.
Applicable only for
ShipAcceptResponse.
Page 214
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Type
Length
1...50
string
N/A
container
Max Allowed
One
No
One
container
N/A
N/A
ImageFormat
container
rnInPage/Image
Image
One
rnInPage
One
CODTurnInPage
/ShipmentResponse/ShipmentResults/Form/F
ormGroupIdName
No
FormGroupIdName
Yes
XPath
Yes
Name
7/09/2012
Required
Format code of the
generated COD Turn In
Page. Valid values: HTML =
HTML format. Only HTML
format is supported for COD
code of generated COD
Turn In page. Applicable
software. Applicable only for
ShipAcceptResponse.
Container for the HighValue
Report generated for
ImportControl or Return
shipments with high package
declared value. Applicable
for one pass
ShipmentResponse and twopass ShipAcceptResponse.
Report image for Import
Control Shipments.
Page 215
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
1...35
String
String
unbounded
N/A
Container
Base 64 Encoded
One
One
No
One
N/A
Image
/ShipmentResponse/ShipmentResults/HighVa
lueReport/Image
Container
lueReport
One
HighValueReport
One
rnInPage/Image/GraphicImage
Yes
GraphicImage
rnInPage/Image/ImageFormat/Description
Cond
Description
Yes*
rnInPage/Image/ImageFormat/Code
Code
Yes
4
XPath
Max Allowed
Name
7/09/2012
Required
Report image format
information for Import
Control Shipments.
One
String
One
String
1...35
String
unbounded
unbounded
/ShipmentResponse/ShipmentResults/LabelU
RL
String
LabelURL
One
lueReport/Image/GraphicImage
One
GraphicImage
Yes*
lueReport/Image/ImageFormat/Description
No
Description
Yes*
lueReport/Image/ImageFormat/Code
Cond
Code
format in which the
HighValueReport is
generated. Possible Values:
PDF = 'pdf'
format
Base 64 Encoded PDF
Image
LabelURL 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
HighValueReport,
CustomsInvoice and
ImportControl instructions.
Page 216
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
N/A
Container
Description
3
lueReport/Image/ImageFormat
Max Allowed
ImageFormat
One
XPath
Yes*
Name
7/09/2012
Required
LocalLanguageLabelURL is
returned only if the
LabelLinksIndicator is
requested for an
also point to
HighValueReport,
CustomsInvoice and
ImportControl instructions in
the Country's local language
if supported by UPS.
ReceiptURL is returned if the
requested for an
ImportControl shipment or a
Return shipment.
LocalLanguageReceiptURL
is returned if the
requested for an
Return shipment. The URL
will contain the receipt in the
Country's local language if
supported by UPS.
Shipment Response
Container
Response Container.
Page 217
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
unbounded
Type
String
unbounded
unbounded
String
String
Max Allowed
One
One
Cond
N/A
/ShipConfirmResponse/Response
container
Response
N/A
/ShipConfirmResponse
container
ShipConfirmResponse
One
/ShipmentResponse/ShipmentResults/LocalL
anguageReceiptURL
One
One
/ShipmentResponse/ShipmentResults/Receipt
URL
Cond
ReceiptURL
/ShipmentResponse/ShipmentResults/LocalL
anguageLabelURL
Cond
LocalLanguageLabelURL
Yes
XPath
Yes
Name
7/09/2012
Required
string
N/A
1...10
1...150
N/A
1...35
string
container
string
string
container
One
One
Yes
Yes
One
/ShipConfirmResponse/Response/Transactio
nReference
One
One
/ShipConfirmResponse/Response/Alert/Descri
ption
One
Description
No
/ShipConfirmResponse/Response/Alert/Code
Yes*
Code
Yes*
/ShipConfirmResponse/Response/Alert
Success.
No
Alert
Successful
description.
the system.
by the system.
Container.
Page 218
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
Validation Rules
Shipment Only
Type
N/A
Description
/ShipConfirmResponse/Response/ResponseS
tatus/Description
container
Code
tatus/Code
Description
1
tatus
Max Allowed
ResponseStatus
One
XPath
Required
Name
7/09/2012
Yes
/ShipConfirmResponse/ShipmentResults/Ship
mentCharges/TransportationCharges
The CustomerContext
Refer to the
Shipment charges
Container. Shipment
or Puerto Rico.
String
N/A
container
One
Transport Charges
container.
Page 219
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
1...512
Validation Rules
Shipment Only
Type
string
N/A
container
Max Allowed
One
One
N/A
mentCharges/RateChart
container
RateChart
One
mentCharges
Description
1
ShipmentCharges
No
/ShipConfirmResponse/ShipmentResults
Yes
ShipmentResults
No
CustomerContext
/ShipConfirmResponse/Response/Transactio
nReference/CustomerContext
Yes
XPath
Cond
Name
7/09/2012
Required
1...19
string
string
N/A
container.
1...19
N/A
string
string
container
One
One
mentCharges/TotalCharges
One
TotalCharges
Yes
MonetaryValue
mentCharges/ServiceOptionsCharges/Moneta
ryValue
Accessorial charges
Shipment request is
returned.
Yes
CurrencyCode
mentCharges/ServiceOptionsCharges/Curren
cyCode
Yes
3
container
One
One
Transportation and
99999999999999.99
One
mentCharges/ServiceOptionsCharges
Yes
Yes
MonetaryValue
mentCharges/TransportationCharges/Monetar
yValue
Yes
CurrencyCode
mentCharges/TransportationCharges/Currenc
yCode
Shipment request is
returned.
from 0 to
99999999999999.99
Page 220
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
3
XPath
Max Allowed
Name
7/09/2012
Required
string
string
1...19
container
N/A
One
container
CurrencyCode
/ShipConfirmResponse/ShipmentResults/Neg
otiatedRateCharges/TotalCharge/CurrencyCo
de
string
MonetaryValue
otiatedRateCharges/TotalCharge/MonetaryVa
lue
N/A
otiatedRateCharges/TotalCharge
includes the
the request.
code.
1..19
string
One
Yes
3
TotalCharge
One
One
One
One
Container.
Yes
otiatedRateCharges
Yes
99999999999999.99
No
MonetaryValue
mentCharges/TotalCharges/MonetaryValue
No
mentCharges/TotalCharges/CurrencyCode
Yes
CurrencyCode
0 to 9999999999999999.99
Page 221
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
3
XPath
Max Allowed
Name
7/09/2012
Required
String
String
shipments only.
user includes the
request.
code
1..19
Yes
3
gross FRS transportation
charges.
0 to 9999999999999999.99
Page 222
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
N/A
Type
Container
One
MonetaryValue
/ShipConfirmResponse/ShipmentResults/FRS
ShipmentData/TransportationCharges/GrossC
harge/MonetaryValue
One
Container
Container
One
CurrencyCode
harge/CurrencyCode
N/A
One
GrossCharge
harge
N/A
Max Allowed
ShipmentData/TransportationCharges
Cond
Yes
ShipmentData
Yes
FRSShipmentData
One
XPath
Cond
Name
7/09/2012
Required
String
One
String
NetCharge
ShipmentData/TransportationCharges/NetCha
rge
One
Container
N/A
CurrencyCode
rge/CurrencyCode
One
String
N/A
MonetaryValue
rge/MonetaryValue
String
1..19
0 to 9999999999999999.99
1..5
code.
1..19
Yes
Yes
Yes
3
discount amount for
9999999999999999.99
Page 223
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Container
String
One
DiscountPercentage
ShipmentData/TransportationCharges/Discou
ntPercentage
One
Type
One
One
MonetaryValue
ntAmount/MonetaryValue
N/A
Yes
CurrencyCode
ntAmount/CurrencyCode
Yes
Max Allowed
DiscountAmount
ntAmount
Yes
XPath
Yes
Name
7/09/2012
Required
Description
/ShipConfirmResponse/ShipmentResults/Billin
gWeight/UnitOfMeasurement/Description
Shipment request is
returned.
string
string
1...35
One
One
string
versus the shipment
dimensional weight. Set to 0
for package type of letters or
envelopes.
string
mentIdentificationNumber
One
Yes
18
One
gWeight/Weight
Weight
Yes
8
Yes
No
are: KGS or LBS.
number. 1Z Number of the
shipment.
Page 224
Partial IV
EEI
Invoice
Nafta CO
CO
Length
N/A
Return Only
Type
container
Validation Rules
Shipment Only
Max Allowed
N/A
Code
gWeight/UnitOfMeasurement/Code
container
gWeight/UnitOfMeasurement
Description
3
UnitOfMeasurement
One
gWeight
One
BillingWeight
Required
XPath
Yes
Name
7/09/2012
Yes
Encoded shipment
Applicable only for
Returned Package
for ShipConfirmResponse
string
N/A
3
Container
One
Yes
string
CurrencyCode
/ShipConfirmResponse/ShipmentResults/Pac
kageResults/ServiceOptionsCharges/Currenc
yCode
One
kageResults/ServiceOptionsCharges
One
Cond
kageResults/TrackingNumber
Yes
TrackingNumber
Package 1Z number.
Applicable only for
ShipConfirmResponse and
ShipAcceptResponse.
ShipAcceptResponse.
Package accessorial
ShipAcceptResponse.
Page 225
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
unbounded
Validation Rules
Shipment Only
Type
string
N/A
Max Allowed
Description
18
kageResults
No
PackageResults
container
mentDigest
##
ShipmentDigest
One
XPath
Cond
Name
7/09/2012
Required
string
1...35
string
One
No
Description
kageResults/ShippingLabel/ImageFormat/Des
cription
Applicable only for
ShipAcceptResponse.
Applicable only for
ShipAcceptResponse.
image format code.
Applicable only for
ShipAcceptResponse.
Page 226
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Package accessorial
99999999999999.99Applica
ble only for
ShipAcceptResponse.
Return Only
Description
Shipment Only
Type
Length
1...19
Max Allowed
One
Yes
string
container
N/A
N/A
Code
kageResults/ShippingLabel/ImageFormat/Cod
e
3
kageResults/ShippingLabel/ImageFormat
One
ImageFormat
One
contai
ner
kageResults/ShippingLabel
One
ShippingLabel
Cond
MonetaryValue
kageResults/ServiceOptionsCharges/Monetar
yValue
Yes
XPath
Yes
Name
7/09/2012
Required
ShipAcceptResponse.
and signature box. EPL2,
ShipAcceptResponse.
only for
ShipAcceptResponse.
Page 227
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Length
unbounded
Description
Shipment Only
Type
Base 64 Encoded
unbounded
Base 64 Encoded
Max Allowed
One
One
unbounded
kageResults/ShippingLabel/HTMLImage
Base 64 Encoded
HTMLImage
kageResults/ShippingLabel/InternationalSigna
tureGraphicImage
One
ge
kageResults/ShippingLabel/GraphicImage
Yes
GraphicImage
Cond
XPath
Cond
Name
7/09/2012
Required
ShipAcceptResponse.
string
One
Yes
Code
kageResults/ShippingReceipt/ImageFormat/C
ode
ShipAcceptResponse.
Page 228
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
unbounded
Validation Rules
Shipment Only
Type
Base 64 Encoded
N/A
N/A
container
Max Allowed
One
container
kageResults/ShippingReceipt/ImageFormat
Description
Base 64 encoded and
returned if the
Applicable only for
ShipAcceptResponse.
4
ImageFormat
kageResults/ShippingReceipt
One
ShippingReceipt
One
kageResults/ShippingLabel/PDF417
Required
PDF417
Cond
XPath
Yes
Name
7/09/2012
Cond
Base 64 encoded PRL
Applicable only for
ShipAcceptResponse.
String
container
One
Cond
N/A
N/A
container
/ShipConfirmResponse/ShipmentResults/Cont
rolLogReceipt/ImageFormat
One
ImageFormat
rolLogReceipt
Yes
ControlLogReceipt
parent exist Applicable only
Page 229
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
Length
1...35
Type
string
Max Allowed
unbounded
kageResults/USPSPICNumber
Base 64 Encoded
USPSPICNumber
One
kageResults/ShippingReceipt/GraphicImage
Validation Rules
1
GraphicImage
Description
One
No
Description
kageResults/ShippingReceipt/ImageFormat/D
escription
Yes
XPath
No
Name
7/09/2012
Required
Applicable only for
ShipAcceptResponse.
Page 230
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
Length
Type
1..35
unbounded
string
string
Base 64 Encoded
One
One
No
One
N/A
/ShipConfirmResponse/ShipmentResults/For
m
Validation Rules
Report. Values are: EPL =
Applicable only for
ShipAcceptResponse.
Applicable only for
ShipAcceptResponse.
container
Form
rolLogReceipt/GraphicImage
Description
ShipAcceptResponse.
One
GraphicImage
rolLogReceipt/ImageFormat/Description
Yes
Description
Cond
rolLogReceipt/ImageFormat/Code
Code
Yes
4
XPath
Max Allowed
Name
7/09/2012
Required
string
One
m/Image/ImageFormat/Code
Cond
Code
ShipAcceptResponse.
Values: All Requested
Applicable only for
ShipAcceptResponse.
Applicable only for
ShipAcceptResponse.
format information.
Applicable only for
ShipAcceptResponse.
Applicable only for
ShipAcceptResponse.
Page 231
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
string
1...35
string
container
One
One
One
N/A
N/A
container
m/Image/ImageFormat
3
ImageFormat
One
m/Image
Image
Yes
m/Description
Cond
Description
Cond
m/Code
Code
Yes
2
XPath
Max Allowed
Name
7/09/2012
Required
CODTurnInPage
/ShipConfirmResponse/ShipmentResults/CO
DTurnInPage
image format code.
Applicable only for
ShipAcceptResponse.
Base 64 encoded
Applicable only for
ShipAcceptResponse.
when code = 0101
ShipAcceptResponse.
only for
ShipAcceptResponse.
Page 232
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
1..35
Type
string
1...26
1...50
unbounded
string
string
Base 64 Encoded
Max Allowed
One
No
One
N/A
m/FormGroupIdName
container
FormGroupIdName
One
m/FormGroupId
One
FormGroupId
One
m/Image/GraphicImage
Cond
GraphicImage
m/Image/ImageFormat/Description
Cond
Description
No
XPath
No
Name
7/09/2012
Required
One
DTurnInPage/Image/ImageFormat/Description
One
String
1...35
One
Base 64 Encoded
unbounded
GraphicImage
DTurnInPage/Image/GraphicImage
COD Turn In Page.
Applicable only for
ShipAcceptResponse.
Format code of the
only for
ShipAcceptResponse.
only for
ShipAcceptResponse.
ShipAcceptResponse.
Page 233
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Length
N/A
Yes
Description
No
String
DTurnInPage/Image/ImageFormat/Code
Yes
Code
Description
Applicable only for
ShipAcceptResponse.
Shipment Only
Type
container
N/A
Max Allowed
container
DTurnInPage/Image/ImageFormat
4
ImageFormat
One
DTurnInPage/Image
One
Image
Required
XPath
Yes
Name
7/09/2012
Yes
Control Shipments.
Report image format
Control Shipments or return
Shipments.
One
String
String
1...35
String
unbounded
/ShipConfirmResponse/ShipmentResults/High
ValueReport/Image/GraphicImage
One
GraphicImage
One
ValueReport/Image/ImageFormat/Description
Yes*
Description
No
ValueReport/Image/ImageFormat/Code
Yes*
Code
format in which the
HighValueReport is
generated.|Possible Values:
PDF = “pdf”
format
Base 64 Encoded PDF
Image
Page 234
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
N/A
Validation Rules
Shipment Only
Type
Container
Container
N/A
N/A
Max Allowed
One
Container
ValueReport/Image/ImageFormat
Description
declared value. Applicable
for one pass
3
ImageFormat
One
Image
ValueReport/Image
One
ValueReport
Required
HighValueReport
Yes*
XPath
Yes*
Name
7/09/2012
Cond
String
No
1
/ShipConfirmResponse/ShipmentResults/Rec
eiptURL
/ShipConfirmResponse/ShipmentResults/Loc
alLanguageReceiptURL
ShipAcceptResponse
/ShipAcceptResponse
Response
/ShipAcceptResponse/Response
String
ReceiptURL
String
String
1
No
Yes
One
container
N/A
Yes
One
container
N/A
No
Shipment Response
Container
Response Container.
Page 235
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
requested for an
also point to
HighValueReport
Receipt URL is returned if
requested for an
Return shipment.
is returned if the
requested for an
supported by UPS.
1
/ShipConfirmResponse/ShipmentResults/Loc
alLanguageLabelURL
No
Description
requested for an
also point to
HighValueReport
Shipment Only
Length
/ShipConfirmResponse/ShipmentResults/Lab
elURL
Type
LabelURL
Max Allowed
XPath
1
Name
7/09/2012
Required
string
N/A
1...10
1...150
N/A
1...35
string
container
string
string
container
One
One
Yes
Yes
One
/ShipAcceptResponse/Response/Transaction
Reference
One
One
/ShipAcceptResponse/Response/Alert/Descri
ption
One
Description
No
/ShipAcceptResponse/Response/Alert/Code
Yes*
Code
Yes*
/ShipAcceptResponse/Response/Alert
"Success".
No
Alert
Successful
description.
the system.
by the system.
Container.
Page 236
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
Validation Rules
Shipment Only
Type
N/A
Description
/ShipAcceptResponse/Response/ResponseSt
atus/Description
container
Code
atus/Code
Description
1
atus
Max Allowed
ResponseStatus
One
XPath
Required
Name
7/09/2012
Yes
/ShipAcceptResponse/ShipmentResults/Ship
mentCharges/TransportationCharges
The CustomerContext
Refer to the
Shipment charges
Container. Shipment
or Puerto Rico.
String
N/A
container
One
Transport Charges
container.
Page 237
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Length
1...512
Validation Rules
Shipment Only
Type
string
N/A
container
Max Allowed
One
One
N/A
mentCharges/RateChart
container
RateChart
One
mentCharges
Description
1
ShipmentCharges
No
/ShipAcceptResponse/ShipmentResults
Yes
ShipmentResults
No
CustomerContext
/ShipAcceptResponse/Response/Transaction
Reference/CustomerContext
Yes
XPath
Cond
Name
7/09/2012
Required
1...19
string
string
N/A
container.
1...19
N/A
string
string
container
One
One
mentCharges/TotalCharges
One
TotalCharges
Yes
MonetaryValue
mentCharges/ServiceOptionsCharges/Moneta
ryValue
Accessorial charges
Shipment request is
returned.
Yes
CurrencyCode
mentCharges/ServiceOptionsCharges/Curren
cyCode
Yes
3
container
One
One
Transportation and
99999999999999.99
One
mentCharges/ServiceOptionsCharges
Yes
Yes
MonetaryValue
mentCharges/TransportationCharges/Monetar
yValue
Yes
CurrencyCode
mentCharges/TransportationCharges/Currenc
yCode
Shipment request is
returned.
from 0 to
99999999999999.99
Page 238
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
3
XPath
Max Allowed
Name
7/09/2012
Required
string
string
1...19
container
N/A
One
container
CurrencyCode
/ShipAcceptResponse/ShipmentResults/Nego
tiatedRateCharges/TotalCharge/CurrencyCod
e
string
MonetaryValue
tiatedRateCharges/TotalCharge/MonetaryVal
ue
N/A
tiatedRateCharges/TotalCharge
includes the
the request.
code.
1..19
string
One
Yes
3
TotalCharge
One
One
One
One
Container.
Yes
tiatedRateCharges
Yes
99999999999999.99
No
MonetaryValue
mentCharges/TotalCharges/MonetaryValue
No
mentCharges/TotalCharges/CurrencyCode
Yes
CurrencyCode
0 to 9999999999999999.99
Page 239
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
3
XPath
Max Allowed
Name
7/09/2012
Required
String
String
shipments only.
user includes the
request.
code
1..19
Yes
3
gross Ground Freight Pricing
0 to 9999999999999999.99
Page 240
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
N/A
Type
Container
One
MonetaryValue
/ShipAcceptResponse/ShipmentResults/FRS
harge/MonetaryValue
One
Container
Container
One
CurrencyCode
harge/CurrencyCode
N/A
One
GrossCharge
harge
N/A
Max Allowed
ShipmentData/TransportationCharges
Cond
Yes
ShipmentData
Yes
FRSShipmentData
One
XPath
Cond
Name
7/09/2012
Required
String
One
String
NetCharge
rge
One
Container
N/A
CurrencyCode
rge/CurrencyCode
String
N/A
1..19
code.
0 to 9999999999999999.99
1..5
Yes
Yes
3
discount amount for
Page 241
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Container
String
One
DiscountPercentage
ntPercentage
One
Type
One
One
MonetaryValue
ntAmount/MonetaryValue
N/A
Yes
CurrencyCode
ntAmount/CurrencyCode
Yes
Max Allowed
DiscountAmount
ntAmount
Yes
XPath
Yes
Name
7/09/2012
Required
Description
/ShipAcceptResponse/ShipmentResults/Billin
gWeight/UnitOfMeasurement/Description
9999999999999999.99
Shipment request is
returned.
string
string
1...35
One
One
string
gWeight/Weight
One
Weight
Yes
8
Yes
No
are: KGS or LBS.
versus the shipment
dimensional weight. Set to 0
for package type of letters or
envelopes.
Page 242
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
1..19
N/A
Validation Rules
Shipment Only
Type
String
container
Length
Max Allowed
One
N/A
Code
gWeight/UnitOfMeasurement/Code
container
gWeight/UnitOfMeasurement
Description
3
UnitOfMeasurement
One
gWeight
One
BillingWeight
Required
MonetaryValue
rge/MonetaryValue
Yes
XPath
Yes
Name
7/09/2012
Yes
string
string
unbounded
N/A
Encoded shipment
Applicable only for
Returned Package
ShipAcceptResponse.
string
One
Package 1Z number.
Applicable only for
ShipAcceptResponse.
N/A
Container
/ShipAcceptResponse/ShipmentResults/Pack
ageResults/ServiceOptionsCharges
One
ageResults/TrackingNumber
Cond
TrackingNumber
Yes
18
ageResults
No
PackageResults
container
Yes
One
One
mentDigest
##
ShipmentDigest
Cond
number. 1Z Number of the
shipment.
ShipAcceptResponse.
Page 243
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
18
XPath
Max Allowed
Name
7/09/2012
Required
string
1...19
string
N/A
container
string
ageResults/ShippingLabel/ImageFormat/Code
One
Code
Yes
3
N/A
One
One
One
ageResults/ShippingLabel/ImageFormat
One
contai
ner
ImageFormat
Yes
ageResults/ShippingLabel
Yes
ShippingLabel
Cond
MonetaryValue
ageResults/ServiceOptionsCharges/Monetary
Value
Yes
CurrencyCode
ageResults/ServiceOptionsCharges/Currency
Code
Package accessorial
ShipAcceptResponse.
Package accessorial
99999999999999.99Applica
ble only for
ShipAcceptResponse.
Applicable only for
ShipAcceptResponse.
Applicable only for
ShipAcceptResponse.
ShipAcceptResponse.
Page 244
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Description
3
XPath
Max Allowed
Name
7/09/2012
Required
image format code.
Applicable only for
ShipAcceptResponse.
ShipAcceptResponse.
and signature box. EPL2,
ShipAcceptResponse.
Page 245
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
1...35
Type
string
unbounded
unbounded
Base 64 Encoded
Base 64 Encoded
Max Allowed
One
No
One
unbounded
ageResults/ShippingLabel/HTMLImage
Base 64 Encoded
HTMLImage
ageResults/ShippingLabel/InternationalSignat
ureGraphicImage
One
ge
ageResults/ShippingLabel/GraphicImage
One
GraphicImage
Yes
Description
ageResults/ShippingLabel/ImageFormat/Desc
ription
Cond
XPath
Cond
Name
7/09/2012
Required
Base 64 encoded and
returned if the
Applicable only for
ShipAcceptResponse.
ShipAcceptResponse.
ShipAcceptResponse.
string
1...35
string
One
One
Yes
Description
ageResults/ShippingReceipt/ImageFormat/De
scription
No
Code
ageResults/ShippingReceipt/ImageFormat/Co
de
ShipAcceptResponse.
ShipAcceptResponse.
Page 246
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Length
Type
Base 64 Encoded
unbounded
N/A
container
container
N/A
Max Allowed
One
Description
4
ageResults/ShippingReceipt/ImageFormat
One
ImageFormat
ageResults/ShippingReceipt
One
ShippingReceipt
Cond
ageResults/ShippingLabel/PDF417
PDF417
Cond
XPath
Yes
Name
7/09/2012
Required
ShipAcceptResponse.
parent exist Applicable only
ShipAcceptResponse.
Page 247
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Length
unbounded
unbounded
Description
Shipment Only
Type
Base 64 Encoded
string
N/A
container
Max Allowed
One
Yes
One
N/A
/ShipAcceptResponse/ShipmentResults/Contr
olLogReceipt/ImageFormat
container
ImageFormat
olLogReceipt
USPSPICNumber is USPS
Package Identification code
which is returned at package
level for UPS Returns
Flexible Access Shipments.
One
ControlLogReceipt
ageResults/USPSPICNumber
Base 64 encoded PRL
Applicable only for
ShipAcceptResponse.
One
USPSPICNumber
ageResults/ShippingReceipt/GraphicImage
Cond
GraphicImage
Cond
XPath
Yes
Name
7/09/2012
Required
1..35
unbounded
Applicable only for
ShipAcceptResponse.
string
One
/ShipAcceptResponse/ShipmentResults/Form
/Code
Yes
Code
ShipAcceptResponse.
Page 248
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Shipment Only
Length
Type
string
Base 64 Encoded
N/A
container
One
One
Applicable only for
ShipAcceptResponse.
Validation Rules
2
Description
Report. Values are: EPL =
Applicable only for
ShipAcceptResponse.
ShipAcceptResponse.
One
Form
olLogReceipt/GraphicImage
Yes
GraphicImage
olLogReceipt/ImageFormat/Description
Cond
Description
No
4
string
olLogReceipt/ImageFormat/Code
Max Allowed
Code
One
XPath
Required
Name
7/09/2012
Yes
1..35
string
One
/Image/ImageFormat/Description
No
Description
Values: All Requested
Applicable only for
ShipAcceptResponse.
Applicable only for
ShipAcceptResponse.
format information.
Applicable only for
ShipAcceptResponse.
Applicable only for
ShipAcceptResponse.
image format code.
Applicable only for
ShipAcceptResponse.
Page 249
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Type
Length
1...35
string
container
N/A
N/A
Max Allowed
One
One
container
/Image/ImageFormat/Code
3
Code
string
/Image/ImageFormat
One
ImageFormat
One
/Image
Image
Yes
/Description
Cond
Description
Cond
XPath
Cond
Name
7/09/2012
Required
Base 64 encoded
Applicable only for
ShipAcceptResponse.
when code = 0101
ShipAcceptResponse.
ShipAcceptResponse.
Applicable only for
ShipAcceptResponse.
Page 250
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Length
unbounded
Description
Shipment Only
Type
Base 64 Encoded
1...26
1...50
string
N/A
container
string
Max Allowed
One
One
Cond
One
N/A
/ShipAcceptResponse/ShipmentResults/COD
TurnInPage/Image
container
Image
TurnInPage
One
CODTurnInPage
/FormGroupIdName
One
FormGroupIdName
/FormGroupId
Cond
FormGroupId
/Image/GraphicImage
No
GraphicImage
No
XPath
Yes
Name
7/09/2012
Required
COD Turn In Page.
Applicable only for
ShipAcceptResponse.
1...35
unbounded
String
String
Base 64 Encoded
Yes
One
One
One
TurnInPage/Image/GraphicImage
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/High
ValueReport
Container
HighValueReport
No
1
GraphicImage
TurnInPage/Image/ImageFormat/Description
No
Description
Yes
TurnInPage/Image/ImageFormat/Code
Code
Format code of the
declared value.Applicable
for one pass
Page 251
Partial IV
EEI
Invoice
Nafta CO
CO
Return Only
Validation Rules
Shipment Only
Type
Max Allowed
Length
N/A
container
TurnInPage/Image/ImageFormat
Description
4
ImageFormat
One
XPath
Yes
Name
7/09/2012
Required
Report image format
Control Shipments or for
return shipments.
ValueReport/Image/ImageFormat/Code
Description
ValueReport/Image/ImageFormat/Description
No
GraphicImage
ValueReport/Image/GraphicImage
format in which the
HighValueReport is
generated.|Possible Values:
PDF = “pdf”
format
/ShipAcceptResponse/ShipmentResults/Label
URL
Container
String
LabelURL
No
1
String
1
String
1
Code
Yes
Yes
String
1
ValueReport/Image/ImageFormat
Yes
ImageFormat
Container
1
Yes
ValueReport/Image
Image
Control Shipments or for
return shipments.
Base 64 Encoded PDF
Image
requested for an
also point to
HighValueReport
Page 252
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
Max Allowed
XPath
1
Name
7/09/2012
Required
/ShipAcceptResponse/ShipmentResults/Local
LanguageReceiptURL
String
String
No
1
/ShipAcceptResponse/ShipmentResults/Recei
ptURL
No
ReceiptURL
String
1
/ShipAcceptResponse/ShipmentResults/Local
LanguageLabelURL
No
requested for an
also point to
HighValueReport
ReceiptURL is returned if the
requested for an
Return shipment.
is returned if the
requested for an
supported by UPS.
Page 253
Partial IV
EEI
Invoice
Nafta CO
CO
Validation Rules
Return Only
Description
Shipment Only
Length
Type
Max Allowed
XPath
1
Name
7/09/2012
Required
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.
Page 254
7/09/2012
LENGTH
N/A
1
N/A
Optional processing. No options
Not used. Left for future uses
TransactionReference identifies
transactions between
client and server.
The client uses CustomerContext
to synchronize Request /response
pairs. The client establishes
contain any information you want,
as along as it is valid XML; it is
echoed back by the server.
N/A
N/A
4
N/A
Request Container
The Unique Transaction Identifier
for a given transaction
1
1...512
VALIDATION RULES
The container for the Ship Void
Request
18
TYPE
Container
String
Container
String
String
Container
Stri
ng
String
DESCRIPTION
The shipments identification
number
N/A
Alpha-numeric. Must pass 1Z
rules. Must be
upper case.
18
MAX
ALLOWED
One
TrackingNumber
/VoidShipmentRequest/VoidShipment/Track
ingNumber
One
/VoidShipmentRequest/VoidShipment/Ship
One
One
/VoidShipmentRequest/VoidShipment
One
VoidShipment
One
TransactionIdentifier
/VoidShipmentRequest/Re
quest/TransactionReference/TransactionIde
ntifier
One
CustomerContext
quest/TransactionReference/CustomerCont
ext
One
REQUIRED
Yes
quest/TransactionReference
No
quest/RequestOption
No
RequestOption
No
quest
Yes
Request
Yes
XPATH
No
NAME
No
1.9.2 Void Web Services Schema
The package's identification
number
Alpha-numeric. Must pass 1Z
rules. Must be
upper case
Page 255
Empty Tag. Not used. Left for
future uses.
Yes
One
container
N/A
Response
/VoidShipmentResponse/Response
Yes
One
container
N/A
ResponseStatus
/VoidShipmentResponse/R
esponse/ResponseStatus
One
container
N/A
Code
/VoidShipmentResponse/Response/Respon
seStatus/Code
One
string
Description
/VoidShipmentResponse/Response/Respon
seStatus/Description
One
string
container
N/A
string
1-10
Yes
One
/VoidShipmentResponse/Response/Alert/C
ode
One
Code
Describes Response Status Code.
Returns text of
Success
No
/VoidShipmentResponse/Response/Alert
Response Container.
Identifies the success or failure of
the transaction.1 = Successful
Yes*
Alert
Void Response Container.
1
/VoidShipmentResponse
1-35
VoidShipmentResponse
Yes
7/09/2012
Yes
Alert Container. There can be zero
to many alert
description.
Warning code returned by the
system
Page 256
One
string
1-150
One
container
N/A
string
1-512
The CustomerContext Information
which will be echoed
during response.
TransactionIdentifier
/VoidShipmentResponse/Response/Transa
ctionReference/TransactionIdentifier
One
string
35
SummaryResult
/VoidShipmentResponse/SummaryResult
One
Container
N/A
Status
/VoidShipmentResponse/SummaryResult/S
tatus
One
Container
N/A
Container for the status of the
Summary Result
Code
tatus/Code
String
1
The Unique TransactionIdentifier
Information for that
transaction. This will be present
only if requested in the
request.
One
One
Yes*
No
CustomerContext
ctionReference/CustomerContext
Transaction Reference Container.
No
ctionReference
Yes
Warning messages returned by
the system.
Yes
/VoidShipmentResponse/Response/Alert/D
escription
Yes
Description
7/09/2012
No
Code for the status of the
Summary Result
Container for the Summary Result
Page 257
One
String
1-35
One
Container
N/A
One
String
18
Container
1
1
/VoidShipmentResponse/PackageLevelRes
ult/Status/Description
1...15
Description
String
ult/Status/Code
Contains the status code tags.
String
Code
One
ult/Status
The package's identification
number
One
Status
Contains the Package Level
Results
One
ult/TrackingNumber
Yes
TrackingNumber
No
ult
*Yes
PackageLevelResult
*Yes
tatus/Description
*Yes
Description
7/09/2012
* Yes
Description of the status of the
Summary Result
The Package Level void status
code. A numeric value
that describes the status code.1 =
Voided or Already
Voided; 0 = Not Voided
A text description of the status
code.
Page 258
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
Page 259
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 wellformed (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>
Page 260
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.
Page 261
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
returned for a shipment level void
request.
1Z2220060294314162 and Tracking Number
1Z2220060291994175
returned for a package level void request.
The request will void the package in the
shipment.
1Z2220060292002190
The request will void the package in the
shipment. .
1ZISDE016691609089 with Tracking Numbers
1ZISDE016694068891 and 1ZISDE016690889305
The request will void all the packages.
1Z2220060290530202 with Tracking Number
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.
Page 262
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
Page 263
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 .
Page 264
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.
Page 265
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.
Page 266
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
120020
Severity
Hard
Description
Max packages per shipment exceeded
120021
Hard
120023
Warning
120024
120100
120101
120102
120103
120104
120105
120106
120107
120108
120109
120110
120111
Warning
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
The same shipment cannot be requested to be created more than once.
Using user generated forms is not permitted. Please attach your user
generated forms with your shipment.
Uploading of your user generated International Forms was not successful.
Please attach the international forms to your shipment.
Missing or invalid shipper number
Missing or invalid shipper name
Missing or invalid shipper address line 1
Invalid shipper address line 2
Invalid shipper address line 3
Missing or invalid Shipper City
Missing or invalid Shipper StateProvinceCode
Missing or invalid Shipper PostalCode. (Description)
Missing or invalid Shipper CountryCode
Missing or invalid Shipper PhoneNumber
Missing or invalid Shipper AttentionName
Shipper EmailAddress cannot exceed a length of 50 characters
Page 267
Error Code
120112
Severity
Hard
Description
Shipper EmailAddress is an invalid format
120113
120114
120115
120116
Hard
Hard
Hard
Hard
120117
120118
Hard
Hard
Shipper number must contain alphanumeric characters only
Shipper phone extension cannot exceed the length of 4.
Shipper PhoneNumber must be at least 10 alphanumeric characters
Shipper phone extension must contain only numbers
Shipper phone extension is allowed only if the shipper is located in US,
Puerto Rico or Canada
Shipper phone extension is only valid if a phone number is given.
120120
120121
120122
120124
Hard
Hard
Hard
Hard
The country associated with Shippers ShipperNumber must be the same as
the shipments Shippers country
The Shippers shipper number cannot be used for the shipment.
Invalid Shipper ShipperNumber
The requested service is unavailable between the selected locations
120125
120200
120201
120202
120203
120204
120205
120206
120207
120208
120209
120210
120211
120212
120213
120214
120216
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
120217
Hard
120218
120300
120301
120302
120303
120304
120305
120306
120307
120308
120309
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
7/09/2012
Consignee billing is only supported in US or Pureto Rico
Missing or invalid ShipTo CompanyName
Missing or invalid ShipTo AttentionName
Missing or invalid ShipTo AddressLine1
Invalid ShipTo AddressLine2
Invalid ShipTo AddressLine3
Missing or invalid ShipTo City
Missing or invalid ShipTo StateProvinceCode
Missing or invalid ShipTo PostalCode. (Description)
Missing or invalid ShipTo CountryCode
Missing or invalid ShipTo PhoneNumber
ShipTo EmailAddress cannot exceed a length of 50 characters
ShipTo EmailAddress is an invalid format
ShipTo PhoneExtension cannot exceed the length of 4.
ShipTo PhoneNumber must be at least 10 alphanumeric characters
ShipTo PhoneExtension must contain only numbers
ShipTo PhoneExtension is only valid if a phone number is given
ShipTo phone number and phone extension together cannot be more than
15 digits long
Missing or Invalid ShipTo tax identification. TaxID may not exceed a
length of 15.
Missing or invalid ShipFrom CompanyName
Missing or invalid ShipFrom AttentionName
Missing or invalid ShipFrom AddressLine1
Invalid ShipFrom AddressLine2
Invalid ShipFrom AddressLine3
Missing or invalid ShipFrom City
Missing or invalid ShipFrom StateProvinceCode
Missing or invalid ShipFrom PostalCode. (Description)
Missing or invalid ShipFrom CountryCode
Missing or invalid ShipFrom PhoneNumber
Page 268
Error Code
120310
120311
120312
120313
120314
120316
Severity
Hard
Hard
Hard
Hard
Hard
Hard
120318
120400
120402
120403
120404
120406
120407
120408
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
120412
120414
120416
120417
120437
120500
120501
120502
120503
120504
120505
120506
120512
120515
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
120517
Hard
120518
Hard
120519
120522
Hard
Hard
120523
120524
120526
120530
120531
120532
120533
120534
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
7/09/2012
Description
ShipFrom EmailAddress cannot exceed a length of 50 characters
ShipFrom EmailAddress is an invalid format
ShipFromPhoneExtension cannot exceed the length of 4.
ShipFrom PhoneNumber must be at least 10 alphanumeric characters
ShipFromPhoneExtension must contain only numbers
ShipFromPhoneExtension is only valid if a phone number is given
ShipFrom phone number and phone extension together cannot be more
than 15 digits long
Missing or invalid shipment payment method
Missing or invalid credit card type
Missing or invalid credit card number
Missing or invalid credit card expiration date
creditcard number is not valid for the credit card type
The credit card provided as the payment method has expired.
Missing credit card type
UPS account number that was provided as the payment method is missing
or invalid.
Credit card authorization failed, contact your financial institution
A single billing option is required per shipment
The account number for FRS payment information is not FRS enabled
Third party or freight collect shippers postal code is missing or invalid.
Missing or invalid Service Code
Invalid Shipment ReferenceNumber Value
InvoiceLineTotal/MonetaryValue must be greater than 0
Shipment Description cannot exceed the length of 35 characters
InvoiceLineTotal is not allowed for this shipment
Saturday Delivery Option cannot be used for this shipment
Invalid Shipment ReferenceNumber Code
Shipment Description is required for this shipment.
{ notification type} Memo cannot exceed the length of 150 characters
The {order} Email Address used for { notification type} exceeds the
maximum length of 50 characters
The format of the {order} Email Address entered for { notification type} is
invalid
The {order} Email Address entered for { notification type} is missing or
contains invalid characters
Alternate Delivery Time is not valid for any available services
Shipment DocumentsOnly is invalid with the shipments origin/destination
pair
Package Pickup Request is not available with this shipments service
InvoiceLineTotal MonetaryValue may not exceed the length of 8
SuiteRoomID length of shipment pickup cannot exceed 8 characters
FloorID length of shipment pickup cannot exceed 3 characters
Location length of shipment pickup cannot exceed 11 characters
The earliest shipment pickup time is required
The latest shipment pickup time is required
Page 269
Error Code
120535
120536
120538
120549
Severity
Hard
Hard
Hard
Hard
120597
Hard
120598
120600
120601
Hard
Hard
Hard
120602
120603
120604
120605
120606
120607
120608
120609
120610
120611
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
120612
Hard
120613
Hard
120614
Hard
120615
120616
120617
120618
120619
Hard
Hard
Hard
Hard
Hard
120620
Hard
120621
120622
120623
120624
120626
120644
Hard
Hard
Hard
Hard
Hard
Hard
120654
Hard
120655
120661
Hard
Hard
7/09/2012
Description
Contact name of shipment pickup is required
Contact phone number of shipment pickup is required
Shipment Pickup Error: (further description is provided in XML)
Invalid ReferenceNumber BarCodeIndicator.
Invalid COD currency code. Please use the destination country currency
code.
Package Delivery Confirmation is not allowed with the shipment
origin/destination.
Missing Package Packaging Type Code
Missing or invalid Package weight
Missing or invalid Combination of package length, width, and height
values.
Invalid Package Reference Value
Invalid package declared value
Mismatch package dimensions with package type
Mismatch package dimensions, package type and package weight
Invalid Package Reference Code
Package weight is required
All Package Dimensions are required and each must be greater than 0
Invalid COD monetary value
The contact name of verbal confirmation cannot exceed a length of 35
The contact phone number of verbal confirmation cannot exceed the
length of 15
The contact phone number of verbal confirmation must be at least 10
The contact phone extension of verbal confirmation cannot exceed the
length of 4
The contact phone extension of verbal confirmation must contain numbers
only
Package weight cannot exceed a length of 6
Package declared value cannot exceed a value of 999
Contact name is required for verbal confirmation of delivery
Contact phone number is required for verbal confirmation of delivery
Package PackageWeight, Package DimensionalWeight, Package
OversizePackage and Package Dimensions do not apply to UPS Envelopes
Package declared value cannot be greater than {Monetary Amount}
{Currency Code}
Package description is required
Invalid Package description
Only one package is allowed for this movement.
The COD Funds Code is invalid. Please check the value entered
LabelDelivery is not valid with the shipment
No more than two email addresses for Receiver Return Notification are
allowed in a shipment.
{0} of Receiver Return Notification is only allowed to be specified at the
first package that has Receiver Return Notification.
For a shipment, the maximum number of {0} allowed for Quantum View
Page 270
Error Code
Severity
120662
120663
120664
120665
120666
120704
120705
120759
120760
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
120761
120801
120802
120803
Hard
Hard
Hard
Hard
120900
120901
121005
121006
121011
Warning
Warning
Hard
Hard
Hard
121015
Hard
121020
Hard
121021
121025
121030
121031
121035
121036
121040
Hard
Hard
Hard
Hard
Hard
Hard
Hard
121041
121045
Hard
Hard
121047
121050
121055
121056
121057
121063
121070
121085
121087
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
7/09/2012
Description
notification is 1.
Invalid Subject Code of {Notification type}
Invalid From name of {Notification type}
Invalid UndeliverableEMailAddress of {Notification type}
Invalid FromEMailAddress of {Notification type}
Missing or invalid subject text of {Notification type}
Missing/Invalid LabelSpecification LabelStockSize Height
Missing/Invalid LabelSpecification LabelStockSize Width.
MovementReferenceNumber must contain alphanumeric characters only.
MovementReferenceNumber must be a length of 18 characters.
Invalid MovementReferenceNumber . The 3rd and 4th Character Must be
the Shipper country ISO Code.
Address Validation Error on Shipper address
Address Validation Error on ShipTo address
Address Validation Error on ShipFrom address
User Id and Shipper Number combination is not qualified to receive
negotiated rates.
Negotiated rates are unavailable at this time
The COD option cannot be combined with the Return Services option.
The COD option cannot be combined with the UPS Import Control option.
Dangerous Goods cannot be shipped using UPS Import Control.
The Saturday Delivery option cannot be combined with the Return
Services option.
The Delivery Confirmation option cannot be combined with the Return
Services option.
The Delivery Confirmation option cannot be combined with the UPS
Import Control option.
The maximum declared amount $50,000 is exceeded
Packages must weigh more than zero pounds.
Packages must weigh more than zero kilogram
{description}
{description}
The Return Services are unavailable with the requested service.
The UPS Import Control accessories are unavailable with the requested
service.
The Saturday Delivery option is unavailable with the requested service.
Saturday Delivery may not be combined with the package type for the
given product.
Package exceeds the maximum size total constraints { description}
Package exceeds the maximum length constraint of {description} inches. .
Package exceeds the maximum length constraint of {description} cm.
The measurement system is not valid
Accessorial cannot be shipped with the selected service.
{Rating error description}.
The requested accessory cannot be added to the shipment.
The Authorized Return Service option is not allowed for shipments.
Page 271
Error Code
121090
121091
121100
121105
121106
121107
121115
Severity
Hard
Hard
Hard
Hard
Hard
Hard
Hard
121120
Hard
121121
121125
Hard
Hard
121126
Hard
121131
Hard
121135
121140
121150
Hard
Hard
Hard
121155
121156
121160
Hard
Hard
Hard
121165
Hard
121166
Hard
121170
121175
Hard
Hard
121182
121195
121196
121200
121205
121206
Hard
Hard
Hard
Hard
Hard
Hard
121208
121210
Hard
Hard
121211
Hard
121212
121213
Hard
Hard
7/09/2012
Description
{Rating error description}
The selected service is invalid for the shipment origin.
The given accessory key is invalid for the shipment origin.
The specified country, origin or destination, is not supported.
A blank origin postal was specified.
The COD amount must be greater than zero
The COD amount cannot exceed $1,000 when a cashiers check or money
order is requested.
The COD value entered exceeds the maximum allowed for cash of
{amount} ({currency code})
The COD amount cannot exceed $50,000.
The COD value entered exceeds the maximum allowed for check of
{amount} ({currency code})
The Saturday Pickup option cannot be combined with the UPS Import
Control option.
The Saturday Pickup option cannot be combined with the Saturday
Delivery option.
Saturday Pickup is unavailable with the selected service.
Delivery confirmation is unavailable with the selected service.
The COD option is unavailable with the selected service, UPS account
type, and/or with the shipments origin/destination pair.
Package Level COD is not valid for the shipment origin and/or destination
The accessory is invalid with the billing option.
The Verbal Confirmation of Deliveryoption cannot be combined with the
Return Services option.
The Verbal Confirmation of Delivery option cannot be combined with the
UPS Import Control option.
The Delivery Confirmation option cannot be combined with the Verbal
Confirmation of Delivery option.
Verbal Confirmation of Delivery is unavailable with the selected service.
The payer's transportation country is not valid for carbon neutral
shipments.
The selected billing option is unavailable with the selected service.
The selected billing option is unavailable with UPS Letters.
Saturday Delivery is unavailable to desired destination.
Additional Handling is unavailable with the selected service.
Additional Handling is unavailable with UPS Letters.
UPS Next Day Air Early A.M. service is not available to the requested
destination. Please select UPS Next Day Air service as an alternative.
The selected service is not available from the origin to the destination.
A package-level accessorial is not available with the shipments origin/dest
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
the destination
Page 272
Error Code
121214
121215
121225
121230
121231
Severity
Hard
Hard
Hard
Hard
Hard
121232
121235
121255
121260
121261
121262
121265
121266
121267
121268
121285
121286
121290
121295
121315
121317
121320
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
121325
121330
121335
121340
Hard
Hard
Hard
Hard
121345
121350
Hard
Hard
121355
Hard
121360
121363
121365
121370
Hard
Hard
Hard
Hard
121375
Hard
121452
Hard
121460
121500
Hard
Hard
7/09/2012
Description
UPS cannot ship from the origin country to the destination country
The selected service is not available to residential destinations.
Return Services are unavailable to the given destination.
Next Day Air Early AM Surcharge is unavailable with the selected service.
Switzerland Domestic Container must weigh greater than 2 KG
Worldwide Express Plus from Europe to Switzerland must be UPS
Envelope or document only
{rating error description}
Shipper Duty Fee is unavailable with the selected service.
Shipper Duty Fee is unavailable with the selected billing option.
Accessory may not be combined with the product.
Accessory may not be combined with the accessory.
The selected billing option is unavailable to the desired country.
The currency code is invalid for the shipment.
The Ship From Country is invalid for the credit card.
The Billing address Country is invalid for the credit card.
The given billing option is invalid
The Authorized Return Service is unavailable with the selected accessorial.
The UPS Import Control option is unavailable with the selected accessory.
The Authorized Return Service is unavailable with the selected service.
The Authorized Return Service is unavailable with the selected billing
option.
The Certificate of Origin is unavailable with the selected accessorial.
The Certificate of Origin is unavailable with the selected service.
The Certificate of Origin is unavailable with the selected billing option.
The Shipper Export Declaration is unavailable with the selected
accessorial.
The Shipper Export Declaration is unavailable with the selected service.
The Shipper Export Declaration is unavailable with the selected billing
option.
The Worldwide Express Plus Surcharge is unavailable with the selected
service.
The One Time Pickup Surcharge is unavailable with the selected service.
Accessorial is not available with the selected access method.
Invalid access method.
Letter service is invalid for shipments with more than 1 package.
International shipment cannot be made with multiple 10KG or 25KG
packages
An Import Control option and a Return Service option are not valid on the
same shipment.
Shipments cannot exceed a COD amount of $5,000 when requesting a
cashiers check or money order.
Page 273
Error Code
121501
121502
121510
121511
121512
121513
Severity
Hard
Hard
Hard
Hard
Hard
Hard
121515
Warning
121520
121521
121523
Hard
Hard
Hard
121524
Hard
121526
121530
121531
Hard
Hard
Hard
121532
Hard
121534
Hard
121535
121536
Hard
Hard
121538
Hard
121539
Hard
121565
Hard
121570
Hard
121575
Hard
121580
Hard
121585
Hard
121590
Hard
121595
Hard
121600
Hard
121605
Hard
7/09/2012
Description
{Rating error Description}
The selected country does not allow forward movements.
Unsupported package type.
Unsupported accessory type
Unsupported billing option
Unsupported service
Weight of (actual weight) exceeds maximum for rating the requested
container. Using standard package rates.
The UPS account number specified for Transportation charges is invalid
for Split Duty VAT shipment.
Invalid payer of Duty and Tax
Invalid GoodsNotInFreeCirculationIndicator
The payer of Duty and Tax charges is not required for UPS Letter,
Documents of No Commercial Value or Qualified Domestic Shipments.
The payment method specified for Transportation charges is invalid for
return service.
The payer of Duty and Tax charges is required.
Invalid SplitDutyVATIndicator
The payer of Duty and Tax charges is invalid for Split Duty VAT
shipment.
The payer of Transportation charges and the payer of Duty and Tax
charges must not be the same for Split Duty VAT shipment.
The payer of Transportation charges is invalid for Split Duty VAT
shipment.
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
country of the return movement
For an EU return movement, the payer of the freight must be in an EU
country.
The UPS Returns Flexible Access option is unavailable with the requested
accessory.
The UPS Returns Flexible Access option is available only with Return
Services Print Mail, Electronic Return Label, and Print Return Label.
The UPS Returns Flexible Access option is unavailable with Additional
Handling.
The UPS Returns Flexible Access option is unavailable with Large
Package.
The UPS Returns Flexible Access option is available for US and Puerto
Rico shippers only.
The maximum per package weight for the UPS Returns Flexible Access
option is ...
The maximum length (the longest side) of a UPS Returns Flexible Access
package is ...
The maximum length of the second-longest side of a UPS Returns Flexible
Access package is ...
The maximum total size constraint (length + girth, where girth is 2 x width
plus 2 x height) of a UPS Returns Flexible Access package is …
Page 274
Error Code
Severity
121610
Hard
121615
121780
121801
121802
123005
123010
123020
123021
Hard
Hard
Hard
Hard
Warning
Warning
Warning
Warning
123060
124022
125000
Warning
Hard
Hard
128001
Hard
128002
Hard
128003
Hard
128004
Hard
128005
128006
128007
Hard
Hard
Hard
128008
Hard
128009
128010
Hard
Hard
128011
Hard
128012
Hard
128013
Hard
128014
Hard
128015
Hard
128016
Hard
128017
128018
Hard
Hard
128019
Hard
128020
Hard
7/09/2012
Description
The maximum declared value amount for the UPS Returns Flexible Access
option is ...
All packages in the shipment must have the UPS Returns Flexible Access
option if 1 package has it.
Commercial Invoice Removal is valid only for Import Control shipments.
{0}
{0}
(Description)
Package(s) in this shipment contains a warning: (Description)
Invalid Ship From postal code
Invalid Ship To postal code
{Rating Error Description} The weight exceeds the limit for the UPS
Letter/Envelope rate and will be rated using the weight.
'Invalid number of shipment level notifications
Missing or invalid shipment digest.
Invalid or missing international forms form type. Valid values are 01, 02,
03 or 04
Invalid or missing forward agent company name. Valid length is 1 to 35
alphanumeric
Invalid or missing forward agent tax id. Valid length is 1 to 15
alphanumeric
Invalid or missing forward agent address line 1. Valid length is 1 to 35
alphanumeric
Invalid forward agent address line 2. Valid length is 0 to 35 alphanumeric
Invalid forward agent address line 3. Valid length is 0 to 35 alphanumeric
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
alphanumeric
Invalid forward agent postal code. Valid length is 0 to 9 alphanumeric
Invalid or missing forward agent country code
Invalid or missing ultimate consignee company name. Valid length is 1 to
35 alphanumeric
Invalid or missing ultimate consignee addressLine1. Valid length is 1 to 35
alphanumeric
Invalid ultimate consignee address line 2. Valid length is 0 to 35
alphanumeric
Invalid ultimate consignee address line 3. Valid length is 0 to 35
alphanumeric
Invalid or missing ultimate consignee city. Valid length is 1 to 30
alphanumeric
Invalid ultimate consignee state province code. Valid length is 0 to 5
alphanumeric
Invalid ultimate consignee postal code. Valid length is 0 to 9 alphanumeric
Invalid or missing ultimate consignee country code
Invalid or missing intermediate consignee company name. Valid length is
1 to 35 alphanumeric
Invalid or missing intermediate consignee address line 1. Valid length is 1
to 35 alphanumeric
Page 275
Error Code
Severity
128021
Hard
128022
Hard
128023
Hard
128024
Hard
128025
Hard
128026
128027
Hard
Hard
128028
Hard
128029
Hard
128030
128031
128032
Hard
Hard
Hard
128033
Hard
128034
128035
128036
128030
128030
128039
128041
Hard
Hard
Hard
Hard
Hard
Hard
Hard
128042
Hard
128043
Hard
128044
Hard
128045
Hard
128046
Hard
128047
Hard
128048
Hard
128049
Hard
128050
Hard
128051
Hard
128052
Hard
7/09/2012
Description
Invalid intermediate consignee address line 2. Valid length is 0 to 35
alphanumeric
Invalid intermediate consignee address line 3. Valid length is 0 to 35
alphanumeric
Invalid or missing intermediate consignee city. Valid length is 1 to 30
alphanumeric
Invalid intermediate consignee state province code. Valid length is 0 to 5
alphanumeric
Invalid intermediate consignee postal code. Valid length is 0 to 9
alphanumeric
Invalid or missing intermediate consignee country code
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
alphanumeric
Invalid or missing producer address line 1. Valid length is 1 to 35
alphanumeric
Invalid producer address line 2. Valid length is 0 to 35 alphanumeric
Invalid producer address line 3. Valid length is 0 to 35 alphanumeric
Invalid or missing producer city. Valid length is 1 to 30 alphanumeric
Invalid producer state province code. Valid length is 0 to 5 alphanumeric
Invalid producer postal code. Valid length is 0 to 9 alphanumeric
Invalid or missing producer country code
Invalid telephone number.
Invalid producer email address. Valid length is 0 to 50 alphanumeric
Invalid producer tax id. Valid length is 0 to 15 alphanumeric
Invalid number of products. Valid number of products are 1 to 50
The form specified for the product must be one of the requested forms.
If invoice is a requested international form, all specified products must
belong to invoice
Invalid or missing product unit number for product number {0}. Valid
length is 1 to 7 numeric
Invalid or missing Product/Unit/UnitOfMeasurement/Code for product
number {0}. Valid length is 1 to 3 alphanumeric
Product/Unit/UnitOfMeasurement/Description
is
required
when
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
is 1 to 12 numeric and it can hold up to 6 decimal places
Invalid part number. Valid length is 0 to 10 alphanumeric
Invalid commodity code for product number {0}. Valid length is 6 to 15
alphanumeric
Invalid or missing product origin country code for product number {0}
Invalid or missing net cost code for product number {0}. Valid values are
NC or NO
Invalid or missing net cost date range begin date for product number {0}.
Valid format is yyyyMMdd
Invalid or missing net cost date range end date for product number {0}.
Valid format is yyyyMMdd
Page 276
Error Code
Severity
128053
Hard
128054
Hard
128055
Hard
128056
Hard
128057
Hard
128058
Hard
128059
Hard
128060
Hard
128061
Hard
128062
Hard
128063
Hard
128064
Hard
128065
128066
128067
128068
128069
128070
128071
Hard
Hard
Hard
Hard
Hard
Hard
Hard
128072
Hard
128073
Hard
128074
Hard
128075
Hard
128076
128077
128078
128079
128080
128081
Hard
Hard
Hard
Hard
Hard
Hard
128082
Hard
128083
Hard
7/09/2012
Description
Invalid or missing preference criteria for product number {0}. Valid values
are A through F
Invalid or missing producer info for product number {0}. Valid values are
YES, NO[1], NO[2] or NO[3]
Invalid or missing marks and numbers for product number {0}. Valid
length is 1 to 35 alphanumeric
Invalid or missing product weight unit of measurement code for product
number {0}. Valid values are KGS or LBS
Invalid or missing product weight for product number {0}. Valid length is
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
alphanumeric
Invalid or missing product schedule B number for product number {0}.
Valid length is 10 alphanumeric
Invalid product schedule B quantity for product number {0}. Valid length
is 0 to 10 numeric
Invalid or missing product schedule B unit of measurement code for
product number {0}. Valid length is 1 to 3 alphanumeric
Schedule B quantity is required when the schedule B unit of measurement
code is not equal to X
Invalid or missing export type for product number {0}. Valid values are D,
F or M
Invalid or missing SED total value for product number {0}. Valid length is
1 to 15 numeric and can hold up to 2 decimal places
Invalid invoice number. Valid length is 0 to 35 alphanumeric
Invalid or missing invoice date. Valid format is yyyyMMdd
Invalid purchase order number. Valid length is 0 to 35 alphanumeric
Invalid terms of shipment.
Invalid or missing reason for export. Valid length is 1 to 20 alphanumeric
Invalid additional comments. Valid length is 0 to 150 alphanumeric
Invalid declaration statement. Valid length is 0 to 250 alphanumeric
Invalid discount monetary value. Valid length is 0 to 15 numeric and can
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
can hold up to 2 decimal places.
Invalid other charges monetary value. Valid length is 0 to 15 numeric and
can hold up to 2 decimal places.
Invalid or missing other charges description. Valid length is 1 to 10
alphanumeric
Invalid or missing blanket period begin date. Valid format is yyyyMMdd
Invalid or missing blanket period end date. Valid format is yyyyMMdd
Invalid or missing export date. Valid format is yyyyMMdd
Invalid or missing export carrier. Valid length is 1 to 35 alphanumeric
Invalid carrier ID. Valid length is 0 to 2 alphanumeric
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
Length is 1 to 25 alpha numeric
Invalid or missing point of origin. Valid length is 1 to 5 alphanumeric
Page 277
Error Code
128084
128085
Severity
Hard
Hard
128086
Hard
128087
128088
128089
128090
128091
Hard
Hard
Hard
Hard
Hard
128092
Hard
128093
Hard
128094
Hard
128095
Hard
128096
Hard
128097
128098
128099
128100
128101
128102
128103
Hard
Hard
Hard
Hard
Hard
Hard
Hard
128104
Hard
128105
Hard
128109
Hard
128110
128111
Hard
Hard
128112
Hard
128113
Hard
128114
Hard
128115
Hard
128116
Hard
128117
Hard
128118
Hard
128119
Hard
7/09/2012
Description
Invalid or missing mode of transport. Valid length is 1 to 35 alphanumeric
Invalid port of export. Valid length is 0 to 35 alphanumeric
Invalid port of unloading. Valid length is 0 to 35 alphanumeric
Invalid loading pier. Valid length is 0 to 35 alphanumeric
Invalid or missing parties to transaction. Valid values are R or N
Invalid license number. Valid length is 0 to 35 alphanumeric
Invalid or missing license date. Valid format is yyyyMMdd
Invalid license exception code. Valid length is 0 to 4 alphanumeric
Either license number or license exception code must be present for a SED
form.
Invalid ECCN number code. Valid length is 1 to 8 alphanumeric
Sold to information is required when an invoice or NAFTA CO is
requested.
Invalid or missing sold to company name. Valid length is 1 to 35
alphanumeric
Invalid or missing sold to address line 1. Valid length is 1 to 35
alphanumeric
Invalid sold to address line 2. Valid length is 0 to 35 alphanumeric
Invalid sold to address line 3. Valid length is 0 to 35 alphanumeric
Invalid or missing sold to city. Valid length is 1 to 30 alphanumeric
Invalid sold to state province code. Valid length is 0 to 5 alphanumeric
Invalid sold to postal code. Valid length is 0 to 9 alphanumeric
Invalid or missing sold to country code
The selected international form is not valid for the shipment origin country
The selected international form is not valid for the shipment origin and
product origin combination.
The selected international form is not valid for the shipment origin and
destination countries
Invalid or missing sold to attention name. Valid value is 1 to 35
alphanumeric
Invalid sold to option. Valid values are 01 or 02
Commodity code is required for NAFTA CO
Invalid insurance monetary value. Valid length is 0 to 15 numeric and can
hold up to 2 decimal places.
Invalid product description for product number {0}. Product description
should be present at least once. Valid range is 0 to 35 alphanumeric
Invalid or missing currency code. Valid length is 3 alphanumeric.
Invalid or missing sold to phone number. Valid length is 1 to 15
alphanumeric.
Invalid sold to tax identification number. Valid length is 1 to 15
alphanumeric.
Invalid or missing Shipper tax identification.
Invalid license information. Either license number and license date or
license exception code and ECCN number must be present. Both the
combinations can not be present together.
Invalid or missing product NumberOfPackagesPerCommodity. Valid
length is 1-3 Numerics.
Page 278
Error Code
Severity
128120
Hard
128121
Hard
128122
Hard
128123
128124
128125
Hard
Hard
Hard
128126
Hard
128201
Hard
128202
128203
Hard
Hard
128204
Hard
128205
Hard
128210
Hard
128211
128212
Hard
Hard
128213
Hard
128214
128215
Hard
Hard
128216
Hard
128217
Hard
128218
128219
128220
128221
128222
128223
128224
128225
128226
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
128227
Hard
128228
128229
128230
128231
128232
Hard
Hard
Hard
Hard
Hard
7/09/2012
Description
Origin country must be different than destination country.
Missing value of other unit of measurement.
Invalid net cost date range.
Invoice cannot be requested for non-document forward shipments.
Invalid blanket period.
Invalid or missing ShipFrom tax identification.
Invalid or missing SED filing option. SED filing option is required when
SED form is requested. Valid values are 01 and 02.
Invalid or missing international forms form type for shipment with return
service. Valid value is 01 or 05.
International forms can not be requested for letters or documents.
Duplicate contact information
Invalid form group id name. valid range is 0 to 50 alphanumeric
Duplicate International FormType Information. valid values are 01, 02, 03,
04
Invalid combination of international forms. Both partial and complete
invoice form cannot be selected together.
Invalid Email Address
Invalid or missing ShipTo tax identification.
Invalid or missing producer attention name. Valid value is 1 to 35
alphanumeric
Invalid telephone extension. Valid length is 1 to 4 alphanumeric.
Invalid telephone extension. Valid length is 1 to 4 alphanumeric.
Invalid or missing international forms form type for ExcludeFromForm.
Valid values are 04.
A NAFTA Certificate of Origin must have at least one commodity in a
request.
A Commercial Invoice must have at least one commodity in a request.
A Blanket Period can not exceed 365 days.
The Total Product units allocated to packages do not match.
Product not associated with a package.
Invalid number of products. The valid number of products is 1 to 1000.
Invalid or missing DocumentID.
Invalid or missing Product Currency Code.
Invalid or missing Invoice Line Total.
Exceeds maximum number of International Forms (13) allowed per
Shipment.
Invalid or missing Package Number (Product is selected to be placed in a
Package that does not exist).
Invalid or missing Product number.
Invalid or missing packing list info.
Invalid or missing package associated data.
Invalid Product Id.
Exceeds the maximum number of packages allowed for the packing list
Page 279
Error Code
128233
Severity
Hard
128234
128235
128236
128237
128238
128239
128240
128241
9120211
9120212
9120213
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
9120214
9120215
9120216
9120217
9120218
Hard
Hard
Hard
Hard
Hard
9120219
9120225
9120226
9120227
9120228
9120241
9120242
9120243
9120244
9120245
9120300
9120301
9120302
9120400
9120401
9120800
9120801
9120802
9120803
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
9120804
9120805
Hard
Hard
9120806
9120807
9120808
Hard
Hard
Hard
7/09/2012
Description
User generated forms size exceeds total allowable limit for shipment of
5MB.
Invalid or missing Shipper Memo.
Invalid PackageInfo object.
Invalid or missing Tracking Number.
No form data found for given formsGroupID.
No PDF found for given documentId.
Exceeds maximum number of Document IDs (13) allowed per Shipment.
Invalid or missing User Created Form Data.
A shipment can only contain one Commercial Invoice.
Missing or invalid declared value currency code for package {0}.
Missing or invalid declared value monetary value for package {0}.
Shipper release is not allowed with return service.
The verbal confirmation of delivery option cannot be combined with the
Return Services option.
Missing verbal confirmation phone number for package {0}.
Missing or invalid package notification code for package {0}.
Missing package notification email information for package {0}.
Missing or invalid notification email address for package {0}.
Receiver Return Notification is not allowed for the shipment without
return service.
Missing commodity information for package{0}
Missing package NMFC prime code of commodity for package{0}
Missing package weight container information for package{0}
Missing packaging type for Package {0}.
Missing label specification information.
Missing label specification label image format.
Missing label specification label image format Code.
Missing label specification label stock size.
Invalid label specification label stock dimensions.
Cannot use multiple types of currency in a shipment.
A shipment can have only one type of unit of measurement for dimensions.
A shipment can have only one type of unit of measurement for a weight.
Missing or invalid shipment digest.
Invalid shipment object.
Missing contact information.
Missing sold to address information.
No more than 3 address line information can be given for sold to address.
Missing forward agent address information.
No more than 3 address line information can be given for forward agent
address.
Missing intermediate consignee address information.
No more than 3 address line information can be given for intermediate
consignee address.
Missing ultimate consignee address information.
No more than 3 address line information can be given for ultimate
Page 280
Error Code
Severity
9120809
9120810
Hard
Hard
9120811
9120812
Hard
Hard
9120813
9120814
9120815
9120816
Hard
Hard
Hard
Hard
9120817
9120818
9120819
9121000
9129087
129203
129204
126086
126087
126088
126089
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
126090
126091
126092
126093
9120246
9120247
9120248
124998
124999
9126005
9126007
9126044
126000
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
126008
126009
126010
126077
126078
20004
20005
20007
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
7/09/2012
Description
consignee address.
Missing producer information.
Missing producer address information.
No more than 3 address line information can be given for producer
address.
Missing product weight information for product number {0}.
Missing product weight unit of measurement information for product
number {0}.
Missing product unit information for product number {0}.
Missing product unit of measurement information for product number {0}.
Missing schedule B information for product number {0}.
Missing schedule B unit of measurement information for product number
{0}.
Missing blanket period information.
Missing license information.
Invalid Ship Request Document
Invalid Shipment Delivery Confirmation Type
Account is not authorized for UPS Exchange service
Account is not authorized for UPS Pack and Collect service
PreAlertNotification Phone Number is missing
PreAlert Notification Phone Number may not exceed length of 15
PreAlertNotification Dialect length must be less than or equal to 2
PreAlertNotification Language-Dialect Pair not valid
Pre-alert notification is valid only with UPS Returns Exchange and UPS
Returns Pack and Collect shipments
Notification Language is missing
Notification Dialect is missing
Notification Language must be less than or equal to 3
Missing/Invalid Label Instruction Code
Invalid set of Label Instruction Codes
LabelSpecification/Instruction is not allowed with the shipment
ReceiptSpecification applies only for PRL or Exchange Return Receipt.
Invalid ImageFormat code
DryIce DryIceWeight Weight is absent or doesn't meet specification.
DryIce DryIceWeight UnitOfMeasurment Code has invalid value.
DryIce Regulation is required or has invalid value.
Shipper is not eligible to ship Dry Ice.
All packages with DryIce RegulationSet must contain the same Regulation
Set.
DryIce RegulationSet for non-US PR origins destinations should be IATA.
DryIce DryIceWeight Weight cannot be larger than package weight.
Number of DryIce items per Package is greater than 1.
DryIce item cannot exist on the same package as another HazMat.
Cannot access the high level business components, {0}
Cannot access the low level business components, {0}
Missing required field, {0}
Page 281
Error Code
20008
20010
20011
250010
250011
250012
250019
250020
250021
250022
250023
250024
250025
250026
250027
250028
250029
250030
250031
250032
250033
250034
250035
250036
250037
250038
250040
250041
250042
250043
250044
250045
250046
250047
250048
250049
250051
250052
250060
250061
250062
250063
250064
110001
120001
Severity
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
7/09/2012
Description
The field, {0}, contains invalid data, {1}
The phone number contains invalid characters
The Integration Indicator is no longer supported
Illegal Request Action
Illegal Request Option
No tool is requested
Invalid field value
Invalid developer license number
The data length is in error for CompanyName
The data length is in error for AddressLine1
The data length is in error for City
Invalid country code
The data is in error for StateProvinceCode
The data length is in error for PostalCode
The data is in error for phone number
Invalid e-mail address
Invalid URL
Invalid Country Code in AccessLicenseProfile
Invalid Language Code in AccessLicenseProfile
Invalid ToolVersion
The data length is in error for the name of contact person
The data length is in error for the title of contact person
The data is in error for fax number
Error in Shipper Number
Client software profile is missed for the 3rd party developer license
Invalid ToolID
Tool Version not available for the Access License
Tool ID not available for the Access License
Tool Version not licensed for developer
Tool already licensed
User already has a license
License number revoked
Missing License Agreement Text
Invalid License Agreement Text
Not allowed to create new license
Authorization system is currently unavailable
The data length is in error for the Software Installer
The data length is in error for the Software Product Name
The data length is in error for the Software Provider
The data length is in error for the Software Version Number
Invalid ToolID/ToolVersion
XML Rating and Service Selection Service Unavailable
XML Shipping System is unavailable, please try again later.
Page 282
Error Code
150000
9120068
Severity
Hard
Hard
128216
Hard
128217
128218
120910
Hard
Hard
Warning
120911
126098
126099
Warning
Warning
Warning
9126004
9126006
9126030
Hard
Hard
Hard
126001
126004
126006
Hard
Hard
Hard
126011
126032
126033
126034
126035
126036
126038
126039
126040
126041
126042
126043
126045
126046
126047
126048
126051
126052
126055
126056
126059
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
126060
126061
126062
Hard
Hard
Hard
7/09/2012
Description
Tracking service unavailable
Either credit card or account number information is needed but not both.
Invalid or missing international forms form type for ExcludeFromForm.
Valid values are 04.
A NAFTA Certificate of Origin must have at least one commodity in the
request.
A Commercial Invoice must have at least one commodity in the request.
TPFCNegotiatedRatesIndicator is applicable only for Third party/Freight
Collect shipments.
Shipper not authorized to request for the Third Party/Freight Collect
negotiated rates for this shipment.
Account authentication is required to be completed to get negotiated rates.
Credit Card is the only valid payment method for this type of account.
PackageServiceOption HazMat Quantity is absent or doesn't meet
specification.
PackageServiceOption HazMat TransportationMode has invalid value.
PackageServiceOption HazMat Regulation required or has invalid value.
Shipper is not eligible to ship Hazardous Material / International
Dangerous Goods.
HazMat Quantity is absent or doesn't meet specification.
HazMat TransportationMode has invalid value.
Package/HazMatPackageInformation required with either
AllPackedInOneIndicator/OverPackedIndicator values.
HazMat ClassDivisionNumber is required.
HazMat ClassDivisionNumber exceeds maximum length of 7 characters.
HazMat ClassDivisionNumber violates datatype. Only ASCII allowed.
HazMat Quantity is required.
HazMat Quantity exceeds maximum value.
HazMat UOM not set or invalid.
HazMat UOM value exceeds maximum length of 10 characters.
HazMat UOM violates datatype only ASCII allowed.
HazMat ProperShippingName is required and not set.
HazMat ProperShippingName exceeds maximum length of 150 characters.
HazMat ProperShippingName violates datatype only ASCII allowed.
HazMat ReferenceNumber exceeds maximum of 15 characters.
HazMat ReferenceNumber violates datatype only ASCII allowed.
HazMat ReportableQuantity exceeds maximum length of 2 characters.
HazMat ReportableQuantity violates datatype only ASCII allowed.
HazMat IDNumber Number exceeds maximum length of 6 characters.
HazMat IDNumber Number violates datatype only ASCII allowed.
HazMat PackagingGroupType exceeds maximum length of 5 characters.
HazMat PackagingGroupType violates datatype only ASCII allowed.
HazMat PackagingInstructionCode is Required.
HazMat PackagingInstructionCode exceeds maximum length of 4
characters.
HazMat PackagingInstructionCode violates datatype only ASCII allowed.
HazMat TransportationMode exceeds maximum length of 30 characters.
Page 283
Error Code
126063
126064
Severity
Hard
Hard
126065
126066
Hard
Hard
126069
126070
126071
126072
126073
126076
126079
Hard
Hard
Hard
Hard
Hard
Hard
Hard
126080
Hard
126081
126082
126083
Hard
Hard
Hard
126084
Hard
126085
120444
Hard
Hard
7/09/2012
Description
HazMat TransportationMode violates datatype only ASCII allowed.
HazMat EmergencyPhone required since Regulation Set is TDG
HazMat EmergencyPhone Number exceeds maximum length of 25
characters.
HazMat EmergencyPhone Number violates datatype only ASCII allowed.
HazMat AdditionalDescription Info exceeds maximum length of 255
characters.
HazMat AdditionalDescription Info violates datatype only ASCII allowed.
HazMat PackagingType is required.
HazMat PackagingType exceeds maximum length of 255 characters.
HazMat PackagingType violates datatype only ASCII allowed.
Number of HazMat entities per package cannot be greater than 3.
HazMat EmergencyContact Information is required for this shipment
HazMat EmergencyContact Information exceeds maximum length of 35
characters.
HazMat EmergencyContact Information violates datatype only ASCII
allowed.
Package HazMatPackageInformation AllPackedInOneIndicator is optional.
Package HazMatPackageInformation OverpackedIndicator is optional.
Package HazMatPackageInformation QValue must exist with
RegulationSet IATA when AllPackedInOneIndicator present.
HazMatPackageInformation QValue must be decimal value with one
significant digit.
Invalid Bill-To type
Page 284
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
190001
190002
190100
190101
Severity
Transient
Transient
Hard
Hard
Description
Void not available at this time
Invalid/Missing registration ID
Invalid ShipmentIdentificationNumber.
Time for voiding has expired.
190102
Hard
No shipment found within the allowed void period
190103
190104
Hard
Hard
The Pickup Request associated with this shipment has already
been completed
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
190107
Hard
190108
190109
190110
190111
Hard
Hard
Hard
Hard
The Pickup Request associated with this shipment has previously
been canceled
The Pickup Request associated with this shipment cannot be
canceled
Invalid TrackingNumber
Invalid Void Package {0}
Package Void Limit Exceeded
Page 285
7/09/2012
Error
Code
Severity
Description
190112
Hard
Return Service Shipments cannot be Voided at the Package Level
190113
190114
190115
Hard
Hard
Hard
190116
190117
190118
Hard
Hard
Hard
International Shipments cannot be Voided at the Package Level
Invalid Return Service Void Date
Invalid Void Date
A Label cannot be generated for a voided Return Service
Shipment
The Shipment has already been voided
Same Day Service Void Not Allowed.
190119
Warning
The requested Void was successful, but the associated Pickup was
not Cancelled
190121
Hard
None of the submitted packages were voided
190122
Hard
Package(s) {0} selected to void is(are) invalid
190124
Hard
190125
Hard
Import Control Shipment cannot be voided later than 3 am of the
day after the shipment uploaded.
Import Control Shipments does not allow package void in a
shipment
Page 286
7/09/2012
Appendix D – Common error codes for all webservices
Common Errors can apply to all web services;
Code
10001
Severity
Hard
Description
The XML document is not well formed
Hard
Hard
The XML document is well formed but the document is not valid
The XML document is either empty or null
10006
Hard
Although the document is well formed and valid, the element content
contains values which do not conform to the rules and constraints contained
in this specification
10013
20001
Hard
Transient
20002
Hard
The message is too large to be processed by the Application
General process failure
The specified service name, {0}, and version number, {1}, combination is
invalid
20003
20006
Hard
Hard
Please check the server environment for the proper J2EE ws apis
Invalid request action
20012
250000
Hard
Hard
The Client Information exceeds its Maximum Limit of {0}
No XML declaration in the XML document
250001
250002
250003
250004
250005
Hard
Hard
Hard
Hard
Hard
Invalid Access License for the tool. Please re-license.
Invalid UserId/Password
Invalid Access License number
Incorrect UserId or Password
No Access and Authentication Credentials provided
250006
Hard
The maximum number of user access attempts was exceeded
250007
250009
250050
Hard
Hard
Transient
The UserId is currently locked out; please try again in 24 hours.
License Number not found in the UPS database
License system not available
10002
10003
Page 287
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
Code
AF
AX
AL
DZ
AS
AD
AO
AI
AQ
AG
AR
AM
AW
AU
AT
AZ
BS
BH
BD
BB
BY
BE
BZ
BJ
BM
BT
BO
BA
BW
BV
BR
IO
BN
Country Name
Afghanistan
Åland Islands
Albania
Algeria
American Samoa
Andorra
Angola
Anguilla
Antarctica
Antigua and Barbados
Argentina
Armenia
Aruba
Australia
Austria
Azerbaijan
Bahamas
Bahrain
Bangladesh
Barbados
Belarus
Belgium
Belize
Benin
Bermuda
Bhutan
Bolivia
Bosnia and Herzegovina
Botswana
Bouvet Island
Brazil
British Indian Ocean
Territory
Brunei Darussalam
Forward
Origin
Return
Origin
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Page 288
Country
Code
BG
BF
BI
KH
CM
CA
CV
KY
CF
TD
CL
CN
CX
CC
CO
KM
CG
CD
CK
CR
CI
HR
CU
CY
CZ
DK
DJ
DM
DO
EC
EG
SV
GQ
ER
EE
ET
FK
FO
FJ
FI
FR
GF
PF
Country Name
Bulgaria
Burkina Faso
Burundi
Cambodia
Cameroon
Canada
Cape Verde
Cayman Islands
Central African Republic
Chad
Chile
China
Christmas Island
Cocos (Keeling) Islands
Colombia
Comoros
Congo
Congo, The Democratic
Republic of
Cook Islands
Costa Rica
Côte Divoire
Croatia
Cuba
Cyprus
Czech Republic
Denmark
Djibouti
Dominica
Dominican Republic
Ecuador
Egypt
El Salvador
Equatorial Guinea
Eritrea
Estonia
Ethiopia
Falkland Islands (Malvinas)
Faroe Islands
Fiji
Finland
France
French Guiana
French Polynesia
7/09/2012
Forward
Origin
Return
Origin
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Page 289
Country
Code
TF
GA
GM
GE
DE
GH
GI
GR
GL
GD
GP
GU
GT
GG
GN
GW
GY
HT
HM
VA
HN
HK
HU
IS
IN
ID
IR
IQ
IE
IM
IL
IT
JM
JP
JE
JO
KZ
KE
KI
KP
Country Name
French Southern Territories
Gabon
Gambia
Georgia
Germany
Ghana
Gibraltar
Greece
Greenland
Grenada
Guadeloupe
Guam
Guatemala
Guernsey
Guinea
Guinea-Bissau
Guyana
Haiti
Heard Island and
McDonald Islands
Holy See (Vatican City
State)
Honduras
Hong Kong
Hungary
Iceland
India
Indonesia
Iran, Islamic Republic of
Iraq
Ireland
Isle of Man
Israel
Italy
Jamaica
Japan
Jersey
Jordan
Kazakhstan
Kenya
Kiribati
Korea, Democratic Peoples
Republic of
7/09/2012
Forward
Origin
Return
Origin
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Page 290
Country
Code
KR
KW
KG
LA
LV
LB
LS
LR
LY
LI
LT
LU
MO
MK
MG
MW
MY
MV
ML
MT
MH
MQ
MR
MU
YT
MX
FM
MD
MC
MN
ME
MS
MA
MZ
MM
NA
NR
NP
NL
AN
NC
Country Name
Korea, Republic of
Kuwait
Kyrgyzstan
Lao Peoples Democratic
Republic
Latvia
Lebanon
Lesotho
Liberia
Libyan Arab Jamahiriya
Liechtenstein
Lithuania
Luxembourg
Macao
Macedonia, The Former
Yugoslav Republic of
Madagascar
Malawi
Malaysia
Maldives
Mali
Malta
Marshall Islands
Martinique
Mauritania
Mauritius
Mayotte
Mexico
Micronesia, Federated
States of
Moldova, Republic of
Monaco
Mongolia
Montenegro
Montserrat
Morocco
Mozambique
Myanmar
Namibia
Nauru
Nepal
Netherlands
Netherlands Antilles
New Caledonia
7/09/2012
Forward
Origin
Yes
Return
Origin
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Page 291
Country
Code
NZ
NI
NE
NG
NG
NU
NF
MP
NO
OM
PK
PW
PS
PA
PG
PY
PE
PH
PN
PL
PT
PR
QA
RE
RO
RU
RW
SH
KN
LC
PM
VC
WS
SM
ST
SA
SN
RS
SC
SL
SG
SK
Country Name
New Zealand
Nicaragua
Niger
Nigeria
Nigeria
Niue
Norfolk Island
Northern Mariana Islands
Norway
Oman
Pakistan
Palau
Palestinian Territory,
Occupied
Panama
Papua New Guinea
Paraguay
Peru
Philippines
Pitcairn
Poland
Portugal
Puerto Rico
Qatar
Réunion
Romania
Russian Federation
Rwanda
Saint Helena
Saint Kitts and Nevis
Saint Lucia
Saint Pierre and Miquelon
Saint Vincent and The
Grenadines
Samoa
San Marino
Sao Tome and Principe
Saudi Arabia
Senegal
Serbia
Seychelles
Sierra Leone
Singapore
Slovakia
7/09/2012
Forward
Origin
Yes
Yes
Return
Origin
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Page 292
Country
Code
SI
SB
SO
ZA
GS
ES
LK
SD
SR
SJ
SZ
SE
CH
SY
TW
TJ
TZ
TH
TL
TG
TK
TO
TT
TN
TR
TM
TC
TV
UG
UA
AE
GB
US
UM
UY
UZ
VU
VE
VN
VG
VI
Country Name
Slovenia
Solomon Islands
Somalia
South Africa
South Georgia and
The South Sandwich Islands
Spain
Sri Lanka
Sudan
Suriname
Svalbard and Jan Mayen
Swaziland
Sweden
Switzerland
Syrian Arab Republic
Taiwan, Province of China
Tajikistan
Tanzania, United Republic of
Thailand
Timor-Leste
Togo
Tokelau
Tonga
Trinidad and Tobago
Tunisia
Turkey
Turkmenistan
Turks and Caicos Islands
Tuvalu
Uganda
Ukraine
United Arab Emirates
United Kingdom
United States
United States Minor
Outlying Islands
Uruguay
Uzbekistan
Vanuatu
Venezuela
Viet Nam
Virgin Islands, British
Virgin Islands, U.S.
7/09/2012
Forward
Origin
Return
Origin
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Page 293
Country
Code
WF
EH
YE
ZM
ZW
Country Name
Wallis and Futuna
Western Sahara
Yemen
Zambia
Zimbabwe
7/09/2012
Forward
Origin
Return
Origin
Page 294
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
Afghanistan
Albania
Algeria
American Samoa
Andorra
Angola
Anguilla
Antigua And Barbuda
Argentina
Armenia
Aruba
Australia
Austria
Azerbaijan
Bahamas
Bahrain
Bangladesh
Barbados
Belarus
Belgium
Belize
Benin
Currency Name
Afghani
Lek
Algerian Dinar
US Dollar
Euro
Kwanza
East Caribbean Dollar
Argentine Peso
Armenian Dram
Aruban Guilder
Australian Dollar
Euro
Azerbaijanian Manat
Bahamian Dollar
Bahraini Dinar
Taka
Barbados Dollar
Belarussian Ruble
Euro
Belize Dollar
CFA Franc BCEAO
Currency Code
AFN
ALL
DZD
USD
EUR
AOA
XCD
XCD
ARS
AMD
AWG
AUD
EUR
AZN
BSD
BHD
BDT
BBD
BYR
EUR
BZD
XOF
Bermuda
Bhutan
Bhutan
Bolivia
Bolivia
Bosnia and Herzegovina
Botswana
Bouvet Island
Brazil
Bermudian Dollar
(customarily known as
Bermuda Dollar)
Indian Rupee
Ngultrum
Boliviano
Mvdol
Convertible Marks
Pula
Norwegian Krone
Brazilian Real
BMD
INR
BTN
BOB
BOV
BAM
BWP
NOK
BRL
Page 295
British Indian Ocean
Territory
Brunei Darussalam
Bulgaria
Burkina Faso
Burundi
Cambodia
Cameroon
Canada
Cape Verde
Cayman Islands
Central African Republic
Chad
Chile
Chile
China
Christmas Island
Cocos (Keeling) Islands
Colombia
Colombia
Comoros
Congo
Congo, The Democratic Republic of
Cook Islands
Costa Rica
Côte Divoire
Croatia
Cuba
Cyprus
Czech Republic
Denmark
Djibouti
Dominica
Dominican Republic
Ecuador
Egypt
El Salvador
El Salvador
Equatorial Guinea
Eritrea
Estonia
Ethiopia
Falkland Islands (Malvinas)
Faroe Islands
Fiji
Finland
7/09/2012
US Dollar
Brunei Dollar
Bulgarian Lev
CFA Franc BCEAO
Burundi Franc
Riel
US Dollar
Canadian Dollar
Cape Verde Escudo
Cayman Islands Dollar
CFA Franc BEAC
CFA Franc BEAC
Chilean Peso
Unidades de formento
Yuan Renminbi
Australian Dollar
Australian Dollar
Colombian Peso
Unidad de Valor Real
Comoro Franc
CFA Franc BEAC
Franc Congolais
New Zealand Dollar
Costa Rican Colon
CFA Franc BCEAO
Croatian Kuna
Cuban Peso
Euro
Czech Koruna
Danish Krone
Djibouti Franc
Dominican Peso
US Dollar
Egyptian Pound
El Salvador Colon
US Dollar
CFA Franc BEAC
Nakfa
Euro
Ethiopian Birr
Falkland Islands Pound
Danish Krone
Fiji Dollar
Euro
USD
BND
BGN
XOF
BIF
KHR
USD
CAD
CVE
KYD
XAF
XAF
CLP
CLF
RMB
AUD
AUD
COP
COU
KMF
XAF
CDF
NZD
CRC
XOF
HRK
CUP
EUR
CZK
DKK
DJF
XCD
DOP
USD
EGP
SVC
USD
XAF
ERN
EUR
ETB
FKP
DKK
FJD
EUR
Page 296
France
French Guiana
French Polynesia
French Southern Territories
Gabon
Gambia
Georgia
Germany
Ghana
Gibraltar
Greece
Greenland
Grenada
Guadeloupe
Guam
Guatemala
Guernsey
Guinea
Guinea-Bissau
Guinea-Bissau
Guyana
Haiti
Haiti
Heard Island ond
Mcdonald Islands
Holy See (Vatican
City State)
Honduras
Hong Kong
Hungary
Iceland
India
Indonesia
Iran (Islamic Republic of)
Iraq
Ireland
Israel
Italy
Jamaica
Japan
Jersey
Jordan
Kazakhstan
Kenya
Kiribati
7/09/2012
Euro
Euro
CFP Franc
Euro
CFA Franc BEAC
Dalasi
Lari
Euro
Cedi
Gibraltar Pound
Euro
Danish Krone
Euro
US Dollar
Quetzal
Pound Sterling
Guinea Franc
Guinea-Bissau Peso
CFA Franc BCEAO
Guyana Dollar
Gourde
US Dollar
EUR
EUR
XPF
EUR
XAF
GMD
GEL
EUR
GHS
GIP
EUR
DKK
XCD
EUR
USD
GTQ
GBP
GNF
GWP
XOF
GYD
HTG
USD
Australian Dollar
AUD
Euro
Lempira
Hong Kong Dollar
Forint
Iceland Krona
Indian Rupee
Rupiah
Iranian Rial
Iraqi Dinar
Euro
New Israeli Sheqel
Euro
Jamaican Dollar
Yen
Pound Sterling
Jordanian Dinar
Tenge
Kenyan Shilling
Australian Dollar
EUR
HNL
HKD
HUF
ISK
INR
IDR
IRR
IQD
EUR
ILS
EUR
JMD
JPY
GBP
JOD
KZT
KES
AUD
Page 297
Korea, Democratic
Peoples Republic of
Korea, Republic of
Kuwait
Kyrgyzstan
Lao Peoples Democratic
Republic
Latvia
Lebanon
Lesotho
Lesotho
Liberia
Libyan Arab Jamahiriya
Liechtenstein
Lithuania
Luxembourg
Macao
Macedonia, The Former
Yugoslav Republic of
Madagascar
Malawi
Malaysia
Maldives
Mali
Malta
Marshall Islands
Martinique
Mauritania
Mauritius
Mayotte
Mexico
Mexico
Micronesia (Federated
States of)
Moldova, Republic of
Monaco
Mongolia
Montenegro
Montserrat
Morocco
Mozambique
Myanmar
Namibia
Namibia
Nauru
7/09/2012
North Korean Won
Won
Kuwaiti Dinar
Som
KPW
KRW
KWD
KGS
Kip
Latvian Lats
Lebanese Pound
Rand
Loti
Liberian Dollar
Libyan Dinar
Swiss Franc
Lithuanian Litas
Euro
Pataca
LAK
LVL
LBP
ZAR
LSL
LRD
LYD
CHF
LTL
EUR
MOP
Denar
Malagascy Ariary
Kwacha
Malaysian Ringgit
Rufiyaa
CFA Franc BCEAO
Euro
US Dollar
Euro
Ouguiya
Mauritius Rupee
Euro
Mexican Peso
Mexican Unidad de
Inversion (UID)
MKD
MGA
MWK
MYR
MVR
XOF
EUR
USD
EUR
MRO
MUR
EUR
MXN
US Dollar
Moldovan Leu
Euro
Tugrik
Euro
Moroccan Dirham
Metical
Kyat
Rand
Namibian Dollar
Australian Dollar
USD
MDL
EUR
MNT
EUR
XCD
MAD
MZN
MMK
ZAR
NAD
AUD
MXV
Page 298
Nepal
Netherlands
Netherlands Antilles
New Caledonia
New Zealand
Nicaragua
Niger
Nigeria
Niue
Norfolk Island
Northern Mariana Islands
Norway
Oman
Pakistan
Palau
Panama
Panama
Papua New Guinea
Paraguay
Peru
Philippines
Pitcairn
Poland
Portugal
Puerto Rico
Qatar
Réunion
Romania
Russian Federation
Rwanda
Saint Helena
Saint Kitts and Nevis
Saint Lucia
Saint Pierre and Miquelon
Saint Vincent and The
Grenadines
Samoa
San Marino
São Tome and Principe
Saudi Arabia
Senegal
Serbia
Seychelles
Sierra Leone
Singapore
7/09/2012
Nepalese Rupee
Euro
Netherlands Antillian
Guilder
CFP Franc
New Zealand Dollar
Cordoba Oro
CFA Franc BCEAO
Naira
New Zealand Dollar
Australian Dollar
US Dollar
Norwegian Krone
Rial Omani
Pakistan Rupee
US Dollar
Balboa
US Dollar
Kina
Guarani
Nuevo Sol
Philippine Peso
New Zealand Dollar
Zloty
Euro
US Dollar
Qatari Rial
Euro
New Leu
Russian Ruble
Rwanda Franc
Saint Helena Pound
Euro
ANG
XPF
NZD
NIO
XOF
NGN
NZD
AUD
USD
NOK
OMR
PKR
USD
PAB
USD
PGK
PYG
PEN
PHP
NZD
PLN
EUR
USD
QAR
EUR
RON
RUB
RWF
SHP
XCD
XCD
EUR
Tala
Euro
Dobra
Saudi Riyal
CFA Franc BCEAO
Serbian Dinar
Seychelles Rupee
Leone
Singapore Dollar
XCD
WST
EUR
STD
SAR
XOF
RSD
SCR
SLL
SGD
NPR
EUR
Page 299
Slovakia
Slovenia
Solomon Islands
Somalia
South Africa
Spain
Sri Lanka
Sudan
Suriname
Svalbard and Jan Mayen
Swaziland
Sweden
Switzerland
Switzerland
Switzerland
Syrian Arab Republic
Taiwan, Province of China
Tajikistan
Tanzania, United Republic
of
Thailand
Timor-Leste
Togo
Tokelau
Tonga
7/09/2012
Euro
Euro
Solomon Islands Dollar
Somali Shilling
Rand
Euro
Sri Lanka Rupee
Sudanese Dinar
Surinam Dollar
Norwegian Krone
Lilangeni
Swedish Krona
Swiss Franc
WIR Franc
WIR Euro
Syrian Pound
New Taiwan Dollar
Somoni
EUR
EUR
SBD
SOS
ZAR
EUR
LKR
SDD
SRD
NOK
SZL
SEK
CHF
CHW
CHE
SYP
TWD
TJS
TZS
THB
USD
XOF
NZD
TOP
Trinidad And Tobago
Tunisia
Turkey
Turkmenistan
Turks And Caicos Islands
Tuvalu
Uganda
Ukraine
United Arab Emirates
United Kingdom
United States
United States Minor Outlying Islands
Uruguay
Tanzanian Shilling
Baht
US Dollar
CFA Franc BCEAO
New Zealand Dollar
Paanga
Trinidad and Tobago
Dollar
Tunisian Dinar
New Turkish Lira
Manat
US Dollar
Australian Dollar
Uganda Shilling
Hryvnia
UAE Dirham
Pound Sterling
US Dollar
US Dollar
Peso Uruguayo
TTD
TND
TRY
TMM
USD
AUD
UGX
UAH
AED
GBP
USD
USD
UYU
Uruguay
Uzbekistan
Vanuatu
Venezuela
Viet Nam
Uruguay Peso en
Unidades
Indexadas
Uzbekistan Sum
Vatu
Bolivar
Dong
UYI
UZS
VUV
VEB
VND
Page 300
7/09/2012
Virgin Islands (British)
Virgin Islands (US)
Wallis And Futuna
Western Sahara
US Dollar
US Dollar
CFP Franc
Moroccan Dirham
USD
USD
XPF
MAD
Yemen
Zambia
Zimbabwe
Yemeni Rial
Kwacha
Zimbabwe Dollar
YER
ZMK
ZWD
Page 301
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.
Description
UPS Express
UPS ExpeditedSM
UPS Standard
UPS Worldwide Express PlusSM
UPS Saver
UPS Today StandardSM
UPS Today Dedicated CourrierSM
UPS Today Express
UPS Today Express Saver
UPS Express
UPS Worldwide ExpeditedSM
UPS Standard
UPS Three-Day Select®
UPS Express Early A.M. SM
UPS Saver SM
UPS Express
UPS Express
UPS ExpeditedSM
UPS Standard
UPS Express Plus
UPS Saver
UPS Express
UPS Standard
UPS Saver
UPS Next Day Air®
UPS Second Day Air®
UPS Ground
UPS Worldwide ExpressSM
UPS Next Day Air® Early A.M. SM
UPS Saver
UPS Express
Category
Polish Domestic Shipments
Shipments Originating in Canada
to the United States
Shipments Originating in Mexico
Shipments Originating in Other Countries
Shipments Originating in Puerto Rico
Shipments Originating in the European Union
Shipping
Service
Code
07
08
11
54
65
82
83
85
86
01
08
11
12
14
65
Rating
Service
Code
07
08
11
54
65
82
83
85
86
01
02
11
12
14
13
01
07
08
11
54
65
07
08
11
54
65
01
02
03
07
08
14
54
65
07
07
07
08
11
54
65
07
08
11
54
65
01
02
03
07
08
14
54
65
07
Page 302
UPS ExpeditedSM
UPS Standard
UPS Saver
UPS Next Day Air®
UPS Ground
UPS Worldwide ExpressSM
UPS Standard
UPS Second Day Air A.M.®
UPS Saver
UPS Next Day Air®
UPS Ground
UPS Next Day Air Saver®
UPS Second Day Air A.M.®
UPS Saver
7/09/2012
Shipments Originating in United States
United States Domestic Shipments
08
11
54
65
01
02
03
07
08
11
12
14
54
59
65
01
02
03
12
13
14
59
65
08
11
54
65
01
02
03
07
08
11
12
14
54
59
65
01
02
03
12
13
14
59
65
Page 303
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
AJ
AT
BM
9V
ON
DP
3Q
IK
MK
MJ
PM
PC
PO
RQ
RZ
SA
SE
ST
TN
EI
TJ
SY
Description
Accounts Receivable Customer Account
Appropriation Number
Bill of Lading Number
Collect on Delivery (COD) Number
Dealer Order Number
Department Number
Food and Drug Administration (FDA) Product Code
Invoice Number
Manifest Key Number
Model Number
Part Number
Production Code
Purchase Order Number
Purchase Request Number
Return Authorization Number
Salesperson Number
Serial Number
Store Number
Transaction Reference Number
Employer’s ID Number
Federal Taxpayer ID No.
Social Security Number
Page 304
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
A
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
agricultural good, see also criterion F and Annex 703.2. (Reference: Article 401(a) and 415)
B
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
Annex 703.2. (Reference: Article 401(b))
C
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
401(c).
D
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.
(Reference: Article 401(d))
E
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
and is common to all NAFTA countries. (Reference: Annex 308.1)
Page 305
Criteria
F
7/09/2012
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
not a quantitative restriction
Page 306
7/09/2012
Appendix J- Hong Kong District Codes
The following table lists the codes UPS uses to represent Hong Kong districts.
Code
SD1
AD
SD2
CB
CD
KT1
CW1
CLK1
ISL1
CSW
CH
SD3
DH
SD4
ISL2
FL
NP1
ST1
HV
HMT
HH
JD
NT1
WD1
KLB
KLC
KLT
KC1
KC2
KC3
KT2
LCK1
LCK2
LT3
ISL3
ISL4
LF1
ST2
LCK3
SD5
District
ABERDEEN
ADMIRALTY
AP LEI CHAU
CAUSEWAY BAY
CENTRAL
CHA KWO LING
CHAI WAN
CHAK LAP KOK
CHEUNG CHAU
CHEUNG SHA WAN
CHOI HUNG
CHUNG HOM KOK
DAIMOND HILL
DEEP WATER BAY
DISCOVERY BAY
FANLING
FORTRESS HILL
FOTAN
HAPPY VALLEY
HO MAN TIN
HUNGHOM
JORDAN
KAM TIN
KENNEDY TOWN
KOWLOON BAY
KOWLOON CITY
KOWLOON TONG
KWAI CHUNG
KWAI FONG
KWAI HING
KWUN TONG
LAI CHI KOK
LAI KING
LAM TIN
LAMMA ISLAND
LANTAU ISLAND
LOK FU
MA ON SHAN
MEI FOO
MIDDLE BAY
Page 307
Code
ML1
MK1
WD2
NTK
NP2
ISL5
SD6
MK2
QB
SD7
SK
WD3
SWH
WD4
SPK
SS1
SSP
NT2
ST3
SKW
SKM
NT4
SD8
WD5
SS2
SW
SL
ST4
CW2
SD9
SD10
SD11
ML2
TKT
NT5
TP
SD12
ST5
NT6
ML3
NP3
NT7
SD13
TKW
TKO
7/09/2012
District
MID-LEVEL
MONGKOK
MOUNT DAVIS
NGAU TAU KOK
NORTH POINT
PING CHAU
POK FU LAM
PRINCE EDWARD
QUARRY BAY
REPULSE BAY
SAI KUNG
SAI WAN
SAI WAN HO
SAI YING PUN
SAN PO KONG
SHA TAU KOK
SHAM SHUI PO
SHAM TSENG
SHATIN
SHAU KEI WAN
SHEK KIP MEI
SHEK KONG
SHEK O
SHEK TONG TSUI
SHEUNG SHUI
SHEUNG WAN
SHUN LEE
SIU LEK YUEN
SIU SAI WAN
SOUTH BAY
SOUTHERN DISTRICT
STANLEY
TAI HANG
TAI KOK TSUI
TAI LAM CHUNG
TAI PO
TAI TAM
TAI WAI
TAP SHEK KOK
THE PEAK
TIN HAU
TIN SHUI WAI
TIN WAN
TO KWA WAN
TSEUNG KWAN O
Page 308
Code
TST1
TST2
NT8
TY
TW
TWS
NT9
CLK2
SD14
WC
LF2
WD6
SD15
WTS
YMT
KT3
NT10
7/09/2012
District
TSIM SHA TSUI
TSIM SHA TSUI EAST
TSING LUNG TAU
TSING YI
TSUEN WAN
TSZ WAN SHAN
TUEN MUN
TUNG CHUNG
WAH FU
WANCHAI
WANG TAU HOM
WESTERN DISTRICT
WONG CHUK HANG
WONG TAI SIN
YAU MA TEI
YAU TONG
YUEN LONG
Page 309
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
AGR
APR
AVS
BAG
CIV
CTP
ENC
GBS
GFT
GOV
KMI
LVS
NLR
RPL
TMP
TSPA
TSR
TSU
License Exception
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.
Items for export or re-export not controlled for
nuclear nonproliferation, missile technology or crime control.
U.S. aircraft or foreign sojourn into foreign country.
Individual or exporting carriers crew members baggage.
National security items for civil end users.
Computer and parts of.
Encrypted software and hardware - financial institutions.
Export or re-export of Country Group B; controlled
for national security reasons.
Gift shipments; packages to individuals, religious,
charitable or education institutions, donations of basic needs.
Government shipments, covers shipments for U.S.
government agencies, personnel or of cooperating foreign governments
Encrypted software and hardware.
Value of shipments limited.
No license required.
Servicing and replacement of parts and equipment, one
for one replacement parts service or replacement of equipment.
Temporary exports, export and re-export of items
temporary in U.S., export and re-export of beta test software.
Software or technology outside the scope of export
regulations.
Technology and software, national security reason,
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
update for fixing programs, mass marketed software.
Page 310
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
Page 311
7/09/2012
Figure2. Sample Return Label
Page 312
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
shipment level void request.
1Z2220060291994175
package level void request. The request will void the
package in the shipment.
1Z2220060292002190
package level void request. The request will void the
package in the shipment.
1ZISDE016691609089 with Tracking Numbers
1ZISDE016694068891 and 1ZISDE016690889305
package level void request. The request will void all the
packages
1Z2220060290530202 with Tracking Number
1Z2220060293874210 and 1Z2220060292634221
A successful XML response will be returned with a
partial void for a package level void request. The request
will void package 1Z2220060293874210 but package
1Z2220060292634221 cannot be voided.
Page 313
7/09/2012
Appendix N- Valid Language-Dialect combination for
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
Page 314
7/09/2012
Appendix O – Valid Origin/Destination Combinations: for DC, DCSR, 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
P
P
P
US50, PR, VI
--
S
S
Intl (not US, PR, VI)
--
S
S
PR, US50
P
P
P
CA, VI
--
S
S
Intl (not US, CA, VI)
--
S
S
Intl (natl, transborder,
worldwide) – per Mktg
validation tables
--
S
S
CA
PR
Intl RAVE-supported origin countries
(not US, PR, CA, VI; see list below)
S = shipment-level accessorial; P= package-level accessorial. All the origin/destination pairs
valid for forward shipments only.
Page 315
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
Page 316
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
US
CA
CA
CA
PR
PR
CA
MX
US
PR
MX
CA
MX
Page 317
7/09/2012
Appendix R- License exception code Possible values: Shipping API –
Package
Values
AGR
APR
AVS
BAG
CIV
CTP
ENC
GBS
GFT
GOV
KMI
LVS
NLR
RPL
TMP
TSPA
TSR
TSU
Description
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.
Items for export or re-export not controlled for nuclear nonproliferation, missile technology
or crime control.
U.S. aircraft or foreign sojourn into foreign country.
Individual or exporting carrier's crew member's baggage.
National security items for civil end users.
Computer and parts of.
Encrypted software and hardware - financial institutions.
Export or re-export of Country Group B; controlled for national security reasons.
Gift shipments; packages to individuals, religious, charitable or education institutions,
donations of basic needs.
Government shipments, covers shipments for U.S. government agencies, personnel or of
cooperating foreign governments.
Encrypted software and hardware.
Value of shipments limited.
No license required.
Servicing and replacement of parts and equipment, one for one replacement parts service or
replacement of equipment.
Temporary exports, export and re-export of items temporary in U.S., export and re-export of
beta test software.
Software or technology outside the scope of export regulations.
Technology and software, national security reason, 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 update for fixing programs, mass
marketed software
Page 318
7/09/2012
Appendix S - Frequently Asked Questions: Shipping API – Package
API
Shipping
Category
Account Based
Rates (ABR) or
Negotiated Rates
Question
Do the Developer
APIs support ABR
also known as
Negotiated Rates?
How do get access
to negotiated
Package rates?
Answer
Yes. Shipping and Rating APIs both XML & Web Services
support Negotiated Rates
To streamline your ability to view your negotiated rates through the
[Shipping/Rating] API UPS has implemented a new process that no
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.
Use the NegotiatedRatesIndicator within the API request to view
your Negotiated rates and the customer was set up by their UPS
Account Rep for negotiated (Account Base rates).
Shipping
Negotiated Rates
Shipping
Negotiated Rates
Shipping
Ground Freight
Pricing (GFP)
Shipping
Duty & Taxes
How do you bill a
3rd Party for Duty
& Taxes?
In order to bill a 3rd Party for D&T, use the noted tags in your
request:
<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
Billing
Does the Shipping
API support ScanBased Billing
Yes, it is supported by default meaning if they are not tendered to
UPS they are not billed.
What flags are
needed to return
Negotiated rates in
the request
Are dimensions
required for GFP
Currently dimensions are not applicable to Ground Freight Pricing
Page 319
API
Shipping
Category
Third
Party/Freight
Collect Shipment
Shipping
Address
Validation
Shipping
Address
Validation
Shipping
Shipping
Shipping
Shipping
Address
Validation
Rural & Super
Rural
UPS Account
International
Commodities
Question
Does the Ship API
validate account
numbers when
shipping Third
Party and Freight
Collect?
How do I turn off
validation of
addresses with the
Shipping API?
Will the Shipping
API provide
validation for
Japanese
addresses with
City and Country
and no zip code?
What validation is
the Shipping API
using to validate
addresses for US
and International
addresses?
Does the Shipping
API - Package
return Rural and
Super Rural
charges?
How do I add a
UPS account to
myUPS ID
account summary?
It is stating that I
have to have an
invoice # and
control ID.
Is there a limit of
the number of line
items for the
Commercial
Invoice?
7/09/2012
Answer
Yes, it validates if the account is active, valid for Manage Inbound
charges and the postal code of the account billed
The value within the "ShipmentRequest/Request/RequestOption"
tag of the request needs to be "nonvalidate".
No, the postal code must be included for validation.
Shipping API does not do ANY address validation at the street
level. Only regional validation; city, state, country (postal code
optional).
Yes the Shipping API will return rural and super rural charges.
These charges will automatically be applied to the transportation
charge portion of the rate
As a means of securing customer information, when adding an
account to their My UPS profile or enroll for electronic billing
options or Quantum View, customers are currently prompted to
authenticate their account by entering an invoice number, invoice
amount, and the invoice date from one of their last three billing
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
Yes, when using international forms only 50 line items
(commodities) can be associated per shipment using the Shipping
API.
Page 320
API
Shipping
Category
HazMat - Dry Ice
Shipping
99 Account
Number
Limitation
Shipping
Proactive
Response
Shipping
Delivery
Intercept
Shipping
Shipping
Shipping
Shipping
Shipper Release
Resi/Comm
Indicator
Returns
Returns
Question
Does the Shipping
API for Package
support the Dry
Ice indicator?
How do I
associate more
than 99 account
numbers for use
with the Shipping
APIs?
Is Proactive
Response
Supported?
Is UPS Delivery
Intercept available
through the
Shipping API?
Is Shipper Release
available with the
Shipping API?
Does the Shipping
API classify
addresses as
residential or
commercial?
Is there a URL
ONLY capability
for returns within
the Shipping API?
Can a Return be
voided? If yes,
what is the cutoff
timing to void a
return?
7/09/2012
Answer
Yes, effective with the July 2011 release, the Shipping API will
support Dry Ice, as long as; it does not include any other Hazmat
materials in the shipment and meets the requirements. Please refer
to UPS.com for more information.
99 accounts is currently the maximum number available. If the user
has more than 99 accounts they must be spread across multiple
UserIds.
No, the Shipping API does not support Proactive Response
No, it is not currently supported.
Yes.
The Shipping API will classify an address based on UPS” history
for that address and the appropriate rate will be returned in the
response
No.
A customer can void an RS label up to 2am/3am Eastern Time the
following night (e.g. Monday request, Tuesday 2am/3am void
cutoff). This is based on when our batch process starts sending
RS1/RS3 labels to the centers. After the cutoff, the customer will
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
returns and returns
in international
countries where
the Shipping API
is supported?
Yes. Please see the UPS Developer’s Guide for the specific
countries supported
Page 321
API
Shipping
Category
Print Return
Labels
Shipping
UPS Return
Labels
Shipping
Returns
Shipping
Shipping
Shipping
Electronic Return
Label Days
Available
Returns
128 Reference
Number Barcode
Question
For the print
return label
option, if a Yahoo
merchant needs to
reprint the return
label, how much
time does he
have? Is it 10
days after the
initial request?
Does UPS charge
the accessorial fee
for a return label
when using the
API?
Does the Shipping
API - Package
support Returns
capabilities?
Does the customer
have to utilize the
label recovery
capability within
the Ship API to
reprint an
electronic return
label? Either way,
how many days is
the label available
to reprint?
Are the Returns
capabilities the
same within the
Web Service
versus XML
versions of the
Shipping API Package?
Can the Shipping
API - Package
generate a 128
Reference number
barcode below the
1Z? Can it
generate a
PDF417
Reference number
barcode below the
1Z?
7/09/2012
Answer
UPS does not provide a mechanism to "reprint" a Print Return
Label (PRL) the vendor must save the label locally if they wish to
reprint. Only the ERL (Electronic Return Label) option provides
that capability.
Yes, the customer will be charged the accessorial fee once they
request a return label.
Yes.
Yes, effective with the July 2010 Release, the time limit for
retrieving an Electronic Return Label has been extended to 30 days.
The prior limit was 10 days. This is noted in the latest Shipping
Developers Guide. An Electronic Return Label is specified by
using Shipment/ReturnService/Code “8” in the Shipment Confirm
Request. The ERL email will contain a link to the label so the
recipient can print the label to attach to a package.
Yes. The Returns capabilities are the same.
Yes. A 128 Reference number barcode can be generated below the
1z number, as the Shipping API can print a barcode in reference
field 1. The Shipping API - Package does not create a PDF417 as
they are not required. The purpose of the PDF417 was as a backup
in case the PLD did not transmit from a shipping system. That is
not possible with the Shipping API - Package because a label is
only returned after the receipt of PLD.
Page 322
API
Shipping
Shipping
Shipping
Shipping
Category
Currency
Conversion
From Suite/Apt#
on Label
High Value
Report
Pickup request
Question
Does the Shipping
API - Package
support
conversion of
Japanese Yen to
US Dollars?
How does a
customer include
the Suite/Apt#
within "From"
address on the
label returned for
the Shipping API Package?
How does the
Shipping API Package work
with High Values?
Does the
paperwork
comeback as a
GIF image and get
printed on a
thermal printer?
Or, does the
customer need to
produce these
themselves?
Can a Pickup be
requested through
7/09/2012
Answer
No. The Shipping API - Package does not support currency
conversions.
The customer needs to include the suite/apt # in delivery address
lines 2 or 3 within the request.
The High Value Report is returned in the response in one of the
supported formats specified by the developer. In each case it will
be a Base64 encoded file that must be decoded and printed. 2
copies should be printed, both will be signed by the driver and the
driver will leave one copy as a receipt. The file, once decoded is a
simple HTML file that can be printed locally
No. All pickup requests must be made through the Pickup web
service. Details are available at the Developer resource center on
ups.com at: https://www.ups.com/upsdeveloperkit.
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
provide a label
and receipt but
does not email a
receipt for the user
nor provide a
confirmation
number?
The output of the Shipping API is a label. There is no receipt
provided. In addition, Ship API only provides the ability to have
the label emailed with the ERL (Electronic Return Label) service
and not for forward shipments
Page 323
API
Shipping
Category
Commerical
Invoice
Shipping
Reprinting Labels
Question
Can a API
customer export
shipments to print
a copy of the
commercial
invoice after the
fact?
Can a customer
using the Shipping
API reprint a
label?
Shipping
Oracle
Are there any
known issues with
implementing
Oracle with the
Does the Shipping
API support Trade
Direct?
Shipping
Trade Direct
Shipping
Paperless Invoice
Does the Shipping
API - Package
support Paperless
Invoice?
Shipping
Paperless Invoice
voids
Shipping
Paperless Invoice
Shipment
Can a Paperless
Invoice shipment
be voided through
the Shipping API Package? If yes,
what happens to
the invoice
information?
How does
Paperless Invoice
work in terms of
the documentation
being forwarded?
7/09/2012
Answer
The API will return a commercial invoice as part of the response
file. Therefore, the customer must save the image from the
response file to retrieve it later. If they didn’t save the response
then the API does not store it for retrieval.
No, at this time the Shipping API does not provide the ability to
reprint labels.
UPS is not aware of any issues customers have implementing the
Shipping API - Package using Oracle at this time. The UPS
Developer APIs are designed so that they can be implemented in
almost any environment as long as the customer application can
open a secure connection of SSL and perform an HTTP Post.
No, the Shipping API does not support Trade Direct shipments.
Yes. The developer guide for the Shipping API - Package lists the
valid countries for paperless invoice. See the
AdditionalDocumentIndicator Element within the Interface Spec
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.
Yes a Paperless Invoice shipment can be voided via the Shipping
API - Package. If a shipment is voided and consequently the
package is never tendered to UPS, then the paperless invoice data
that was uploaded with the shipment is not used to create an
invoice image and it is eventually purged.
Those customers setup for paperless invoicing shipping
internationally to a paperless supported country with the necessary
data for paperless will have the invoice automatically sent to
brokerage.
Page 324
API
Shipping
Category
Paperless Invoice
Conditions
Question
What are the preconditions
required for a
customer to be set
up on Paperless
Invoice?
Shipping
Ref Number 1 Text Values on
Label
Can a customer
implementing the
Shipping API Package "rename"
reference value
one through the
API
Does the Shipping
API support
Batch?
How do you
indicate the "Ship
TO" as
residential?
How are voids
processed?
Shipping
Batch Processing
Shipping
Resi/Comm
Indicator
Shipping
Voids
7/09/2012
Answer
The process to support Paperless Invoice using the Shipping API
are listed below:
1. The Sold To country must be the same as the Ship To country.
2. The customer must have a paperless invoice contract and be set
up in UPS back end systems. (The UPS Account Manager should
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.
No, The reference field descriptions cannot be modified at this
time. You must use one of the values provided in the Developer’s
Guide.
No, the Shipping API only supports transactional requests.
Use the ResidentialAddress element outlined within the Shipping
API - Package developer guide.
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.
Page 325
API
Shipping
Category
Tracking
Numbers
Shipping
UPS World Ease
Shipping
International
Forms
Shipping
Shipper's Export
Declaration
(SED)
Shipping
Label
Shipping
Shipping
Maximum
Packages within
a shipment
CWT and
Shipping API
Question
Can a customer
create their own
tracking numbers
using the Shipping
API - Package?
Does the Shipping
API - Package
support UPS
World Ease?
Does the Shipping
API - Package
support
international
forms?
Does the customer
has to complete
their SED filing or
is there an option
for UPS to do that
for the customer
via the Shipping
API?
Does the Web
Services version
of the Shipping
API - Package
behave differently
in rendering a
label than the
XML version of
Is there a
difference
between the
Shipping API Package Web
Service versus
XML versions in
the number of
packages that can
be included within
a forward
movement?
Is there a solution
using the ship API
(or other solution)
that would prompt
7/09/2012
Answer
No…a customer cannot create their own tracking numbers using
the Shipping API - Package. The tracking numbers will be
automatically created and returned in the response
No…the Shipping API - Package does not support UPS World
Ease at this time.
Yes.
Yes, the customer has to complete their own filing and you can
identify it has been filed in your request but the Shipping API does
not provide an option UPS to file a customer's SED.
The Web Services Shipping API - Package behaves similarly as the
XML Shipping API - Package in that the label elements returned in
the Shipment Accept response consist of two parts, both of which
are base64 encoded data which must be decoded. Part one consists
of the label image and part two contains the HTML which is used
to properly size the label image in a browser for display and
printing. When the two parts are combined they form a unit which
will satisfy the requirements for printing a proper label to apply to
a package. This ensures the label will meet the standards necessary
for UPS to scan and process the label within the shipping system.
There is no difference between the Shipping XML Tool and Web
Service Tool regarding the maximum number of packages allowed
for forward movements. The Web Service Developer Guide
indicates 200 is the maximum.
No, there is no solution in place for the Ship API.
In order to obtain the CWT price with the Ship API, the pkgs.
would have to be processed as one shipment, the UserId being used
Page 326
API
Category
Shipping
Reference
Number Rules
Shipping
Labeling
Shipping
Label Reference
Number
Shipping
Certification
Shipping
Signature
Required
Question
UPS billing or
PLD upload or
other to aggregate
single piece
packages into
hundredweight
pricing (shipment)
after the package
has been
processed?
What does the
Shipping API Package support
in terms of
Reference
Numbers?
Does the Shipping
API support ASC
BIO labels like
WorldShip does?
Can any of the
reference fields be
blocked from
printing on the
label through a
Shipping API?
What is required
to certify for the
Does the Shipping
API - Package
support Signature
Required service?
7/09/2012
Answer
must be ABR enabled and you must include the
<NegotiatedRatesIndicator> tags to receive the Hundredweight
rates.
Supports Two Shipment Level Reference Numbers or two package
level reference numbers You cannot use the Shipment Level and
Package Level Reference numbers at the same time within a SHIP
API shipment.
Shipment Level Reference Numbers are only allowed for
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.
The Ship API does not support ASC BIO on the label it is a
contract service that is not supported by the Shipping
At this time we are unaware of a facility which suppresses
reference number printing on the label when they are included in
the shipment data. However, please note that reference numbers are
not required and may be omitted if there is no need for them.
Please review the Customer Integration Environment section of
UPS Developer’s Guide for certification requirements. Essentially
UPS needs to see the source XML and copies of your labels to
certify you.
Yes.
Page 327
API
Shipping
Category
Future Date
Shipping
Shipping
Security for
Credit cards
All
General - security
All
API availability
All
Mail Innovations
All
UPS Logos High
Resolution
All
Technical
Support email
form
All
Technical
Support
All
Characters
Question
Is there a future
date shipping
capability within
Please describe
the security on the
UPS web server?
Is the credit card
information
submitted over an
encrypted (secure)
connection?
Does UPS support
chained or
unchained digital
certificates?
Within what
countries are the
Developer APIs
available?
Is Mail
Innovations
available within
any of the
Developer APIs?
How do I get
access to higher
resolution logos
than what are
available within
the downloads for
the UPS
Developer Kit Developer APIs?
Is XPCI a required
field within the
email support
form?
How do I get
technical support
for the APIs at
ups.com?
Can Japanese
Kanji character be
recognized by
UPS Developer
APIs?
7/09/2012
Answer
No. We do not support future date shipping. All packages are
considered tendered on the date of their transaction.
Yes, we use 128 bit encryption for all aspects of the APIs. In
addition credit card information is “tokenized” once we receive it,
so we never store it in plain text
Yes, we support chained digital certificates.
The Developer APIs are available in the countries listed at ups.com
by API and by country under the UPS Developer Resource center
located at: https://www.ups.com/upsdeveloperkit
No, Mail Innovations is not available within a Developer API.
Customers are not routinely provided these UPS shield graphics
without having a design/layout submitted to UPS Brand
Management for approval.
The customer needs to visit:
https://www.upsbrandexchange.com/brandHome.awsp
This site will take them through the process for downloading a
limited set of sample images for layout, and how to secure an
approval for customer use, as well as the high-resolution graphics.
No. it is not required.
Go to the Developer Resource Center and select email support
under the UPS Developer Kit Support Column (link noted):
http://www.ups.com/content/us/en/resources/techsupport/developer
center.html
No.
Page 328
API
All
Category
Basic
All
ASMX
All
Pointing to the
wrong URL for
API
Question
Do any of the
Developer APIs
support Basic
service?
Are the Web
Services versions
of the APIs
ASMX based?
I keep getting,
"XML document
is well formed but
the document is
not valid." error
message. What
am I doing
wrong?
7/09/2012
Answer
No. Basic is not supported within the Shipping API.
No. All Web Services are XML based. This is described in the
section 'UPS OnLine API Technologies' of every developer's guide
The "XML document is well formed but the document is not valid"
error message is generally returned when an element in the XML
request does not adhere to the formatting defined within the Xpath
section of that API's developer guide. When the API returns this
error it indicates the field which is not valid in the
ErrorLocationElementName element in the XML response. When
we test the XML provided by you earlier in this email chain we are
able to receive a successful response.
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
All
Examples of API
Implementations
All
Code languages
supported
All
Password
changes
Is phone support
provided for the
UPS Developer
Kit - Developer
APIs? If so, what
is the number and
what are the hours
of operation?
Are there any
examples of
implementations
that we can review
to understand how
best to utilize the
APIs?
Do the APIs
support PHP or
Perl with code
sample within the
Developer Guides
or the developer
kit zip files?
Are there new
login password
requirements?
Yes. Phone support is provided for basic API questions. This
includes integration questions and production questions. However,
customer's questions that cannot be answered verbally will be
directed to the email support form at ups.com.
Phone Support Hours:
M-F 730am- 9pm EST
Sa-Su 9am - 6pm EST
800-247-9035
No, we do not provide implementation examples.
Yes, We currently support PHP or Perl with sample code.
Yes, for new or updated passwords the following rules apply:
Page 329
API
Category
Question
7/09/2012
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
Page 330

Shipping Package WebServices Developers Guide

Transcription

Similar documents

SHIPPING TO CANADA IS EASY

PDF - Jantzen

TV 3~P-2ts extoll city - Henderson Libraries` Digital Collections

Patriot Preferred Metals Program

for submission of IN Form to HQ

DICOM-NewWebSiteFeatures-jd

Calbag Portland

lri express package service

KN PharmaChain - Kuehne + Nagel UK

success in furniture retail