UPS Shipping XML Tool Shipping API Developers Guide

Below you will find brief information for the Shipping XML Tool. This guide provides comprehensive details for developers looking to integrate UPS shipping, cancellation, and return services directly into their applications or web sites. It covers essential topics such as authentication, working with HTTP, SSL, and XML, and understanding the core shipping services, enabling real-time access to UPS functionalities like label generation and rate verification, ensuring seamless automation of shipment processes.

PDF

Document

UPS OnLine&reg; Tools
Shipping XML Tool
Developers Guide
9 February 2009
UPS OnLine Tools Shipping
Important Information
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.
&copy; Copyright 2009 United Parcel Service of America, Inc. All Rights Reserved.
Trademarks
UPS OnLine&reg; is a registered trademark of United Parcel Service of America, Inc. All other trademarks are the
property of their respective owners.
Some of the UPS corporate applications use U.S. city, state, and postal code information obtained by United Parcel
Service of America, Inc. under a non-exclusive license from the United States Postal Service.
9 February 2009
Page 2
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Important Information
Important Information
UPS OnLine Tools Shipping Tool:
Your development of an application using the UPS OnLine Tools Shipping Tool is 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 OnLine Tools Shipping Tool. For
more information on all requirements for the UPS OnLine Tools Shipping Tool, please refer to the UPS
Technology Agreement or the Customer Technology Agreement.
Key Legal Requirements for UPS OnLine Tools Shipping Tool:
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
OnLine Tools Shipping Tool to third parties, other than to persons having a bona fide interest in such
information (e.g., the shipper, consignee or the third party payer).
UPS Account. You must design your application to only provide a user access to the UPS OnLine Tools
Shipping Tool if the user has a UPS Account. Once the user provides UPS Account credentials, all tendered
shipments manifested through the UPS OnLine Tools Shipping Tool must be billed to (1) Your UPS Account;
or (2) a valid credit card account acceptable to UPS; or (3) a UPS account assigned by UPS to the consignee
(this payment method also known as Freight Collect Billing); or (4) a UPS account assigned by UPS to a
third party who has authorized You to use such UPS account for a tendered shipment (this payment method
also known as Third Party Billing).
Consent to Use of UPS Mark.
•
All screens or forms generated by your application including information received through the
UPS OnLine Tools Shipping Tool 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: &quot;UPS, the UPS brand mark, and the Color Brown are trademarks of United
Parcel Service of America, Inc. All Rights Reserved&quot;. 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.
9 February 2009
Page 3
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
•
Important Information
The UPS Mark may not be combined with any other symbols, including words, logos, icons,
graphics, photos, slogans, numbers or other design elements. A minimum amount of empty
space must surround the UPS Mark separating it from any other object, such as type,
photography, borders, edges, etc. The required area of empty space around the UPS Mark must
be 1/3x, where x equals the height of the UPS Mark.
Copyright and Proprietary Notices. You must include in your application and any POD Letters you prepare
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 OnLine Tools Shipping Tool. Your
application must present all data within each field received through the UPS OnLine Tools Shipping Tool
without amendment, deletion or modification of any type.
9 February 2009
Page 4
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Table of Contents
Important Information ................................................................................................................. 3
Welcome to UPS OnLine&reg; Tools.................................................................................................. 8
How to Use this Guide.............................................................................................................. 8
What's New for July 2008......................................................................................................... 9
Required Steps for Integrating with UPS OnLine Tools...........................................................11
Planning Your Applications ........................................................................................................ 12
OnLine Tools Applications ..................................................................................................... 12
Licensing the UPS OnLine Tools............................................................................................ 13
Branding Requirements.................................................................................................... 13
Developing Client Applications for OnLine Tools ................................................................. 14
Microsoft Visual Studio.................................................................................................... 14
Java Standard Edition and Enterprise Edition .................................................................. 14
Open Source ..................................................................................................................... 14
Getting Technical Support ...................................................................................................... 14
Within the United States................................................................................................... 15
Outside of the United States .............................................. Error! Bookmark not defined.
Testing and Deploying Applications ....................................................................................... 16
UPS Label Certification.......................................................................................................... 16
Keeping Up-to-Date................................................................................................................ 17
UPS OnLine Tools Technologies................................................................................................. 18
Hypertext Transfer Protocol and Secure Sockets Layer 3 ...................................................... 18
Working with HTTP and SSL in Application Programs ......................................................... 19
Microsoft Visual Studio.................................................................................................... 20
Java Standard Edition and Enterprise Edition .................................................................. 20
Open Source ..................................................................................................................... 21
Extensible Markup Language (XML)..................................................................................... 21
Working with XML in Application Programs......................................................................... 23
Microsoft Visual Studio.................................................................................................... 23
Java Standard Edition and Enterprise Edition .................................................................. 24
Open Source ..................................................................................................................... 25
Understanding UPS OnLine Tools Shipping Services.............................................................. 27
What Shipping Services Can Do............................................................................................. 27
Shipments ......................................................................................................................... 27
Cancellations (Voids)........................................................................................................ 27
9 February 2009
Page 5
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Contents
Returns ............................................................................................................................. 27
How Shipping Services Work ................................................................................................. 28
Forward and Return Shipments........................................................................................ 28
Cancellations (Voids)........................................................................................................ 28
Shipping Reference...................................................................................................................... 30
Describing OnLine Tools Messages........................................................................................ 30
Authenticating Client Applications......................................................................................... 30
AccessRequest.................................................................................................................. 30
Forward and Return Shipments .............................................................................................. 31
ShipmentConfirmRequest ................................................................................................ 31
ShipmentConfirmRequest ............................................................................................ 32
ShipmentConfirmResponse............................................................................................ 150
ShipmentConfirmResponse ....................................................................................... 150
ShipmentAcceptRequest ................................................................................................ 150
ShipmentAcceptRequest ............................................................................................ 150
ShipmentAcceptResponse .............................................................................................. 150
ShipmentAcceptResponse......................................................................................... 150
Cancelling Shipments ........................................................................................................... 150
VoidShipmentRequest .................................................................................................... 150
VoidShipmentRequest ................................................................................................ 150
VoidShipmentResponse.................................................................................................. 150
VoidShipmentResponse ............................................................................................. 150
Error Codes ........................................................................................................................... 150
Customer Integration Environment ........................................................................................ 150
Negotiated Rates ................................................................................................................... 150
Shipping ......................................................................................................................... 150
Verifying Shipping Rates ............................................................................................... 150
System Availability ........................................................................................................ 150
Server Availability Check .............................................................................................. 150
Appendix A:
Sample Shipping and Return Labels ............................................................. 150
Appendix B:
Shipping and Tracking Numbers for Void Testing ....................................... 150
Appendix C:
UPS Service Codes........................................................................................... 150
Appendix D:
Reference Number Codes ............................................................................... 150
Appendix E:
Country Codes ................................................................................................. 150
Appendix F:
Currency Codes ............................................................................................... 150
Appendix G:
Export License Exception Codes.................................................................... 150
Appendix H:
International Forms Preference Criteria ...................................................... 150
9 February 2009
Page 6
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix I:
Index
Contents
Countries that Accept Paperless Invoices...................................................... 150
……………………………..150
9 February 2009
Page 7
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Welcome to UPS OnLine&reg; Tools
Welcome to the UPS OnLine Tools Developers Guide. This guide provides the
information you need to begin using UPS OnLine Tools.
The UPS OnLine Tools offer a fast and convenient way to access UPS service
information using the Internet. With these tools, 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.
How to Use this Guide
If you are an experienced developer, you can begin developing applications
quickly after reviewing “Required Steps for Integrating with UPS OnLine Tools”
for a brief overview of the tools.
If you would like a more step-by-step guide to developing and deploying UPS
OnLine Tools, “Planning Your Applications” provides advice and describes
options for developing and deploying applications and web sites that use UPS
OnLine Tools.
The &quot;UPS OnLine Tools Technologies&quot; section explains key technologies on
which the UPS OnLine Tools rely. That section also includes hints for using those
technologies in various software development environments.
If you would like to learn more about what UPS OnLine Tools can do for your
applications, “Understanding UPS OnLine Tools Shipping Services” explains the
services that those tools offer.
For a complete technical reference to the OnLine Tools, “Shipping Reference”
includes a complete programming reference.
Additional material, including reference tables and lists, may be found in the
appendices.
9 February 2009
Page 8
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Welcome to UPS OnLine&reg; Tools
What's New for January 2009
New Functionality for January 2009:
Germany to non-EU export shipments over 100 Euros may require an Export
Accompanying Document (EAD). When the shipper has a Movement
Reference Number for the EAD, the Ship Tool now allows that value to be
entered:
New element: MovementReferenceNumber (See page 83)
New error messages:
120759 (See page 150)
120760 (See page 150)
120761 (See page 150)
New Electronic Return Label Rules for January 2009:
The time limit for retrieving an Electronic Return Label has been extended to
30 days. (The prior limit was 10 days)
New Pickup Rules for January 2009:
Pickups can now be scheduled in Poland, Czech Republic, and Hungary.
New Rating Rules for January 2009:
UPS will apply a minimum billable weight to each package for all non-US
shipment rated services.
UPS will apply a tier specific minimum billable weight per package for US
Domestic Air and Ground Hundredweight Shipments
UPS will now assess an Additional Handling Charge (AHC) globally for all
services, all billing options, and all package movements.
New Address Classification Rules for January 2009:
UPS will now classify full Canadian addresses as well as full US addresses.
Defect Fixes for January 2009:
The description for element “InvoiceLineTotal” has been corrected to remove
the “forward shipment” restriction. (See page 86)
The description for element “ReasonForExport” has been corrected to limit
the allowable values to the set in the description. (See page 131)
9 February 2009
Page 9
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Welcome to UPS OnLine&reg; Tools
The descriptions for AddressLine2 for shipper, ShipTo and ShipFrom have
been clarified. AddressLine2 does NOT appear on the label; however, it is
transmitted to UPS systems.
9 February 2009
Page 10
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Required Steps for Integrating with UPS OnLine Tools
1. Review the UPS Technology Agreement available at www.ups.com. This
agreement requires that you follow certain procedures and practices in using
UPS OnLine Tools.
2. Develop applications that make use of standard HTTP communications
protocols, SSL security, and XML-based document representations.
3. Test your application and/or web site using the designated UPS staging
environment.
4. If you are a UPS Ready developer, review your application with UPS.
5. Obtain UPS Label Certification for your application. (If you are a new
customer or if you haven’t previously certified. Please see the “UPS Label
Certification” section for further details.).
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.
9 February 2009
Page 11
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Planning Your Applications
Planning is a key part of any successful development activity, and UPS OnLine
Tools applications are no exception. This section helps that planning by
describing the important activities of any UPS OnLine Tools 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.
OnLine Tools Applications
Many different types of applications can take advantage of UPS OnLine Tools.
Those application types include dedicated desktop applications, databases, web
applications, and documents. The following figures illustrate some of the
possibilities for applications using UPS OnLine Tools. The only essential
requirement for all of these applications is that they must have access to the
Internet.
UPS
OnLine Tools
Desktop
Applications
Internet
Figure 1: Dedicated applications that users run on their desktops can access UPS
OnLine Tools.
Database
Applications
UPS
OnLine Tools
Database
Clients
Internet
Figure 2: Database applications can access UPS OnLine Tools and return
information to their clients.
9 February 2009
Page 12
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Planning Your Applications
Web Users
UPS
OnLine Tools
Internet
Web Site
Figure 3: Web sites can access UPS OnLine Tools and return information to users'
web browsers.
UPS
OnLine Tools
Internet
Web-Enabled
Document
Figure 4: Non-traditional applications such as Microsoft Office or Adobe Acrobat
documents can use UPS OnLine Tools to automatically update their content.
The UPS OnLine Tools 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 OnLine Tools.
Licensing the UPS OnLine Tools
As part of the UPS Technology Agreement, users of the tools have certain
obligations that are spelled out within the service agreement and its exhibits.
Regardless of the manner in which the UPS OnLine Tools are integrated into
your specific e-commerce web site or enterprise application, you must adhere to
appropriate usage requirements.
Branding Requirements
UPS should receive attribution and branding in all applications (including
websites and software applications) that use the OnLine Tools. No End User,
Third Party Developer or Access User should be permitted to use the OnLine
9 February 2009
Page 13
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Planning Your Applications
Tools without providing branded recognition to UPS. Your use of the UPS logo
can in no way imply endorsement, sponsorship or certification of your ecommerce web site or enterprise application by UPS. You are not allowed to use
or alter the information returned by the UPS OnLine Tools in a way that
misrepresents the information or the functionality of the service.
Developing Client Applications for OnLine Tools
When you develop software that uses the UPS OnLine Tools, you are building a
client application. Because the UPS OnLine Tools rely on standard Internet-based
technology, you can develop those applications using a wide variety of software
development platforms, including Microsoft's Visual Studio, the Java Standard
Edition and Enterprise Edition distributions, and many open source projects. This
section introduces important technologies available in each of these development
environments. Later sections of this document include more details on using each
platform. Look for the icons in the left margin, which identify information
relevant to a particular development environment.
Microsoft Visual Studio
Visual
Studio
Developers using the Microsoft Visual Studio environment can rely on the
Microsoft XML Core Services (MSXML) for interacting with UPS OnLine
Tools. Those services include functions to help applications create requests for
and interpret responses, and they include functions to manage the
communications between applications and UPS.
Java Standard Edition and Enterprise Edition
Java developers can find all the classes they need for UPS OnLine Tools in the
Java Standard Edition and Enterprise Edition distributions. The URL class in the
java.net package provides the functions required for communication with UPS
servers, and the Java API for XML Processing (JAXP) services let programs
create requests and interpret responses from UPS.
Java
Open Source
Open
Source
There are a number of open source efforts that include technology useful for
creating OnLine Tools client applications; open source developers may find two
particular projects to be especially helpful. The libcurl project is a library of
functions that can manage the communications with UPS servers. For creating
requests and interpreting responses, the xerces project provides essential
functions in a variety of software languages.
Getting Technical Support
UPS provides technical support for developers who are using the UPS OnLine
Tools. To get in touch with a UPS technical support engineer, fill out the
technical support request form on the UPS web site.
9 February 2009
Page 14
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Planning Your Applications
Within the United States
Effective July 2007, there is a phone number for External Customer
Technology Support (ECTS): 1-877-289-6420 for customers who have
completed testing in the Customer Integration Environment and are ready
to process live shipments.
For developers in the United States, the request form may be found by selecting
“Contact UPS” from the www.myups.com web site, or from www.ups.com from
the steps below.
1. Navigate to the UPS website http://www.ups.com.
2. Select a language, (ex. United States – English).
3. Log into www.ups.com with your User ID and Password.
4. Click the “Support” tab
5. Select “Technology Support” from “Support” tab
6. Click on “UPS OnLine Tools”, and then click “Tools Support” on the
left-hand navigation window.
7. Click the link for technical support.
8. Complete the e-mail form. Please explain details about errors that are
being returned, and under what circumstances.
Outside of the United States
Developers outside the United States can find the technical support request in the
OnLine Tools page within the Support section of their country's UPS web site.
1. Navigate to the UPS website http://www.ups.com.
2. Select a language,
3. Log into www.ups.com with your User ID and Password.
4. Click the “Support” tab
5. Select “Technology Support” from “Support” tab
6. Click on “UPS OnLine Tools”, and then click “Tools Support” on the
left-hand navigation window.
7. Click the link for technical support.
8. Complete the e-mail form. Please explain details about errors that are
being returned, and under what circumstances.
For more information or assistance with UPS technical support, please contact
your UPS OnLine Tools representative.
9 February 2009
Page 15
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Planning Your Applications
Testing and Deploying Applications
UPS maintains a special environment to support testing and staging of
applications that rely on UPS OnLine Tools. This environment is called the
Customer Integration Environment (CIE) and allows developers test and debug
their applications by simulating transactions with UPS. The CIE site responds to
requests just like the UPS production environment; however, it does not initiate
actual UPS business services.
For example, if you send a shipping request to the UPS production site, a UPS
driver may show up at your location expecting to pick up a package (and
expecting payment for the service.) Sending the shipping request to CIE will
avoid this problem.
UPS Label Certification
UPS requires that customers pass a Certification process prior to shipping actual
(billable) packages. The Certification Process is as follows:
1. Ship five shipments in the Customer Integration Environment (CIE).
These shipments must be valid shipments but may contain any
combination of origins, destinations and services. At least one of these
tests must produce a High Value Report by including a shipment with an
InsuredValue greater than $999.
2. Void the four UPS-defined “Void” test cases in CIE.
3. If you are using a Browser, e-mail the following 39 files along with your
UPS OnLine “Developer’s Key” to [email protected]:
•
The requests and responses of the ShipConfirm and ShipAccept
XML documents from all five shipments (20 files).
•
The resulting GIF images of the label from all five shipments (5
files).
•
The resulting GIF images of the High Value Report for at least
one shipment (1 file).
•
The HTML pages containing the scaling information for the
label from all five shipments (5 files).
•
The requests and responses of all the Void XML documents (8
files).
4. If you are printing labels via a Thermal Printer, the labels must be sent to
UPS via a provided label from the Tool support group. Include a High
Value Report for at least one shipment with the thermal labels. Email the
following 28 files along with your UPS OnLine “Developer’s Key” to
[email protected]:
•
The requests and responses of the ShipConfirm and ShipAccept
XML documents from all five shipments (20 files).
•
The requests and responses of all the Void XML documents (8
files).
9 February 2009
Page 16
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Planning Your Applications
5. UPS will contact you within 2 business days to inform you of your
approval status. Once approved, UPS will provide you with the
Production URL.
Certification for third parties is described in the Product Provider Testing Guide.
Note: UPS reserves the right to revoke shipping privileges from any customers
who fail to abide by the Certification Requirements outlined above.
Keeping Up-to-Date
As UPS adds new services and features, UPS OnLine Tools will evolve, offering
more features and service benefits. Once you register to use UPS OnLine Tools,
UPS will notify you by e-mail of updates and changes to the OnLine Tools. 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 occur or responsibilities for the
OnLine Tools shift within your company. You can also return to the UPS Support
area of ups.com for the latest updated information about UPS OnLine Tools.
9 February 2009
Page 17
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
UPS OnLine Tools Technologies
The foundation technologies for UPS OnLine Tools are the same underlying
technologies in use on the Internet today. They include the Hypertext Transfer
Protocol (HTTP) with Secure Sockets Layer 3 (SSL3) security and the Extensible
Markup Language (XML). Because these technologies are critical to the Internet,
most software development tools provide many powerful features that make it
easy for application programs to use them. This section provides a quick
introduction to the technologies and to the tools that can support them.
Hypertext Transfer Protocol and Secure Sockets Layer 3
Today's Internet supports a wide variety of applications including email, instant
messaging, web browsing, and voice communications. All of these applications
have a well-defined set of rules that determines how they communicate. Those
rules are known as protocols. As an Internet application themselves, the UPS
OnLine tools also rely on protocols to set the rules for their communications. The
primary protocol for UPS OnLine Tools is the hypertext transfer protocol, or
HTTP.
HTTP is a relatively simple protocol. An application that wants to use an OnLine
Tool acts as an HTTP client. It sends its request to UPS as part of an HTTP POST
message. UPS servers reply to each request using an HTTP response message.
1
UPS
OnLine Tools
POST message
Internet
2
Client
Applications
Response message
Figure 5. UPS OnLine Tools accept requests from client applications in HTTP POST
messages and reply to the requests with HTTP responses.
As part of the POST message, client applications indicate the type of content the
message contains using an HTTP Content-Type header. For UPS OnLine Tools,
that content type should be application/x-www-form-urlencoded. (Presently,
Version 1.1 is supported)
In many cases the UPS OnLine tools exchange information that should be kept
private. To protect confidential information, the UPS OnLine Tools rely on the
Secure Sockets Layer 3 (SSL3) protocol in addition to HTTP. When two systems
communicate using SSL, the protocol creates a secure channel between them,
and it encrypts all information that they exchange using this channel. The SSL
9 February 2009
Page 18
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
UPS OnLine Tools Technologies
protocol that UPS OnLine Tools use is the same protocol used to secure millions
of on-line purchases on the web.
UPS
OnLine Tools
Internet
Client
Applications
Encrypted “channel”
created by SSL
Figure 6: SSL creates a secure channel across a network and protects confidential
communications using that channel.
Working with HTTP and SSL in Application Programs
UPS OnLine Tools are not the only Internet services that rely on the HTTP and
SSL protocols. Both protocols, in fact, were originally developed for web
browsing, and they provide the foundation for the majority of Internet
applications. Because HTTP and SSL are so common, software development
tools make using these protocols very simple.
Because HTTP and SSL are commonly used for web browsing, software
development tools often rely on the same notation and abbreviations as standard
web browsers. In particular, most tools identify a specific service (such as a UPS
OnLine Tool) using a Uniform Resource Locator (URL). URLs begin with an
abbreviation of the communication protocol. For UPS OnLine Tools that
abbreviation will always be &quot;https&quot; to indicate HTTP and SSL. The protocol
abbreviation is followed by a colon, two slashes, and the name of a server.
Additional information about the specific service can follow the server name; it is
written like the path to a file in a directory, with slashes separating individual
folders. Figure 7 shows how a URL combines these individual components.
https://wwwcie.ups.com/ups.app/xml/ShipConfirm
https://wwwcie.ups.com/ups.app/xml/ShipConfirm
https://wwwcie.ups.com/ups.app/xml/ShipConfirm
protocol
protocol
abbreviation
abbreviation
(https
(https==
HTTP
HTTPwith
with
SSL)
SSL)
https://wwwcie.ups.com/ups.app/xml/ShipConfirm
name
name
of
of
server
server
path
path to
to
specific
specific
service
service
Figure 7. URLs identify communication protocols, servers, and specific services.
9 February 2009
Page 19
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
UPS OnLine Tools Technologies
The subsections that follow provide brief introductions to using HTTP and SSL
with various software development tools, including Microsoft Visual Studio, Java
Standard and Enterprise Edition, and popular open source environments.
Microsoft Visual Studio
Visual
Studio
The Microsoft Visual Studio environment includes many tools, classes, and
libraries that simplify the use of HTTP and SSL protocols. A very convenient set
of tools are included in the Microsoft XML Core Services (MSXML). The
following code fragment shows how a Visual Basic program can send a request
and retrieve the response. To keep the example as simple as possible, no
exception handling is included in the figure. Production software should, of
course, appropriately handle all exceptions.
' create the object that manages the communication
Dim oXMLHttp As XMLHTTP
Set oXMLHttp = New XMLHTTP
' prepare the HTTP POST request
oXMLHttp.open &quot;POST&quot;, &quot;https://www.server.com/path&quot;, False
oXMLHttp.setRequestHeader &quot;Content-Type&quot;, _
&quot;application/x-www-form-urlencoded&quot;
' send the request
oXMLHttp.send requestString
' server's response will be available in oXMLHttp.responseXML
Figure 8. Visual Basic programs can use features of the MSXML tools to send and
receive messages using HTTP and SSL.
Java Standard Edition and Enterprise Edition
Java
In a Java SE or EE environment, the URL class in the java.net package provides
a convenient way to manage HTTP and SSL communications. Figure 9 contains a
small code fragment that demonstrates the use of this class. As above, the
fragment doesn't include exception handling that should be inherent in any
production software.
import java.io.*;
import java.net.*;
URL url = new URL(&quot;https://www.server.com/path&quot;);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod(&quot;POST&quot;);
conn.setRequestProperty(&quot;Content-Type&quot;,
&quot;application/x-www-form-urlencoded&quot;);
conn.setDoOutput(true);
PrintWriter out = new PrintWriter(conn.getOutputStream());
out.println(requestString);
out.close();
BufferedReader in = new BufferedReader(
new InputStreamReader(conn.getInputStream()));
/* server response is available by reading the in object */
Figure 9. The URL class from the java.net package is a convenient way for Java
programs to use HTTP and SSL.
9 February 2009
Page 20
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
UPS OnLine Tools Technologies
Open Source
Open
Source
The libcurl project is an open source project that includes support for using
HTTP and SSL protocols. The fragment in Figure 10 shows how to set up libcurl
to send a request using HTTP and SSL. It relies on a callback function to accept
the server's response.
CURL *curl;
CURLcode res;
/* prepare to send the request */
curl = curl_easy_init();
curl_easy_setopt(curl, CURLOPT_URL, https://www.server.com/path&quot;);
curl_easy_setopt(curl, CURLOPT_POSTFIELDS, requestString);
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, fnCallback);
res = curl_easy_perform(curl);
Figure 10. The open source libcurl library simplifies the use of HTTP and SSL.
Extensible Markup Language (XML)
The Extensible Markup Language (XML) is an international standard developed
by the World Wide Web Consortium, the governing body for web standards and
guidelines. XML provides a way to identify the structure of content within a
document or, in the case of UPS OnLine Tools, a message. Figure 11 shows how
a simple XML message could describe a book.
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;
&lt;book&gt;
&lt;title&gt;
HTTP Essentials: Protocols for Secure, Scaleable Web Sites
&lt;/title&gt;
&lt;author&gt;
&lt;firstname&gt;
Stephen
&lt;/firstname&gt;
&lt;lastname&gt;
Thomas
&lt;/lastname&gt;
&lt;/author&gt;
&lt;publisher&gt;
John Wiley and Sons
&lt;/publisher&gt;
&lt;year&gt;
2001
&lt;/year&gt;
&lt;isbn&gt;
0-471-398233
Figure 11: XML identifies the structure of documents, as in this document
describing a book.
As the figure illustrates, XML is a text-based format. XML messages contain
regular text, though that text follows specific rules that XML defines. XML
distinguishes different parts of a message with a label known as a tag. Tags in the
example include &lt;book&gt;, &lt;title&gt;, &lt;author&gt;, &lt;firstname&gt;, etc. A tag can indicate
the start of information if it begins with an angle bracket (&lt;), and a tag can
9 February 2009
Page 21
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
UPS OnLine Tools Technologies
indicate the end of information if it begins with an angle bracket and a slash (&lt;/).
A beginning tag, ending tag, and the information between the two make up an
element. In this example the publisher element tells us that the publisher for the
book is &quot;John Wiley and Sons.&quot;
The figure also shows how an XML message follows a defined structure.
Elements can be contained within other elements, as &lt;firstname&gt; and &lt;lastname&gt;
are included within the &lt;author&gt; element. This structure indicates that firstname
and lastname are &quot;children&quot; of the author &quot;parent.&quot;
Although XML elements can contain almost any text, there are two special
characters that cannot appear within an element. Those characters are the lessthan sign (&lt;) and the ampersand (&amp;). Elements that include these contents must
replace the special characters with &quot;&amp;lt;&quot; or &quot;&amp;amp;&quot; respectively. The name of a
large telecommunications company, for example, would appear as &quot;AT&amp;amp;T&quot;
within an XML message.
Because XML is a text-based format, software has to take extra steps to use XML
with binary data. For example, some UPS services return binary image data such
as the image of a shipping label. To include this data in an XML message, UPS
converts it from binary to text format using an algorithm known as Base64
encoding. The &quot;The Base16, Base32, and Base64 Data Encodings&quot; standard, also
known as RFC 3548, defines that algorithm.
Although XML messages consist of a series of text characters, most software
development tools represent XML messages in a tree-like data structure. That
representation clarifies the structure of the message. Figure 12 shows the same
XML message as Figure 11, but it uses a more visual representation to highlight
the message's structure.
book
title
HTTP
Essentials:
Protocols for
Secure,
Scaleable Web
Sites
author
publisher
firstname
lastname
Stephen
Thomas
year
John Wiley and
Sons
isbn
2001
0-471-398233
Figure 12. It is often convenient to show XML messages in a tree-like graph to
highlight their structure.
The example of Figure 11 and Figure 12 is a relatively simple XML message
with just a few elements. UPS OnLine Tools rely on XML messages that are
larger than this simple example, and it is difficult to show them in a pure graph
like Figure 12 without losing legibility. Figure 13 shows an alternate way of
9 February 2009
Page 22
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
UPS OnLine Tools Technologies
depicting the tree-like structure of XML messages; it uses the same example as
before.
book
├─title
│ └─&quot;HTTP Essentials: Protocols for Secure, Scaleable Web Sites&quot;
├─author
│ ├─firstname
│ │ └─&quot;Stephen&quot;
│ └─lastname
│
└─&quot;Thomas&quot;
├─publisher
│ └─&quot;John Wiley and Sons&quot;
├─year
│ └─&quot;2001&quot;
└─isbn
└─&quot;0-471-398233&quot;
Figure 13. It is possible to show the tree-like structure of XML messages using text.
A great deal of information on XML is available on the Internet. A good starting
point for further research is the World Wide Web Consortium’s main page on
XML at http://www.w3.org/XML/.
Working with XML in Application Programs
The popularity of Extensible Markup Language means that nearly all
development environments include sophisticated support for creating and
interpreting XML messages. This subsection provides a brief introduction to
working with XML in Microsoft, Java, and Open Source environments. The
examples it contains are only representative approaches; many other approaches
are possible.
Microsoft Visual Studio
Visual
Studio
The Microsoft XML Core Services (MSXML) offers one way to work with XML
documents in Visual Studio applications. Figure 14 shows one approach for
creating an XML message in Visual Basic, and Figure 15 demonstrates how
Visual Basic programs can interpret XML responses. To remain as simple as
possible, the examples do not include any exception handling. Production
software should, of course, provide full exception handling.
' Define a variable and initialize it to a new XML message
Dim dom
Set dom = New DOMDocument30
' Set properties of the variable
dom.async = False
dom.validateOnParse = False
dom.resolveExternals = False
dom.preserveWhiteSpace = True
' Identify the message as XML version 1.0
Set node = dom.createProcessingInstruction(&quot;xml&quot;, &quot;version='1.0'&quot;)
dom.appendChild node
Set node = Nothing
' Create the root (book) element and add it to the message
9 February 2009
Page 23
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
UPS OnLine Tools Technologies
Dim root
Set root = dom.createElement(&quot;book&quot;)
dom.appendChild root
' Create child elements and add them to the root
Dim node
Set node = dom.createElement(&quot;title&quot;)
node.text = &quot;HTTP Essentials: ...&quot;
root.appendChild node
Set node = Nothing
Set node = dom.createElement(&quot;author&quot;)
Dim child
Set child = dom.createElement(&quot;firstname&quot;)
child.text = &quot;Stephen&quot;
node.appendChild child
Set child = Nothing
Set child = dom.createElement(&quot;lastname&quot;)
child.text = &quot;Thomas&quot;
node.appendChild child
root.appendChild node
' And so on
Figure 14. Visual Basic can create XML messages through the DOMDocument
object.
' Define a variable to hold the parsed message
Dim dom As New DOMDocument30
dom.async = False
dom.validateOnParse = False
dom.resolveExternals = False
dom.preserveWhiteSpace = True
' Try to parse the message
If dom.loadXML(messageText) = False Then
' The text did not contain valid XML
End If
' Get the title information from the message
Dim node As IXMLDOMNode
Set node = dom.selectSingleNode(&quot;/title&quot;)
If node Is Nothing Then
' The message did not contain title information
Else
' Do something with node.text
End If
Figure 15. Visual Basic can read the contents of XML messages after parsing them
with the DOMDocument object.
Visual Basic also has built-in classes to interpret Base64-encoded values. The
Convert.FromBase64String() function converts from a Base64-encoded string
to an array of 8-bit unsigned integers.
Java Standard Edition and Enterprise Edition
Java
The Java API for XML Processing (JAXP) is the preferred approach for working
with XML messages in Java. Figure 16 shows how a BookClass object can be
converted into an XML message, a process that JAXP calls marshalling.
Similarly, Figure 17 shows the reverse process, where an XML message is
converted into a BookClass object. This reverse process is unmarshalling. As
above, exception handling code is omitted from these examples to make them as
clear as possible.
9 February 2009
Page 24
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
UPS OnLine Tools Technologies
import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;
import java.io.StringWriter;
/* create the book object */
BookClass book = new BookClass(&quot;HTTP Essentials...&quot;,
new AuthorClass(&quot;Stephen&quot;, &quot;Thomas&quot;),
&quot;John Wiley and Sons&quot;,
&quot;2001&quot;,
&quot;0-471-398233&quot;);
/* convert it to an XML string */
StringWriter writer = new StringWriter();
JAXBContext context = JAXBContext.newInstance(book.class);
Marshaller m = context.createMarshaller();
m.marshal(book, writer);
Figure 16. JAXP provides a convenient way for Java applications to create XML
messages from Java objects.
import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;
import java.io.StringReader;
/* xmlMessage contains the XML message */
StringReader reader = new StringReader(xmlMessage);
JAXBContext context = JAXBContext.newInstance(Book.class);
Unmarshaller u = context.createUnmarshaller();
BookClass book = (BookClass) u.unmarshal(reader);
/* access properties of the book */
System.out.println(book.getAuthor().getFirstname())
Figure 17. JAXP also gives Java applications a convenient way to retrieve elements
from an XML message.
Open Source
Open
Source
As of this writing, the most popular open source tool for working with XML is
the xerces project. That project includes C++, Java, and Perl implementations of
an XML library. The xerces distribution includes extensive sample applications.
The code fragment in Figure 18 demonstrates creating an XML message in C++
with the xerces library. Figure 19 shows sample code for accessing an element
within an XML message. In both cases exception handling is not shown in order
to keep the examples as simple as possible. Production software should always
contain full exception handling.
DOMImplementation* impl =
DOMImplementationRegistry::getDOMImplementation(X(&quot;Core&quot;));
DOMDocument* doc = impl-&gt;createDocument(0, X(&quot;book&quot;), 0);
DOMElement* rootElem = doc-&gt;getDocumentElement();
DOMElement* titleElem = doc-&gt;createElement(X(&quot;title&quot;));
rootElem-&gt;appendChild(titleElem);
DOMText* titleVal = doc-&gt;createTextNode(X(&quot;HTTP Essentials...&quot;));
titleElem-&gt;appendChild(titleVal);
Figure 18. The Xerces C++ library includes classes that can create XML messages.
XMLCh* TAG_book;
XMLCh* TAG_title;
xercesc::XercesDOMParser *parser;
XMLPlatformUtils::Initialize();
9 February 2009
Page 25
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
UPS OnLine Tools Technologies
TAG_book = XMLString::transcode(&quot;book&quot;);
TAG_title = XMLString::transcode(&quot;title&quot;);
parser = new XercesDOMParser;
parser-&gt;parse(inputText);
DOMDocument* xmlDoc = parser-&gt;getDocument();
DOMElement* elementRoot = xmlDoc-&gt;getDocumentElement();
DOMNodeList* children = elementRoot-&gt;getChildNodes();
const XMLSize_t nodeCount = children-&gt;getLength();
for (XMLSize_t cnt = 0; cnt &lt; nodeCount; ++cnt ) {
DOMNode* currentNode = children-&gt;item(cnt);
if( currentNode-&gt;getNodeType() &amp;&amp;
currentNode-&gt;getNodeType() == DOMNode::ELEMENT_NODE ) {
DOMElement* currentElement =
dynamic_cast&lt; xercesc::DOMElement* &gt;( currentNode );
if( XMLString::equals(currentElement-&gt;getTagName(),
TAG_title)) {
/* do something with the title */
}
}
}
Figure 19. The Xerces C++ library also supports parsing XML messages to find
individual elements.
9 February 2009
Page 26
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Understanding UPS OnLine Tools Shipping Services
This section provides an overview of the OnLine Tools Shipping Services. It
describes the services available through the OnLine Tools, and it explains—at an
overview level—how the Tools operate. The next section, &quot;Shipping Reference,&quot;
documents the details of the Shipping Services OnLine Tools operations.
What Shipping Services Can Do
OnLine Tools make UPS shipping services available to client applications that
communicate with UPS using the Internet. With the OnLine Tools applications
can prepare or schedule small package shipments, manage returns, or cancel
previously scheduled shipments.
Shipments
OnLine Tools Shipping 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 UPS OnLine Tools designed for freight 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.
Cancellations (Voids)
If you need to cancel a previously processed shipment, the UPS OnLine Tools
Shipping Services let client applications automate that task. This process is
known as voiding a shipment.
Returns
UPS OnLine Tools also support the UPS returns services. Either as part of a
forward shipment or in a separate process, clients can request a return label for
their customers. (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
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.
9 February 2009
Page 27
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Understanding UPS OnLine Tools Shipping Services
How Shipping Services Work
Because forward and return shipments share many of the same characteristics
(they have an origin, destination, service type, etc.), UPS OnLine Tools use the
same procedure and message types for both services. Cancelling or voiding a
shipment requires its own procedure and message types.
Forward and Return Shipments
For forward and return services client applications use a four-step procedure to
process a shipment. As Figure 20 shows, the procedure begins when a client
application sends a ShipmentConfirmRequest to UPS. This request provides
details of the shipment and the desired UPS services. UPS replies to this request
with a ShipmentConfirmResponse. ShipmentConfirmResponses include
estimated rates for the shipment. If the rates and services are acceptable to the
client, it sends a ShipmentAcceptRequest to UPS. This message authorizes UPS
to charge for the shipment and process the shipment data. UPS acknowledges the
request by returning a ShipmentAcceptResponse. For forward shipments and for
preprinted return labels, this response includes a label for the shipment.
Figure 20. Forward and return shipments require four separate steps to complete
the shipment processing.
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.
Cancellations (Voids)
To cancel, or void, a previously scheduled shipment, client applications send a
VoidShipmentRequest to UPS. As Figure 21 illustrates, UPS replies to this
request with a VoidShipmentResponse.
9 February 2009
Page 28
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Understanding UPS OnLine Tools Shipping Services
VoidShipment
Request
1
UPS
OnLine Tools
Internet
2
Client
Application
VoidShipment
Response
Figure 21. 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.
9 February 2009
Page 29
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Shipping Reference
This section documents the details of the XML messages, including the requests
that clients send to UPS and the responses that UPS returns. The first subsection
explains the notation that this section uses. It is followed by a section that
describes how UPS verifies that client applications are authorized to use the tool.
The next subsections define the messages used by the tool for its services. The
final subsection provides a list of error codes.
Describing OnLine Tools Messages
As noted previously, all messages that UPS OnLine Tools send and receive
consist of XML documents. This reference section defines the specific elements
within those XML documents.
Authenticating Client Applications
UPS OnLine Tools Shipping Services are only available for authorized UPS
customers. To enforce this policy, UPS requires that every message that a client
application sends include important authentication information. That information
is contained in an AccessRequest XML document that must begin each message.
AccessRequest
AccessRequest
├─AccessLicenseNumber::string
AccessLicenseNumber
├─UserId::string
UserId
└─Password::string
Password
Each AccessRequest contains three child elements: an AccessLicenseNumber, a
UserId, and a Password. The following figure shows an example AccessRequest
document.
&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;AccessRequest xml:lang='en-US'&gt;
&lt;AccessLicenseNumber&gt;
YOURACCESSLICENSENUMBER
&lt;/AccessLicenseNumber&gt;
&lt;UserId&gt;
YOURUSERID
&lt;/UserId&gt;
&lt;Password&gt;
YOURPASSWORD
&lt;/Password&gt;
&lt;/AccessRequest&gt;
9 February 2009
Page 30
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Forward and Return Shipments
Forward and Return Shipments
Four different message types make up a complete shipment processing
procedure: ShipmentConfirmRequest, ShipmentConfirmResponse,
ShipmentAcceptRequest, and ShipmentAcceptResponse.
ShipmentConfirmRequest
The ShipmentConfirmRequest message consists of two complete XML
documents. The first document is an AccessRequest. The AccessRequest is
immediately followed by (concatenated to) a ShipmentConfirmRequest. When a
client application is undergoing testing and integration, the document
combination should be sent to the URL:
https://wwwcie.ups.com/ups.app/xml/ShipConfirm
Once a client application is in production, the combined documents should be
sent to the URL provided as part of the certification process.
The ShipmentConfirmRequest document in the request must conform to the
following XML structure.
(See next pages)
Note: The “Required” Column has four potential values:
Yes: Always required
No: Always optional
Yes*: Conditionally required
Cond: Conditional
9 February 2009
Page 31
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Indicates the action to be taken by the XML
service.
/RequestAction
Must be ‘ShipConfirm’.
Optional Processing.
‘nonvalidate’ = No address validation.
/RequestOption
1..256
String
/Request
1
RequestOption
Yes
‘validate’ = Fail on failed address validation.
/ShipmentConfirmRequest
Defaults to ‘validate’.
Note: Full address validation is not performed.
Therefore, it is the responsibility of the
Values blank, ‘validate’, or
‘nonvalidate’.
Shipping Tool User to ensure the address
entered is correct to avoid an address
correction fee.
9 February 2009
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Page 32
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
N/A
N/A
11
Container
Container
String
/Request
Yes
/ShipmentConfirmRequest
RequestAction
TYPE
1
/Request
1
/ShipmentConfirmRequest
1
Request
/ShipmentConfirmRequest
Yes
ShipmentConfirmRequest
XPATH
Yes
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/TransactionReference
/TransactionReference
String
1
No
/Request
Customer context . Free form field for
between client and server.
customers to us… (there was verbiage here
previously with a description). See pg 210.
/CustomerContext
String
4
N/A
/TransactionReference
Container
/Request
1
XpciVersion
No
/ShipmentConfirmRequest
Message version. Defaults to ‘1.0001’. (or is it
now just 1.0?)
/ShipmentConfirmRequest
/Shipment
1
Shipment
Yes
/XpciVersion
9 February 2009
Page 33
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
FORWARD ONLY
LENGTH
TransactionReference identifies transactions
/ShipmentConfirmRequest
CustomerContext
VALIDATION RULES
N/A
/Request
No
/ShipmentConfirmRequest
TransactionReference
DESCRIPTION
1..512
TYPE
Container
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Required if all of the listed
conditions are true: ShipFrom
The Description of Goods for the shipment.
1..35
String
/Shipment
1
Description
Applies to international shipments only.
Cond
/ShipmentConfirmRequest
/Description
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.
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
shipment’s service type is not
/ReturnService
Type of Return service. When this container
exists, the shipment is a return shipment.
Yes
N/A
1
/Shipment
No
/ShipmentConfirmRequest
ReturnService
Container
UPS Standard.
Return Service types:
/Code
‘3’ = UPS Return Service 1-Attempt (RS1)
‘5’ = UPS Return Service 3-Attempt (RS3)
‘8’ = UPS Electronic Return Label (ERL)
‘9’ = UPS Print Return Label (PRL)
9 February 2009
Page 34
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
1
String
/ReturnService
‘2’ = UPS Print and Mail (PNM)
1
Code
/Shipment
Yes*
/ShipmentConfirmRequest
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
0
/Shipment
1
DocumentsOnly
No
/ShipmentConfirmRequest
String
Indicates a shipment contains written, typed,
/DocumentsOnly
or printed communication of no commercial
Valid only for shipments with
value. If DocumentsOnly is not specified then
different origin and destination
it implies that the shipment contains non
countries. The origin country is
documents or documents of commercial value. not US, and the destination
Default is a shipment contains non-
country is not CA, PR or MX.
documents or documents of commercial value.
Yes
1
String
1..35
Container tag for Shipper’s information
1
String
1..35
/Shipment
Yes
/ShipmentConfirmRequest
Shipper
Shipper’s company name.
/Shipper
/ShipmentConfirmRequest
Name
/Shipment
/Shipper
/Name
Required if destination is
1..35
/Shipper
String
/Shipment
1
AttentionName
Cond
/ShipmentConfirmRequest
international. Required if Invoice
Shipper’s Attention Name
/AttentionName
9 February 2009
and Co International forms are
requested and the ShipFrom
address is not present.
Page 35
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
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,
/Shipper
the account must be either a
6
String
/Shipment
1
ShipperNumber
Yes
/ShipmentConfirmRequest
Shipper’s six digit account number.
daily pickup account, an
occasional account, or a
/ShipperNumber
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.
Conditionally required if SED
1..15
String
/Shipper
1
TaxIdentificationNumber
/Shipment
Cond
/ShipmentConfirmRequest
Shipper’s Tax Identification Number
/TaxIdentificationNumber
9 February 2009
form (International forms) is
requested and ship From is not
mentioned.
Page 36
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Valid values are 0 – 9.If Shipper
country is US, PR, CA, and VI,
the layout is areacode, 7 digit
phonenumber or areacode, 7
1..15
/Shipper
String
/Shipment
1
PhoneNumber
Cond
/ShipmentConfirmRequest
digit phonenumber, 4 digit
Shipper’s Phone Number
extension number; for other
countries, the layout is
/PhoneNumber
countrycode, area code, 7 digit
number. A phone number is
required if destination is
international.
/PhoneNumber
Required if parent element,
PhoneNumber, is required and a
N/A
/Shipper
Container
StructuredPhoneNumber
1
/Shipment
Cond
/ShipmentConfirmRequest
phone number is not provide at
the parent node.
/StructuredPhoneNumber
/ShipmentConfirmRequest
1..3
/PhoneNumber
String
/Shipper
1
PhoneCountryCode
No
/Shipment
The Country Code portion of the phone
number.
Not valid for US phone numbers.
/StructuredPhoneNumber
/PhoneCountryCode
9 February 2009
Page 37
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Shipper’s Fax Number.
/StructuredPhoneNumber
/PhoneDialPlanNumber
/ShipmentConfirmRequest
/Shipment
PhoneLineNumber
/Shipper
/PhoneNumber
/StructuredPhoneNumber
/PhoneLineNumber
/ShipmentConfirmRequest
/Shipment
PhoneExtension
/Shipper
/PhoneNumber
/StructuredPhoneNumber
/PhoneExtension
/ShipmentConfirmRequest
FaxNumber
/Shipment
/Shipper
/FaxNumber
9 February 2009
Page 38
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
1..14
/PhoneNumber
SED
1..4
String
/Shipper
INVOICE
1..15
String
1
PhoneDialPlanNumber
N/AFTA CO
LENGTH
1..15
String
1
Shipper’s phone extension.
/Shipment
CERT. OF ORIGIN
TYPE
String
1
Line number portion of the phone number.
/ShipmentConfirmRequest
RETURN ONLY
MAXALLOWED
1
Dial plan number portion of the phone number.
VALIDATION RULES
FORWARD ONLY
REQUIRED
DESCRIPTION
Yes
XPATH
Yes
NAME
No
ShipmentConfirmRequest
No
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
EMailAddress
/Shipment
/Shipper
Shipper’s email address.
/EMailAddress
The package should be returned
to this address if the package is
undeliverable. This address
corner of the label. If the
N/A
/Shipper
1
/Shipment
Yes
Address
Container
appears on the upper left hand
/ShipmentConfirmRequest
Address of the shipper.
ShipFrom container is not
present then this address will be
/Address
used as the ShipFrom address.
If this address is used as the
ShipFrom the shipment will be
rated from this origin address
1..35
String
/Shipper
1
/Shipment
AddressLine1
Yes
/ShipmentConfirmRequest
Address Line 1 of the shipper.
/Address
/AddressLine1
1..35
String
Room/Floor information.
/Shipper
1
Address Line 2 of the shipper. Usually
/Shipment
No
AddressLine2
/ShipmentConfirmRequest
/Address
Note: This information does NOT appear on
/AddressLine2
the label
9 February 2009
Page 39
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1..50
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
No
UPS OnLine Tools Shipping
1..35
String
department information.
/Shipper
1
Address Line 3 of the shipper. Usually
/Shipment
/Address
Note: This information does NOT appear on
/AddressLine3
the label
1..30
String
/Shipper
1
/Shipment
City
Yes
/ShipmentConfirmRequest
Shipper’s city.
/Address
/City
Required if shipper is in the US
CA, then the value must be a
2..5
String
/Shipper
1
/Shipment
StateProvinceCode
or CA. If Shipper country is US or
Cond
/ShipmentConfirmRequest
Shipper’s state or province code.
valid US State/Canadian
/Address
Province code. If the country is
/StateProvinceCode
Ireland, the StateProvinceCode
will contain the county.
9 February 2009
Page 40
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
FORWARD ONLY
LENGTH
DESCRIPTION
/ShipmentConfirmRequest
No
AddressLine3
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
If Shipper country is US or
Puerto Rico, 5 or 9 digits is
required. The character '-' may
be used to separate the first five
digits and the last four digits. If
1..10
/Shipper
String
PostalCode
the Shipper country is CA, then
1
/Shipment
Cond
/ShipmentConfirmRequest
the postal code is required and
Shipper’s postal code.
must be 6 alphanumeric
/Address
characters whose format is
/PostalCode
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.
9 February 2009
Page 41
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
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
2
/Shipper
String
CountryCode
following country codes are the
1
/Shipment
Yes
/ShipmentConfirmRequest
/Address
Shipper’s country code. Refer to Origin
same: ShipTo, ShipFrom, and
Country Information table for valid origin
Shipper.2) None of the following
countries and their UPS Billing codes.
country codes are the same and
/CountryCode
are a member of the EU: ShipTo,
ShipFrom, and Shipper.3) None
of the following country codes
are the same and at least one of
them is not a member of the EU,
the shipper must have Third
Country contract service: ShipTo,
/ShipTo
N/A
1
/Shipment
Yes
/ShipmentConfirmRequest
ShipTo
Container
ShipFrom, and Shipper.
9 February 2009
Page 42
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
CompanyName
/Shipment
/ShipTo
Consignee’s company name.
/CompanyName
Required for: UPS Next Day Air
1..35
String
/ShipTo
Early A.M. service, and when
1
AttentionName
/Shipment
Cond
/ShipmentConfirmRequest
Contact name at the consignee’s location.
/AttentionName
ShipTo country is different than
ShipFrom country. Required if
Invoice International form is
requested
1..15
/ShipTo
String
/Shipment
1
TaxIdentificationNumber
No
/ShipmentConfirmRequest
Consignee’s tax identification number.
/TaxIdentificationNumber
9 February 2009
Page 43
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1..35
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes
UPS OnLine Tools Shipping
/ShipTo
/PhoneNumber
Ship To country is different than
the ShipFrom country. If ShipTo
country is US, PR, CA, and VI,
1..15
/Shipment
Early A.M. service, and when
element
PhoneNumber
Cond
/ShipmentConfirmRequest
1
Mixed: String or StructuredPhoneNumber
Required for: UPS Next Day Air
the layout is areacode, 7 digit
Consignee’s phone number.
digit phonenumber, 4 digit
extension number; number; for
other countries, the layout is
countrycode, area code, 7 digit
number
/PhoneNumber
Required if parent element,
PhoneNumber, is required and a
N/A
Container
/ShipTo
1
StructuredPhoneNumber
Cond
/ShipmentConfirmRequest
/Shipment
phonenumber or areacode, 7
phone number is not provide at
the parent node.
/StructuredPhoneNumber
/ShipmentConfirmRequest
1..3
/PhoneNumber
String
/ShipTo
1
PhoneCountryCode
No
/Shipment
The Country Code portion of the phone
number.
Not valid for US phone numbers.
/StructuredPhoneNumber
/PhoneCountryCode
9 February 2009
Page 44
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Consignee’s fax number.
/StructuredPhoneNumber
/PhoneDialPlanNumber
/ShipmentConfirmRequest
/Shipment
PhoneLineNumber
/ShipTo
/PhoneNumber
/StructuredPhoneNumber
/PhoneLineNumber
/ShipmentConfirmRequest
/Shipment
PhoneExtension
/ShipTo
/PhoneNumber
/StructuredPhoneNumber
/PhoneExtension
/ShipmentConfirmRequest
FaxNumber
/Shipment
/ShipTo
If ShipTo country is US 10 digits
/FaxNumber
9 February 2009
allowed, otherwise 1..15 digits
allowed.
Page 45
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
1..15
/PhoneNumber
SED
1..4
String
/ShipTo
INVOICE
1..15
String
1
PhoneDialPlanNumber
N/AFTA CO
LENGTH
1..15
String
1
ShipTo’s Phone extension.
/Shipment
CERT. OF ORIGIN
TYPE
String
1
Line number portion of the phone number.
/ShipmentConfirmRequest
RETURN ONLY
MAXALLOWED
1
Dial plan number portion of the phone number.
VALIDATION RULES
FORWARD ONLY
REQUIRED
DESCRIPTION
Yes
XPATH
Yes
NAME
No
ShipmentConfirmRequest
No
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
EMailAddress
/Shipment
/ShipTo
Ship To email address.
/EMailAddress
1
Container
N/A
String
1..35
/ShipTo
1
/Shipment
Yes
Address
Yes
/ShipmentConfirmRequest
/Address
/ShipmentConfirmRequest
/Shipment
AddressLine1
/ShipTo
Address Line 1 of the consignee.
/Address
/AddressLine1
1..35
String
Room/Floor information.
/ShipTo
1
Address Line 2 of the consignee. Usually
/Shipment
No
AddressLine2
/ShipmentConfirmRequest
/Address
Note: This information does NOT appear on
/AddressLine2
the label
/Address
1..35
1
/ShipTo
No
/Shipment
AddressLine3
String
/ShipmentConfirmRequest
Address Line 3 of the consignee. Usually
department information.
/AddressLine3
9 February 2009
Page 46
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1..50
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
No
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/Shipment
City
/ShipTo
Consignee’s city.
/Address
/City
If destination is US or CA, then
/ShipmentConfirmRequest
2..5
String
/ShipTo
1
StateProvinceCode
the value must be a valid two
Cond
/Shipment
/Address
Consignee’s state or province code. Required character US State/Canadian
for US or Canada.
Province code. If the country is
Ireland, the StateProvinceCode
/StateProvinceCode
will contain the county.
If the ShipTo country is US or
Puerto Rico, 5 or 9 digits is
required. The character '-' may
be used to separate the first five
digits and the last four digits. If
the ShipTo country is CA, then
/ShipmentConfirmRequest
1..10
String
/ShipTo
1
PostalCode
the postal code is required and
Cond
/Shipment
Consignee’s postal code.
/Address
/PostalCode
must be 6 alphanumeric
characters whose format is
A#A#A# where A is an
uppercase letter and # is a digit.
Otherwise optional. For all other
countries the postal code is
optional and must be no more
than 9 alphanumeric characters
long.
9 February 2009
Page 47
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1..30
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes
UPS OnLine Tools Shipping
Must be a valid UPS Billing
country code. Refer to supported
return service movements. For
Return Shipment the country
code must meet the following
conditions:1) At least two of the
following country codes are the
/ShipmentConfirmRequest
2
String
/ShipTo
1
CountryCode
same: ShipTo, ShipFrom, and
Yes
/Shipment
Shipper.2) None of the following
Consignee’s country code.
country codes are the same and
/Address
are a member of the EU: ShipTo,
/CountryCode
ShipFrom, and Shipper.3) None
of the following country codes
are the same and at least one of
them is not a member of the EU,
the shipper must have Third
Country contract service: ShipTo,
ShipFrom, and Shipper.
/Address
Consignee’s Residential address indicator.
0
1
/ShipTo
No
/Shipment
ResidentialAddress
String
/ShipmentConfirmRequest
The presence indicates a residential address;
the absence indicates a business address.
/ResidentialAddress
9 February 2009
Page 48
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
LocationID
/Shipment
No
/ShipmentConfirmRequest
/ShipTo
Location ID is a unique identifier referring to a
specific shipping/receiving location.
Container
N/A
String
1..35
Pickup location’s company name.
1..35
1
1
1
/ShipFrom
String
Cond
Yes*
/Shipment
Yes*
/ShipmentConfirmRequest
Contact name at the pickup location.
alphanumeric characters. All
letters must be capitalized.
/LocationID
ShipFrom
Location ID must be
Required if pickup location is different from the
shipper’s address.
Required for return shipment
/ShipmentConfirmRequest
CompanyName
/Shipment
/ShipFrom
Required if ShipFrom tag is in
the XML.
/CompanyName
/ShipmentConfirmRequest
AttentionName
/Shipment
/ShipFrom
.Required if ShipFrom tag is in
the XML and Invoice or CO
International forms is requested
/AttentionName
1..15
/ShipFrom
String
/Shipment
1
TaxIdentificationNumber
Cond
/ShipmentConfirmRequest
Company’s Tax Identification Number at the
pick up location
/TaxIdentificationNumber
9 February 2009
Conditionally required if SED
form (International forms) is
requested
Page 49
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
LENGTH
3…10
DESCRIPTION
FORWARD ONLY
TYPE
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
If ShipFrom country is US, PR,
CA, and VI, the layout is
areacode, 7 digit phone number
or areacode, 7 digit phone
1..15
/ShipFrom
String
/Shipment
1
PhoneNumber
Cond
/ShipmentConfirmRequest
number, 4 digit extension
Pickup location’s phone number.
number; for other countries, the
layout is countrycode, area code,
/PhoneNumber
7 digit number. Required if
ShipFrom tag is in the XML and
International forms is requested
/PhoneNumber
Required if parent element,
PhoneNumber, is required and a
N/A
/ShipFrom
Container
StructuredPhoneNumber
1
/Shipment
Cond
/ShipmentConfirmRequest
phone number is not provide at
the parent node.
/StructuredPhoneNumber
/ShipmentConfirmRequest
1..3
/PhoneNumber
String
/ShipFrom
1
PhoneCountryCode
No
/Shipment
The Country Code portion of the phone
number.
Not valid for US phone numbers.
/StructuredPhoneNumber
/PhoneCountryCode
9 February 2009
Page 50
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Pickup location’s fax number.
/StructuredPhoneNumber
/PhoneDialPlanNumber
/ShipmentConfirmRequest
/Shipment
PhoneLineNumber
/ShipFrom
/PhoneNumber
/StructuredPhoneNumber
/PhoneLineNumber
/ShipmentConfirmRequest
/Shipment
PhoneExtension
/ShipFrom
/PhoneNumber
/StructuredPhoneNumber
/PhoneExtension
/ShipmentConfirmRequest
FaxNumber
/Shipment
/ShipFrom
/FaxNumber
9 February 2009
Page 51
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
1..15
/PhoneNumber
SED
1..4
String
/ShipFrom
INVOICE
1..15
String
1
PhoneDialPlanNumber
N/AFTA CO
LENGTH
1..15
String
1
ShipFrom’s Phone extension.
/Shipment
CERT. OF ORIGIN
TYPE
String
1
Line number portion of the phone number.
/ShipmentConfirmRequest
RETURN ONLY
MAXALLOWED
1
Dial plan number portion of the phone number.
VALIDATION RULES
FORWARD ONLY
REQUIRED
DESCRIPTION
Yes*
XPATH
Yes*
NAME
No
ShipmentConfirmRequest
No
UPS OnLine Tools Shipping
1
Address of the pickup location.
address. The shipment will be
rated from this origin address to
/Address
the destination ship to address.
1..35
String
/ShipFrom
1
/Shipment
AddressLine1
Yes*
/ShipmentConfirmRequest
Required if ShipFrom tag is in
Address Line 1 of the pickup location.
the XML.
/Address
/AddressLine1
1..35
String
Room/Floor information.
/ShipFrom
1
Address Line 2 of the pickup location. Usually
/Shipment
No
AddressLine2
/ShipmentConfirmRequest
/Address
Note: This information does NOT appear on
/AddressLine2
the label
String
1..35
Address Line 3 of the pickup location. Usually
1..30
1
/ShipFrom
No
/Shipment
AddressLine3
String
/ShipmentConfirmRequest
Pickup location’s city.
/Address
department information.
/AddressLine3
/ShipFrom
1
/Shipment
City
Yes*
/ShipmentConfirmRequest
/Address
Required if ShipFrom tag is in
the XML.
/City
9 February 2009
Page 52
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
FORWARD ONLY
LENGTH
VALIDATION RULES
from or being shipped from this
N/A
/ShipFrom
Yes*
/Shipment
DESCRIPTION
The package will be originating
/ShipmentConfirmRequest
Address
TYPE
XPATH
Container
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Required if ShipFrom tag is in
the XML, and ShipFrom/Country
/ShipmentConfirmRequest
2..5
String
/ShipFrom
1
StateProvinceCode
is US. If ShipFrom country is US
Cond
/Shipment
Pickup location’s state or province code.
/Address
or CA, then the value must be a
valid US State/Canadian
Province code. If the country is
/StateProvinceCode
Ireland, the StateProvinceCode
will contain the county.
Required if ShipFrom tag is in
the XML and the ShipFrom
country is the US, Puerto Rico .
For US, Puerto Rico must be
valid 5 or 9 digit postal code. .
The character '-' may be used to
1..10
/ShipFrom
String
PostalCode
separate the first five digits and
1
/Shipment
Cond
/ShipmentConfirmRequest
the last four digits. If the
Pickup location’s postal code.
ShipFrom country is CA, then the
/Address
postal code must be 6
/PostalCode
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.
9 February 2009
Page 53
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Required if ShipFrom tag is in
the XML. For Return Shipment
the country code must meet the
following conditions:1) At least
two of the following country
codes are the same: ShipTo,
ShipFrom, and Shipper.2) None
are the same and are a member
2
/ShipFrom
String
CountryCode
of the following country codes
1
/Shipment
Cond
/ShipmentConfirmRequest
Pickup location’s country code.
of the EU: ShipTo, ShipFrom,
/Address
and Shipper.3) None of the
/CountryCode
following country codes are the
same and at least one of them is
not a member of the EU, the
shipper must have Third Country
contract service: ShipTo,
ShipFrom, and Shipper. Refer to
Origin Country Information table
/SoldTo
Applies to Invoice and NAFTA
N/A
/Shipment
Container
SoldTo
1
/ShipmentConfirmRequest
Cond
for country codes
The person or company who imports and pays CO Forms. Required if Invoice or
any duties due on the current shipment.
9 February 2009
NAFTA CO (International Form)
is requested
Page 54
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
The text associated with the code will be
/SoldTo
String
printed in the sold to section of the NAFTA CO
1
Option
/Shipment
No
/ShipmentConfirmRequest
/Option
form
Applies to NAFTA CO form.
The values indicate the following 01 –
Possible Values are
Unknown
02 - Various
Applies to Invoice form. Applies
1..35
String
/SoldTo
to NAFTA CO form if sold to
1
CompanyName
/Shipment
Cond
/ShipmentConfirmRequest
Company name.
/CompanyName
option is empty or not present
Required for Invoice. Required
for NAFTA CO if sold to option is
not provided
Applies to Invoice form. Applies
1..35
String
/SoldTo
to NAFTA CO form if sold to
1
AttentionName
/Shipment
Cond
/ShipmentConfirmRequest
Contact name.
/AttentionName
option is empty or not present
Required for Invoice. Required
for NAFTA CO if sold to option is
not provided
1..15
/SoldTo
String
/Shipment
1
TaxIdentificationNumber
No
/ShipmentConfirmRequest
Applies to Invoice form. Applies
SoldTo Tax Identification Number
/TaxIdentificationNumber
9 February 2009
to NAFTA CO form if sold to
option is empty or not present
Page 55
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Applies to Invoice form. Applies
1..15
String
/SoldTo
to NAFTA CO form if sold to
1
PhoneNumber
/Shipment
Cond
/ShipmentConfirmRequest
option is empty or not present
Sold To contact’s phone number.
Required for Invoice. Required
/PhoneNumber
for NAFTA CO if sold to option is
not provided
/SoldTo
to NAFTA CO form if sold to
N/A
1
No
Address
/Shipment
Container
Applies to Invoice form. Applies
/ShipmentConfirmRequest
option is empty or not present
Address of the Sold to location.
Required for Invoice. Required
/Address
for NAFTA CO if sold to option is
not provided
Applies to Invoice form. Applies
/ShipmentConfirmRequest
1..35
String
/SoldTo
1
AddressLine1
to NAFTA CO form if sold to
Yes*
/Shipment
option is empty or not present.
Address Line 1 of the Sold to location.
Required for Invoice. Required
/Address
for NAFTA CO if sold to option is
/AddressLine1
not provided
/Address
1..35
1
/SoldTo
No
/Shipment
AddressLine2
String
/ShipmentConfirmRequest
Address Line 2 of the pickup location. Usually
Room/Floor information.
Applies to Invoice form. Applies
to NAFTA CO form if sold to
option is empty or not present
/AddressLine2
9 February 2009
Page 56
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/SoldTo
No
/Shipment
AddressLine3
/Address
department information.
Applies to Invoice form. Applies
to NAFTA CO form if sold to
option is empty or not present
/AddressLine3
Applies to Invoice form. Applies
/ShipmentConfirmRequest
1..30
String
/SoldTo
1
City
to NAFTA CO form if sold to
Yes*
/Shipment
option is empty or not present
SoldTo location’s city.
Required for Invoice. Required
/Address
for NAFTA CO if sold to option is
/City
not provided
/ShipmentConfirmRequest
0..5
String
/SoldTo
1
StateProvinceCode
Applies to Invoice form. Applies
Cond
/Shipment
SoldTo location’s state or province code.
/Address
Applies to Invoice form. Applies
/ShipmentConfirmRequest
1..10
String
1
/SoldTo
to NAFTA CO form if sold to
Cond
PostalCode
option is empty or not present
Required for certain countries
/StateProvinceCode
/Shipment
to NAFTA CO form if sold to
SoldTo location’s postal code.
/Address
/PostalCode
9 February 2009
option is empty or not present
Required for certain countries
The length of the postal code
depends on the country code.
Page 57
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
LENGTH
1..35
Address Line 3 of the pickup location. Usually
VALIDATION RULES
FORWARD ONLY
TYPE
DESCRIPTION
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Applies to Invoice form. Applies
/ShipmentConfirmRequest
2
String
/SoldTo
1
CountryCode
to NAFTA CO form if sold to
Cond
/Shipment
option is empty or not present
SoldTo location’s country code.
Required for Invoice
/Address
Required for NAFTA CO if sold
/CountryCode
to option is not provided
/PaymentInformation
element,
N/A
Container
/Shipment
1
PaymentInformation
Cond
This element or its sibling
/ShipmentConfirmRequest
Payment information
ItemizedPaymentInformation,
must be present but no more
than one can be present.
1
billing option. This element or its
N/A
/PaymentInformation
Cond
Prepaid
/Shipment
Container
Required for the Bill Shipper
/ShipmentConfirmRequest
sibling element, BillThirdParty or
Prepaid container for a billing option.
FreightCollect must be present,
/Prepaid
but no more than one can be
present.
A payment method must be
/Prepaid
/BillShipper
Container for the BillShipper billing option. The
N/A
/PaymentInformation
Container
BillShipper
1
/Shipment
Cond
/ShipmentConfirmRequest
two payment methods that are available for
the Bill Shipper billing option are account
number or credit card.
specified for the Bill Shipper
billing option. Therefore, either
the AccountNumber child
element or the CreditCard child
element must be provided, but
not both.
9 February 2009
Page 58
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Must be the same UPS account
/ShipmentConfirmRequest
number as the one provided in
Shipper/ShipperNumber. Either
6
String
UPS Account number.
element CreditCard must be
/BillShipper
provided, but both may not be
/AccountNumber
provided.
Required if
/ShipmentConfirmRequest
Credit card information container
not present. Credit card payment
/BillShipper
is valid for shipments without
/CreditCard
return service only.
Values are
/ShipmentConfirmRequest
‘01’ = American Express,
/Shipment
/BillShipper
/CreditCard
/Type
2
String
/Prepaid
1
Type
‘03’ = Discover,
Yes*
/PaymentInformation
d/BillShipper/AccountNumber is
Yes
1
ment/PaymentInformation/Prepai
N/A
/Prepaid
Cond
/PaymentInformation
Container
/ShipmentConfirmRequest/Ship
/Shipment
CreditCard
this element or the sibling
‘04’ = MasterCard,
‘05’ = Optima,
‘06’ = VISA,
Valid values are: ‘01’, ‘03’, ‘04’
and ‘06’.For Discover card the
ShipFrom country has to be US
‘07’ = Bravo, and
‘08’ = Diners Club.
9 February 2009
Page 59
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/Prepaid
1
/PaymentInformation
Cond
/Shipment
AccountNumber
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/PaymentInformation
Number
/Prepaid
Yes
/Shipment
/BillShipper
/CreditCard
/Number
/ShipmentConfirmRequest
/Prepaid
month and YYYY is the 4 digit year.
/BillShipper
Valid month values are 01-12
and valid year values are
Yes
/PaymentInformation
ExpirationDate
Yes*
/Shipment
Present Year - 2015
/CreditCard
/ExpirationDate
Valid values are 3 or 4 digit It is
recommended to provide the
/ShipmentConfirmRequest
security code if credit card
/Shipment
/BillShipper
/CreditCard
front of credit card or on the back of credit
the ShipFrom countries are other
card. Number of digits varies by credit card
than the below mentioned
type.
countries. Argentina, Bahamas,
/SecurityCode
Costa Rica, Dominican Rep,
Guatemala, Panama, Puerto
Rico, Russia.
9 February 2009
Page 60
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
3..4
String
1
/Prepaid
Cond
/PaymentInformation
SecurityCode
Three or four digits that can be found either on information is provided and when
PARTIAL INV.
SED
INVOICE
N/AFTA CO
6
/ShipmentConfirmRequest
CERT. OF ORIGIN
LENGTH
9..16
String
Format is MMYYYY where MM is the 2 digit
VALIDATION RULES
RETURN ONLY
TYPE
String
Credit Card number
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes*
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/BillShipper
address if credit card information
Container to hold the Credit card Billing
is provided and when the
Address.
Yes
N/A
/Prepaid
Container
Address
It is required to provide the billing
1
/PaymentInformation
Cond
/Shipment
ShipFrom country is the US, PR,
/CreditCard
and CA.
/Address
/ShipmentConfirmRequest
/Shipment
1..35
Address Line 1 of the credit card billing
1..35
Address Line 2 of the credit card billing
address. Usually Street address information.
Yes
String
/BillShipper
String
/Prepaid
1
AddressLine1
Yes*
/PaymentInformation
/CreditCard
/Address
/AddressLine1
/ShipmentConfirmRequest
/Shipment
/BillShipper
Address. Usually Room/Floor information.
/CreditCard
/Address
/AddressLine2
9 February 2009
Page 61
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/Prepaid
1
AddressLine2
No
/PaymentInformation
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/Shipment
/Prepaid
/BillShipper
address. Usually department information.
Yes
AddressLine3
No
/PaymentInformation
/CreditCard
/Address
/AddressLine3
/ShipmentConfirmRequest
/Shipment
Yes
String
/BillShipper
1
/Prepaid
1
City
Yes*
/PaymentInformation
/CreditCard
/Address
/City
/ShipmentConfirmRequest
/Shipment
/Prepaid
/BillShipper
address.
/CreditCard
/Address
/StateProvinceCode
9 February 2009
Page 62
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
StateProvinceCode
Yes*
/PaymentInformation
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
2..5
State or province code of the credit card billing
VALIDATION RULES
RETURN ONLY
LENGTH
1..35
1..30
City of the credit card billing address
DESCRIPTION
FORWARD ONLY
TYPE
String
Address Line 3 of the credit card billing
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/Shipment
PostalCode
/Prepaid
/BillShipper
Yes
/PaymentInformation
/CreditCard
/Address
/PostalCode
/ShipmentConfirmRequest
/PaymentInformation
CountryCode
/Prepaid
/BillShipper
Must be a valid UPS Billing
country code. For Discover card
it should be US
/CreditCard
/Address
/CountryCode
element Prepaid or
N/A
/PaymentInformation
1
/Shipment
Cond
BillThirdParty
Container
This element or its sibling
/ShipmentConfirmRequest
Container for the third party billing option.
FreightCollect must be present,
but no more than one can be
/BillThirdParty
present.
/BillThirdParty
N/A
Container
/PaymentInformation
1
/Shipment
BillThirdPartyShipper
Yes
/ShipmentConfirmRequest
Container for the third party shipper billing
option.
/BillThirdPartyShipper
9 February 2009
Page 63
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/Shipment
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1..10
2
VALIDATION RULES
RETURN ONLY
TYPE
String
String
Credit card billing address country code.
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
Credit card billing addressee postal code.
1
XPATH
REQUIRED
NAME
Yes*
ShipmentConfirmRequest
Yes*
UPS OnLine Tools Shipping
The account must be a valid
UPS account number that is
active. For US, PR and CA
/ShipmentConfirmRequest
accounts, the account must be
6
String
/BillThirdParty
either a daily pickup account, an
1
AccountNumber
/PaymentInformation
Yes
/Shipment
The UPS account number of the third party
occasional account, or a
shipper.
customer B.I.N account, or a
/BillThirdPartyShipper
drop shipper account. All other
/AccountNumber
accounts must be either a daily
pickup account, an occasional
account, a drop shipper account,
or a non-shipping account
N/A
/BillThirdParty
Container for additional information for the
N/A
/PaymentInformation
1
ThirdParty
Yes
/Shipment
Container
/ShipmentConfirmRequest
Container for additional information for the
third party shipper's UPS account.
/BillThirdPartyShipper
/ThirdParty
/ShipmentConfirmRequest
/BillThirdPartyShipper
Container
/BillThirdParty
1
/PaymentInformation
Address
Yes
/Shipment
third party shipper's UPS account address.
/ThirdParty
/Address
9 February 2009
Page 64
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
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
/ShipmentConfirmRequest
account pickup address has a
/Shipment
postal code. If the UPS account's
1..10
/BillThirdPartyShipper
String
/BillThirdParty
1
PostalCode
The postal code for the UPS account's pickup pickup country is US or Puerto
Cond
/PaymentInformation
/ThirdParty
address. The pickup postal code was entered
Rico, the postal code is 5 or 9
in the UPS system when the account was set- digits. The character '-' may be
up.
used to separate the first five
/Address
digits and the last four digits. If
/PostalCode
the UPS account's pickup
country is CA, the postal code is
6 alphanumeric characters
whose format is A#A#A# where
A is an uppercase letter and # is
a digit.
/ShipmentConfirmRequest
/Shipment
/BillThirdPartyShipper
2
String
/BillThirdParty
1
CountryCode
Yes
/PaymentInformation
The country code for the UPS account's
pickup address.
/ThirdParty
/Address
/CountryCode
9 February 2009
Page 65
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Container for the Freight Collect billing option.
/FreightCollect
must be present, but no more
than one can be present. Only
Yes
1
element Prepaid or BillThirdParty
N/A
/PaymentInformation
Cond
FreightCollect
/Shipment
Container
This element or its sibling
/ShipmentConfirmRequest
allowed for shipment without
return service.
/FreightCollect
Container for billing the consignee all freight
Yes
N/A
Container
/PaymentInformation
1
/Shipment
BillReceiver
Yes
/ShipmentConfirmRequest
charges option.
/BillReceiver
The account must be a valid
UPS account number that is
6
String
/FreightCollect
1
either a daily pickup account, an
/PaymentInformation
Yes
AccountNumber
accounts, the account must be
/Shipment
The UPS account number of Freight Collect.
occasional account, a customer
B.I.N account, or a dropper
/BillReceiver
shipper account. All other
/AccountNumber
accounts must be either a daily
pickup account, an occasional
account, a drop shipper account,
or a non-shipping account
9 February 2009
Page 66
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
active. For US, PR and CA
/ShipmentConfirmRequest
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Address
/PaymentInformation
No
/Shipment
/FreightCollect
Yes
/ShipmentConfirmRequest
receiver's UPS account address.
/BillReceiver
/Address
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
/Shipment
/BillReceiver
/Address
1..10
String
/FreightCollect
1
PostalCode
The postal code for the UPS account's pickup
Cond
/PaymentInformation
address. The pickup postal code was entered
in the UPS system when the account was setup.
/PostalCode
account pickup address has a
postal code. If the UPS account's
pickup country is US or Puerto
Rico, the postal code is 5 or 9
digits. If the UPS account's
pickup country is CA, the postal
code is 6 alphanumeric
characters whose format is
A#A#A# where A is an
uppercase letter and # is a digit.
9 February 2009
Page 67
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/ShipmentConfirmRequest
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
Container for additional information for the bill
VALIDATION RULES
FORWARD ONLY
LENGTH
DESCRIPTION
N/A
TYPE
Container
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
This element or its sibling
/PaymentInformation
0
String
/Shipment
1
ConsigneeBilled
Consignee Billing payment option indicator.
Cond
/ShipmentConfirmRequest
The presence indicates consignee billing
option is selected. The absence indicates one
/ConsigneeBilled
of the other payment options is selected.
element Prepaid or
FreightCollect or BillThirdParty
must be present, but no more
than one can be present. Only
applies to US/PR and PR/US
/ItemizedPaymentInformation
N/A
that are available for specification are
must be present but no more
1
applicable to a shipment and a
N/A
/ItemizedPaymentInformation
This element or its sibling
shipment charges. The two shipment charges element, PaymentInformation,
If Duty and Tax charges are
Yes
/Shipment
Payment information container for detailed
Transportation charges and Duties and Taxes. than one can be present.
/ShipmentConfirmRequest
ShipmentCharge
Container
/Shipment
Container
ItemizedPaymentInformation
1
/ShipmentConfirmRequest
Cond
shipment origins and destination.
Shipment charge container
/ShipmentCharge
9 February 2009
payer is not specified, the default
payer of Duty and Tax charges is
Bill to Receiver.
Page 68
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
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
2
/ItemizedPaymentInformation
String
Type
Shipment is any shipment in
1
/Shipment
Yes*
/ShipmentConfirmRequest
/ShipmentCharge
Values are
which one of the following
‘01’ = Transportation,
applies:1) The origin and
‘02’ = Duties and Taxes
destination country is the same2)
/Type
US to PR shipment3) PR to US
shipment4) The origin and
destination country are both
European Union Countries and
the GoodsNotInFreeCirculation
indicator is not present5) The
origin and destination IATA code
is the same
This element or its sibling
/ShipmentCharge
/BillShipper
Container for the BillShipper billing option. The element, BillReceiver,
N/A
Container
/ItemizedPaymentInformation
1
/Shipment
BillShipper
Cond
/ShipmentConfirmRequest
two payment methods that are available for
BillThirdParty or
the Bill Shipper billing option are account
ConsigneeBilled, must be
number or credit card.
present but no more than one
9 February 2009
can be present.
Page 69
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Must be the same UPS account
/ShipmentConfirmRequest
number as the one provided in
/ShipmentCharge
Shipper/ShipperNumber. Either
6
String
/ItemizedPaymentInformation
1
AccountNumber
Cond
/Shipment
UPS account number
this element or the sibling
element CreditCard must be
/BillShipper
provided, but both may not be
/AccountNumber
provided.
Required if
N/A
/ShipmentCharge
Container
ment/ItemizedPaymentInformatio
/ItemizedPaymentInformation
1
/ShipmentConfirmRequest/Ship
/Shipment
Cond
CreditCard
/ShipmentConfirmRequest
n/ShipmentCharge/BillShipper/A
Credit card information container
ccountNumber is not present.
/BillShipper
Credit card payment is valid for
/CreditCard
shipments without return service
only.
/ShipmentConfirmRequest
/Shipment
/BillShipper
/CreditCard
2
String
/ShipmentCharge
1
Type
Values are ‘01’ = American Express, ‘03’ =
Yes*
/ItemizedPaymentInformation
Discover, ‘04’ = MasterCard, ‘05’ = Optima,
‘06’ = VISA, ‘07’ = Bravo, and ‘08’ = Diners
Club
Valid values are: ‘01’, ‘03’, ‘04’
and ‘06’.For Discover card the
ShipFrom country has to be US
/Type
9 February 2009
Page 70
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/Shipment
/ItemizedPaymentInformation
Number
/ShipmentCharge
/BillShipper
/CreditCard
/Number
/ShipmentConfirmRequest
/Shipment
ExpirationDate
/ShipmentCharge
Valid month values are 01-12
Yes*
/ItemizedPaymentInformation
/BillShipper
and valid year values are
month and YYYY is the 4 digit year.
Present Year – (Present Year +
10 years)
/CreditCard
/ExpirationDate
/ShipmentConfirmRequest
/Shipment
/BillShipper
/CreditCard
3..4
String
/ShipmentCharge
1
SecurityCode
Three or four digits that can be found either on
Cond
/ItemizedPaymentInformation
top of credit card number or on the back of
credit card. Number of digits varies for
different type of credit card.
Valid values are 3 or 4 digits.
Required if credit card
information is provided and
ShipFrom country is US, CA, or
PR.
/SecurityCode
9 February 2009
Page 71
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
6
/ShipmentConfirmRequest
CERT. OF ORIGIN
LENGTH
9..16
String
Format is MMYYYY where MM is the 2 digit
VALIDATION RULES
RETURN ONLY
TYPE
String
Credit Card number
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes*
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
Address
/ShipmentCharge
/BillShipper
Required if credit card
N/A
/ItemizedPaymentInformation
Cond
/Shipment
Container to hold the Credit card Billing
information is provided and
Address.
ShipFrom countries are US, CA
and PR.
/CreditCard
/Address
/ShipmentConfirmRequest
/Shipment
String
1..35
Address Line 1 of the credit card billing
1..35
/BillShipper
String
/ShipmentCharge
1
AddressLine1
Yes*
/ItemizedPaymentInformation
Address Line 2 of the credit card billing
address. Usually Street address information.
/CreditCard
/Address
/AddressLine1
/ShipmentConfirmRequest
/Shipment
/ShipmentCharge
/BillShipper
1
AddressLine2
No
/ItemizedPaymentInformation
Address. Usually Room/Floor information.
/CreditCard
/Address
/AddressLine2
9 February 2009
Page 72
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
TYPE
Container
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/Shipment
AddressLine3
/ShipmentCharge
No
/ItemizedPaymentInformation
/BillShipper
address. Usually department information.
/CreditCard
/Address
/AddressLine3
/ShipmentConfirmRequest
/Shipment
String
/BillShipper
1
/ShipmentCharge
1
City
Yes*
/ItemizedPaymentInformation
/CreditCard
/Address
/City
/ShipmentConfirmRequest
/Shipment
StateProvinceCode
/ShipmentCharge
/BillShipper
Yes*
/ItemizedPaymentInformation
address.
/CreditCard
/Address
/StateProvinceCode
9 February 2009
Page 73
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
2..5
State or province code of the credit card billing
VALIDATION RULES
RETURN ONLY
LENGTH
1..35
1..30
City of the credit card billing address
DESCRIPTION
FORWARD ONLY
TYPE
String
Address Line 3 of the credit card billing
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/Shipment
/ItemizedPaymentInformation
PostalCode
/ShipmentCharge
/BillShipper
/CreditCard
/Address
/PostalCode
/ShipmentConfirmRequest
/Shipment
/ItemizedPaymentInformation
CountryCode
/ShipmentCharge
/BillShipper
Must be a valid UPS Billing
country code. For Discover card
it should be US
/CreditCard
/Address
/CountryCode
This element or its sibling
element, BillShipper,
/ShipmentCharge
BillThirdParty or
N/A
/ItemizedPaymentInformation
Container
BillReceiver
1
/Shipment
Cond
/ShipmentConfirmRequest
Container for the BillReceiver billing option.
/BillReceiver
ConsigneeBilled, must be
present but no more than one
can be present. For a return
shipment, BillReceiver is invalid
for Transportation charges.
9 February 2009
Page 74
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1..10
2
VALIDATION RULES
RETURN ONLY
TYPE
String
String
Credit card billing address country code.
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
Credit card billing addressee postal code.
1
XPATH
REQUIRED
NAME
Yes*
ShipmentConfirmRequest
Yes*
UPS OnLine Tools Shipping
The account must be a valid
UPS account number that is
active. For US, PR and CA
/ShipmentCharge
6
String
either a daily pickup account, an
/ItemizedPaymentInformation
1
accounts, the account must be
/Shipment
Yes
AccountNumber
/ShipmentConfirmRequest
occasional account, a customer
The UPS account number.
B.I.N account, or a dropper
/BillReceiver
shipper account. All other
/AccountNumber
accounts must be either a daily
pickup account, an occasional
account, a drop shipper account,
or a non-shipping account
/ShipmentCharge
N/A
/ItemizedPaymentInformation
1
Address
No
/Shipment
Container
/ShipmentConfirmRequest
Container for additional information for the bill
receiver's UPS account address.
/BillReceiver
/Address
9 February 2009
Page 75
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
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
/ShipmentConfirmRequest
postal code. If the UPS account's
/Shipment
1..10
String
1
/ShipmentCharge
Cond
/ItemizedPaymentInformation
PostalCode
The postal code for the UPS account's pickup pickup country is US or Puerto
/BillReceiver
address. The pickup postal code was entered
up.
/Address
Rico, the postal code is 5 or 9
in the UPS system when the account was set- digits. The character '-' may be
used to separate the first five
digits and the last four digits. If
/PostalCode
the UPS account's pickup
country is CA, the postal code is
6 alphanumeric characters
whose format is A#A#A# where
A is an uppercase letter and # is
a digit.
/ShipmentCharge
element, BillShipper, BillReceiver
N/A
/ItemizedPaymentInformation
Container
BillThirdParty
This element or its sibling
1
/Shipment
Cond
/ShipmentConfirmRequest
Container for the third party billing option.
/BillThirdParty
9 February 2009
or ConsigneeBilled, must be
present but no more than one
can be present.
Page 76
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
N/A
/ShipmentCharge
1
/ItemizedPaymentInformation
Cond
BillThirdPartyShipper
Container
This element or its sibling
/Shipment
Container for the shipper third party billing
option.
element,
BillThirdPartyConsignee, must
be present but no more than one
/BillThirdParty
can be present.
/BillThirdPartyShipper
The account must be a valid
UPS account number that is
active. For US, PR and CA
/ShipmentConfirmRequest
accounts, the account must be
/Shipment
6
String
/ShipmentCharge
1
AccountNumber
either a daily pickup account, an
Yes
/ItemizedPaymentInformation
/BillThirdParty
The UPS account number of the third party
occasional account, or a
shipper.
customer B.I.N account, or a
drop shipper account. All other
/BillThirdPartyShipper
accounts must be either a daily
/AccountNumber
pickup account, an occasional
account, a drop shipper account,
or a non-shipping account
/ShipmentConfirmRequest
/BillThirdParty
N/A
Container
/ShipmentCharge
1
/ItemizedPaymentInformation
ThirdParty
Yes
/Shipment
Container for additional information for the
third party shipper's UPS account.
/BillThirdPartyShipper
/ThirdParty
9 February 2009
Page 77
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
Address
/ShipmentCharge
/BillThirdParty
Yes
/ItemizedPaymentInformation
N/A
/Shipment
Container for additional information for the
third party shipper's UPS account address.
/BillThirdPartyShipper
/ThirdParty
/Address
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
/ShipmentConfirmRequest
account pickup address has a
/Shipment
postal code. If the UPS account's
/ItemizedPaymentInformation
/BillThirdPartyShipper
/ThirdParty
1..10
String
1
/BillThirdParty
Cond
/ShipmentCharge
PostalCode
The postal code for the UPS account's pickup pickup country is US or Puerto
address. The pickup postal code was entered
Rico, the postal code is 5 or 9
in the UPS system when the account was set- digits. The character '-' may be
up.
/Address
/PostalCode
used to separate the first five
digits and the last four digits. If
the UPS account's pickup
country is CA, the postal code is
6 alphanumeric characters
whose format is A#A#A# where
A is an uppercase letter and # is
a digit.
9 February 2009
Page 78
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
TYPE
Container
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/Shipment
/BillThirdParty
2
/ShipmentCharge
CountryCode
Yes
/ItemizedPaymentInformation
The country code for the UPS account's
pickup address.
/BillThirdPartyShipper
/ThirdParty
/Address
/CountryCode
This element or its sibling
N/A
/ShipmentCharge
1
BillThirdPartyConsignee
/ItemizedPaymentInformation
Cond
/Shipment
Container
/ShipmentConfirmRequest
Container for the consignee third party billing
element, BillThirdPartyShipper,
option.
must be present but no more
/BillThirdParty
than one can be present.
/BillThirdPartyConsignee
The account must be a valid
UPS account number that is
active. For US, PR and CA
/ShipmentConfirmRequest
accounts, the account must be
/Shipment
/BillThirdParty
6
String
/ShipmentCharge
1
AccountNumber
either a daily pickup account, an
Yes
/ItemizedPaymentInformation
The UPS account number of the third party
occasional account, or a
consignee.
customer B.I.N account, or a
/BillThirdPartyConsignee
/AccountNumber
drop shipper account. All other
accounts must be either a daily
pickup account, an occasional
account, a drop shipper account,
or a non-shipping account
9 February 2009
Page 79
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
TYPE
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/BillThirdParty
N/A
/ShipmentCharge
Container for additional information for the
N/A
/ItemizedPaymentInformation
ThirdParty
Yes
/Shipment
Container for additional information for the
third party consignee's UPS account.
/BillThirdPartyConsignee
/ThirdParty
/ShipmentConfirmRequest
/ShipmentCharge
/BillThirdParty
1
Address
Yes
/ItemizedPaymentInformation
Container
/Shipment
third party consignee's UPS account address.
/BillThirdPartyConsignee
/ThirdParty
/Address
9 February 2009
Page 80
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
TYPE
Container
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
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
/ShipmentConfirmRequest
account pickup address has a
/Shipment
postal code. If the UPS account's
/ItemizedPaymentInformation
1..10
String
1
/BillThirdParty
Cond
/ShipmentCharge
PostalCode
The postal code for the UPS account's pickup pickup country is US or Puerto
/BillThirdPartyConsignee
address. The pickup postal code was entered
up.
/ThirdParty
Rico, the postal code is 5 or 9
in the UPS system when the account was set- digits. The character '-' may be
used to separate the first five
digits and the last four digits. If
/Address
the UPS account's
/PostalCode
pickup country is CA, the postal
code is 6 alphanumeric
characters whose format is
A#A#A# where A is an
uppercase letter and # is a digit.
/ShipmentConfirmRequest
/Shipment
/BillThirdPartyConsignee
2
String
/BillThirdParty
1
/ShipmentCharge
CountryCode
Yes
/ItemizedPaymentInformation
The country code for the UPS account's
pickup address.
/ThirdParty
/Address
/CountryCode
9 February 2009
Page 81
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
This element or its sibling
element, BillShipper, BillReceiver
or BillThirdParty, must be
0
/ItemizedPaymentInformation
String
ConsigneeBilled
1
/Shipment
Cond
/ShipmentConfirmRequest
Consignee Billing payment option indicator.
present but no more than one
The presence indicates consignee billing
can be present. This billing
option is selected. The absence indicates one option is valid for a shipment
/ShipmentCharge
of the other payment options is selected.
/ConsigneeBilled
charge type of Transportation
only. Only applies to US/PR and
PR/US shipment origins and
destination.
Split Duty VAT Indicator. The presence
indicates the payer specified for
/ItemizedPaymentInformation
The payment method for
Transportation Charges will pay transportation Transportation charges must be
0
String
/Shipment
1
SplitDutyVATIndicator
No
/ShipmentConfirmRequest
/SplitDutyVATIndicator
charges and any duties that apply to the
UPS account. The UPS account
shipment. The payer specified for Duties and
must be a daily pickup account
Taxes will pay the VAT (Value-Added Tax)
or an occasional account.
only.
This indicator is invalid for a
0
1
/GoodsNotInFreeCirculationIn
String
tor
No
/ShipmentConfirmRequest
GoodsNotInFreeCirculationIndica /Shipment
Goods Not In Free Circulation indicator.
DocumentsOnly.
/RateInformation
N/A
1
/Shipment
No
/ShipmentConfirmRequest
Container
dicator
RateInformation
package type of UPS Letter and
Rate information
9 February 2009
Page 82
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
The Shipper account and Userid
combination must be qualified to
receive Negotiated rates. If the
indicator is present and the
/RateInformation
0
String
/Shipment
1
NegotiatedRatesIndicator
Negotiated Rates option indicator. If the
Yes*
/ShipmentConfirmRequest
indicator is present and the Shipper is
authorized then Negotiated Rates should be
/NegotiatedRatesIndicator
returned in the response.
Shipper is qualified then
Negotiated rates will be returned
in the response. Only the
Shipper account number taken
from
/ShipmentConfirmRequest/Ship
ment/Shipper/ShipperNumber is
used when checking qualification
for Negotiated rates.
Must contain alphanumeric
18
/MovementReferenceNumb
1
MovementReferenceNumber
No
/Shipment
String
/ShipmentConfirmRequest
er
Movement Reference Number. Used for for
characters only.
Germany to non-EU export shipments over
Must be a length of 18
1000 Euros that require an Export
characters.
Accompanying Document
The 3rd and 4th Characters must
/ReferenceNumber
N/A
1
/Shipment
No
/ShipmentConfirmRequest
ReferenceNumber
Container
be the Shipper country ISO Code
Reference Number information container
9 February 2009
Valid if the origin/destination pair
is not US/US or PR/PR.
Page 83
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Only one shipment-level or
package-level reference number
can be bar coded per shipment.
/ReferenceNumber
0
String
/Shipment
1
BarCodeIndicator
No
/ShipmentConfirmRequest
If the indicator is present then the reference
number’s value will be bar coded on the label.
/BarCodeIndicator
In order to barcode a reference
number, its value must be no
longer than 14 alphanumeric
characters or 24 numeric
characters and cannot contain
spaces.
/ReferenceNumber
2
String
/Shipment
1
Code
Yes
/ShipmentConfirmRequest
/Code
Shipment Reference number type code. The
Valid if the origin/destination pair
code specifies the Reference name. Refer to
is not US/US or PR/PR2
the Reference Number Code table.
character alpha-numeric.
String
1..35
Customer supplied reference number.
Container
N/A
1
/ReferenceNumber
1
/Shipment
Yes
Value
Yes
/ShipmentConfirmRequest
UPS service type
Valid if the origin/destination pair
is not US/US or PR/PR
/Value
/ShipmentConfirmRequest
Service
/Shipment
/Service
9 February 2009
Page 84
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Values are:
‘01’ = Next Day Air,
/Service
The following Services are not
‘03’ = Ground,
available to return shipment:
‘07’ = Express,
13 - Next Day Air Saver
‘08’ = Expedited,
14 - Next Day Air Early AM,
‘11’ = UPS Standard,
59 – 2nd Day Air A.M.
‘12’ = 3 Day Select, ‘13’ = Next Day Air Saver, 82 = UPS Today Standard
2
String
/Shipment
1
Code
Yes
/ShipmentConfirmRequest
‘02’ = 2nd Day Air,
/Code
‘14’ = Next Day Air Early AM,
83 = UPS Today Dedicated
‘54’ = Express Plus,
Courier
‘59’ = 2nd Day Air A.M.,
84 = UPS Today Intercity
‘65’ = UPS Saver.
85 = UPS Today Express
‘82’ = UPS Today Standard
86 = UPS Today Express Saver.
‘83’ = UPS Today Dedicated Courier
Refer to service guide for
‘84’ = UPS Today Intercity
available services.
‘85’ = UPS Today Express
‘86’ = UPS Today Express Saver
1..35
/Service
String
/Shipment
1
Description
No
/ShipmentConfirmRequest
Description of the service code. Examples are
Next Day Air, Worldwide Express, Ground.
/Description
9 February 2009
Page 85
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Required for shipments that do
not have any packages of type
UPS Letter and whose origin is
/InvoiceLineTotal
Rico or Canada.
N/A
/Shipment
Container
InvoiceLineTotal
1
/ShipmentConfirmRequest
Cond
the US and destination is Puerto
If International forms Invoice is
requested, this value should
match the invoice line total on
the invoice form. If not it will be
replaced by the actual calculated
invoice line total.
String
3
String
1..19
N/A
/InvoiceLineTotal
Container
/Shipment
1
CurrencyCode
No
/ShipmentConfirmRequest
Invoice Line Total currency type. Defaults to
Refer to Origin Country
the currency used in the shipper’s country.
Information table.
Invoice Line Total amount for the entire
Valid values are from 1 to
shipment.
99999999
/CurrencyCode
1
/InvoiceLineTotal
1
/Shipment
Yes
MonetaryValue
No
/ShipmentConfirmRequest
/MonetaryValue
/ShipmentConfirmRequest
ShipmentServiceOptions
/Shipment
/ShipmentServiceOptions
9 February 2009
Page 86
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
0
Saturday delivery indicator. The presence
Not available to shipment with
return service.
Information table for On Call Air
On Call Air container
Pickup availability. Not available
/OnCallAir
to shipment with return service.
N/A
4-Feb
District code for Hong Kong pickup locations.
Required for an On Call Air
Pickup.
Yes
Container
/OnCallAir
On Call Air Pickup details
String
/ShipmentServiceOptions
1
/Shipment
PickupDetails
Yes*
/ShipmentConfirmRequest
/PickupDetails
/ShipmentConfirmRequest
/OnCallAir
Please see appendix for valid values.
/PickupDetails
/DistrictCode
9 February 2009
Page 87
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/ShipmentServiceOptions
1
DistrictCode
No
/Shipment
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
FORWARD ONLY
Refer to the Origin Country
N/A
/ShipmentServiceOptions
Container
1
No
/ShipmentConfirmRequest
OnCallAir
indicates Saturday delivery, the absence
indicates not Saturday delivery.
/SaturdayDelivery
/Shipment
VALIDATION RULES
Yes
/ShipmentServiceOptions
String
/Shipment
1
SaturdayDelivery
No
/ShipmentConfirmRequest
DESCRIPTION
Yes
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Required for an On Call Air
Pickup. The pickup date must be
/ShipmentConfirmRequest
8
String
/OnCallAir
1
/ShipmentServiceOptions
Yes*
PickupDate
Date of the On Call Air Pickup. Format is
YYYYMMDD
creation date. Not valid if the
pickup date is the same day for
Yes
within ten days of the shipment's
/Shipment
shipment(s) containing Germany
/PickupDetails
to Germany UPS Standard
/PickupDate
service. Error 129090 will be
returned in this case.
/ShipmentConfirmRequest
4
The earliest time a shipment is ready to be
Required for an On Call Air
picked up.
Pickup.
Yes
/OnCallAir
String
/ShipmentServiceOptions
1
EarliestTimeReady
Yes*
/Shipment
/PickupDetails
/EarliestTimeReady
/OnCallAir
The latest time a shipment can be picked up.
4
String
/ShipmentServiceOptions
1
LatestTimeReady
Yes*
/Shipment
Can be also referred as the Closing Time for a
pickup time window.
/PickupDetails
Required for an On Call Air
Pickup.
Yes
/ShipmentConfirmRequest
/LatestTimeReady
/ShipmentConfirmRequest
The suite or room where the shipment is be
picked up
/PickupDetails
/SuiteRoomID
9 February 2009
Page 88
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
1..8
/OnCallAir
String
/ShipmentServiceOptions
1
SuiteRoomID
No
/Shipment
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/OnCallAir
Yes
/ShipmentServiceOptions
/PickupDetails
/FloorID
/ShipmentConfirmRequest
Location
/ShipmentServiceOptions
/OnCallAir
Yes
/Shipment
/PickupDetails
/Location
/ShipmentConfirmRequest
/Shipment
ContactInfo
/ShipmentServiceOptions
/OnCallAir
/PickupDetails
/ContactInfo
/ShipmentConfirmRequest
/PickupDetails
The name of the contact person where the
Required for an On Call Air
shipment is picked up
Pickup.
/ContactInfo
/Name
9 February 2009
Page 89
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/OnCallAir
1.35
/ShipmentServiceOptions
Name
Yes*
/Shipment
PARTIAL INV.
SED
N/A
FloorID
INVOICE
1..11
Container
String
/Shipment
N/AFTA CO
LENGTH
1..3
String
1
1
/ShipmentConfirmRequest
CERT. OF ORIGIN
TYPE
String
1
The location where to shipment is picked up
VALIDATION RULES
RETURN ONLY
MAXALLOWED
1
The floor where shipment is be picked up
DESCRIPTION
FORWARD ONLY
REQUIRED
XPATH
No
NAME
No
ShipmentConfirmRequest
No
UPS OnLine Tools Shipping
/ShipmentServiceOptions
PhoneNumber
/OnCallAir
/PickupDetails
/ContactInfo
/PhoneNumber
The phone number of the contact person
Required for an On Call Air
where the shipment is picked up.
Pickup.
/ShipmentConfirmRequest
PhoneNumber, is required and a
phone number is not provide at
/ContactInfo
Yes
Required if parent element,
N/A
/PickupDetails
1
StructuredPhoneNumber
/OnCallAir
Cond
/ShipmentServiceOptions
Container
/Shipment
the parent node.
/PhoneNumber
/StructuredPhoneNumber
/ShipmentConfirmRequest
/Shipment
/ContactInfo
The Country Code portion of the phone
number.
Not valid for US phone numbers.
/PhoneNumber
/StructuredPhoneNumber
/PhoneCountryCode
9 February 2009
Page 90
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
1..3
1
/PickupDetails
No
/OnCallAir
PhoneCountryCode
String
/ShipmentServiceOptions
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
LENGTH
1..15
/Shipment
VALIDATION RULES
FORWARD ONLY
TYPE
StructuredPhoneNumb
/ShipmentConfirmRequest
DESCRIPTION
Yes
MAXALLOWED
XPATH
1
Mixed: String or
NAME
REQUIRED
ShipmentConfirmRequest
Cond
UPS OnLine Tools Shipping
Yes
/PickupDetails
/ContactInfo
/PhoneNumber
/StructuredPhoneNumber
/PhoneDialPlanNumber
/ShipmentConfirmRequest
/Shipment
/PickupDetails
Yes
/OnCallAir
PhoneLineNumber
Yes
/ShipmentServiceOptions
/ContactInfo
/PhoneNumber
/StructuredPhoneNumber
/PhoneLineNumber
/ShipmentConfirmRequest
/Shipment
/ShipmentServiceOptions
/OnCallAir
PhoneExtension
/PickupDetails
/ContactInfo
/PhoneNumber
/StructuredPhoneNumber
/PhoneExtension
9 February 2009
Page 91
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
1..4
/OnCallAir
PhoneDialPlanNumber
SED
1..15
String
/ShipmentServiceOptions
INVOICE
1..15
String
1
Phone extension.
/Shipment
N/AFTA CO
LENGTH
String
1
Line number portion of the phone number.
/ShipmentConfirmRequest
CERT. OF ORIGIN
TYPE
1
Dial plan number portion of the phone number.
VALIDATION RULES
RETURN ONLY
MAXALLOWED
DESCRIPTION
FORWARD ONLY
REQUIRED
XPATH
Yes
NAME
Yes
ShipmentConfirmRequest
No
UPS OnLine Tools Shipping
Indicates COD is requested.
COD container
shipper's account type Daily
Yes
/ShipmentServiceOptions
for EU origin countries and for
N/A
1
/Shipment
No
COD
Container
Shipment COD is only available
/ShipmentConfirmRequest
Pickup and Drop Shipping
/COD
Not available to shipment with
return service.
COD type value. ‘3’ = Tagless COD.
Valid value is ‘3’.
Yes
1
String
/ShipmentServiceOptions
1
/Shipment
CODCode
Yes
/ShipmentConfirmRequest
/COD
/CODCode
/ShipmentConfirmRequest
'1' = cash
‘9’ = check, cashier’s check or money order -
/COD
no cash allowed
/CODFundsCode
/COD
N/A
Container
/ShipmentServiceOptions
1
/Shipment
CODAmount
Yes
/ShipmentConfirmRequest
/CODAmount
9 February 2009
Page 92
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
1
/ShipmentServiceOptions
No
CODFundsCode
String
Values are:
/Shipment
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/ShipmentServiceOptions
/COD
COD amount currency code type. Defaults to
Yes
CurrencyCode
No
/Shipment
the currency used in the destination country.
/CODAmount
/CurrencyCode
/ShipmentConfirmRequest
/COD
Yes
/ShipmentServiceOptions
1
MonetaryValue
Yes
/Shipment
COD Amount.
/CODAmount
/Notification
service) or Return Notification (valid for
shipment with UPS 1-Attempt and UPS 3Attempt Return Services).
/Shipment
6- QVN Ship Notification
/ShipmentServiceOptions
1
The type of notification requested. Valid Value:
String
/ShipmentConfirmRequest
Yes
NotificationCode
(QVN) (valid for shipment without return
N/A
/ShipmentServiceOptions
Container for the Quantum View notification
Container
/Shipment
1
Notification
No
/ShipmentConfirmRequest
Many (up to 3)
/MonetaryValue
7- QVN Exception Notification
/Notification
8 – QVN Delivery Notification
/NotificationCode
2-Return Notification
9 February 2009
Quantum view Notification is only
allowed for shipment without
return service; Return
Notification is only for allowed
return service 1-Attempt and 3Attempt
Page 93
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
3
1..8
LENGTH
TYPE
String
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/Shipment
EMailMessage
/ShipmentServiceOptions
/Notification
Container for the eMail message.
/EMailMessage
/Notification
/EMailMessage
1..50
/ShipmentServiceOptions
Up to five email addresses are
String
EMailAddress
Yes
/Shipment
Many (up to 5)
/ShipmentConfirmRequest
allowed in the shipment for all
Email address where the notification is sent
the Quantum ViewTM
notification. Up to two email
address for return notification.
/EMailAddress
/ShipmentConfirmRequest
1..50
/Notification
String
/ShipmentServiceOptions
1
UndeliverableEMailAddress
No
/Shipment
/EMailMessage
The address where an undeliverable eMail
The UndeliverableEMailAddress
message is sent if the eMail with the
must occur only once in the
notification is undeliverable.
shipment
/UndeliverableEMailAddress
/ShipmentConfirmRequest
/EMailMessage
1..50
/Notification
String
/ShipmentServiceOptions
1
FromEMailAddress
Cond
/Shipment
The e-mail address specifies the Reply To Email address. The From field of the message
Return Notification only.
header contains [email protected].
/FromEMailAddress
9 February 2009
Page 94
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
VALIDATION RULES
RETURN ONLY
TYPE
Container
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
FromName
/ShipmentServiceOptions
No
/Shipment
/Notification
The FromName must occur only
Defaults to the Shipper Name
once in the shipment
The Memo must occur only once
eMail.
in the shipment
The eMail’s subject.
Return Notification only.
/EMailMessage
/FromName
/ShipmentConfirmRequest
/ShipmentServiceOptions
1
Memo
No
/Shipment
/Notification
/EMailMessage
/Memo
/ShipmentConfirmRequest
/Notification
String
/ShipmentServiceOptions
1
Subject
No
/Shipment
Defaults to text provided by UPS
/EMailMessage
/Subject
9 February 2009
Page 95
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
LENGTH
1..35
1..150
User defined text that will be included in the
DESCRIPTION
FORWARD ONLY
TYPE
String
The name the email will appear to be from.
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Specifies a reference code and reference
number to display in the subject of the
Notification.
Refer to Table for the valid
subject codes.
The valid subject codes are:
For return notification:
If the subject code tag is not
01 - Shipment Reference Number 1
provided and the subject text is
provided, the subject of the
02 - Shipment Reference Number 2
notification will be the subject
03 - package Reference Number 1
text;
04 - package Reference Number 2
If the subject text is provided and
08 – Subject Text (Return Notification only)
the subject code tag exists, then
If a subject code is not provided or provided
the subject code value must be
that refers to a nonexistent reference number,
‘08’.
the subject will default to shipment
If Subject code is “08”, subject
Identification Number
text must exist.
/ShipmentConfirmRequest
1
String
1
Container
N/A
Container
N/A
/Notification
/EMailMessage
/SubjectCode
/ShipmentConfirmRequest
LabelDelivery
/Shipment
/ShipmentServiceOptions
Valid for shipments with a
Container for the Label Delivery accessorial
Electronic Return Label Return
Yes
/ShipmentServiceOptions
No
SubjectCode
No
/Shipment
Service.
/LabelDelivery
/LabelDelivery
1
/ShipmentServiceOptions
No
/Shipment
EMailMessage
Yes
/ShipmentConfirmRequest
Container for the eMail message.
/EMailMessage
9 February 2009
Page 96
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/ShipmentServiceOptions
/LabelDelivery
The destination eMail address for the Label
Yes
EMailAddress
Yes*
/Shipment
Delivery.
/EMailMessage
/EMailAddress
1..50
/LabelDelivery
String
/ShipmentServiceOptions
1
UndeliverableEMailAddress
No
/Shipment
The address where an undeliverable eMail
message is sent if the Label Delivery email is
Defaults to FromEMailAddress.
Yes
/ShipmentConfirmRequest
undeliverable.
/EMailMessage
/UndeliverableEMailAddress
1..50
/LabelDelivery
String
/ShipmentServiceOptions
1
FromEMailAddress
Yes*
/Shipment
The e-mail address specifies the Reply To Email address. The From field of the message
Yes
/ShipmentConfirmRequest
header contains [email protected].
/EMailMessage
/FromEMailAddress
/ShipmentConfirmRequest
The name notification will appear to be from.
Defaults to the Shipper Name
/EMailMessage
/FromName
9 February 2009
Page 97
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
1..35
/LabelDelivery
String
/ShipmentServiceOptions
1
FromName
No
/Shipment
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
LENGTH
1..50
DESCRIPTION
FORWARD ONLY
TYPE
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/ShipmentServiceOptions
/LabelDelivery
User defined text that will be included in the
Yes
Memo
No
/Shipment
eMail.
/EMailMessage
/Memo
/ShipmentConfirmRequest
/LabelDelivery
String
/ShipmentServiceOptions
1
Subject
No
/Shipment
The eMail’s subject. Defaults to the 'Label
Delivery Notification' plus the shipment ID.
Defaults to text provided by UPS
/EMailMessage
/Subject
/ShipmentConfirmRequest
/LabelDelivery
String
/ShipmentServiceOptions
1
SubjectCode
No
/Shipment
Specifies a reference code and reference
number to display in the subject of the Label
Delivery notification. When the subject code is
provided, the subject will contain the following:
1.
‘UPS Label Delivery’
2.
The reference code (the reference code
will be mapped to the corresponding
ANSI value)
Plus the reference number.
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.
/EMailMessage
/SubjectCode
9 February 2009
If a subject code is provided that
refers to a nonexistent reference
number, the subject will default
to the shipment identification
number.
Page 98
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
LENGTH
1..150
DESCRIPTION
FORWARD ONLY
TYPE
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
N/AFTA CO
INVOICE
SED
PARTIAL INV.
Rqd
Rqd
Rqd
/ShipmentServiceOptions
Rqd
/Shipment
CERT. OF ORIGIN
N/A
InternationalForms
Rqd
LENGTH
Container
International Forms information
/ShipmentConfirmRequest
VALIDATION RULES
RETURN ONLY
TYPE
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
No
UPS OnLine Tools Shipping
/InternationalForms
Possible Values are
01 – Invoice
/InternationalForms
2
/ShipmentServiceOptions
03 – CO
String
FormType
Yes*
/Shipment
Many (up to 4)
02 – SED
/ShipmentConfirmRequest
Indicates the name of the International form
requested.
/FormType
04 – NAFTA CO
05 – Partial Invoice
For shipment with return service,
01 or 05 are the only valid value.
Note: 01 &amp; 05 are mutually
exclusive and 05 is only valid for
return shipments only.
9 February 2009
Page 99
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
1.
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
This indicator should be set
when the shipper intends to
utilize UPS paperless invoice
functionality and the shipper has
SELF-PREPARED other
International Forms (SEC, CO,
/InternationalForms
NAFTA_CO or CO.
0
Opt
when:
Rqd
shipment. It is evaluated only
Opt
supply additional document, such as SED,
NAFTACO) to accompany the
Opt
Presence of the indicator means user will
0
/ShipmentServiceOptions
1
AdditionalDocumentIndicator
No
/Shipment
Empty
/ShipmentConfirmRequest
- account is paperless enabled
/AdditionalDocumentIndicator
- movement requires an invoice
- destination country accepts
paperless invoice
- invoice data is supplied by the
client and
- data passes validation
N/A
N/A
N/A
N/A
N/A
N/A
Rqd
N/A
group of International forms. This element
N/A
/InternationalForms
N/A
Contains description text which identifies the
50
1
/ShipmentServiceOptions
No
/Shipment
FormGroupIdName
String
/ShipmentConfirmRequest
does not appear on the forms.
/FormGroupIdName
/ShipmentConfirmRequest
/InternationalForms
2
String
/ShipmentServiceOptions
1
SEDFilingOption
Applicable for SED form and is
Cond
/Shipment
Indicates whether or not UPS will file SED on
required. Valid values is:01 –
shipper’s behalf.
Shipper filing SED02 – UPS filing
/SEDFilingOption
9 February 2009
SED on Shipper’s behalf –
Page 100
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Applicable for SED form and
/InternationalForms
N/A
Rqd
consignee contact information is
N/A
parties.
NAFTA CO and Invoice. Ultimate
Rqd
Holds the contact information of various
N/A
N/A
/ShipmentServiceOptions
Container
Contacts
NAFTA CO only. Required for
1
/Shipment
Cond
/ShipmentConfirmRequest
required for SED. Producer
/Contacts
contact information is required
for NAFTA CO
Container
N/A
1…35
Company Name or the Individual name of the
1…15
Tax ID of the Forwarding agent.
N/A
Opt
N/A
person acting as agent in the trans-shipping of Applicable for SED form only.
N/A
The forwarding agent is the company or
N/A
/InternationalForms
String
/ShipmentServiceOptions
1
ForwardAgent
No
/Shipment
String
/ShipmentConfirmRequest
freight to the destination country.
/Contacts
/ForwardAgent
Applicable for SED form only.
N/A
N/A
N/A
Cond Rqd Sec 5a
N/A
Applicable for SED form only.
N/A
N/A
N/A
Cond Rqd Sec 5b
N/A
/ShipmentConfirmRequest
1
1
/InternationalForms
Yes*
/ShipmentServiceOptions
CompanyName
Yes*
/Shipment
/Contacts
Forwarding agent.
/ForwardAgent
/CompanyName
/ShipmentConfirmRequest
/Shipment
/ShipmentServiceOptions
TaxIdentificationNumber
/InternationalForms
/Contacts
/ForwardAgent
/TaxIdentificationNumber
9 February 2009
Page 101
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
1…35
1…35
CERT. OF ORIGIN
LENGTH
N/A
String
String
Address line 2 of the Forwarding agent.
VALIDATION RULES
RETURN ONLY
TYPE
Container
1
Address line 1 of the Forwarding agent.
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
Address information of the Forwarding agent.
1
XPATH
REQUIRED
NAME
Yes*
ShipmentConfirmRequest
Yes*
UPS OnLine Tools Shipping
N/A
Cond Rqd Sec 5a
N/A
Applicable for SED form only.
N/A
Opt Sec 5a
N/A
N/A
Applicable for SED form only.
N/A
N/A
Applicable for SED form only.
N/A
/Contacts
N/A
/InternationalForms
N/A
/ShipmentServiceOptions
Address
N/A
/Shipment
Cond Rqd Sec 5a
/ShipmentConfirmRequest
/ForwardAgent
/Address
/ShipmentConfirmRequest
/Shipment
/ShipmentServiceOptions
AddressLine1
/InternationalForms
/Contacts
/ForwardAgent
/Address
/AddressLine1
/ShipmentConfirmRequest
/Shipment
AddressLine2
/InternationalForms
/Contacts
No
/ShipmentServiceOptions
Usually Room/Floor information
/ForwardAgent
/Address
/AddressLine2
9 February 2009
Page 102
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
1…5
State of the Forwarding agent.
VALIDATION RULES
RETURN ONLY
LENGTH
1…35
1…30
City of the Forwarding agent.
DESCRIPTION
FORWARD ONLY
TYPE
String
Address line 3 of the Forwarding agent.
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
Applicable for SED form only.
N/A
Usually department information
N/A
/Contacts
N/A
/InternationalForms
N/A
AddressLine3
No
/ShipmentServiceOptions
Opt Sec 5
/Shipment
/ForwardAgent
/Address
/AddressLine3
/ShipmentConfirmRequest
Applicable for SED form only.
N/A
N/A
N/A
Cond Rqd Sec 5a
N/A
Applicable for SED form only.
N/A
N/A
N/A
Cond Rqd Sec 5a
N/A
/Shipment
1
String
/Contacts
1
/InternationalForms
Yes*
City
Cond
/ShipmentServiceOptions
/ForwardAgent
/Address
/City
/ShipmentConfirmRequest
/Shipment
/ShipmentServiceOptions
StateProvinceCode
/InternationalForms
/Contacts
Required for certain countries.
/ForwardAgent
/Address
/StateProvinceCode
9 February 2009
Page 103
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
N/A
The length of the postal code
/ForwardAgent
N/A
Required for certain countries.
Postal code of the Forwarding agent.
N/A
1…9
String
/Contacts
Applicable for SED form only.
1
PostalCode
/InternationalForms
Cond
/ShipmentServiceOptions
depends on the country code.
N/A
/Shipment
Cond Rqd Sec 5a
/ShipmentConfirmRequest
/Address
/PostalCode
/ShipmentConfirmRequest
N/A
N/A
N/A
Cond Rqd Sec 5a
N/A
N/A
N/A
N/A
Rqd Sec 4a
N/A
/Shipment
/Contacts
2
String
/InternationalForms
1
CountryCode
Yes*
/ShipmentServiceOptions
Country code of the Forwarding agent.
Applicable for SED form only.
/ForwardAgent
/Address
/CountryCode
/Contacts
The ultimate consignee is the person or
N/A
/InternationalForms
1
UltimateConsignee
/ShipmentServiceOptions
Cond
/Shipment
Container
/ShipmentConfirmRequest
company who receives the goods for end-use
or the person or company listed on the export
license. This is the end-user of the goods.
Applicable for SED form only.
Required when the form
requested is SED.
/UltimateConsignee
9 February 2009
Page 104
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
Address line 1 of the Ultimate consignee.
VALIDATION RULES
FORWARD ONLY
LENGTH
1…35
N/A
Address information of the Ultimate
1…35
TYPE
Company Name or the Individual name of the
Container
String
DESCRIPTION
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
N/A
Applicable for SED form only.
N/A
Ultimate consignee.
Rqd Sec
/Contacts
N/A
/InternationalForms
N/A
/ShipmentServiceOptions
CompanyName
Yes*
/Shipment
/UltimateConsignee
/CompanyName
/ShipmentConfirmRequest
Applicable for SED form only.
N/A
N/A
Rqd Sec 4a
N/A
Applicable for SED form only.
N/A
N/A
Rqd Sec 4a
N/A
consignee.
N/A
/Contacts
N/A
1
1
/InternationalForms
Yes*
/ShipmentServiceOptions
Address
Yes*
/Shipment
/UltimateConsignee
/Address
/ShipmentConfirmRequest
/Shipment
/ShipmentServiceOptions
AddressLine1
/InternationalForms
/Contacts
/UltimateConsignee
/Address
/AddressLine1
9 February 2009
Page 105
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
1…35
1…30
City of the Ultimate consignee.
VALIDATION RULES
RETURN ONLY
LENGTH
1…35
String
Address line 3 of the Ultimate consignee.
DESCRIPTION
FORWARD ONLY
TYPE
String
Address line 2 of the Ultimate consignee.
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
Applicable for SED form only.
/UltimateConsignee
N/A
Usually Room/Floor information
N/A
/Contacts
N/A
/InternationalForms
N/A
AddressLine2
No
/ShipmentServiceOptions
Opt Sec 4a
/Shipment
/Address
/AddressLine2
/ShipmentConfirmRequest
/Shipment
Applicable for SED form only.
N/A
N/A
Opt Sec 4a
N/A
Applicable for SED form only.
N/A
N/A
Cond Rqd Sec 4a
N/A
Usually department information
N/A
/Contacts
N/A
/InternationalForms
1
AddressLine3
No
/ShipmentServiceOptions
/UltimateConsignee
/Address
/AddressLine3
/ShipmentConfirmRequest
/Shipment
/InternationalForms
/Contacts
1
City
Yes*
/ShipmentServiceOptions
/UltimateConsignee
/Address
/City
9 February 2009
Page 106
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1…5
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Cond
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
Applicable for SED form only.
State of the Ultimate consignee.
Required for certain countries
/UltimateConsignee
N/A
/Contacts
N/A
/InternationalForms
N/A
StateProvinceCode
N/A
/ShipmentServiceOptions
Rqd Sec 4a
/Shipment
/Address
/StateProvinceCode
/ShipmentConfirmRequest
/Shipment
N/A
N/A
Rqd Sec 4a
N/A
N/A
Rqd Sec 4a
N/A
The length of the postal code
N/A
/UltimateConsignee
Required for certain countries.
N/A
Postal code of the Ultimate consignee.
N/A
1…9
String
/Contacts
Applicable for SED form only.
1
PostalCode
/InternationalForms
Cond
/ShipmentServiceOptions
depends on the country code.
/Address
/PostalCode
/ShipmentConfirmRequest
/Shipment
/Contacts
2
String
/InternationalForms
1
CountryCode
Yes*
/ShipmentServiceOptions
Country code of the Ultimate consignee.
Applicable for SED form only.
/UltimateConsignee
/Address
/CountryCode
9 February 2009
Page 107
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
N/A
Address information of the Intermediate
DESCRIPTION
FORWARD ONLY
N/A
1…35
Company Name or the Individual name of the
LENGTH
TYPE
Container
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Applicable for SED form only.
final delivery to the ultimate consignee.
/Contacts
N/A
company in the importing country that makes
N/A
/InternationalForms
The intermediate consignee is the person or
N/A
/ShipmentServiceOptions
N/A
IntermediateConsignee
No
/Shipment
Opt Sec 4b
/ShipmentConfirmRequest
/IntermediateConsignee
Applicable for SED form only.
N/A
N/A
N/A
Cond Rqd Sec 4b
N/A
Applicable for SED form only.
N/A
N/A
N/A
Cond Rqd Sec 4b
N/A
/ShipmentConfirmRequest
/InternationalForms
1
/ShipmentServiceOptions
CompanyName
Yes*
/Shipment
/Contacts
Intermediate consignee.
/IntermediateConsignee
/CompanyName
/ShipmentConfirmRequest
/Contacts
Container
/InternationalForms
1
/ShipmentServiceOptions
Address
Yes*
/Shipment
Consignee.
/IntermediateConsignee
/Address
9 February 2009
Page 108
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
1…35
N/AFTA CO
1…35
String
Address line 3 of the Intermediate Consignee.
CERT. OF ORIGIN
LENGTH
1…35
String
Address line 2 of the Intermediate Consignee.
VALIDATION RULES
RETURN ONLY
TYPE
String
Address line 1 of the Intermediate Consignee. Applicable for SED form only.
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes*
UPS OnLine Tools Shipping
/Contacts
N/A
/InternationalForms
N/A
AddressLine1
N/A
/ShipmentServiceOptions
/IntermediateConsignee
N/A
/Shipment
Cond Rqd Sec 4b
/ShipmentConfirmRequest
/Address
/AddressLine1
/ShipmentConfirmRequest
/Shipment
Applicable for SED form only.
N/A
N/A
Opt Sec 4b
N/A
Applicable for SED form only.
N/A
Opt Sec 4b
N/A
Usually Room/Floor information
N/A
/Contacts
N/A
/InternationalForms
N/A
AddressLine2
No
/ShipmentServiceOptions
/IntermediateConsignee
/Address
/AddressLine2
/ShipmentConfirmRequest
/Shipment
/InternationalForms
/Contacts
1
AddressLine3
No
/ShipmentServiceOptions
Usually department information
/IntermediateConsignee
/Address
/AddressLine3
9 February 2009
Page 109
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1…30
1…5
VALIDATION RULES
RETURN ONLY
TYPE
String
String
State of the Intermediate Consignee.
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
City of the Intermediate Consignee.
1
XPATH
REQUIRED
NAME
Yes*
ShipmentConfirmRequest
Cond
UPS OnLine Tools Shipping
/Contacts
Applicable for SED form only.
N/A
/InternationalForms
N/A
City
N/A
/ShipmentServiceOptions
/IntermediateConsignee
N/A
/Shipment
Cond Rqd Sec 4b
/ShipmentConfirmRequest
/Address
/City
/ShipmentConfirmRequest
N/A
N/A
N/A
Cond Rqd Sec 4b
N/A
N/A
N/A
N/A
Cond Rqd Sec 4b
N/A
/Shipment
/ShipmentServiceOptions
StateProvinceCode
/InternationalForms
/Contacts
Applicable for SED form only.
Required for certain countries.
/IntermediateConsignee
/Address
/StateProvinceCode
/ShipmentConfirmRequest
/Shipment
1…9
String
/Contacts
Applicable for SED form only.
1
PostalCode
/InternationalForms
Cond
/ShipmentServiceOptions
Postal code of the Intermediate Consignee.
/IntermediateConsignee
Required for certain countries.
The length of the postal code
depends on the country code.
/Address
/PostalCode
9 February 2009
Page 110
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
2
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes*
UPS OnLine Tools Shipping
/Contacts
Country code of the Intermediate Consignee.
Applicable for SED form only.
N/A
/InternationalForms
N/A
CountryCode
N/A
/ShipmentServiceOptions
/IntermediateConsignee
N/A
/Shipment
Cond Rqd Sec 4b
/ShipmentConfirmRequest
/Address
/CountryCode
N/A
N/A
N/A
must be the date the Certificate was
N/A
/Producer
N/A
signed, and dated by the producer. The date
N/A
Required for NAFTA CO forms
/Contacts
Rqd Sec 3
Applies to NAFTA CO
use by the exporter, it must be completed,
Rqd Sec 3
Certificate is completed by the producer for
N/A
N/A
Container
/InternationalForms
1
signed, and dated by the exporter. When the
/ShipmentServiceOptions
Cond
Producer
Certificate of Origin must be completed,
/Shipment
N/A
Information of the producer. The NAFTA
/ShipmentConfirmRequest
completed and signed.
The text associated with the code will be
printed in the producer section instead of
/ShipmentConfirmRequest
producer contact information. Use attached
/Shipment
/Contacts
/Producer
/Option
2
1
/InternationalForms
No
Option
String
List if more than one producer’s good is
/ShipmentServiceOptions
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
Applies to NAFTA CO. Possible
Values are:
01: AVAILABLE TO CUSTOMS
UPON REQUEST
02: SAME AS EXPORTER
03: ATTACHED LIST
04: UNKNOWN
field.
9 February 2009
Page 111
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
/Contacts
Conditionally required for:
NAFTA CO, when Producer
/Producer
SED
INVOICE
N/AFTA CO
PARTIAL INV.
N/A
option is empty or not present.
Producer.
N/A
Company Name or the Individual name of the
N/A
1…35
String
/InternationalForms
1
CompanyName
Only applicable when producer
Cond
/ShipmentServiceOptions
N/A
Applies to NAFTA CO
/Shipment
Cond Rqd Sec 3
/ShipmentConfirmRequest
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
option is not specified.
/CompanyName
/ShipmentConfirmRequest
N/A
Opt Sec 3
N/A
N/A
N/A
N/A
Cond Rqd Sec 3
N/A
N/A
N/A
1…15
1
/InternationalForms
No
/ShipmentServiceOptions
TaxIdentificationNumber
String
/Shipment
Applies to NAFTA CO
Tax ID of the Producer.
/Contacts
Only applicable when producer
option is empty or not present
/Producer
/TaxIdentificationNumber
/ShipmentConfirmRequest
Applies to NAFTA CO
/Contacts
Only applicable if producer
N/A
/InternationalForms
Container
Address
1
/ShipmentServiceOptions
Cond
/Shipment
Address information of the Producer.
/Producer
/Address
9 February 2009
option is empty or not present.
Conditionally required for:
NAFTA CO, when Producer
option is not specified.
Page 112
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
1…35
N/AFTA CO
1…35
String
Address line 3 of the Producer. Usually
CERT. OF ORIGIN
LENGTH
1…35
String
Address line 2 of the Producer. Usually
RETURN ONLY
TYPE
String
Address line 1 of the Producer.
VALIDATION RULES
FORWARD ONLY
MAXALLOWED
DESCRIPTION
1
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes*
UPS OnLine Tools Shipping
/Contacts
Applies to NAFTA CO
/Producer
N/A
/InternationalForms
N/A
AddressLine1
N/A
/ShipmentServiceOptions
N/A
/Shipment
Cond Rqd Sec 3
/ShipmentConfirmRequest
/Address
/AddressLine1
/ShipmentConfirmRequest
/Shipment
Applies to NAFTA CO
Opt Sec 3
N/A
N/A
N/A
Applies to NAFTA CO
N/A
N/A
N/A
Room/Floor information
Opt Sec 3
/Contacts
N/A
/InternationalForms
N/A
AddressLine2
No
/ShipmentServiceOptions
/Producer
/Address
/AddressLine2
/ShipmentConfirmRequest
/Shipment
/InternationalForms
/Contacts
1
AddressLine3
No
/ShipmentServiceOptions
department information
/Producer
/Address
/AddressLine3
9 February 2009
Page 113
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/Producer
NAFTA CO, when Producer
option is not specified.
N/A
Conditionally required for:
N/A
City of the Producer.
N/A
1…30
String
/Contacts
Applies to NAFTA CO
1
City
/InternationalForms
Yes*
/ShipmentServiceOptions
N/A
/Shipment
Cond Rqd Sec 3
/ShipmentConfirmRequest
/Address
/City
/ShipmentConfirmRequest
N/A
Cond Rqd Sec 3
N/A
N/A
N/A
N/A
Cond Rqd Sec 3
N/A
N/A
N/A
/Shipment
1…5
/Contacts
String
/InternationalForms
1
StateProvinceCode
Cond
/ShipmentServiceOptions
State of the Producer.
Applies to NAFTA CO. Required
for certain countries
/Producer
/Address
/StateProvinceCode
/ShipmentConfirmRequest
/Shipment
1…9
String
/Contacts
Applies to NAFTA CO
1
PostalCode
/InternationalForms
Cond
/ShipmentServiceOptions
Postal code of the Producer.
/Producer
Required for certain countries
The length of the postal code
depends on the country code.
/Address
/PostalCode
9 February 2009
Page 114
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1…2
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes*
UPS OnLine Tools Shipping
/Contacts
Country code of the Producer.
Applies to NAFTA CO
/Producer
N/A
/InternationalForms
N/A
CountryCode
N/A
/ShipmentServiceOptions
N/A
/Shipment
Cond Rqd Sec 3
/ShipmentConfirmRequest
/Address
/CountryCode
/InternationalForms
/Product
Opt
Rqd
Rqd
requested Product must be
Rqd
Contains the commodity/ product information
Rqd
When any International form is
N/A
/ShipmentServiceOptions
Invoice, CO and NAFTA CO.
Container
Product
Yes*
/Shipment
Many (up to 50)
Applies to SED, Invoice, Partial
/ShipmentConfirmRequest
present at least once but no
more than 50. Note: For Partial
Invoice this container is optional.
Rqd
Rqd
Rqd
Opt
N/A
Rqd
N/A
Opt
Invoice. Must be present at least
Rqd
/Product
Forms. Optional for Partial
Description of the product.
N/A
/InternationalForms
1…35
/ShipmentServiceOptions
Applies to all International
String
Description
Yes*
/Shipment
Many (up to 3)
/ShipmentConfirmRequest
once and can occur for a
maximum of 3 times
/Description
/InternationalForms
N/A
/ShipmentServiceOptions
1
Unit
Cond
/Shipment
Container
/ShipmentConfirmRequest
Container tag for the units information of each Required for Invoice forms and
product. (also called as commodity)
optional for Partial Invoice.
/Product
/Unit
9 February 2009
Page 115
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
Rqd Sec 5a
N/A
Opt
Rqd Sec 5f
N/A
Opt
be numeric. Valid characters are
N/A
Unit of Measure field
optional for Partial Invoice. Must
N/A
shipped, measured in the units specified in the
Required for Invoice forms and
N/A
/Product
Total quantity of each commodity to be
N/A
1…7
/InternationalForms
String
Number
1
/ShipmentServiceOptions
Yes*
/Shipment
0-9.
/Unit
/Number
Applies to Invoice &amp; Partial
Invoice form. Required for
Invoice forms and Partial Invoice
forms. Amount should be greater
than zero. Valid characters are 09 and .(Decimal point). Limit to 6
digits after the decimal. The
/ShipmentConfirmRequest
maximum length of the field is 12
/Product
1…12
/InternationalForms
String
Value
1
/ShipmentServiceOptions
Yes*
/Shipment
Monetary amount used to specify the worth or
price of the commodity. Amount should be
greater than zero
/Unit
/Value
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
9 February 2009
Page 116
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
CERT. OF ORIGIN
N/AFTA CO
INVOICE
SED
PARTIAL INV.
N/A
Rqd Sec 5b
N/A
Opt
optional for Partial Invoice.
N/A
Required for Invoice forms and
the commodity.
RETURN ONLY
Container tag for the Unit of measurement for
VALIDATION RULES
FORWARD ONLY
LENGTH
DESCRIPTION
N/A
TYPE
Container
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/ShipmentServiceOptions
UnitOfMeasurement
/InternationalForms
/Product
Yes*
/Shipment
/Unit
/UnitOfMeasurement
9 February 2009
Page 117
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
CERT. OF ORIGIN
N/AFTA CO
INVOICE
SED
PARTIAL INV.
N/A
N/A
Rqd
N/A
Opt
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Applies to Invoice and partial
invoice forms and is required.
Valid entries are: BA = Barrel, BE
= Bundle, BG = Bag, BH =
Bunch, BOX = Box, BT = Bolt,
BU = Butt, CI = Canister, CM =
Centimeter, CON = Container ,
/ShipmentConfirmRequest
CR = Crate, CS = Case, CT =
/Shipment
Carton, CY = Cylinder, DOZ =
1… 3
String
/Product
Dozen, EA = Each, EN =
1
Code
/InternationalForms
Yes*
/ShipmentServiceOptions
Code for the Unit of measurement of the
Envelope, FT = Feet, KG =
commodity units.
Kilogram, KGS = Kilograms, LB
/Unit
= Pound, LBS = Pounds, L =
/UnitOfMeasurement
Liter, M = Meter, NMB = Number,
/Code
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.
9 February 2009
Page 118
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
N/A
Cond Rqd Sec 5b
N/A
Cond Rqd Sec 5b
Rqd Sec 6
Opt Sec 5d?
N/A
Opt
1..3
1
String
/Product
Invoice forms. Conditionally
Cond
Description
/InternationalForms
N/A
Applies to Invoice and Partial
/ShipmentServiceOptions
N/A
/Shipment
The Unit of Measure if OTH (Other) is entered Required for the Invoice &amp; Partial
as the UnitOfMeasurement code.
Invoice form if OTH is entered as
/Unit
the units UnitOfMeasurement
/UnitOfMeasurement
code
/Description
Applies to Invoice, Partial Invoice
and NAFTA CO. Required for
NAFTA CO and optional for
Partial Invoice. Should be at
least 6 alphanumeric. For
/ShipmentConfirmRequest
NAFTA CO: For each good
/Product
6…15
String
/InternationalForms
1
CommodityCode
/ShipmentServiceOptions
Cond
/Shipment
6-to-15-alphanumeric commodity code.
Customs uses this code to determine what
duties should be assessed on the commodity.
/CommodityCode
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.
9 February 2009
Page 119
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
indicated on the customs invoice.
/Product
Invoice.
Opt
Applies to Invoice &amp; Partial
N/A
product contained in the invoice line, as
Opt Sec 5c2
The part number or reference number for the
N/A
1…10
/InternationalForms
String
/ShipmentServiceOptions
1
PartNumber
No
/Shipment
N/A
/ShipmentConfirmRequest
for NAFTA CO if
/OriginCountryCode
www.customs.gov or contact your country’s
JointProductionIndicator is not
Customs authority.
present.
Opt
Customs and Border Protection Web site at
N/A
Invoice. Conditionally required
/Product
Rqd Sec 5e
forms. Optional for Partial
related matters, please refer to the U.S.
/InternationalForms
Cond Rqd Sec 10
Required for Invoice and CO
certificate of origin, rules of origin, and any
/ShipmentServiceOptions
2
detailed information on country of origin,
String
Invoice, CO and NAFTA CO.
/Shipment
1
Applies to Invoice, Partial
manufactured, produced, or grown. For
Cond
OriginCountryCode
The country in which the good was
/ShipmentConfirmRequest
Rqd
/PartNumber
/ShipmentConfirmRequest
Opt Sec 10
N/A
N/A
N/A
N/A
N/A
N/A
/Product
Applies to NAFTA CO only
Rqd
Product/OriginCountryCode tag will be
N/A
country code on the NAFTA form and the
N/A
/InternationalForms
If present, ‘JNT’ will be used as the origin of
EMPTY
1
JointProductionIndicator
/ShipmentServiceOptions
No
/Shipment
ignored.
/JointProductionIndicator
/InternationalForms
2
String
Goods field, where the good is subject to a
/ShipmentServiceOptions
1
For each good described in the Description of
/Shipment
Cond
NetCostCode
/ShipmentConfirmRequest
regional value content (RVC) requirement,
indicate NC if the RVC is calculated according
/Product
to the net cost method; otherwise, indicate
/NetCostCode
NO.
9 February 2009
Applies to NAFTA CO only.
Required for NAFTA CO.
Possible Values: NCNO
Page 120
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
VALIDATION RULES
RETURN ONLY
TYPE
Container
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
No
UPS OnLine Tools Shipping
Date Range for regional value content (RVC)
Applies to NAFTA CO only.
N/A
/InternationalForms
N/A
/ShipmentServiceOptions
N/A
NetCostDateRange
Opt
/Shipment
N/A
/ShipmentConfirmRequest
/Product
/NetCostDateRange
/ShipmentConfirmRequest
/Shipment
Opt
N/A
N/A
N/A
N/A
N/A
N/A
Format is YYYYMMDD
Opt
Applies to NAFTA CO only.
(YYYYMMDD) of that period. (Reference:
N/A
/Product
it should be identified by the begin date
N/A
8
String
/InternationalForms
1
BeginDate
If the RVC is calculated over a period of time,
Yes*
/ShipmentServiceOptions
Articles 402.1, 402.5).
/NetCostDateRange
/BeginDate
/ShipmentConfirmRequest
/Shipment
/Product
/NetCostDateRange
8
String
/InternationalForms
1
EndDate
If the RVC is calculated over a period of time,
Yes*
/ShipmentServiceOptions
it should be identified by the End date
Applies to NAFTA CO only.
(YYYYMMDD) of that period. (Reference:
Format is YYYYMMDD
Articles 402.1, 402.5).
/EndDate
9 February 2009
Page 121
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Indicates the criterion (A through F) for each
description of these values.
/PreferenceCriteria
(certain textile goods) and Annex 308.1
N/A
ABCDEF. See Table IF1 for
agricultural goods), Annex 300-B, Appendix 6
N/A
are described in Annex 703.2 (certain
/Product
N/A
Applicable for NAFTA CO and is
Chapter Four and Annex 401. Additional rules required. Possible Values:
N/A
1
String
/InternationalForms
1
guide: The rules of origin are contained in
/ShipmentServiceOptions
Cond
PreferenceCriteria
field if applicable. Do not put in developers’
/Shipment
Rqd Sec 7
good described in the Description of Goods
/ShipmentConfirmRequest
(certain automatic data processing goods and
their parts).
Indicate the following: Yes - If shipper is the
producer of the good. If not, state 02, 03, 04
depending on whether this certificate was
/ShipmentConfirmRequest
N/A
N/A
N/A
N/A
N/A
No[2]
N/A
Yes/No[1]
representation (other than a Certificate of
Rqd Sec 8
required. Possible Values:
Reliance on the producer’s written
N/A
/Product
good qualifies as an originating good. No[2] -
N/A
3 0r 5
String
/InternationalForms
1
/ShipmentServiceOptions
Cond
ProducerInfo
Opt Sec 2a
based upon: No[1] - Knowledge of whether the Applicable for NAFTA CO and is
/Shipment
Origin) that the good qualifies as an originating No[3]
/ProducerInfo
good. No[3] - A completed and signed
Certificate for the good voluntarily provided to
the exporter by the producer.
/ShipmentConfirmRequest
1…35
/InternationalForms
String
/ShipmentServiceOptions
1
MarksAndNumbers
No
/Shipment
Any special marks, codes, and numbers that
may appear on package
Applies to CO Only
/Product
/MarksAndNumbers
9 February 2009
Page 122
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
LENGTH
1…3
DESCRIPTION
FORWARD ONLY
TYPE
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/Product
containers for the commodity
Applicable for CO and is
required. Should be numeric.
Valid characters are 0 -9.
N/A
The total number of packages, cartons, or
N/A
/InternationalForms
N/A
y
/ShipmentServiceOptions
N/A
NumberOfPackagesPerCommodit
Cond
/Shipment
Rqd Sec 2b
/ShipmentConfirmRequest
/NumberOfPackagesPerCom
modity
N/A
Rqd Sec 24
N/A
N/A
Rqd Sec 24
N/A
forms.
N/A
does not include carrier equipment.
only. Required for CO and SED
N/A
Tariff Code / Schedule B Number. This weight
Applies to CO and SED forms
Rqd Sec 2c
/Product
each commodity with a separate Harmonized
Rqd Sec 2c
The shipping weight, including containers, for
N/A
/InternationalForms
1
ProductWeight
/ShipmentServiceOptions
Cond
/Shipment
Container
/ShipmentConfirmRequest
/ProductWeight
/ShipmentConfirmRequest
/Product
N/A
Container
/InternationalForms
1
/ShipmentServiceOptions
UnitOfMeasurement
Yes*
/Shipment
Container tag for the Unit of Measurement of
Applies to CO and SED forms
weight
only
/ProductWeight
/UnitOfMeasurement
9 February 2009
Page 123
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
3
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
1
XPATH
REQUIRED
NAME
Yes*
ShipmentConfirmRequest
Yes
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
Rqd Sec 24
N/A
N/A
only. Possible values :KGS / LBS
/ProductWeight
Rqd Sec 24
Applies to CO and SED forms
N/A
Code for unit of Measurement of weight
N/A
/Product
N/A
/InternationalForms
N/A
Code
Rqd Sec 2c
/ShipmentServiceOptions
Rqd Sec 2c
/Shipment
/UnitOfMeasurement
/Code
/ShipmentConfirmRequest
/Shipment
Description
/InternationalForms
/Product
String
/ShipmentServiceOptions
/ProductWeight
/UnitOfMeasurement
/Description
/InternationalForms
1…5
Weight
String
only. Valid characters are 0-9
/ShipmentServiceOptions
1
Applies to CO and SED forms
/Shipment
Yes*
/ShipmentConfirmRequest
and .(Decimal point). Limit to 1
Weight
digit after the decimal. The
/Product
maximum length of the field is 5
/ProductWeight
including ‘.’ and can hold up to 1
/Weight
decimal place.
9 February 2009
Page 124
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/Product
(PIN) for those used self propelled vehicles for
/VehicleID
which there are no VINs. Or no Vehicle Title
N/A
Applies to SED forms only
Opt Sec 25
format. Or The Product Identification Number
N/A
Identification Number (VIN) in the proper
N/A
1…25
/InternationalForms
String
1
regulations 19 CFR 192.1: The unique Vehicle
/ShipmentServiceOptions
No
VehicleID
self-propelled vehicles as defined in Customs
/Shipment
N/A
Includes the following information for used
/ShipmentConfirmRequest
Number.
N/A
N/A
Rqd Sec 22
N/A
N/A
Rqd Sec 22
N/A
Required for SED form
N/A
a commodity
N/A
Container tag for the schedule B information of Applies to SED forms only.
N/A
/InternationalForms
N/A
/ShipmentServiceOptions
1
ScheduleB
Cond
/Shipment
Container
/ShipmentConfirmRequest
/Product
/ScheduleB
/ShipmentConfirmRequest
10
String
code for the item being exported. (To classify
/InternationalForms
1
A unique 10-digit commodity classification
/ShipmentServiceOptions
Yes*
Number
/Shipment
a commodity access the following Web page:
/Product
http://www.census.gov/foreign-
/ScheduleB
trade/schedules/b/#search).
Applies to SED forms only. Has
to be 10 characters.
/Number
9 February 2009
Page 125
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
N/A
N/A
UnitOfMeasurement is not X.
PARTIAL INV.
Cond Rqd Sec 23
Conditionally required for SED
forms if ScheduleB
SED
INVOICE
N/AFTA CO
Rqd Sec 23?
shipped, indicate 8 in this field.
N/A
/ScheduleB
N/A
measure is dozens and eight dozen, is being
N/A
/Product
N/A
only).For example, if the Schedule B unit of
Applies to SED forms only.
N/A
/InternationalForms
1…10
the current good are in the shipment (SED
String
/ShipmentServiceOptions
1
The count of how many Schedule B units of
Cond
Quantity
/Shipment
N/A
/ShipmentConfirmRequest
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Should be Numeric. Valid
characters are 0 -9.
/Quantity
/ShipmentConfirmRequest
/Product
N/A
Container
/InternationalForms
1
/ShipmentServiceOptions
UnitOfMeasurement
Yes*
/Shipment
The unit of measure indicated on the Export
License.
Applies to SED forms only.
/ScheduleB
/UnitOfMeasurement
9 February 2009
Page 126
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
CERT. OF ORIGIN
N/AFTA CO
INVOICE
SED
PARTIAL INV.
N/A
N/A
N/A
Rqd Sec 23?
N/A
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Applies to SED forms only.
Required for the SED form.
Possible Values:
BBL: Barrels, CAR: Carat, CKG:
Content Kilogram, CM2: Square
Centimeters, CTN: Content Ton,
CUR: Curie, CYK: Clean Yield
/ShipmentConfirmRequest
Kilogram, DOZ: Dozen, DPC:
/Shipment
Dozen Pieces , DPR: Dozen
/ScheduleB
The unit of measure indicated on the Export
1..3
String
/Product
1
Code
/InternationalForms
Yes*
/ShipmentServiceOptions
License. Enter an X if there is no unit of
measure in the Schedule B Unit field.
Pairs, FBM: Fiber Meter , GCN:
Gross Containers, GM: Gram,
GRS: Gross, HUN: Hundred, KG:
Kilogram, KM3: 1,000 Cubic
/UnitOfMeasurement
Meters, KTS: Kilogram Total
/Code
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 req
9 February 2009
Page 127
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
CERT. OF ORIGIN
N/AFTA CO
INVOICE
SED
PARTIAL INV.
N/A
N/A
N/A
Rqd Sec 21
N/A
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
TYPE
String
LENGTH
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/Shipment
/ShipmentServiceOptions
Description
/InternationalForms
/Product
/ScheduleB
/UnitOfMeasurement
/Description
Code indicating Domestic: Exports that have
been produced, manufactured, or grown in the
United States or Puerto Rico. This includes
enhanced in value or changed from the form in Required for SED form. Possible
Applies to SED forms only.
Values:
processing in the United States or Puerto
D: Domestic
/Product
Rico. Foreign: Merchandise that has entered
F: Foreign
/ExportType
the United States and is being exported again M: Foreign Military
1
which imported by further manufacture or
/InternationalForms
1
/ShipmentServiceOptions
String
imported merchandise which has been
/Shipment
Cond
ExportType
/ShipmentConfirmRequest
in the same condition as when imported.
Foreign Military: Exported merchandise that is
sold under the foreign military sales program.
9 February 2009
Page 128
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Applies to SED forms only.
Required for SED form. Valid
characters are 0-9 and .(Decimal
point). Limit to 2 digit after the
decimal. The maximum length of
N/A
Rqd Sec 26
N/A
N/A
Opt Sec 3
Note: This value is calculated
Opt Sec 3
USD.
/Product
can hold up to 2 decimal places.
N/A
on the S.E.D. This amount will always be
the field is 15 including ‘.’ and
N/A
The value of the S.E.D. commodity contained
N/A
1…15
String
/InternationalForms
1
SEDTotalValue
/ShipmentServiceOptions
Cond
/Shipment
N/A
/ShipmentConfirmRequest
based on the Product/Unit/Value
/SEDTotalValue
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.
/InternationalForms
1…35
1
/ShipmentServiceOptions
No
/Shipment
InvoiceNumber
String
/ShipmentConfirmRequest
Commercial Invoice number assigned by the
Applies to Invoice &amp; Partial
exporter
Invoice forms only.
/InvoiceNumber
9 February 2009
Page 129
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Applies to Invoice &amp; Partial
Invoice forms only. Optional for
N/A
Rqd Sec 3
N/A
Opt Sec 3
N/A
Opt Sec 3
N/A
Opt Sec 3
is the same as the ship date.
/InternationalForms
N/A
Date when the Invoice is created. Ideally this
N/A
8
/ShipmentServiceOptions
String
InvoiceDate
Partial Invoice. Required for
1
/Shipment
Cond
/ShipmentConfirmRequest
Invoice form for forward
shipments. For shipment with
return service, the user input will
/InvoiceDate
be ignored, and the field will be
blank on the invoice. Format is
YYYYMMDD
1…35
1
/ShipmentServiceOptions
No
/Shipment
PurchaseOrderNumber
String
/ShipmentConfirmRequest
The customer's order reference number
/InternationalForms
Applies to Invoice &amp; Partial
Invoice forms
/PurchaseOrderNumber
9 February 2009
Page 130
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Applies to Invoice &amp; Partial
Invoice forms only. Possible
values are:
CFR: Cost and Freight
CIF: Cost, Insurance and Freight
CIP: Carriage and Insurance
Opt Sec 3
DDP: Delivery Duty Paid
/TermsOfShipment
N/A
DAF: Delivered at Frontier
Opt Sec 3
buyer.
/InternationalForms
CPT: Carriage Paid To
N/A
Indicates the rights to the seller from the
N/A
1
/ShipmentServiceOptions
No
TermsOfShipment
3
Paid
/Shipment
String
/ShipmentConfirmRequest
DDU: Delivery Duty Unpaid
DEQ: Delivered Ex Quay
DES: Delivered Ex Ship
EXW: Ex Works
FAS: Free Alongside Ship
FCA: Free Carrier
Opt Sec 3
Invoice forms only.
Opt Sec 6
Applies to Invoice &amp; Partial
shipment
N/A
Any extra information about the current
N/A
Invoice. No validation
Rqd Sec 3
Invoice &amp; Optional for Partial
INTERCOMPANYDATA, Any other reason
Opt Sec 6
Invoice forms. Required for
SALE,GIFT,SAMPLE, RETURN, REPAIR,
N/A
/ReasonForExport
Applies to Invoice &amp; Partial
shipment. Only values allowed:
N/A
/InternationalForms
Reason to export the current international
N/A
1…20
/ShipmentServiceOptions
String
ReasonForExport
1
/Shipment
Cond
/ShipmentConfirmRequest
N/A
FOB: Free On Board
1…150
/InternationalForms
1
/ShipmentServiceOptions
No
/Shipment
Comments
String
/ShipmentConfirmRequest
/Comments
9 February 2009
Page 131
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
This is the legal explanation, used by
Customs, for the delivering of this shipment. It
must be identical to the set of declarations
Opt Sec 7
EEA statement: The exporter of the products
Opt Sec 8b
stated above.
N/A
contents and value of this shipment is as
products covered by this
N/A
on this invoice is true and correct and the
is ignored): The exporter of the
Opt Sec 7
/DeclarationStatement
the NAFTA.I hereby certify that the information
verbiage is as follows (user input
Opt Sec 8b
/InternationalForms
purposes of preferential tariff treatment under
invoice for return shipment, the
N/A
/ShipmentServiceOptions
1…250
shipment qualify as originating goods for
String
/Shipment
1
I hereby certify that the goods covered by this
No
DeclarationStatement
/ShipmentConfirmRequest
Invoice forms only. On the
N/A
are:
Applies to Invoice &amp; Partial
N/A
declarations that might be entered in this field
N/A
actually used by Customs. Examples of
document declares that except
where otherwise clearly indicated
these products are of EEA
preferential origin
covered by this document declares that except
where otherwise clearly indicated these
products are of EEA preferential origin.
/InternationalForms
N/A
1
/ShipmentServiceOptions
No
/Shipment
Discount
Container
/ShipmentConfirmRequest
Container tag that holds the discount.
Applies to Invoice &amp; Partial
Invoice forms only.
/Discount
9 February 2009
Page 132
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Applies to Invoice &amp; Partial
Invoice forms only. Valid
characters are 0-9 and .(Decimal
/ShipmentConfirmRequest
can hold up to 2 decimal places.
/Discount
Opt Sec 8b
the field is 15 including ‘.’ and
N/A
the total value on the invoice.
decimal. The maximum length of
N/A
The discount to be subtracted from the sum of
N/A
15
String
/InternationalForms
1
/ShipmentServiceOptions
Yes*
MonetaryValue
Opt Sec 8b
point). Limit to 2 digit after the
/Shipment
This value should be greater
/MonetaryValue
than or equal to zero or less than
or equal to the value of all goods
listed on the invoice.
N/A
Opt Sec 8d
N/A
Opt Sec 8d
Opt Sec 8d
N/A
Opt Sec 8d
Invoice forms only.
N/A
Applies to Invoice &amp; Partial
N/A
Container tag that holds the Freight Charges
N/A
/InternationalForms
N/A
1
/ShipmentServiceOptions
No
/Shipment
FreightCharges
Container
/ShipmentConfirmRequest
/FreightCharges
Applies to Invoice &amp; Partial
/ShipmentConfirmRequest
Invoice forms only. Valid
0…15
/InternationalForms
String
/ShipmentServiceOptions
1
MonetaryValue
Yes*
/Shipment
characters are 0-9 and .(Decimal
Cost to transport the shipment
/FreightCharges
/MonetaryValue
9 February 2009
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.
Page 133
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
TYPE
Container
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Opt Sec 8e
N/A
Invoice forms only.
N/A
Applies to Invoice &amp; Partial
Charges
Opt Sec 8e
/InternationalForms
Container tag that holds the Insurance
N/A
/ShipmentServiceOptions
No
/Shipment
InsuranceCharges
N/A
/ShipmentConfirmRequest
/InsuranceCharges
Applies to Invoice &amp; Partial
/ShipmentConfirmRequest
N/A
N/A
decimal. The maximum length of
Opt Sec 8e
lost or damaged
/InsuranceCharges
characters are 0-9 and .(Decimal
cover the cost of replacing the shipment if it is point). Limit to 2 digit after the
N/A
0…15
String
/InternationalForms
1
/ShipmentServiceOptions
Yes*
MonetaryValue
The amount the shipper or receiver pays to
Opt Sec 8e
Invoice forms only. Valid
/Shipment
the field is 15 including ‘.’ and
/MonetaryValue
can hold up to 2 decimal places.
N/A
Opt Sec 8f
N/A
Opt Sec 8f
Opt Sec 8f
N/A
Opt Sec 8f
Invoice forms only.
N/A
already listed on the invoice
Applies to Invoice &amp; Partial
N/A
amount that covers additional charges not
N/A
/InternationalForms
Container tag that holds the information of
N/A
1
/ShipmentServiceOptions
No
/Shipment
OtherCharges
Container
/ShipmentConfirmRequest
/OtherCharges
Applies to Invoice &amp; Partial
/ShipmentConfirmRequest
Invoice forms only. Valid
0…15
/InternationalForms
String
/ShipmentServiceOptions
1
MonetaryValue
Yes*
/Shipment
characters are 0-9 and .(Decimal
The Monetary value of OtherCharges
/OtherCharges
/MonetaryValue
9 February 2009
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.
Page 134
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
/InternationalForms
Applies to Invoice &amp; Partial
Invoice forms only.
/OtherCharges
SED
INVOICE
PARTIAL INV.
Opt Sec 8f?
/ShipmentServiceOptions
N/A
Description
N/A
/Shipment
N/A
/ShipmentConfirmRequest
Cond Rqd Sec 8f?
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1…10
3
Currency code for all the monetary values of
VALIDATION RULES
RETURN ONLY
TYPE
String
Description of what the other charges are for.
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes*
UPS OnLine Tools Shipping
N/A
N/A
Invoice forms2 only.
Opt Sec 8g
/InternationalForms
Applies to Invoice &amp; Partial
the Invoice form
N/A
String
/ShipmentServiceOptions
1
/Shipment
CurrencyCode
Cond
/ShipmentConfirmRequest
Rqd Sec 8g
/Description
/CurrencyCode
This field should be entered if the NAFTA
Certificate covers multiple shipments of
Rqd Sec 2
N/A
N/A
N/A
N/A
N/A
N/A
/BlanketPeriod
Required for NAFTA CO.
Rqd Sec 2
(the blanket period). The importation of a good
Applies to NAFTA CO form only.
N/A
country for a specified period of up to one year
N/A
/InternationalForms
of Goods field that are imported into a NAFTA
N/A
/ShipmentServiceOptions
Container
BlanketPeriod
identical goods as described in the Description
1
/Shipment
Cond
/ShipmentConfirmRequest
for which preferential treatment is claimed
based on this certificate must occur between
these dates.
/ShipmentConfirmRequest
Begin date of the blanket period. It is the date
/InternationalForms
/BlanketPeriod
/BeginDate
upon which the Certificate becomes applicable Applies to NAFTA CO form only.
8
String
/ShipmentServiceOptions
1
BeginDate
Yes*
/Shipment
to the good covered by the blanket Certificate
Required for NAFTA CO. Format
(it may be prior to the date of signing this
is YYYYMMDD
Certificate).
9 February 2009
Page 135
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
TYPE
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/BlanketPeriod
is YYYYMMDD
N/A
Required for NAFTA CO. Format
N/A
upon which the blanket period expires.
Applies to NAFTA CO form only.
N/A
/InternationalForms
End Date of the blanket period. It is the date
N/A
/ShipmentServiceOptions
8
EndDate
Yes*
/Shipment
Rqd Sec 2
/ShipmentConfirmRequest
forms. Format is YYYYMMDD
N/A
only. Required for CO and SED
Rqd Sec 2
/InternationalForms
N/A
The date the goods will be exiting the country
N/A
Applies to CO and SED forms
8
String
/ShipmentServiceOptions
1
/Shipment
ExportDate
Cond
/ShipmentConfirmRequest
Rqd Sec 1c
/EndDate
N/A
Rqd Sec 10
N/A
Opt Sec 14
N/A
forms.
N/A
only. Required for CO and SED
also be entered, if the carrier is a vessel.
N/A
Applies to CO and SED forms
shipment. The vessel's flag number should
N/A
/InternationalForms
The name of the carrier that is exporting the
Rqd Sec 1c?
1…35
String
/ShipmentServiceOptions
1
/Shipment
ExportingCarrier
Cond
/ShipmentConfirmRequest
N/A
/ExportDate
/ExportingCarrier
1…17
String
AlphaCode (SCAC) for vessel, rail, and truck
/ShipmentServiceOptions
1
The four-character Standard Carrier
/Shipment
No
CarrierID
/ShipmentConfirmRequest
shipments. For air shipment, enter the two or
/InternationalForms
three character International Air Transport
/CarrierID
Association (IATA) code
9 February 2009
Applies to SED forms only. No
Validations.
Page 136
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Warehouse withdrawal for
/InBondCode
T&amp;E62: T&amp;E63: IE67: IE from a
N/A
N/A
Warehouse withdrawal for IE37:
/InternationalForms
N/A
The two-character In Bond Code
N/A
values are:70: Not in bond36:
2
String
/ShipmentServiceOptions
1
InBondCode
Required for SED forms. Valid
Cond
/Shipment
Rqd Sec 18
Applies to SED forms only.
/ShipmentConfirmRequest
bond code value is other than
16
N/A
N/A
N/A
Temporary Import Bond or Drawbacks)
/EntryNumber
Required for SED forms when In
N/A
import transactions (examples: In Bond,
Conditionally
N/A
/InternationalForms
transaction is used as proof of export for
Applies to SED forms only.
N/A
1…25
String
/ShipmentServiceOptions
1
EntryNumber
The Import Entry Number when the export
Cond
/Shipment
N/A
/ShipmentConfirmRequest
Cond Rqd Sec
FTZ68: T&amp;E from a FTZ
70(Not In Bond)
Contains one of the following
the source for the good with the highest value.
/InternationalForms
The state of consolidation. The Foreign Trade
/PointOfOrigin
Zone number of the zone from where the
Applies to SED forms only.
Required for SED
exports are leaving. If the goods were shipped
from Puerto Rico, enter PR.
9 February 2009
Page 137
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
N/A
1…5
String
1
shipped to the port of export. The state that is
/ShipmentServiceOptions
Cond
PointOfOrigin
for the state from which the goods were
/Shipment
Rqd Sec 6
The two-digit U.S. Postal Service abbreviation
/ShipmentConfirmRequest
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Mode of transport by which the goods are
exported. Possible values:
RoadOther
characters will be truncated on
SeaBarge
the form.
N/A
form. Anything greater than 10
/ModeOfTransport
Rqd Sec 9
RailContainerized
N/A
Characters can appear on the
/InternationalForms
N/A
values can be entered. Only 10
Rail
/ShipmentServiceOptions
1…35
PassengerHandcarried Pedestrian
String
Required for SED. Only allowed
/Shipment
1
Applies to SED forms only.
Auto FixedTransportInstallations Mail
Cond
ModeOfTransport
AirContainerized
/ShipmentConfirmRequest
N/A
Air
SeaContainerized SeaNoncontainerized
Truck
TruckContainerized
Should be one of the followingOverland: The U.S. Customs port where the
/ShipmentConfirmRequest
N/A
N/A
Opt Sec 11
N/A
N/A
Opt Sec 12
N/A
validation.
N/A
the goods are loaded on the carrier to be
N/A
/InternationalForms
-Vessel and Air: The U.S. Customs port where Applies to SED forms only. No
N/A
1…35
1
/ShipmentServiceOptions
No
PortOfExport
String
carrier crosses the U.S. border.
/Shipment
exported from the U.S.
/PortOfExport
-Postal: The U.S. Postal Office from where the
goods are mailed
/InternationalForms
1…35
1
/ShipmentServiceOptions
No
/Shipment
PortOfUnloading
String
/ShipmentConfirmRequest
The country and the port where the goods will
be unloaded from the exporting carrier. For
vessel and air shipments only.
Applies to SED forms only
No validation.
/PortOfUnloading
9 February 2009
Page 138
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
LENGTH
1…35
DESCRIPTION
FORWARD ONLY
TYPE
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
N/A
No validation.
N/A
Applies to SED forms only
shipments only
Opt Sec 8
/InternationalForms
Pier where goods are loaded. For vessel
N/A
/ShipmentServiceOptions
No
/Shipment
LoadingPier
N/A
/ShipmentConfirmRequest
/LoadingPier
Information about parties to transaction. Use
Related, if the parties to the transaction are
/PartiesToTransaction
R – Related
least 10 percent of the voting shares of the
N – Non related
N/A
Valid values are:
person or business where the person has at
N/A
Applies to SED forms only
business or from a U.S. business to a foreign
N/A
U.S. businessperson or business to a foreign
Rqd Sec 1c
/InternationalForms
1
String
/ShipmentServiceOptions
1
PartiesToTransaction
Cond
/Shipment
N/A
related. A related party is an export from a
/ShipmentConfirmRequest
business during the fiscal year. If
unincorporated, then an equivalent interest in
N/A
N/A
Applies to SED forms only
N/A
authorizes a U.S. forwarding (or other) agent
GUI)Sec 19
N/A
Applies to SED forms only
N/A
/RoutedExportTransactionIndi
where the foreign principal party in interest
N/A
1
/InternationalForms
transaction. A routed export transaction is one,
N/A
r
No
RoutedExportTransactionIndicato /ShipmentServiceOptions
EMPTY
If Present, indicates that it is a routed export
/Shipment
Opt (Rqd for
the business.
/ShipmentConfirmRequest
to export the merchandise outside the U.S.
cator
containerized. This applies to vessel
shipments only
/ContainerizedIndicator
9 February 2009
Page 139
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
N/A
If present indicates that the goods are
Opt Sec 13
/InternationalForms
1
/ShipmentServiceOptions
No
/Shipment
ContainerizedIndicator
EMPTY
/ShipmentConfirmRequest
/InternationalForms
exception code needs to be entered. If
Applies to SED forms only
shipping different products that are covered
Required for SED forms.
PARTIAL INV.
SED
INVOICE
N/A
N/A
Cond Rqd Sec 27
N/A
N/A
Cond Rqd Sec 27
N/A
product.
License exception code should
be present for SED form, both
License number and License
Exception code cannot be
present for SED form.
1…8
String
Conditionally required for SED
1
Applies to SED forms only
/Shipment
Cond
/ShipmentConfirmRequest
/InternationalForms
N/A
1…35
String
1
Cond
The license number that authorizes ship
/Number
Date
N/A
Either License number or
/License
/ShipmentServiceOptions
N/A
Applies to SED forms only
/Shipment
/InternationalForms
N/AFTA CO
then separate SEDs must be created.
/ShipmentConfirmRequest
/ShipmentServiceOptions
CERT. OF ORIGIN
under different licenses or license exceptions,
/License
Number
RETURN ONLY
product is not licensable, a valid license
N/A
Container
1
/ShipmentServiceOptions
Cond
License
VALIDATION RULES
Container for License information. If the
/ShipmentConfirmRequest
/Shipment
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
License Date
forms if there is a license
number. Only applicable when
/License
License Number is provided.
/Date
Format YYYYMMDD
9 February 2009
Page 140
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
SED
PARTIAL INV.
N/A
INVOICE
N/A
Cond Rqd Sec 27
N/AFTA CO
N/A
N/A
CERT. OF ORIGIN
N/A
N/A
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
License exception code
Possible values
AGR: Agricultural commodities; APR: Items for
export or re-export not controlled for nuclear
nonproliferation, missile technology or crime
control; AVS: U.S. aircraft or foreign sojourn
License exception code should
Encrypted software; GBS: controlled for
be present for SED form, both
national security reasons; GFT: Gift
License number and License
/License
shipments;
Exception code cannot be
/ExceptionCode
GOV: Government shipments; KMI: Encrypted present for SED form. Validated
/ShipmentServiceOptions
/InternationalForms
1…4
end users; CTP: Computer and parts; ENC:
String
Either License number or
/Shipment
1
Applies to SED forms only
baggage; CIV: National security items for civil
Cond
ExceptionCode
into foreign country; BAG: Crew members
/ShipmentConfirmRequest
software and hardware;
for possible values
LVS: Value of shipments limited; NLR: No
license required; RPL: Replacement parts;
TMP: Temporary exports; TSPA: Software or
technology outside scope of export
regulations; TSR: Technology and software;
/InternationalForms
/ECCNNumber
number identifies categories, product groups,
strategic level of control, and country groups.
Some products have an ECCN number.
9 February 2009
Applies to SED forms only
ECCN is required one of the
following License Exception
Codes is entered: CIV CTP ENC
KMI LVS
Page 141
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
28
N/A
8
String
/ShipmentServiceOptions
1
ECCNNumber
Export Control Classification Number. This
Cond
/Shipment
N/A
/ShipmentConfirmRequest
Cond Rqd Sec
TSU: Technology and software updates
Valid For Poland to Poland
requested the ReturnOfDocument accessorial shipment without return service.
Yes
N/A
1
No
/ShipmentServiceOptions
Container
be added to the shipment
/ShipmentConfirmRequest
/Shipment
If the flag is present, the shipper has
Yes
0
String
/ShipmentServiceOptions
/ReturnOfDocumentIndicator
DeliveryConfirmation
/DeliveryConfirmation
/ShipmentConfirmRequest
Type of delivery confirmation
/DeliveryConfirmation
/Package
For Return Shipments up to and
including 20 packages are
N/A
200)
Container
Yes
/Shipment
Many (up to
Package
2 - Delivery Confirmation Adult
Signature Required
/DCISType
/ShipmentConfirmRequest
Confirmation Signature Required
Package Information.
allowed. US/PR origin return
movements are limited to only
one package.
1..35
/Package
String
/Shipment
1
Description
Cond
/ShipmentConfirmRequest
Merchandise description of package.
Required for shipment with return
service
/Description
9 February 2009
Page 142
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
1
String
/ShipmentServiceOptions
1
DCISType
Valid values are:1 - Delivery
Yes
/Shipment
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
Return of Documents Indicator
1
ReturnOfDocumentIndicator
/Shipment
No
/ShipmentConfirmRequest
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/Shipment
/Package
/PackagingType
Package types. Values are:
Package type ‘24’, or ‘25’ or ‘30’
‘01’ = UPS Letter,
is only allowed for shipment
‘02’ = Customer Supplied Package,
2
String
/Package
1
Code
Packaging type must be valid for
‘04’ = PAK,
Yes
/Shipment
without return service
‘03’ = Tube,
/ShipmentConfirmRequest
all the following: ShipTo country,
‘21’ = UPS Express Box,
ShipFrom country, a shipment
‘24’ = UPS 25KG Box,
/PackagingType
going from ShipTo country to
‘25’ = UPS 10KG Box
/Code
ShipFrom country, all
‘30’ = Pallet
accessorials at both the
2a = Small Express Box
shipment and package level, and
2b = Medium Express Box
the shipment service type.
2c = Large Express Box
1..35
1
/Package
No
/Shipment
Description
String
/ShipmentConfirmRequest
/PackagingType
Description of packaging type. Examples are
letter, customer supplied, express box.
/Description
be less than or equal to 130 IN or
N/A
/Package
1
/Shipment
Cond
Dimensions
Container
Length + 2*(Width+Height) must
/ShipmentConfirmRequest
Dimensions information container.
/Dimensions
9 February 2009
330 CM. Dimensions are
required for GB to GB and
Poland to Poland Shipments.
Page 143
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
PackagingType
VALIDATION RULES
RETURN ONLY
TYPE
Container
/ShipmentConfirmRequest
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/Shipment
UnitOfMeasurement
/Package
/Dimensions
/UnitOfMeasurement
Package dimensions measurement code.
Codes are: ‘IN’ = Inches, ‘CM’ = Centimeters,
‘00’ = Metric Units Of Measurement, ‘01’ =
/Dimensions
2
/Package
String
origin shipments no defaulting is performed
1
English Units of Measurement. In Canada-
/Shipment
Yes*
Code
/ShipmentConfirmRequest
and a unit of measurement is required. For
shipment with return service the unit of
/UnitOfMeasurement
measure is defaulted to the shipper’s country
/Code
unit of measure. For all other shipments the
The unit of measurement must
be valid for the Shipper country.
Refer to Origin Country
Information table for valid unit of
measurement.
unit of measurement will default to the unit of
measurement for the origin country specified
in the Country Information table.
/ShipmentConfirmRequest
1..35
/Dimensions
String
/Package
1
Description
No
/Shipment
Description of the package dimensions
measurement units.
/UnitOfMeasurement
/Description
9 February 2009
Page 144
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
VALIDATION RULES
RETURN ONLY
TYPE
Container
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes
UPS OnLine Tools Shipping
/Shipment
Length
/Package
/Dimensions
Package length. Length must be the longest
Valid values are 0 to 108 IN and
dimension of the container.
0 to 270 CM.
/Length
/ShipmentConfirmRequest
/Shipment
Width
/Package
/Dimensions
/Width
/ShipmentConfirmRequest
/Shipment
Height
/Package
/Dimensions
/Height
/ShipmentConfirmRequest
PackageWeight
/Shipment
/Package
Not required for Letter
/PackageWeight
/ShipmentConfirmRequest
/Shipment
UnitOfMeasurement
/Package
/PackageWeight
/UnitOfMeasurement
9 February 2009
Page 145
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
N/A
N/A
/ShipmentConfirmRequest
CERT. OF ORIGIN
9
Container
Container
VALIDATION RULES
RETURN ONLY
9
9
String
1
1
DESCRIPTION
FORWARD ONLY
TYPE
String
String
1
Package height.
LENGTH
MAXALLOWED
1
1
Package width.
REQUIRED
Yes
Yes
XPATH
Yes
NAME
Cond
ShipmentConfirmRequest
Yes*
UPS OnLine Tools Shipping
Package weight unit of measurement code.
Codes are:
‘LBS’ = Pounds,
‘KGS’ = Kilograms,
‘00’ = Metric Unit of Measurements,
/ShipmentConfirmRequest
‘01’ = English Unit of Measurements
/PackageWeight
In Canada-origin shipments no defaulting is
3
String
/Package
1
Code
Yes*
/Shipment
performed and a unit of measurement is
required. For shipment with return service the
/UnitOfMeasurement
Valid codes are: ‘KGS’, ‘LBS’,
‘00’ and ‘01’.
unit of measure is defaulted to the shipper’s
/Code
country unit of measure. For all other
shipments the unit of measurement will default
to the unit of measurement for the origin
country specified in the Country Information
table.
/ShipmentConfirmRequest
1..35
Description of the package weight
1..5
/PackageWeight
String
/Package
1
Description
No
/Shipment
Packages weight. Set to 1.0 for package type
measurement units.
/UnitOfMeasurement
/Description
/PackageWeight
String
/Package
1
/Shipment
Weight
Yes
/ShipmentConfirmRequest
letter.
/Weight
9 February 2009
Page 146
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/Shipment
/Package
0
LargePackageIndicator
No
/ShipmentConfirmRequest
Presence of the indicator mentions that the
package is Large Package.
/Package
N/A
/Shipment
1
ReferenceNumber
No
/ShipmentConfirmRequest
Container
/LargePackageIndicator
Package reference number information
Valid if the origin/destination pair
container
is US/US or PR/PR.
/ReferenceNumber
Only one shipment-level or
package-level reference number
/ShipmentConfirmRequest
0
1
/Package
No
BarCodeIndicator
String
can be bar coded per shipment.
/Shipment
If the indicator is present then the reference
number’s value will be bar coded on the label.
/ReferenceNumber
/BarCodeIndicator
In order to barcode a reference
number, its value must be no
longer than 14 alphanumeric
characters or 24 numeric
characters and cannot contain
spaces.
/ShipmentConfirmRequest
/ReferenceNumber
/Code
2
String
/Package
1
Code
Reference number type code, for the entire
Yes
/Shipment
shipment. The code specifies the Reference
name. Refer to the Reference Number Code
table.
9 February 2009
Valid if the origin/destination pair
is US/US or PR/PR.2 character
alpha-numeric.
Page 147
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
TYPE
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
1..35
/Package
String
Value
Valid if the origin/destination pair
1
/Shipment
Yes
/ShipmentConfirmRequest
combinations of Reference code-
/Value
value combinations.
Additional Handling Required. The presence
/Package
0
String
1
No
/Shipment
required.
No
1
Container
N/A
No
1
Container
N/A
/ShipmentConfirmRequest
/Shipment
indicates additional handling is required, the
absence indicates no additional handling is
/AdditionalHandling
PackageServiceOptions
to 2 customer supplied
/ReferenceNumber
/ShipmentConfirmRequest
AdditionalHandling
is US/US or PR/PR. Supports up
Customer supplied reference number.
/Package
/PackageServiceOptions
/Shipment
DeliveryConfirmation
/Package
/PackageServiceOptions
Yes
/ShipmentConfirmRequest
/PackageServiceOptions
1
String
1 - Delivery Confirmation
/Package
1
Valid values are:
/Shipment
Yes
DCISType
/ShipmentConfirmRequest
Type of delivery confirmation
2 - Delivery Confirmation
Signature Required
/DeliveryConfirmation
3 - Delivery Confirmation Adult
/DCISType
Signature Required
9 February 2009
Page 148
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/DeliveryConfirmation
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
Delivery Confirmation Control number
Yes
1..11
/PackageServiceOptions
String
/Package
1
DCISNumber
No
/Shipment
associated with the delivery confirmation for
the package
/DeliveryConfirmation
/DCISNumber
No
1
Container
N/A
No
1
String
N/A
/ShipmentConfirmRequest
/Shipment
InsuredValue
/Package
/PackageServiceOptions
/InsuredValue
/ShipmentConfirmRequest
Type
/Package
/PackageServiceOptions
Container for Insured Value Type.
N/A
/InsuredValue
/Type
9 February 2009
Page 149
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/Shipment
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
The user cannot specify different
type of declared value at
/ShipmentConfirmRequest
shipper declared value (DVS) or
02=DVS
declared value (EVS) but not
/InsuredValue
Defaults to 01 i.e. EVS if declared value type
both at package level. Note: The
/Type
is not provided.
Shipper DeclaredValue is
/PackageServiceOptions
2
01=EVS
String
shipment. You can either have
/Package
1
Declared value type. Valid values are
Yes*
Code
package level for entire
/Shipment
/Code
applicable for forward shipments
when the billing option is freight
collect or third party
/ShipmentConfirmRequest
1…35
1
/PackageServiceOptions
No
/Package
Description
String
/Shipment
Declared value Description
N/A
/InsuredValue
/Type
/Description
/ShipmentConfirmRequest
/InsuredValue
Defaults to the currency used in the shipper’s
country.
Code must represent a currency
that is a valid for Shipper
country. Refer to Origin Country
Information table.
/CurrencyCode
9 February 2009
Page 150
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
Declared value amount currency type.
3
String
/PackageServiceOptions
1
CurrencyCode
/Package
No
/Shipment
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
MonetaryValue
/Package
/PackageServiceOptions
Yes
/Shipment
Declared value amount.
/InsuredValue
/MonetaryValue
Indicates COD is requested.
package level COD is available
/PackageServiceOptions
service from US/PR to US/PR,
N/A
1
/Package
No
COD
COD container
CA to CA, and CA to US.CA to
Yes
for shipment without return
/Shipment
Container
/ShipmentConfirmRequest
US COD is not allowed for
/COD
package Letter/ Envelope. COD
is not valid for return service
movements.
/ShipmentConfirmRequest
1
COD type value.
Valid values are ‘3’.
‘3’ = Tagless COD.
Yes
/PackageServiceOptions
String
/Package
1
CODCode
Yes
/Shipment
/COD
/CODCode
/ShipmentConfirmRequest
/COD
/CODFundsCode
String
/PackageServiceOptions
1
/Package
Yes
CODFundsCode
‘0’ = check, cashier’s check or money order no cash allowed,
‘8’ = cashier’s check or money order - no cash
allowed.
9 February 2009
Page 151
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
Values are:
/Shipment
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1..19
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
No
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/Shipment
CODAmount
/Package
/PackageServiceOptions
/COD
/CODAmount
/ShipmentConfirmRequest
String
3
String
1..8
COD Amount.
N/A
Verbal Confirmation Info.
COD amount currency code type. Defaults to
Yes
/PackageServiceOptions
No
/Package
CurrencyCode
Container
/Shipment
the currency used in the destination country.
/COD
/CODAmount
/CurrencyCode
/ShipmentConfirmRequest
/COD
Valid values: 0.01 USD –
50000.00 USD
Yes
1
1
/PackageServiceOptions
Yes
/Package
MonetaryValue
No
/Shipment
/CODAmount
/MonetaryValue
/Shipment
VerbalConfirmation
/Package
/PackageServiceOptions
Allowed for shipment without
return service.
/VerbalConfirmation
9 February 2009
Page 152
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/ShipmentConfirmRequest
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
VALIDATION RULES
RETURN ONLY
TYPE
Container
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
Yes*
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
Yes
PhoneNumber, and PhoneExtension(optional)
N/A
1
Container
/PackageServiceOptions
Cond
/Package
are given and are the desired name, phone
number and extension, respectively, to be
/VerbalConfirmation
used for verbal confirmation.
/ContactInfo
/ShipmentConfirmRequest
/VerbalConfirmation
Name of the person to be contacted for
AttentionName is given and that
confirmation. Defaults to Shipper
is the name of the person to be
AttentionName if given.
contacted else required for
/ContactInfo
Yes
1..35
/PackageServiceOptions
String
Name
Optional if Shipper/
1
/Package
Cond
/Shipment
verbal confirmation.
PhoneNumber
/PackageServiceOptions
/VerbalConfirmation
/ContactInfo
/PhoneNumber
Optional if
Shipper/PhoneNumber is given
Phone number UPS uses to reach the person
to give the confirmation. Defaults to Shipper
PhoneNumber if given.
9 February 2009
and that is the name of the
person to be contacted else
required for verbal confirmation.
If phone number is in the US 10
digits allowed, otherwise 1..15
digits allowed.
Page 153
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/Package
Cond
/Shipment
1
Mixed: String or
/ShipmentConfirmRequest
StructuredPhoneNumber
/Name
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
Optional if the Shippers AttentionName,
/Shipment
ContactInfo
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
PhoneNumber, is required and a
phone number is not provide at
/ContactInfo
Yes
Required if parent element,
N/A
/VerbalConfirmation
1
StructuredPhoneNumber
/PackageServiceOptions
Cond
/Package
Container
/Shipment
the parent node.
/PhoneNumber
/StructuredPhoneNumber
/ShipmentConfirmRequest
/Shipment
1..3
The Country Code portion of the phone
1..15
Dial plan number portion of the phone number.
/ContactInfo
number.
Not valid for US phone numbers.
Yes
String
1
/VerbalConfirmation
No
/PackageServiceOptions
PhoneCountryCode
String
/Package
/PhoneNumber
/StructuredPhoneNumber
/PhoneCountryCode
/ShipmentConfirmRequest
/Shipment
/ContactInfo
/PhoneNumber
/StructuredPhoneNumber
/PhoneDialPlanNumber
9 February 2009
Page 154
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/VerbalConfirmation
1
/PackageServiceOptions
PhoneDialPlanNumber
Yes
/Package
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/Shipment
/PackageServiceOptions
PhoneLineNumber
/VerbalConfirmation
Yes
/Package
/ContactInfo
/PhoneNumber
/StructuredPhoneNumber
/PhoneLineNumber
/ShipmentConfirmRequest
/Shipment
/PackageServiceOptions
PhoneExtension
/VerbalConfirmation
Yes
/Package
/ContactInfo
/PhoneNumber
/StructuredPhoneNumber
/PhoneExtension
/PackageServiceOptions
be released by driver without a signature from US50/PR packages without
the consignee
return service.
/ShipperReleaseIndicator
9 February 2009
Page 155
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
The presence indicates that the package may Only available for US50/PR to
0
1
/Package
No
/Shipment
ShipperReleaseIndicator
String
/ShipmentConfirmRequest
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1..15
1..4
VALIDATION RULES
RETURN ONLY
TYPE
String
String
Phone extension
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
Line number portion of the phone number.
1
XPATH
REQUIRED
NAME
Yes
ShipmentConfirmRequest
No
UPS OnLine Tools Shipping
/Shipment
Notification
/Package
/PackageServiceOptions
Applicable for Shipment with
Receiver Return Notification
returned service.
Yes
/ShipmentConfirmRequest
/Notification
/ShipmentConfirmRequest
Container
N/A
String
1..50
The destination eMail address of the receiver
3 – Receiver Return Notification
Yes
1
1
Container for the e-mail Message.
Many (up to 2)
/PackageServiceOptions
Yes*
/Package
Yes*
NotificationCode
Yes*
/Shipment
/Notification
/NotificationCode
/Shipment
EMailMessage
/Package
/PackageServiceOptions
Yes
/ShipmentConfirmRequest
/Notification
/EMailMessage
/Shipment
/Package
EMailAddress
/PackageServiceOptions
/Notification
return notification eMail.
The shipment can have up to two
receiver return notification email
address for the whole shipment.
/EMailMessage
/EMailAddress
9 February 2009
Page 156
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/ShipmentConfirmRequest
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
1
VALIDATION RULES
RETURN ONLY
TYPE
Container
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmRequest
No
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/Notification
The e-mail address where an undeliverable
eMail message is sent if the Receiver Return
Notification email is undeliverable.
Defaults to FromEMailAddress.
Only allowed at the first package.
Yes
1..50
1
/PackageServiceOptions
No
/Package
UndeliverableEMailAddress
String
/Shipment
/EMailMessage
/UndeliverableEMailAddress
/ShipmentConfirmRequest
/Shipment
Only allowed at the first package.
Yes
/Notification
of the message header, includes name and e-
The name the receiver return notification will
Defaults to the ShipperName.
appear to be from.
Only allowed at the first package.
Yes
1..50
String
/PackageServiceOptions
1
FromEMailAddress
The email address listed in the Reply To field
Yes
/Package
mail address of sender. The From field of the
message header contains [email protected].
/EMailMessage
/FromEMailAddress
/ShipmentConfirmRequest
/Notification
1..35
1
/PackageServiceOptions
No
/Package
FromName
String
/Shipment
/EMailMessage
/FromName
9 February 2009
Page 157
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentConfirmRequest
/PackageServiceOptions
No
/Package
Memo
/Notification
User defined text that will be included in the
eMail.
Only allowed at the first package.
/EMailMessage
/Memo
/ShipmentConfirmRequest
1
/PackageServiceOptions
No
/Package
Subject
String
/Shipment
The eMail’s subject.
Return Notification only.
Defaults to text provided by UPS
/Notification
/EMailMessage
/Subject
Specifies a reference code and reference
number to display in the subject of the
Notification.
The valid subject codes are:
/ShipmentConfirmRequest
/Notification
/EMailMessage
/SubjectCode
1
/PackageServiceOptions
No
/Package
String
/Shipment
SubjectCode
Refer to Table for the valid
subject codes.
For return notification:
If the subject code tag is not
01 - Shipment Reference Number 1
provided and the subject text is
provided, the subject of the
02 - Shipment Reference Number 2
notification will be the subject
03 - package Reference Number 1
text;
04 - package Reference Number 2
If the subject text is provided and
08 – Subject Text (Return Notification only)
the subject code tag exists, then
If a subject code is not provided or provided
the subject code value must be
that refers to a nonexistent reference number,
‘08’.
the subject will default to shipment
If Subject code is “08”, subject
Identification Number
text must exist.
9 February 2009
Page 158
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
/Shipment
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
LENGTH
1..150
DESCRIPTION
FORWARD ONLY
TYPE
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/LabelPrintMethod
/Code
Required for shipment without
required by the user to print and/or display the return service, or shipment with
UPS shipping label.
3
1
String
/LabelPrintMethod
Yes
Code
PRL return service
The device used to print a label image.
Label print method code that the labels are to
For shipments without return
be generated for EPL2 formatted labels use
service the valid value is GIF,
‘EPL’, for SPL formatted labels use ‘SPL’, for
EPL, ZPL, STARPL and SPL.
ZPL formatted labels use ‘ZPL’, for STAR
For shipments with PRL return
printer formatted labels use ‘STARPL’ and for
service, the valid values are EPL,
image formats use ‘GIF’.
ZPL, STARPL, SPL and GIF.
1..35
/LabelPrintMethod
String
/LabelSpecification
1
Description
No
/ShipmentConfirmRequest
Label Specification Code description
/Description
/HTTPUserAgent
1..64
/LabelSpecification
String
HTTPUserAgent
1
/ShipmentConfirmRequest
Cond
Required if
Browser HTTPUserAgent String. This is the
preferred way of identifying GIF image type to
be generated
ShipmentConfirmRequest/Label
Specification/LabelPrintMethod/C
ode = GIF. Default to Mozilla/4.5
if this field is missing or has
invalid value.
9 February 2009
Page 159
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
Container used to define the properties
/ShipmentConfirmRequest
/LabelSpecification
DESCRIPTION
FORWARD ONLY
N/A
N/A
1
/LabelSpecification
Yes
/ShipmentConfirmRequest
LabelPrintMethod
LENGTH
TYPE
Container
/LabelSpecification
Container
/ShipmentConfirmRequest
MAXALLOWED
LabelSpecification
XPATH
Cond
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
/LabelStockSize
Container for the EPL2, ZPL, STARPL or SPL For EPL2, ZPL, STARPL and
label size
SPL labels.
For EPL2, ZPL, STARPL and
Height of the label image. For IN, use whole
‘4’.
inches.
Note: Label Image will only scale
/Height
Yes
1..3
String
/LabelStockSize
SPL labels. Only valid value is
1
Height
/LabelSpecification
Yes*
/ShipmentConfirmRequest
up to 4 X 6, even when
requesting 4 X 8.
For EPL2, ZPL, STARPL and
Width of the label image. For IN, use whole
or ‘8’.
inches.
Note: Label Image will only scale
/Width
up to 4 X 6, even when
/LabelImageFormat
N/A
1
/LabelSpecification
Yes
/ShipmentConfirmRequest
LabelImageFormat
Container
requesting 4 X 8.
9 February 2009
Page 160
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Yes
1..3
String
/LabelStockSize
SPL labels. Valid values are ‘6’
1
Width
/LabelSpecification
Yes*
/ShipmentConfirmRequest
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
FORWARD ONLY
DESCRIPTION
Yes
LENGTH
N/A
TYPE
/LabelSpecification
Container
/ShipmentConfirmRequest
LabelStockSize
MAXALLOWED
XPATH
Cond
NAME
1
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
Required if
3
String
/LabelImageFormat
ShipmentConfirmRequest/Label
1
Code
/LabelSpecification
Cond
/ShipmentConfirmRequest
Code type that the label image is to be
Specification/LabelPrintMethod/C
generated in.
ode = GIF. Valid values are GIF
/Code
or PNG. Only GIF is supported
on the remote server.
1..35
/LabelImageFormat
String
/LabelSpecification
1
Description
No
/ShipmentConfirmRequest
Description of the label image format code.
/Description
9 February 2009
Page 161
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmRequest
REQUIRED
UPS OnLine Tools Shipping
UPS OnLine Tools Shipping
ShipmentConfirmRequest
ShipmentConfirmRequest Example Message:
&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;AccessRequest xml:lang='en-US'&gt;
&lt;AccessLicenseNumber&gt;YOURACCESSLICENSENUMBER&lt;/AccessLicenseNumber&gt;
&lt;UserId&gt;YOURUSERID&lt;/UserId&gt;
&lt;Password&gt;YOURPASSWORD&lt;/Password&gt;
&lt;/AccessRequest&gt;
&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;ShipmentConfirmRequest&gt;
&lt;Request&gt;
&lt;TransactionReference&gt;
&lt;CustomerContext&gt;guidlikesubstance&lt;/CustomerContext&gt;
&lt;XpciVersion&gt;1.0001&lt;/XpciVersion&gt;
&lt;/TransactionReference&gt;
&lt;RequestAction&gt;ShipConfirm&lt;/RequestAction&gt;
&lt;RequestOption&gt;nonvalidate&lt;/RequestOption&gt;
&lt;/Request&gt;
&lt;Shipment&gt;
&lt;Shipper&gt;
&lt;Name&gt;Joe's Garage&lt;/Name&gt;
&lt;AttentionName&gt;John Smith&lt;/AttentionName&gt;
&lt;PhoneNumber&gt;9725551212&lt;/PhoneNumber&gt;
&lt;ShipperNumber&gt;123X67&lt;/ShipperNumber&gt;
&lt;Address&gt;
&lt;AddressLine1&gt;1000 Preston Rd&lt;/AddressLine1&gt;
&lt;City&gt;Plano&lt;/City&gt;
&lt;StateProvinceCode&gt;TX&lt;/StateProvinceCode&gt;
&lt;CountryCode&gt;US&lt;/CountryCode&gt;
&lt;PostalCode&gt;75093&lt;/PostalCode&gt;
&lt;/Address&gt;
&lt;/Shipper&gt;
&lt;ShipTo&gt;
&lt;CompanyName&gt;Pep Boys&lt;/CompanyName&gt;
&lt;AttentionName&gt;Manny&lt;/AttentionName&gt;
&lt;PhoneNumber&gt;
&lt;StructuredPhoneNumber&gt;
&lt;PhoneDialPlanNumber&gt;410&lt;/PhoneDialPlanNumber&gt;
&lt;PhoneLineNumber&gt;5125551212&lt;/PhoneLineNumber&gt;
&lt;PhoneExtension&gt;1234&lt;/PhoneExtension&gt;
&lt;/StructuredPhoneNumber&gt;
&lt;/PhoneNumber&gt;
&lt;Address&gt;
&lt;AddressLine1&gt;201 York Rd&lt;/AddressLine1&gt;
&lt;City&gt;Timonium&lt;/City&gt;
&lt;StateProvinceCode&gt;MD&lt;/StateProvinceCode&gt;
&lt;CountryCode&gt;US&lt;/CountryCode&gt;
&lt;PostalCode&gt;21093&lt;/PostalCode&gt;
&lt;ResidentialAddress /&gt;
&lt;/Address&gt;
&lt;/ShipTo&gt;
&lt;Service&gt;
9 February 2009
Page 162
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
ShipmentConfirmRequest
&lt;Code&gt;14&lt;/Code&gt;
&lt;Description&gt;Next Day Air Early AM&lt;/Description&gt;
&lt;/Service&gt;
&lt;PaymentInformation&gt;
&lt;Prepaid&gt;
&lt;BillShipper&gt;
&lt;CreditCard&gt;
&lt;Type&gt;06&lt;/Type&gt;
&lt;Number&gt;4111111111111111&lt;/Number&gt;
&lt;ExpirationDate&gt;121999&lt;/ExpirationDate&gt;
&lt;/CreditCard&gt;
&lt;/BillShipper&gt;
&lt;/Prepaid&gt;
&lt;/PaymentInformation&gt;
&lt;ShipmentServiceOptions&gt;
&lt;OnCallAir&gt;
&lt;PickupDetails&gt;
&lt;PickupDate&gt;09132000&lt;/PickupDate&gt;
&lt;EarliestTimeReady&gt;0945&lt;/EarliestTimeReady&gt;
&lt;LatestTimeReady&gt;1445&lt;/LatestTimeReady&gt;
&lt;ContactInfo&gt;
&lt;Name&gt;Jane Smith&lt;/Name&gt;
&lt;PhoneNumber&gt;9725551234&lt;/PhoneNumber&gt;
&lt;/ContactInfo&gt;
&lt;/PickupDetails&gt;
&lt;/OnCallAir&gt;
&lt;/ShipmentServiceOptions&gt;
&lt;Package&gt;
&lt;PackagingType&gt;
&lt;Code&gt;02&lt;/Code&gt;
&lt;/PackagingType&gt;
&lt;Dimensions&gt;
&lt;UnitOfMeasurement&gt;
&lt;Code&gt;IN&lt;/Code&gt;
&lt;/UnitOfMeasurement&gt;
&lt;Length&gt;22&lt;/Length&gt;
&lt;Width&gt;20&lt;/Width&gt;
&lt;Height&gt;18&lt;/Height&gt;
&lt;/Dimensions&gt;
&lt;PackageWeight&gt;
&lt;Weight&gt;14.1&lt;/Weight&gt;
&lt;/PackageWeight&gt;
&lt;ReferenceNumber&gt;
&lt;Code&gt;02&lt;/Code&gt;
&lt;Value&gt;1234567&lt;/Value&gt;
&lt;/ReferenceNumber&gt;
&lt;PackageServiceOptions&gt;
&lt;InsuredValue&gt;
&lt;CurrencyCode&gt;USD&lt;/CurrencyCode&gt;
&lt;MonetaryValue&gt;149.99&lt;/MonetaryValue&gt;
&lt;/InsuredValue&gt;
&lt;VerbalConfirmation&gt;
&lt;Name&gt;Sidney Smith&lt;/Name&gt;
&lt;PhoneNumber&gt;4105551234&lt;/PhoneNumber&gt;
&lt;/VerbalConfirmation&gt;
&lt;/PackageServiceOptions&gt;
&lt;/Package&gt;
9 February 2009
Page 163
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
ShipmentConfirmRequest
&lt;Package&gt;
&lt;PackagingType&gt;
&lt;Code&gt;02&lt;/Code&gt;
&lt;/PackagingType&gt;
&lt;PackageWeight&gt;
&lt;Weight&gt;22.0&lt;/Weight&gt;
&lt;/PackageWeight&gt;
&lt;ReferenceNumber&gt;
&lt;Code&gt;PM&lt;/Code&gt;
&lt;Value&gt;1234568&lt;/Value&gt;
&lt;/ReferenceNumber&gt;
&lt;ReferenceNumber&gt;
&lt;Code&gt;ST&lt;/Code&gt;
&lt;Value&gt;Distributor&lt;/Value&gt;
&lt;/ReferenceNumber&gt;
&lt;PackageServiceOptions&gt;
&lt;InsuredValue&gt;
&lt;MonetaryValue&gt;299.99&lt;/MonetaryValue&gt;
&lt;/InsuredValue&gt;
&lt;/PackageServiceOptions&gt;
&lt;/Package&gt;
&lt;/Shipment&gt;
&lt;LabelSpecification&gt;
&lt;LabelPrintMethod&gt;
&lt;Code&gt;GIF&lt;/Code&gt;
&lt;/LabelPrintMethod&gt;
&lt;HTTPUserAgent&gt;Mozilla/4.5&lt;/HTTPUserAgent&gt;
&lt;LabelImageFormat&gt;
&lt;Code&gt;GIF&lt;/Code&gt;
&lt;/LabelImageFormat&gt;
&lt;/LabelSpecification&gt;
&lt;/ShipmentConfirmRequest&gt;
9 February 2009
Page 164
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
ShipmentConfirmResponse
ShipmentConfirmResponse
The ShipmentConfirmResponse message contains a single XML document that conforms to the following structure.
(Forward) ShipmentConfirmResponse XML Details:
Note: The “Required” Column has four potential values:
9 February 2009
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Page 165
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
VALIDATION RULES
RETURN ONLY
TYPE
Container
DESCRIPTION
FORWARD ONLY
MAXALLOWED
/ShipmentConfirmResponse
1
ShipmentConfirmResponse
XPATH
REQUIRED
NAME
Cond
Yes: Always required
No: Always optional
Yes*: Conditionally required
Cond: Conditional
1
Yes
/Response
1 = Successful
String
1
Yes
Describes Response Status Code. Returns
text of &quot;Success&quot; or &quot;Failure&quot;
/Error
If an error is encountered during the
N/A
Container
/Response
1
Error
Cond
/ResponseStatusDescription
/ShipmentConfirmResponse
between client and server.
0 = Failure
/ShipmentConfirmResponse
/Response
TransactionReference identifies transactions
transaction.
/ResponseStatusCode
ResponseStatusDescription
interchange, the Response contains an error.
If the error is present, then the ErrorSeverity
and ErrorCode are required.
9 February 2009
Page 166
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
Identifies the success or failure of the
/ShipmentConfirmResponse
ResponseStatusCode
DESCRIPTION
FORWARD ONLY
LENGTH
N/A
/TransactionReference
N/A
TYPE
Container
Container
/Response
Yes
/ShipmentConfirmResponse
TransactionReference
String
/Response
MAXALLOWED
/ShipmentConfirmResponse
1
Response
XPATH
1
NAME
REQUIRED
ShipmentConfirmResponse
Yes
UPS OnLine Tools Shipping
Describes the severity of the
error.
TransientError - Customer’s data has not been
processed due to system unavailability. The
customer has to wait and try again.
/Error
HardError - The error was
String
/Response
1
ErrorSeverity
Yes
/ShipmentConfirmResponse
encountered processing the
customer’s data and that the data needs
/ErrorSeverity
correction.
Warning - The customer’s data
was successfully processed;
however, there were warnings
encountered during processing.
A numeric value that describes
the error.
1..15
/Error
String
/Response
1
ErrorCode
Yes
/ShipmentConfirmResponse
Each tool defines a range of error codes.
Refer to Error Conditions table in the
’Programming
/ErrorCode
Information’ chapter for detailed descriptions
of all errors.
1..50
/Error
String
/Response
1
ErrorDescription
Yes
/ShipmentConfirmResponse
Describes the error code.
/ErrorDescription
9 February 2009
Page 167
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmResponse
REQUIRED
UPS OnLine Tools Shipping
Number of seconds to wait until retry. This
1..5
/Error
String
MinimumRetrySeconds
field is populated on special conditions of the
1
/Response
No
/ShipmentConfirmResponse
/MinimumRetrySeconds
Transient Error only, as defined
Never returned
by the service.
A number between 1 and
N/A
/Error
1
/Response
ErrorLocation
Yes
/ShipmentConfirmResponse
Container
86400 (24 hours)
Identifies the element in error.
/ErrorLocation
1..512
String
/Error
1
/Response
ErrorLocationElementName
Yes
/ShipmentConfirmResponse
/ErrorLocation
The XPATH name of the element in error. This
is a valid XPATH pointing to an element in the
request document.
/ErrorLocationElementName
/ShipmentConfirmResponse
/ErrorLocation
String
/Error
1
ErrorLocationElementReference
Yes
/Response
Not Used
/ErrorLocationElementRefere
nce
/ShipmentConfirmResponse
/ErrorLocation
/ErrorLocationAttributeName
1..50
String
/Error
1
ErrorLocationAttributeName
The name of the attribute in
Yes
/Response
error. This is the name of the
attribute contained by the Error Location
Element.
9 February 2009
Page 168
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
ShipmentConfirmResponse
REQUIRED
UPS OnLine Tools Shipping
/Response
/Error
The contents of the element in
error.
Shipment charges info.
N/A
Container
/ShipmentCharges
1
ShipmentCharges
/ShipmentConfirmResponse
Cond
/ErrorDigest
Shipment charges
are only guaranteed to be returned for
shipments whose origin country is US or
/TransportationCharges
N/A
1
/ShipmentCharges
yes
/ShipmentConfirmResponse
TransportationCharges
Container
Puerto Rico.
/TransportationCharges
Transportation charges currency code type.
3
String
/ShipmentCharges
1
CurrencyCode
Yes
/ShipmentConfirmResponse
The currency code used in the Shipment
ConfirmRequest is returned.
/CurrencyCode
1..19
/TransportationCharges
String
/ShipmentCharges
1
MonetaryValue
Yes
/ShipmentConfirmResponse
Transportation and surcharges value amount.
Valid values are from 0 to
99999999999999.99
/MonetaryValue
9 February 2009
Page 169
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
LENGTH
Variable.
ErrorDigest
Yes
/ShipmentConfirmResponse
DESCRIPTION
FORWARD ONLY
TYPE
String
XPATH
MAXALLOWED
NAME
1
ShipmentConfirmResponse
REQUIRED
UPS OnLine Tools Shipping
/ServiceOptionsCharges
/ServiceOptionsCharges
Service options charges currency code type.
3
String
/ShipmentCharges
1
CurrencyCode
Yes
/ShipmentConfirmResponse
The currency code used in the Shipment
ConfirmRequest is returned.
/CurrencyCode
String
1..19
N/A
/ServiceOptionsCharges
Container
/ShipmentCharges
1
MonetaryValue
Yes
/ShipmentConfirmResponse
Service options charges value amount
Valid values are from 0 to
99999999999999.99
1
/ShipmentCharges
Yes
/ShipmentConfirmResponse
TotalCharges
one
/MonetaryValue
/TotalCharges
/TotalCharges
/CurrencyCode
Total charges currency code type. The
3
String
/ShipmentCharges
1
CurrencyCode
Yes
/ShipmentConfirmResponse
currency code used in the Shipment
ConfirmRequest is returned.
9 February 2009
Page 170
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
/ShipmentCharges
VALIDATION RULES
RETURN ONLY
TYPE
Container
/ShipmentConfirmResponse
ServiceOptionsCharges
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
XPATH
REQUIRED
NAME
ShipmentConfirmResponse
Yes
UPS OnLine Tools Shipping
/ShipmentConfirmResponse
MonetaryValue
/ShipmentCharges
/TotalCharges
Valid values are from 0 to
Total charges value amount.
99999999999999.99
1
Container
N/A
Container
N/A
/BillingWeight
1
/ShipmentConfirmResponse
Yes
BillingWeight
Yes
/MonetaryValue
/ShipmentConfirmResponse
UnitOfMeasurement
/BillingWeight
/UnitOfMeasurement
Billing Weight unit of measurement code. The
2..3
/UnitOfMeasurement
String
/BillingWeight
1
Code
Yes
/ShipmentConfirmResponse
unit of measurement used in Shipment
Confirm Request is returned.
/Code
/UnitOfMeasurement
3
String
/BillingWeight
1
Description
No
/ShipmentConfirmResponse
Description of the billing weight measurement
units. Valid values are: KGS or LBS
/Description
9 February 2009
Page 171
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1..19
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentConfirmResponse
Yes
UPS OnLine Tools Shipping
18
String
1
Yes
1Z Number of the first package in
Returned UPS shipment ID number.
the shipment.
/NetSummaryCharges
Encoded
Variable
N/A
Encoded shipment parameters required to be
passed in the accept phase
(ShipmentAcceptrequest).
Negotiated Rates info.
N/A
1
Container
Container
/NegotiatedRates
1
/NegotiatedRates
/ShipmentConfirmResponse
NetSummaryCharges
1
/ShipmentConfirmResponse
No
/ShipmentDigest
Cond
NegotiatedRates
/ShipmentConfirmResponse
Yes
r
ShipmentDigest
Valid value up to 99999.99
envelopes.
/ShipmentConfirmResponse
/ShipmentIdentificationNumbe
weight versus the shipment dimensional
weight. Set to 0 for package type of letters or
/Weight
ShipmentIdentificationNumber
Net Summary Charges are only returned for
shipper account /userid combinations qualified
for Negotiated rates.
9 February 2009
Page 172
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
FORWARD ONLY
LENGTH
8
1
Yes
/BillingWeight
DESCRIPTION
Billing weight. Higher of the actual shipment
/ShipmentConfirmResponse
Weight
TYPE
XPATH
String
NAME
MAXALLOWED
ShipmentConfirmResponse
REQUIRED
UPS OnLine Tools Shipping
Container
N/A
String
1..19
String
3
Net Summary charges currency code type.
/GrandTotal
/ShipmentConfirmResponse
/NegotiatedRates
MonetaryValue
/NetSummaryCharges
/GrandTotal
Valid values are from 0 to
9999999999999999.99
/MonetaryValue
/ShipmentConfirmResponse
CurrencyCode
/NegotiatedRates
/NetSummaryCharges
/CurrencyCode
9 February 2009
Page 173
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
FORWARD ONLY
LENGTH
1
1
Net Summary charges monetary value.
1
/NetSummaryCharges
Cond
/NegotiatedRates
VALIDATION RULES
Yes
GrandTotal
DESCRIPTION
Yes
/ShipmentConfirmResponse
TYPE
XPATH
MAXALLOWED
NAME
ShipmentConfirmResponse
REQUIRED
UPS OnLine Tools Shipping
UPS OnLine Tools Shipping
ShipmentConfirmResponse
ShipmentConfirmResponse Example Message:
&lt;?xml version=&quot;1.0&quot; ?&gt;ShipmentAcceptRequest
&lt;ShipmentConfirmResponse&gt;
&lt;Response&gt;
&lt;TransactionReference&gt;
&lt;CustomerContext&gt;guidlikesubstance&lt;/CustomerContext&gt;
&lt;XpciVersion&gt;1.0001&lt;/XpciVersion&gt;
&lt;/TransactionReference&gt;
&lt;ResponseStatus&gt;0&lt;/ResponseStatus&gt;
&lt;ResponseStatusDescription&gt;success&lt;/ResponseStatusDescription&gt;
&lt;/Response&gt;
&lt;ShipmentCharges&gt;
&lt;TransportationCharges&gt;
&lt;MonetaryValue&gt;19.60&lt;/MonetaryValue&gt;
&lt;/TransportationCharges&gt;
&lt;ServiceOptionsCharges&gt;
&lt;MonetaryValue&gt;3.40&lt;/MonetaryValue&gt;
&lt;/ServiceOptionsCharges&gt;
&lt;TotalCharges&gt;
&lt;MonetaryValue&gt;23.00&lt;/MonetaryValue&gt;
&lt;/TotalCharges&gt;
&lt;/ShipmentCharges&gt;
&lt;BillingWeight&gt;
&lt;Weight&gt;36.0&lt;/Weight&gt;
&lt;/BillingWeight&gt;
&lt;ShipmentIdentificationNumber&gt;1Z123X670299567041&lt;/ShipmentIdentificationNumber&gt;
&lt;ShipmentDigest&gt;FSDJHFSDJSHDJK47873487489KFSDJKQSDFSJDFK94238093489034K
SDFJSDFKLJFDSKFKDJFSDKJFLSDKA923809234893402KLSDFJKLSDFJDFKSJFSDKLJFDSKLJFSD
KLJ49230843920814309KLSDFJFKLSDJFDKLSJSDFKLJDKFLJDSKLJ092348349223098IJKLFJKL
FSDJFKLASDJFKAJFSDIUR897348574KJWEHRIQEWU8948348(truncated)&lt;/ShipmentDigest&gt;
&lt;/ShipmentConfirmResponse&gt;
9 February 2009
Page 174
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
ShipmentAcceptRequest
ShipmentAcceptRequest
The ShipmentAcceptRequest message consists of two complete XML documents. The first document is an AccessRequest. The
AccessRequest is immediately followed by a ShipmentAcceptRequest. When a client application is undergoing testing and
integration, the document combination should be sent to the URL:
https://wwwcie.ups.com/ups.app/xml/ShipAccept
Once a client application is in production, the combined documents should be sent to the URL provided as part of the certification
process.
The ShipmentAcceptRequest conforms to the following XML structure.
Note: The “Required” Column has four potential values:
Yes: Always required
No: Always optional
Yes*: Conditionally required
Cond: Conditional
9 February 2009
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Page 175
Container
N/A
1..50
/TransactionReference
String
1
/Request
No
/ShipmentAcceptRequest
Indicates the action to be taken by the XML
Must be ‘ShipAccept’.
TransactionReference identifies transactions
between client and server.
/Request
/TransactionReference
1
CustomerContext
No
/ShipmentAcceptRequest
Customer context
/CustomerContext
9 February 2009
Page 176
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
service.
/RequestAction
TransactionReference
DESCRIPTION
FORWARD ONLY
LENGTH
N/A
N/A
10
Container
Container
String
/Request
Yes
/ShipmentAcceptRequest
RequestAction
TYPE
1
/Request
1
ShipmentAcceptRequest
1
Request
ShipmentAcceptRequest
Yes
ShipmentAcceptRequest
XPATH
Yes
NAME
MAXALLOWED
ShipmentAcceptRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentAcceptRequest
XpciVersion
/Request
/TransactionReference
Deprecated
length
String
/ShipmentDigest
Variable
/ShipmentAcceptRequest
1
ShipmentDigest
Yes
/XpciVersion
Encoded shipment parameters required to be
passed in the accept phase.
ShipmentAcceptRequest Example Message:
&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;AccessRequest xml:lang='en-US'&gt;
&lt;AccessLicenseNumber&gt;YOURACCESSLICENSENUMBER&lt;/AccessLicenseNumber&gt;
&lt;UserId&gt;YOURUSERID&lt;/UserId&gt;
&lt;Password&gt;YOURPASSWORD&lt;/Password&gt;
&lt;/AccessRequest&gt;
&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;ShipmentAcceptRequest&gt;
&lt;Request&gt;
&lt;TransactionReference&gt;
&lt;CustomerContext&gt;guidlikesubstance&lt;/CustomerContext&gt;
9 February 2009
Page 177
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
4
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
ShipmentAcceptRequest
No
UPS OnLine Tools Shipping
UPS OnLine Tools Shipping
ShipmentAcceptRequest
&lt;XpciVersion&gt;1.0001&lt;/XpciVersion&gt;
&lt;/TransactionReference&gt;
&lt;RequestAction&gt;ShipAccept&lt;/RequestAction&gt;
&lt;/Request&gt;
&lt;ShipmentDigest&gt;FSDJHFSDJSHDJK47873487489KFSDJKQSDFSJDFK94238093489034KSDFJSDFKLJFDSKFKDJFSDKJFLSDKA923809234893402K
LSDFJKLSDFJDFKSJFSDKLJFDSKLJFSDKLJ49230843920814309KLSDFJFKLSDJFDKLSJSDFKLJDKFLJDSKLJ092348349223098IJKLFJKLFSDJFKLASDJFKAJF
SDIUR897348574KJWEHRIQEWU8948348(truncated)&lt;/ShipmentDigest&gt;
&lt;/ShipmentAcceptRequest&gt;
9 February 2009
Page 178
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
ShipmentAcceptResponse
ShipmentAcceptResponse
The ShipmentAcceptResponse message contains a single XML document that conforms to the following structure.
(Forward) ShipmentAcceptResponse XML Details:
Note: The “Required” Column has four potential values:
9 February 2009
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Page 179
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
N/A
N/A
TYPE
Container
MAXALLOWED
Container
/Response
1
/ShipmentAcceptResponse
1
Response
/ShipmentAcceptResponse
Yes
ShipmentAcceptResponse
XPATH
Yes
NAME
REQUIRED
Yes: Always required
No: Always optional
Yes*: Conditionally required
Cond: Conditional
/TransactionReference
String
/Response
1
CustomerContext
No
/ShipmentAcceptResponse
/CustomerContext
/TransactionReference
String
/Response
1
XpciVersion
No
/ShipmentAcceptResponse
/XpciVersion
Yes
1
String
1
String
/Response
Yes
/ShipmentAcceptResponse
ResponseStatusCode
/ResponseStatusCode
/ShipmentAcceptResponse
ResponseStatusDescription
/Response
/ResponseStatusDescription
9 February 2009
Page 180
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
/TransactionReference
N/A
1
/Response
Yes
/ShipmentAcceptResponse
TransactionReference
TYPE
XPATH
Container
NAME
MAXALLOWED
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
/Response
/Error
interchange, the Response contains an error.
If the error is present, then the ErrorSeverity
and ErrorCode are required.
Describes the severity of the
error.
TransientError - Customer’s data has not been
processed due to system unavailability. The
customer has to wait and try again.
1..15
/Error
String
/Response
1
ErrorSeverity
Yes
/ShipmentAcceptResponse
HardError - The error was
encountered processing the
customer’s data and that the data needs
/ErrorSeverity
correction.
Warning - The customer’s data
was successfully processed;
however, there were warnings
encountered during processing.
A numeric value that describes
the error.
/ErrorCode
1..15
/Error
String
/Response
1
ErrorCode
Yes
/ShipmentAcceptResponse
Each tool defines a range of error codes.
Refer to Error Conditions table in the
’Programming
Information’ chapter for detailed descriptions
of all errors.
9 February 2009
Page 181
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
FORWARD ONLY
LENGTH
TYPE
DESCRIPTION
If an error is encountered during the
N/A
Error
Container
/ShipmentAcceptResponse
1
XPATH
Cond
NAME
MAXALLOWED
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentAcceptResponse
ErrorDescription
/Response
/Error
/ErrorDescription
/ShipmentAcceptResponse
ErrorLocation
/Response
/Error
/ErrorLocation
/ShipmentAcceptResponse
String
/Error
1
ErrorLocationElementName
The XPATH name of the element in error. This
Yes
/Response
is a valid
XPATH pointing to an element in the request
/ErrorLocation
document.
/ErrorLocationElementName
/ShipmentAcceptResponse
1..50
String
/Error
1
ErrorLocationAttributeName
The name of the attribute in
Yes
/Response
/ErrorLocation
Variable
1
String
/Error
Yes
/ShipmentAcceptResponse
/Response
attribute contained by the Error Location
Element.
/ErrorLocationAttributeName
ErrorDigest
error. This is the name of the
The contents of the element in
error.
/ErrorDigest
9 February 2009
Page 182
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1..50
N/A
VALIDATION RULES
RETURN ONLY
TYPE
String
Container
Identifies the element in error.
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
Describes the error code.
1
XPATH
REQUIRED
NAME
Yes
VoidShipmentRequest
Yes
UPS OnLine Tools Shipping
/ShipmentCharges
/TransportationCharges
Transportation charges currency code type.
3
String
/ShipmentCharges
1
/ShipmentResults
CurrencyCode
Yes
/ShipmentAcceptResponse
/TransportationCharges
The currency code used in the
ShipmentConfirmRequest is returned.
/CurrencyCode
1..19
String
/ShipmentCharges
1
/ShipmentResults
MonetaryValue
Yes
/ShipmentAcceptResponse
Transportation and surcharges value amount.
/TransportationCharges
Valid values are from 0 to
99999999999999.99
/MonetaryValue
9 February 2009
Page 183
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
N/A
shipments whose origin country is US or
RETURN ONLY
TYPE
Container
1
yes
/ShipmentResults
Shipment charges
are only guaranteed to be returned for
Puerto Rico.
/ShipmentAcceptResponse
TransportationCharges
Shipment charges info.
VALIDATION RULES
FORWARD ONLY
MAXALLOWED
/ShipmentCharges
DESCRIPTION
N/A
/ShipmentResults
Container
ShipmentCharges
Container
/ShipmentAcceptResponse
1
/ShipmentResults
1
/ShipmentAcceptResponse
REQUIRED
ShipmentResults
XPATH
Cond
NAME
VoidShipmentRequest
yes
UPS OnLine Tools Shipping
/ShipmentResults
/ShipmentCharges
/ServiceOptionsCharges
Accessorial charges currency code type. The
3
String
/ShipmentCharges
1
/ShipmentResults
CurrencyCode
Yes
/ShipmentAcceptResponse
/ServiceOptionsCharges
currency code used in the
ShipmentConfirmRequest is returned.
/CurrencyCode
String
1..19
Container
N/A
1
1
/ShipmentCharges
Yes
/ShipmentResults
MonetaryValue
yes
/ShipmentAcceptResponse
Valid values are from 0 to
Accessorial charges value amount.
99999999999999.99
/ServiceOptionsCharges
/MonetaryValue
/ShipmentAcceptResponse
TotalCharges
/ShipmentResults
/ShipmentCharges
/TotalCharges
/TotalCharges
Total charges currency code type. The
3
String
/ShipmentCharges
1
/ShipmentResults
CurrencyCode
Yes
/ShipmentAcceptResponse
currency code used in the
ShipmentConfirmRequest is returned.
/CurrencyCode
9 February 2009
Page 184
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
ServiceOptionsCharges
VALIDATION RULES
RETURN ONLY
TYPE
Container
/ShipmentAcceptResponse
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
XPATH
REQUIRED
NAME
VoidShipmentRequest
yes
UPS OnLine Tools Shipping
/ShipmentResults
MonetaryValue
/ShipmentCharges
Valid values are from 0 to
Total charges value amount.
99999999999999.99
/TotalCharges
/MonetaryValue
/NegotiatedRates
Account Based Rates info.
/ShipmentResults
/NegotiatedRates
1
NetSummaryCharges
Cond
/ShipmentAcceptResponse
Net Summary
Charges are only returned for ABR eligible
N/A
/ShipmentResults
Container
/ShipmentAcceptResponse
NegotiatedRates
shipper account/userid combinations when the
user includes the NegotiatedRates indicator in
/NetSummaryCharges
the ShipConfirm request.
1
Container
N/A
1
String
1..19
/NegotiatedRates
Yes
/ShipmentResults
GrandTotal
Yes*
/ShipmentAcceptResponse
/NetSummaryCharges
/GrandTotal
/ShipmentAcceptResponse
/ShipmentResults
MonetaryValue
/NegotiatedRates
/NetSummaryCharges
Net Summary charges monetary value.
Valid values are from 0 to
9999999999999999.99
/GrandTotal
/MonetaryValue
9 February 2009
Page 185
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
LENGTH
1..19
N/A
/ShipmentAcceptResponse
CERT. OF ORIGIN
TYPE
String
Container
VALIDATION RULES
RETURN ONLY
MAXALLOWED
1
1
DESCRIPTION
FORWARD ONLY
REQUIRED
XPATH
Yes
NAME
VoidShipmentRequest
Cond
UPS OnLine Tools Shipping
/ShipmentAcceptResponse
/ShipmentResults
CurrencyCode
/NegotiatedRates
Net Summary charges currency code.
/NetSummaryCharges
Yes
1
Container
N/A
Yes
1
Container
N/A
/CurrencyCode
/ShipmentAcceptResponse
BillingWeight
/ShipmentResults
/BillingWeight
/ShipmentAcceptResponse
UnitOfMeasurement
/ShipmentResults
/BillingWeight
/UnitOfMeasurement
Billing weight unit of measurement code. The
2..3
String
/BillingWeight
1
/ShipmentResults
Code
Yes
/ShipmentAcceptResponse
/UnitOfMeasurement
unit of measurement used in
ShipmentConfirmRequest is returned.
/Code
/UnitOfMeasurement
3
1
/BillingWeight
No
/ShipmentResults
Description
String
/ShipmentAcceptResponse
Description of the billing weight measurement
units. Values are: KGS or LBS
/Description
9 February 2009
Page 186
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
3
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
VoidShipmentRequest
Yes*
UPS OnLine Tools Shipping
/BillingWeight
8
String
Weight
weight versus the shipment dimensional
weight. Set to 0 for package type of letters or
/Weight
envelopes.
String
18
String
11
1
/ShipmentIdentificationNumbe
1
/ShipmentResults
Yes
ShipmentIdentificationNumber
No
/ShipmentAcceptResponse
1Z Number of the first package in
Returned UPS shipment ID number.
the shipment.
r
/ShipmentAcceptResponse
PickupRequestNumber
/ShipmentResults
Shipment pickup number.
If an On Call pickup is requested.
/PickupRequestNumber
/ControlLogReceipt
declared value between $999
N/A
/ShipmentResults
Container
ControlLogReceipt
1
/ShipmentAcceptResponse
Cond
When forward shipment’s
and $50,000 USD.
Container for the High Value reports
Two copies of high value report
/ControlLogReceipt
N/A
/ShipmentResults
1
ImageFormat
Cond
/ShipmentAcceptResponse
Container
needs to be printed out.
Container for the High Value report format,
required if parent exist
/ImageFormat
9 February 2009
Page 187
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
Billing weight. Higher of the actual shipment
1
/ShipmentResults
Yes
/ShipmentAcceptResponse
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
Values are:
‘EPL’ = EPL2 (when user
4
/ControlLogReceipt
String
Code
requests label in EPL2 format)
1
/ShipmentResults
Yes*
/ShipmentAcceptResponse
Code for the type of Graphic Image for the
High Value Report.
/ImageFormat
‘SPL’ = SPL (when user requests
label in SPL format)
‘ZPL’ = ZPL (when user requests
/Code
label in ZPL format)
‘HTML’= HTML (when user
requests label in HTML format)
1
1
Base 64
1..35
No
/ControlLogReceipt
Yes*
/ShipmentResults
Description
String
/ShipmentAcceptResponse
Description of the format code
/ImageFormat
GraphicImage
/ShipmentResults
/ControlLogReceipt
Length
/ShipmentAcceptResponse
Encoded
Variable
/Description
Base 64 encoded html, EPL2, ZPL, STARPL
or SPL image
/PackageResults
N/A
200)
Container
/ShipmentResults
No
/ShipmentAcceptResponse
PackageResults
Many (up to
/GraphicImage
Returned Package Information.
9 February 2009
Page 188
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentAcceptResponse
TrackingNumber
/ShipmentResults
/PackageResults
Package 1Z number.
Shipment charges info.
N/A
/PackageResults
1
ServiceOptionsCharges
/ShipmentResults
Cond
/ShipmentAcceptResponse
Container
/TrackingNumber
/ServiceOptionsCharges
Shipment charges
are only guaranteed to be returned for
shipments whose origin country is US or
Puerto Rico.
Package accessorial charges currency code
3
String
/PackageResults
1
/ShipmentResults
CurrencyCode
Yes
/ShipmentAcceptResponse
/ServiceOptionsCharges
type. The currency code used in the
ShipmentConfirmRequest is returned.
/CurrencyCode
String
1..19
Package accessorial charges value amount.
Container
N/A
1
1
/PackageResults
Yes
/ShipmentResults
MonetaryValue
Cond
/ShipmentAcceptResponse
The container for UPS shipping label
/ServiceOptionsCharges
Valid values are from 0 to
99999999999999.99
/MonetaryValue
/ShipmentAcceptResponse
LabelImage
/ShipmentResults
/PackageResults
Shipment without return service
or with PRL return service.
/LabelImage
9 February 2009
Page 189
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
18
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
XPATH
REQUIRED
NAME
VoidShipmentRequest
Yes
UPS OnLine Tools Shipping
/ShipmentAcceptResponse
/ShipmentResults
LabelImageFormat
/PackageResults
/LabelImage
/LabelImageFormat
/ShipmentAcceptResponse
3
String
/LabelImage
Label image code that the labels are
1
Code
/PackageResults
Yes
/ShipmentResults
generated. Values ‘EPL’ = EPL2, ‘SPL’ = SPL, Only ‘EPL’, ‘SPL’, ‘ZPL’ and ‘GIF’
‘ZPL’ = ZPL, ‘GIF’ = gif images, or ‘PNG’ for
/LabelImageFormat
are currently supported.
PNG images.
/Code
/ShipmentAcceptResponse
String
Encoded
/LabelImage
1..35
1
1
/PackageResults
No
Description
Yes
/ShipmentResults
Description of the label image format code.
/LabelImageFormat
/Description
/PackageResults
/LabelImage
Length
/ShipmentResults
GraphicImage
Variable
/ShipmentAcceptResponse
Base 64 encoded graphic image.
/GraphicImage
9 February 2009
Page 190
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
VALIDATION RULES
RETURN ONLY
TYPE
Container
DESCRIPTION
FORWARD ONLY
MAXALLOWED
XPATH
1
NAME
REQUIRED
VoidShipmentRequest
yes
UPS OnLine Tools Shipping
/LabelImage
1
Encoded
ge
Cond
/ShipmentResults
InternationalSignatureGraphicIma /PackageResults
/InternationalSignatureGraphi
labels. The image will be
Base 64 encoded graphic image of the
Warsaw text and signature box.
returned for non-US based
shipments. One image will be
given per shipment and it will be
in the first PackageResults
cImage
container.
Length
Variable
/LabelImage
Encoded
/PackageResults
1
/ShipmentResults
HTMLImage
Cond
/ShipmentAcceptResponse
Base 64 encoded html browser image
This is only returned for gif and
rendering software.
png image formats.
/LabelImage
/PDF417
Container
/PackageResults
1
/ShipmentResults
Cond
/ShipmentAcceptResponse
Receipt
PDF-417 is a two-dimensional barcode, which
can store up to about 1,800 printable ASCII
characters or 1,100 binary characters per
Shipment with PRL return
symbol. The symbol is rectangular. The image service only
is Base 64 encoded and returned if the
LabelImageFormat code is GIF
N/A
/PackageResults
Encoded
PDF417
1
/ShipmentResults
Cond
/ShipmentAcceptResponse
Variable Length
/HTMLImage
Container for the receipt and the receipt link.
Not supported for ERL or PRL
shipments.
/Receipt
9 February 2009
Page 191
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
FORWARD ONLY
LENGTH
DESCRIPTION
EPL2, ZPL, STARPL and SPL
/ShipmentAcceptResponse
Variable Length
XPATH
TYPE
NAME
MAXALLOWED
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
/PackageResults
/Receipt
/Image
/ShipmentAcceptResponse
/ShipmentResults
ImageFormat
/PackageResults
/Receipt
/Image
/ImageFormat
/ShipmentAcceptResponse
Code representing the format in which a
4
String
/Receipt
1
/PackageResults
Code
Yes*
/ShipmentResults
/Image
receipt is returned. Valid values:
“HTML” = HTML format
/ImageFormat
/Code
/ShipmentAcceptResponse
1..35
1
/Receipt
No
/PackageResults
Description
String
/ShipmentResults
Description of the image format code.
/Image
/ImageFormat
/Description
9 February 2009
Page 192
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
N/A
N/A
/ShipmentResults
Image
CERT. OF ORIGIN
LENGTH
Container
Container
Container for a receipt format
/ShipmentAcceptResponse
RETURN ONLY
TYPE
1
Container for the receipt of a return shipment
VALIDATION RULES
FORWARD ONLY
MAXALLOWED
DESCRIPTION
1
XPATH
REQUIRED
NAME
Cond
VoidShipmentRequest
Yes*
UPS OnLine Tools Shipping
Code that indicates the type of form
/Image
/GraphicImage
/ShipmentAcceptResponse
Form
/ShipmentResults
/Form
/ShipmentAcceptResponse
Code
/ShipmentResults
/Form
Possible Values
01 – All Requested International
Forms
/Code
1….35
/Form
String
/ShipmentResults
1
Description
Yes*
/ShipmentAcceptResponse
Possible Values
Description that indicates the type of form
Forms
N/A
/Form
1
/ShipmentResults
Cond
/ShipmentAcceptResponse
Container
/Description
Image
All Requested International
Container tag for the International forms image
/Image
9 February 2009
Page 193
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
2
/Receipt
SED
N/A
String
/PackageResults
INVOICE
Variable Length
Container
1
GraphicImage
N/AFTA CO
LENGTH
Encoded
1
Container tag for the International forms image
/ShipmentResults
CERT. OF ORIGIN
TYPE
1
Base 64 encoded PRL receipt in HTML format
/ShipmentAcceptResponse
VALIDATION RULES
RETURN ONLY
MAXALLOWED
DESCRIPTION
FORWARD ONLY
REQUIRED
XPATH
Yes*
NAME
Cond
VoidShipmentRequest
Yes*
UPS OnLine Tools Shipping
/ShipmentResults
ImageFormat
/Form
Cond
/ShipmentAcceptResponse
/Image
format information
/ImageFormat
/ShipmentAcceptResponse
3
String
/Image
Code representing the format in which the
1
Code
/Form
Cond
/ShipmentResults
forms are generated
Only PDF is supported currently
Possible Values
/ImageFormat
PDF = “pdf”
/Code
/ShipmentAcceptResponse
1
1
Base 64
/Image
1..35
No
/Form
Cond
Description
String
/ShipmentResults
Description of the form image format code.
/ImageFormat
/Description
/Form
/Image
Length
/ShipmentResults
GraphicImage
Encoded
Variable
/ShipmentAcceptResponse
Base 64 encoded International forms image
/GraphicImage
1…26
String
/Form
1
/ShipmentResults
One
FormGroupId
Cond
/ShipmentAcceptResponse
Unique Id for later retrieval of saved version of
the completed international forms.
/FormGroupId
9 February 2009
Always returned when code = 01
“01” represents international
forms.
Page 194
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
Container tag for the International forms image
VALIDATION RULES
FORWARD ONLY
LENGTH
DESCRIPTION
N/A
TYPE
Container
XPATH
MAXALLOWED
NAME
1
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
1…50
String
/Form
Container
1
Container
N/A
1
Container
N/A
No
/CODTurnInPage
/ShipmentAcceptResponse
Image
/ShipmentResults
/CODTurnInPage
part of both request and response. This
N/A
1
Yes*
/ShipmentAcceptResponse
/ShipmentResults
group of International forms. This element is
element does not appear on the forms.
Yes*
/FormGroupIdName
CODTurnInPage
The container of the image for COD Turn In
Page.
/Image
/ShipmentAcceptResponse
/ShipmentResults
ImageFormat
/CODTurnInPage
/Image
The container for format of COD Turn In Page
/ImageFormat
/ShipmentAcceptResponse
/Image
/ImageFormat
Format code of the generated COD Turn In
4
String
/CODTurnInPage
1
Code
Yes*
/ShipmentResults
Page. Valid values:
‘HTML’ = HTML format
Only HTML format is supported
for COD Turn In Page.
/Code
9 February 2009
Page 195
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
Contains description text which identifies the
1
FormGroupIdName
/ShipmentResults
No
/ShipmentAcceptResponse
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentAcceptResponse
Description
/CODTurnInPage
No
/ShipmentResults
/Image
Description of the format code of generated
COD Turn In page.
/ImageFormat
/Description
1
Base 64
1
String
11
Shipment pickup number.
1
Container
N/A
Container for the High Value reports
1
Container
/Image
Length
Yes*
No
/CODTurnInPage
Cond
/ShipmentResults
GraphicImage
Encoded
Variable
/ShipmentAcceptResponse
Base 64 encoded html browser image
rendering software.
/GraphicImage
/ShipmentAcceptResponse
PickupRequestNumber
/ShipmentResults
/ShipmentAcceptResponse
ControlLogReceipt
/ShipmentResults
/ControlLogReceipt
ImageFormat
/ShipmentResults
/ControlLogReceipt
Cond
/ShipmentAcceptResponse
N/A
/PickupRequestNumber
Container for the High Value report format,
required if parent exist
/ImageFormat
9 February 2009
Page 196
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
LENGTH
1…35
DESCRIPTION
FORWARD ONLY
TYPE
String
XPATH
MAXALLOWED
NAME
1
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentAcceptResponse
/ShipmentResults
Code
/ControlLogReceipt
Code for the type of Graphic Image for the
High Value Report.
/ImageFormat
/Code
/ShipmentAcceptResponse
/ShipmentResults
Description
/ControlLogReceipt
Description of the format code
/ImageFormat
GraphicImage
/ShipmentResults
/ControlLogReceipt
Length
/ShipmentAcceptResponse
Encoded
Variable
/Description
Base 64 encoded html, EPL2, ZPL, STARPL
or SPL image
N/A
Returned Package Information.
String
18
/PackageResults
200)
Container
/ShipmentResults
No
/ShipmentAcceptResponse
PackageResults
Many (up to
/GraphicImage
Package 1Z number.
/ShipmentResults
/PackageResults
1
TrackingNumber
Yes
/ShipmentAcceptResponse
/TrackingNumber
9 February 2009
Page 197
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
4
1..35
DESCRIPTION
FORWARD ONLY
TYPE
String
String
LENGTH
MAXALLOWED
1
1
1
Base 64
REQUIRED
XPATH
Yes*
NAME
No
VoidShipmentRequest
Yes*
UPS OnLine Tools Shipping
/ServiceOptionsCharges
Shipment charges
are only guaranteed to be returned for
shipments whose origin country is US or
Puerto Rico.
Package accessorial charges currency code
3
String
/PackageResults
1
/ShipmentResults
CurrencyCode
Yes
/ShipmentAcceptResponse
/ServiceOptionsCharges
type. The currency code used in the
ShipmentConfirmRequest is returned.
/CurrencyCode
Yes
1
String
1..19
Package accessorial charges value amount.
1
Container
N/A
The container for UPS shipping label
1
Container
N/A
/PackageResults
Cond
/ShipmentResults
MonetaryValue
yes
/ShipmentAcceptResponse
/ServiceOptionsCharges
/MonetaryValue
/ShipmentAcceptResponse
LabelImage
/ShipmentResults
/PackageResults
/LabelImage
/ShipmentAcceptResponse
/ShipmentResults
LabelImageFormat
/PackageResults
/LabelImage
/LabelImageFormat
9 February 2009
Page 198
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
FORWARD ONLY
LENGTH
TYPE
DESCRIPTION
Shipment charges info.
N/A
/PackageResults
1
ServiceOptionsCharges
/ShipmentResults
Cond
/ShipmentAcceptResponse
Container
XPATH
MAXALLOWED
NAME
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentAcceptResponse
3
String
/LabelImage
Label image code that the labels are
1
Code
/PackageResults
Yes
/ShipmentResults
generated. Values ‘EPL’ = EPL2, ‘SPL’ = SPL,
‘ZPL’ = ZPL, ‘GIF’ = gif images, or ‘PNG’ for
/LabelImageFormat
PNG images.
/Code
/ShipmentAcceptResponse
String
Encoded
Encoded
/LabelImage
1..35
1
1
1
/PackageResults
No
Description
Yes
/ShipmentResults
Description of the label image format code.
/LabelImageFormat
/Description
/PackageResults
/LabelImage
Length
/ShipmentResults
GraphicImage
Variable
/ShipmentAcceptResponse
Base 64 encoded graphic image.
/ShipmentAcceptResponse
ge
/LabelImage
/InternationalSignatureGraphi
Cond
/ShipmentResults
InternationalSignatureGraphicIma /PackageResults
Variable Length
/GraphicImage
Base 64 encoded graphic image of the
Warsaw text and signature box.
cImage
9 February 2009
Page 199
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
/LabelImage
Length
/PackageResults
Variable
/ShipmentResults
HTMLImage
Cond
/ShipmentAcceptResponse
Base 64 encoded html browser image
rendering software.
/PackageResults
/LabelImage
Encoded
PDF417
1
/ShipmentResults
Cond
/ShipmentAcceptResponse
/PDF417
characters or 1,100 binary characters per
symbol. The symbol is rectangular. The image
is Base 64 encoded and returned if the
Cond
1
Container
N/A
Container for the receipt and the receipt link.
Cond
1
Container
N/A
Container for the receipt of a return shipment
1
Container
N/A
/PackageResults
can store up to about 1,800 printable ASCII
Yes*
/ShipmentResults
PDF-417 is a two-dimensional barcode, which
LabelImageFormat code is GIF
/ShipmentAcceptResponse
Receipt
Variable Length
/HTMLImage
Container for a receipt format
/Receipt
/ShipmentAcceptResponse
/ShipmentResults
Image
/PackageResults
/Receipt
/Image
/ShipmentAcceptResponse
/ShipmentResults
ImageFormat
/PackageResults
/Receipt
/Image
/ImageFormat
9 February 2009
Page 200
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
TYPE
Encoded
XPATH
MAXALLOWED
NAME
1
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
/ShipmentAcceptResponse
Code representing the format in which a
4
String
/Receipt
1
/PackageResults
Code
Yes*
/ShipmentResults
/Image
receipt is returned. Valid values:
“HTML” = HTML format
/ImageFormat
/Code
/ShipmentAcceptResponse
/ShipmentResults
No
1
String
1..35
Description of the image format code.
Yes*
1
Encoded
Variable Length
Base 64 encoded PRL receipt in HTML format
1
Container
N/A
/Receipt
Cond
/PackageResults
Description
Container tag for the International forms image
/Image
/ImageFormat
/Description
/ShipmentAcceptResponse
/ShipmentResults
GraphicImage
/PackageResults
/Receipt
/Image
/GraphicImage
/ShipmentAcceptResponse
Form
/ShipmentResults
/Form
9 February 2009
Page 201
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
XPATH
TYPE
NAME
MAXALLOWED
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
Container tag for the International forms image
/Code
/ShipmentAcceptResponse
Description
/ShipmentResults
/Form
/Description
/ShipmentAcceptResponse
Image
/ShipmentResults
/Form
/Image
/ShipmentResults
ImageFormat
/Form
Cond
/ShipmentAcceptResponse
/Image
format information
/ImageFormat
/ShipmentAcceptResponse
/ShipmentResults
/ImageFormat
3
1
String
/Image
Code representing the format in which the
Cond
Code
/Form
forms are generated
Possible Values
PDF = “pdf”
/Code
9 February 2009
Page 202
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
N/A
/Form
SED
N/A
Container
/ShipmentResults
INVOICE
1….35
Container
1
Code
N/AFTA CO
LENGTH
2
String
1
Container tag for the International forms image
/ShipmentAcceptResponse
CERT. OF ORIGIN
TYPE
String
1
Description that indicates the type of form
VALIDATION RULES
RETURN ONLY
MAXALLOWED
1
Code that indicates the type of form
DESCRIPTION
FORWARD ONLY
REQUIRED
XPATH
Yes*
NAME
Yes*
VoidShipmentRequest
Cond
UPS OnLine Tools Shipping
/ShipmentAcceptResponse
/ShipmentResults
Description
/Form
/Image
Description of the form image format code.
/ImageFormat
/Description
/Form
/Image
Length
/ShipmentResults
GraphicImage
Encoded
Variable
/ShipmentAcceptResponse
Base 64 encoded International forms image
/GraphicImage
1…26
String
/Form
1
/ShipmentResults
One
FormGroupId
Cond
/ShipmentAcceptResponse
Unique Id for later retrieval of saved version of
the completed international forms.
/FormGroupId
1…50
/Form
String
Contains description text which identifies the
1
FormGroupIdName
/ShipmentResults
No
/ShipmentAcceptResponse
/CODTurnInPage
N/A
1
/ShipmentResults
No
/ShipmentAcceptResponse
CODTurnInPage
part of both request and response. This
element does not appear on the forms.
Container
/FormGroupIdName
group of International forms. This element is
9 February 2009
Page 203
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
1..35
VALIDATION RULES
RETURN ONLY
TYPE
String
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
1
Base 64
XPATH
REQUIRED
NAME
No
VoidShipmentRequest
Cond
UPS OnLine Tools Shipping
/ShipmentResults
/CODTurnInPage
The container of the image for COD Turn In
Page.
/Image
/ShipmentAcceptResponse
/ShipmentResults
ImageFormat
/CODTurnInPage
/Image
The container for format of COD Turn In Page
/ImageFormat
/ShipmentAcceptResponse
/Image
Format code of the generated COD Turn In
4
String
/CODTurnInPage
1
Code
Yes*
/ShipmentResults
Page. Valid values:
‘HTML’ = HTML format
/ImageFormat
/Code
/ShipmentAcceptResponse
1…35
/Image
String
/CODTurnInPage
1
Description
No
/ShipmentResults
Description of the format code of generated
COD Turn In page.
/ImageFormat
/Description
/Image
Length
Encoded
Variable
/CODTurnInPage
1
Base 64
/ShipmentResults
GraphicImage
Yes*
/ShipmentAcceptResponse
Base 64 encoded html browser image
rendering software.
/GraphicImage
9 February 2009
Page 204
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
N/A
N/A
Image
DESCRIPTION
FORWARD ONLY
TYPE
Container
Container
/ShipmentAcceptResponse
LENGTH
MAXALLOWED
1
1
XPATH
REQUIRED
NAME
Yes*
VoidShipmentRequest
Yes*
UPS OnLine Tools Shipping
UPS OnLine Tools Shipping
9 February 2009
VoidShipmentRequest
Page 205
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
ShipmentAcceptResponse
(Forward) ShipmentAcceptResponse Example Message:
&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;ShipmentAcceptResponse&gt;
&lt;Response&gt;
&lt;TransactionReference&gt;
&lt;CustomerContext&gt;guidlikesubstance&lt;/CustomerContext&gt;
&lt;XpciVersion&gt;1.0001&lt;/XpciVersion&gt;
&lt;/TransactionReference&gt;
&lt;ResponseStatus&gt;0&lt;/ResponseStatus&gt;
&lt;ResponseStatusDescription&gt;success&lt;/ResponseStatusDescription&gt;
&lt;/Response&gt;
&lt;ShipmentResults&gt;
&lt;ShipmentCharges&gt;
&lt;TransportationCharges&gt;
&lt;MonetaryValue&gt;19.60&lt;/MonetaryValue&gt;
&lt;/TransportationCharges&gt;
&lt;ServiceOptionsCharges&gt;
&lt;MonetaryValue&gt;3.40&lt;/MonetaryValue&gt;
&lt;/ServiceOptionsCharges&gt;
&lt;TotalCharges&gt;
&lt;MonetaryValue&gt;23.00&lt;/MonetaryValue&gt;
&lt;/TotalCharges&gt;
&lt;/ShipmentCharges&gt;
&lt;BillingWeight&gt;
&lt;Weight&gt;36.0&lt;/Weight&gt;
&lt;/BillingWeight&gt;
&lt;ShipmentIdentificationNumber&gt;
1Z123X670299567041
&lt;/ShipmentIdentificationNumber&gt;
&lt;PackageResults&gt;
&lt;TrackingNumber&gt;1Z123X670299567041&lt;/TrackingNumber&gt;
&lt;ServiceOptionsCharges&gt;
&lt;MonetaryValue&gt;1.20&lt;/MonetaryValue&gt;
&lt;/ServiceOptionsCharges&gt;
&lt;LabelImage&gt;
&lt;LabelImageFormat&gt;
&lt;Code&gt;GIF&lt;/Code&gt;
&lt;/LabelImageFormat&gt;
&lt;GraphicImage&gt;FSDJHSDJHJ3487EHNE9U8DY9VHRFV89SDFHFSDJHFSDIDF
HSJKDFSJKDFSJIU9GFIUGJIFDUJG9UKGLDJFDKJDGKJDFKGDJLDFKSJGKDFJDKGFDG9E0ERIJGE39
IWURE9U9ER0UW9R0UR9WEGU9URE9WGUW90U90GRUG90GERUG9REUGWERGJIOJGIODFGUI
OFDUGIOFUIGRUE090U9TERUT90RUT9EU90ERUT9ERU9EUER9TUT9R0UTE90RU9TERU90RTEU9
SDKHGJHGDFU&lt;/GraphicImage&gt;
&lt;HTMLImage&gt;SKJJKLHGIGKHGKJHGFJGFJHDFJGHDDJFHFDJHFJHFJKDHJKFDHJ
FJDFHDFJHJDFHGJDHGDFSHJKFSDHSDFJHFJSDHJKDFHFJKSHDSKJHGFDJSJDFSKSKJJKLHGIGKHG
KJHGFJGFJHDFJGHDDJFHFDJHFJHFJKDHJKFDHJFJDFHDFJHJDFHGJDHGDFSHJKFSDHSDFJHFJSDHJ
KDFHFJKSHDSKJHGFDJSJDFSKHGJKDS&lt;/HTMLImage&gt;
&lt;/LabelImage&gt;
&lt;/PackageResults&gt;
&lt;PackageResults&gt;
&lt;TrackingNumber&gt;1Z123X670292134678&lt;/TrackingNumber&gt;
&lt;AccessorialCharges&gt;
&lt;MonetaryValue&gt;2.20&lt;/MonetaryValue&gt;
&lt;/AccessorialCharges&gt;
&lt;LabelImage&gt;
9 February 2009
Page 206
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
&lt;LabelImageFormat&gt;
&lt;Code&gt;GIF&lt;/Code&gt;
&lt;/LabelImageFormat&gt;
&lt;GraphicImage&gt;895UIGJ89XCASDVIGFUISDFNKLFSDANUI43UIT34IONSDFK
HG89GUKGJNGKDJFKDJDGKJDKFSDU089REUTDRKJOEIOUTERIJREIKGRJIGOWEJIEJIEGJGRIOEJGR
IGJIODJGFIODFJSIOUDFIOGDFUGDF890ERUTRIOGTJRDIOOGJGIOSDFJGIOJGIOJIOGFUGJIOGU90E
8T9TRFIRWEU90WERU90WU90WTU90WUT09WEUTWRJGKSDFJGIOSDFJGOISDFJGIOSJSD&lt;/Grap
hicImage&gt;
&lt;HTMLImage&gt;JDFSKAATRIOERHIOEGHNVIXCUIFGJMFDGMAN8Y89H54JMN1
MK345H8SDHFDHGJKGHFDJKGHDGKSFJAH893YTUITNGDFJSGH8935Y5RTHDDFJKHT89HTJETHW
ER8934Y89534KGNDFOJKKH893RYETFIHTRUIOEY89TY34IHDFUIHGRU9T38934UITHDIUJTHEQW
89RY8WIERHT9RI&lt;/HTMLImage&gt;
&lt;/LabelImage&gt;
&lt;/PackageResults&gt;
&lt;/ShipmentResults&gt;
&lt;/ShipmentAcceptResponse&gt;
9 February 2009
Page 207
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
VoidSipmentRequest
Cancelling Shipments
UPS OnLine Tools use a two-message exchange to cancel a shipment. Those
messages are VoidShipmentRequest and VoidShipmentResponse.
VoidShipmentRequest
The VoidShipmentRequest message consists of two complete XML documents.
The first document is an AccessRequest. The AccessRequest is immediately
followed by a VoidShipmentRequest. When a client application is undergoing
testing and integration, the document combination should be sent to the URL:
https://wwwcie.ups.com/ups.app/xml/Void
Once a client application is in production, the combined documents should be
sent to the URL provided as part of the certification process.
The VoidShipmentRequest document in the request must conform to the
following XML structure.
VoidShipmentRequest XML Details:
Note: The “Required” Column has four potential values:
Yes: Always required
No: Always optional
Yes*: Conditionally required
Cond: Conditional
(See next pages)
9 February 2009
Page 208
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
/TransactionReference
1
/Request
No
/VoidShipmentRequest
TransactionReference
Container
/RequestOption
Currently, there is only 1 valid
RequestAction value.
Optional processing.
No options
TransactionReference identifies transactions
between client and server.
9 February 2009
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Page 209
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
FORWARD ONLY
LENGTH
1
1
No
/VoidShipmentRequest
/Request
service.
1 = Void the shipment.
String
/RequestAction
RequestOption
DESCRIPTION
Indicates the action to be taken by the XML
1
1
/Request
Yes
/VoidShipmentRequest
RequestAction
TYPE
Container
/Request
Container
/VoidShipmentRequest
String
Request
1
/VoidShipmentRequest
1
VoidShipmentRequest
Yes
XPATH
Yes
NAME
MAXALLOWED
VoidSipmentRequest
REQUIRED
UPS OnLine Tools Shipping
1..512
/TransactionReference
String
1
No
/Request
synchronize request/response pairs. The client
establishes CustomerContext, which can
contain any information you want, as along as
/CustomerContext
it is valid XML; it is echoed back by the server.
/TransactionReference
4
String
/Request
1
XpciVersion
No
/VoidShipmentRequest
Message version. Defaults to ‘1.0001’.
/XpciVersion
18
String
/ShipmentIdentificationNumbe
1
ShipmentIdentificationNumber
Must pass 1Z rules.
Cond
/VoidShipmentRequest
The shipment’s identification number
r
This element is mutually
1
1
Container
/ExpandedVoidShipment
exclusive with the Expanded
Void Shipment node.
Cond
ExpandedVoidShipment
/VoidShipmentRequest
This element is mutually
Expanded Void Capability
exclusive with the VoidShipment
Request/
ShipmentIdentificationNumber.
/ShipmentIdentificationNumbe
18
String
/ExpandedVoidShipment
1
ShipmentIdentificationNumber
Yes
/VoidShipmentRequest
The shipment’s identification number
Must pass 1Z rules.
r
9 February 2009
Page 210
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
The client uses CustomerContext to
/VoidShipmentRequest
CustomerContext
DESCRIPTION
FORWARD ONLY
LENGTH
TYPE
XPATH
MAXALLOWED
NAME
VoidShipmentRequest
REQUIRED
UPS OnLine Tools Shipping
9 February 2009
Must pass 1Z rules. Must be
upper case.
Page 211
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
LENGTH
18
/TrackingNumber
The package’s identification number
CERT. OF ORIGIN
TYPE
String
/ExpandedVoidShipment
VALIDATION RULES
RETURN ONLY
MAXALLOWED
/VoidShipmentRequest
TrackingNumber
DESCRIPTION
FORWARD ONLY
REQUIRED
XPATH
No
NAME
VoidShipmentRequest
Zero to Many
unbounded
UPS OnLine Tools Shipping
UPS OnLine Tools Shipping
VoidSipmentRequest
VoidShipmentRequest Example Message:
&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;AccessRequest xml:lang='en-US'&gt;
&lt;AccessLicenseNumber&gt;YOURACCESSLICENSENUMBER&lt;/AccessLicenseNumber&gt;
&lt;UserId&gt;YOURUSERID&lt;/UserId&gt;
&lt;Password&gt;YOURPASSWORD&lt;/Password&gt;
&lt;/AccessRequest&gt;
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;
&lt;VoidShipmentRequest&gt;
&lt;Request&gt;
&lt;TransactionReference&gt;
&lt;CustomerContext&gt;Customer Transaction ID&lt;/CustomerContext&gt;
&lt;XpciVersion&gt;1.0001&lt;/XpciVersion&gt;
&lt;/TransactionReference&gt;
&lt;RequestAction&gt;Void&lt;/RequestAction&gt;
&lt;RequestOption /&gt;
&lt;/Request&gt;
&lt;ExpandedVoidShipment&gt;
&lt;ShipmentIdentificationNumber&gt;
1Z12345E2318693258
&lt;/ShipmentIdentificationNumber&gt;
&lt;TrackingNumber&gt;1Z12345E0390819985&lt;/TrackingNumber&gt;
&lt;TrackingNumber&gt;1Z12345E0193078536&lt;/TrackingNumber&gt;
&lt;/ExpandedVoidShipment&gt;
&lt;/VoidShipmentRequest&gt;
9 February 2009
Page 212
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
VoidShipmentResponse
VoidShipmentResponse
The VoidShipmentResponse message contains a single XML document that conforms to the following structure.
VoidShipmentResponse XML Details:
Note: The “Required” Column has four potential values:
Contains Errors information tags along with
the success/fail status of the void request.
9 February 2009
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
Page 213
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
N/A
N/A
TYPE
Container
/Response
Container
/VoidShipmentResponse
MAXALLOWED
Response
1
/VoidShipmentResponse
1
VoidShipmentResponse
REQUIRED
XPATH
Yes
NAME
Yes
Yes: Always required
No: Always optional
Yes*: Conditionally required
Cond: Conditional
/TransactionReference
0..512
/TransactionReference
String
/Response
1
CustomerContext
No
/VoidShipmentResponse
Customer provided data. May be XML. If this
data is present in the request, it is echoed
back to the customer.
/CustomerContext
1..50
/TransactionReference
String
/Response
1
XpciVersion
No
/VoidShipmentResponse
Identifies the version of the message. Current
version is 1.0001
/XpciVersion
1
/Response
Yes
ResponseStatusCode
String
Identifies the success or failure of the
/VoidShipmentResponse
interchange.
1 = Success
/ResponseStatusCode
1..15
1
/Response
No
/VoidShipmentResponse
ResponseStatusDescription
String
0 = Failure
Describes the Response Status Code.
/ResponseStatusDescription
9 February 2009
Page 214
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
/Response
VALIDATION RULES
RETURN ONLY
TYPE
Container
/VoidShipmentResponse
TransactionReference
DESCRIPTION
FORWARD ONLY
MAXALLOWED
1
XPATH
REQUIRED
NAME
VoidShipmentResponse
Yes
UPS OnLine Tools Shipping
/Error
interchange, the Response contains an error.
If the error is present, then the ErrorSeverity
and ErrorCode are required.
Yes
1
String
1..15
Describes the severity of the error.
1
String
1..15
A numeric value that describes the error.
1
String
1..50
Describes the error code.
1
Container
N/A
/Error
Yes
/Response
No
ErrorSeverity
No
/VoidShipmentResponse
Identifies the element in error.
/ErrorSeverity
/VoidShipmentResponse
ErrorCode
/Response
/Error
/ErrorCode
/VoidShipmentResponse
ErrorDescription
/Response
/Error
/ErrorDescription
/VoidShipmentResponse
ErrorLocation
/Response
/Error
/ErrorLocation
9 February 2009
Page 215
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
FORWARD ONLY
LENGTH
TYPE
DESCRIPTION
If an error is encountered during the
N/A
/Response
1
Error
No
/VoidShipmentResponse
Container
XPATH
MAXALLOWED
NAME
VoidShipmentResponse
REQUIRED
UPS OnLine Tools Shipping
1..512
1
/Error
No
/Response
ErrorLocationElementName
String
/VoidShipmentResponse
/ErrorLocation
The Xpath name of the element in error. This
is a valid Xpath pointing to an element in the
request document.
1
Container
N/A
Contains Status information tags.
Container
N/A
/Status
1
/VoidShipmentResponse
Yes
Status
Yes
/ErrorLocationElementName
Contains the status type tags.
/VoidShipmentResponse
StatusType
/Status
/StatusType
String
/StatusType
A numeric value that describes the status
1
Code
/Status
Yes
/VoidShipmentResponse
type.
1 = Success
/Code
0 = Failure
1..15
/StatusType
String
/Status
1
Description
No
/VoidShipmentResponse
A text description of the status type.
/Description
9 February 2009
Page 216
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
VALIDATION RULES
RETURN ONLY
DESCRIPTION
FORWARD ONLY
LENGTH
TYPE
XPATH
MAXALLOWED
NAME
VoidShipmentResponse
REQUIRED
UPS OnLine Tools Shipping
/StatusCode
The Shipment level void status code. A
/StatusCode
numeric value that describes the status code.
String
/Status
1
Code
Yes
/VoidShipmentResponse
2 = Partially Voided
1 = Success or Voided
/Code
0 = Failure
String
Container
N/A
Contains the Package Level Results
String
18
The package’s identification number
1..15
1
/StatusCode
unbounded
/Status
1
Description
Yes*
/VoidShipmentResponse
A text description of the status code.
/PackageLevelResults
/VoidShipmentResponse
TrackingNumber
/PackageLevelResults
No
/VoidShipmentResponse
Yes*
PackageLevelResults
Zero to Many
/Description
For the expanded void functionality only.
/TrackingNumber
9 February 2009
Page 217
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
LENGTH
N/A
/Status
RETURN ONLY
TYPE
Container
Contains the status code tags.
/VoidShipmentResponse
StatusCode
VALIDATION RULES
FORWARD ONLY
MAXALLOWED
DESCRIPTION
1
XPATH
REQUIRED
NAME
VoidShipmentResponse
Yes
UPS OnLine Tools Shipping
/PackageLevelResults
1..15
String
1
/PackageLevelResults
0 = Not Voided
Yes*
/VoidShipmentResponse
numeric value that describes the status code.
1 = Voided or Already Voided
/StatusCode
Description
A text description of the status code.
/Description
9 February 2009
Page 218
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
PARTIAL INV.
SED
INVOICE
N/AFTA CO
CERT. OF ORIGIN
RETURN ONLY
VALIDATION RULES
FORWARD ONLY
TYPE
MAXALLOWED
LENGTH
1
StatusCode
DESCRIPTION
The Package Level void status code. A
String
/VoidShipmentResponse
1
XPATH
Yes*
NAME
VoidShipmentResponse
REQUIRED
UPS OnLine Tools Shipping
UPS OnLine Tools Shipping
VoidShipmentResponse
VoidShipmentResponse Example Message:
&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;VoidShipmentResponse&gt;
&lt;Response&gt;
&lt;TransactionReference&gt;
&lt;CustomerContext&gt;Customer Transaction ID&lt;/CustomerContext&gt;
&lt;XpciVersion&gt;1.0001&lt;/XpciVersion&gt;
&lt;/TransactionReference&gt;
&lt;ResponseStatusCode&gt;1&lt;/ResponseStatusCode&gt;
&lt;ResponseStatusDescription&gt;Success&lt;/ResponseStatusDescription&gt;
&lt;/Response&gt;
&lt;Status&gt;
&lt;StatusType&gt;
&lt;Code&gt;1&lt;/Code&gt;
&lt;Description&gt;Success&lt;/Description&gt;
&lt;/StatusType&gt;
&lt;StatusCode&gt;
&lt;Code&gt;1&lt;/Code&gt;
&lt;Description&gt;Success&lt;/Description&gt;
&lt;/StatusCode&gt;
&lt;/Status&gt;
&lt;/VoidShipmentResponse&gt;
9 February 2009
Page 219
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
ErrorCodes
Error Codes
To discover errors, check the ResponseStatusCode element. A “1” normally
indicates a successful response, whereas a “0” indicates an error, either Transient
or Hard. When an error occurs there will also be an error code, and an error
description.
•
•
Success – Successful responses may or may not include Warnings.
o
(without warnings) Request is processed as anticipated by the client.
o
(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.
o
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.
o
Hard errors indicate that an error existed in the request that UPS
could not resolve. These errors are critical and prevent requests from
processing.
Applications should not re-issue requests with Hard errors without first
correcting the error.
The following table lists the errors that UPS may return in response to a request.
Code
Severity
10001
Hard
10002
Hard
120001
Transient
120014
Warning
120016
Warning
120017
Warning
120019
120020
Warning
Hard
120021
Hard
120022
120050
120051
Warning
Hard
Hard
Explanation
The XML document is not well formed
The XML document is well formed but the document is
not valid
XML Shipping System is unavailable, please try again
later.
A Large Air Package Minimum Surcharge has been
applied to Package %package.index%.
Customs Invoice is required when the shipment is
tendered to shipment
If the value of the goods you are shipping is above 6,000
Euro or local equivalent, you must supply an EUR1 form
in addition to signing your invoice.
The location ID you provided is not valid. Valid location ID
consists of 3 to 10 alpha numeric characters.
Max packages per shipment exceeded.
The same shipment cannot be requested to be created
more than once.
For packages with high value report: give them to a UPS
driver or UPS Customer Center representative to ensure
he signs one copy of the receipt and returns it to you.
This is your proof that UPS has accepted the package(s),
and will be required for submitting a claim.
RequestAction has an unsupported value.
Invalid RequestOption
9 February 2009
Page 220
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Error Codes
Code
Severity
120100
120101
120102
120103
120104
120105
120106
120107
120108
120109
120110
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
120111
120112
Hard
Hard
120113
120114
Hard
Hard
120115
120116
Hard
Hard
120117
Hard
120118
Hard
120119
Hard
120120
Hard
120121
120122
120200
120201
120202
120203
120204
120205
120206
120207
120208
120209
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
120210
120211
120212
Hard
Hard
Hard
120213
120214
Hard
Hard
120216
Hard
120217
120218
Hard
Hard
120300
Hard
Explanation
Missing/Invalid shipper number
Missing/Invalid shipper name
Missing/Invalid shipper address line 1
Invalid shipper address line 2
Invalid shipper address line 3
Missing/Invalid Shipper City
Missing/Invalid Shipper StateProvinceCode
Missing/Invalid Shipper PostalCode. (Description)
Missing/Invalid Shipper CountryCode
Missing/Invalid Shipper PhoneNumber
Missing/Invalid Shipper AttentionName
Shipper EmailAddress cannot exceed a length of 50
characters
Shipper EmailAddress is an invalid format
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
Shipper phone number and phone extension together
cannot be more than 15 digits long
The country associated with Shipper's ShipperNumber
must be the same as the shipments ShipFrom's country.
The Shipper's shipper number cannot be used for the
shipment.
Invalid Shipper ShipperNumber
Missing/Invalid ShipTo CompanyName
Missing/Invalid ShipTo AttentionName
Missing/Invalid ShipTo AddressLine1
Invalid ShipTo AddressLine2
Invalid ShipTo AddressLine3
Missing/Invalid ShipTo/ City
Missing/Invalid ShipTo StateProvinceCode
Missing/Invalid ShipTo PostalCode. (Description)
Missing/Invalid/Unsupported ShipTo CountryCode
Missing/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/Invalid ShipFrom CompanyName
9 February 2009
Page 221
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Error Codes
Code
Severity
120301
120302
120303
120304
120305
120306
120307
120308
120309
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
120310
120311
120312
Hard
Hard
Hard
120313
120314
Hard
Hard
120316
Hard
120317
Hard
120318
120400
120402
120403
120404
120406
Hard
Hard
Hard
Hard
Hard
Hard
120407
120408
120410
120411
120412
Hard
Hard
Hard
Hard
Hard
120413
Hard
120414
Hard
120415
120416
120430
120437
120500
120501
120502
Hard
Hard
Hard
Hard
Hard
Hard
Hard
120503
120504
Hard
Hard
120505
120506
120508
120510
120511
Hard
Hard
Hard
Hard
Hard
Explanation
Missing/Invalid ShipFrom AttentionName
Missing/Invalid ShipFrom AddressLine1
Invalid ShipFrom AddressLine2
Invalid ShipFrom AddressLine3
Missing/Invalid ShipFrom City
Missing/Invalid ShipFrom StateProvinceCode
Missing/Invalid ShipFrom PostalCode. (Description)
Missing/Invalid/Unsupported ShipFrom CountryCode
Missing/Invalid ShipFrom PhoneNumber
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
The ShipFrom country must be the same as the Shipper
country
ShipFrom phone number and phone extension together
cannot be more than 15 digits long
Missing/Invalid shipment payment method
Missing/Invalid credit card type
Missing/Invalid credit card number
Missing/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
One payment method is required.
Credit card payment is not allowed for this shipment.
{Description}
The UPS account number provided as the payment
method cannot be billed, please try another account.
Credit card authorization failed, contact your financial
institution
PaymentInformation/Prepaid/BillShipper/AccountNumber
must be the same shipper number as
Shipper/ShipperNumber
A single billing option is required per shipment.
Missing/Invalid country code of billed third party
Missing/Invalid PostalCode of payment account
Missing/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
Missing/Invalid On Call Air pickup date
Missing/Invalid latest On Call Air pickup time
Invalid earliest or latest On Call Air pickup time
9 February 2009
Page 222
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Error Codes
Code
Severity
120512
Hard
120515
Hard
120517
Hard
120518
Hard
120519
Hard
120520
Hard
120521
Hard
120522
Hard
120523
Hard
120524
Hard
120526
120527
Hard
Hard
120528
Hard
120529
Hard
120530
Hard
120531
Hard
120532
120533
120534
120535
120536
120537
Hard
Hard
Hard
Hard
Hard
Hard
120538
Hard
120539
120540
Hard
Hard
120541
Hard
120542
Hard
120543
Hard
120544
120545
Hard
Hard
120546
Hard
120547
Hard
Explanation
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
For a shipment, the maximum number of Email
Addresses allowed for Quantum View Notification is 5
For a shipment, the maximum number of Memos allowed
for {Quantum View notification type} is 1
Alternate Delivery Time is not valid for any available
services
Shipment/DocumentsOnly is invalid with the shipment's
orgin/destination pair
Package Pickup Request is not available with this
shipment's service
InvoiceLineTotal/MonetaryValue may not exceed the
length of 8
Cannot use multiple types of currency in a shipment
A shipment can have only one type of
UnitOfMeasurement for Dimensions
A shipment can have only one type of
UnitOfMeasurement for a Weight
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
Contact name of shipment pickup is required
Contact phone number of shipment pickup is required
Invalid/Missing the earliest shipment pickup time
Shipment Pickup Error: (further description is provided in
XML)
InvoiceLineTotal/ MonetaryValue is required and must be
a whole number
On Call Air Pickup is not available for this shipment
Shipment/ReferenceNumber is not allowed for this
shipment
Package/ReferenceNumber is not allowed for this
shipment
No more than 2 Shipment/ReferenceNumber can be
given per shipment
No more than 2 Package/ReferenceNumber can be
given per package
Shipment/Description is not valid with this shipment
(UOM Weight) is not a valid unit of measurement for
weight for this shipment
(UOM Dimension) is not a valid unit of measurement for
dimensions.
9 February 2009
Page 223
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Error Codes
Code
Severity
120548
120549
Hard
Hard
120550
Hard
120551
120552
Hard
Hard
120553
Hard
120597
Hard
120598
120599
120600
120601
Hard
Hard
Hard
Hard
120602
120603
120604
120605
Hard
Hard
Hard
Hard
120606
120607
120608
Hard
Hard
Hard
120609
120610
Hard
Hard
120611
Hard
120612
Hard
120613
Hard
120614
Hard
120615
120616
120617
Hard
Hard
Hard
120618
Hard
120619
Hard
120620
Hard
120621
120622
120623
120624
120625
120626
Hard
Hard
Hard
Hard
Hard
Hard
Explanation
A shipment cannot have a KGS/IN or LBS/CM as its unit
of measurements
Invalid ReferenceNumber/BarCodeIndicator.
Shipment/ReferenceNumber[(reference numer)]/Value
cannot be bar-coded
Package{sequence} /ReferenceNumber[(reference
numer)]/Value cannot be bar-coded
LabelLinkIndicator is not allowed for the shipment.
ReferenceNumber/BarCodeIndicator is not allowed with
the shipment.
Invalid COD currency code. Please use the destination
country currency code.
Package Delivery Confimation is not allowed with the
shipment origin/destination
Invalid package Delivery Confirmation type
Missing Package/Packag ingType/Code
Missing/Invalid Package weight
Missing/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 alphanumeric characters
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.
Invalid/Missing Shipment/ReturnServiceCode
The COD Funds Code is invalid. Please check the value
9 February 2009
Page 224
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Error Codes
Code
Severity
120627
120644
120645
Hard
Hard
Hard
120649
Hard
120650
Hard
120654
Hard
120655
Hard
120658
Hard
120659
Hard
120660
Hard
120661
120662
120663
120664
120665
120666
120667
120670
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
120700
120701
Hard
Hard
120702
Hard
120703
120704
120705
Hard
Hard
Hard
120759
Hard
120760
Hard
120761
Hard
120801
120802
120803
Hard
Hard
Hard
120804
Warning
120805
Warning
120806
Warning
120900
120901
121005
Warning
Warning
Hard
Explanation
entered
The COD Code is invalid. Please check the value entered
LabelDelivery is not valid for the shipment
Return Notification is not valid for the shipment
Invalid
ShipmentServiceOptions/Notification/NotificationCode
Invalid PackageServiceOptions/
Notification/NotificationCode
No more than two email addresses for Receiver Return
Notification are allowed in a shipment
{Email field} of Receiver Return Notification is only
allowed to be specified at the first package.
Receiver Return Notification is not allowed for the
shipment without return service
ShipmentServiceOptions/ShipmentNotification is not
allowed with return service
ShipmentServiceOptions/ShipmentNotification is not
allowed with ShipmentServiceOptions/Notification
For a shipment, the maximum number of {email field}
allowed for Quantum View notification is 1.
Invalid Subject Code of {Notification type}
Invalid From name of {Notification tye}
Invalid UndeliverableEMailAddress of {Notification type}
Invalid FromEMailAddress of {Notification type}
Missing/Invalid subject text of {Notification type}
{field} is not allowed in Quantum View Notification
Shipper Release is not allowed with Return Service
Missing/Invalid LabelSpecification/
LabelPrintMethod/Code
Missing/Invalid LabelSpecification/ HTTPUserAgent
Missing/Invalid LabelSpecification/
LabelImageFormat/Code
Missing/Invalid Combination of LabelSpecification/
LabelStockSize
Missing/Invalid LabelSpecification/ LabelStockSize/Height
Missing/Invalid LabelSpecification/LabelStockSize/Width
Invalid Movement Reference Number (note: must contain
only alpha numeric characters)
Invalid Movement Reference Number (note: must be 18
characters in lenght)
Invalid Movement Reference Number (note: characters 3
&amp; 4 must be the ISO country code)
Address Validation Error on Shipper address
Address Validation Error on ShipTo address
Address Validation Error on ShipFrom address
Address Validation Warning on Shipper address.
{Description}
Address Validation Warning on ShipTo address.
{Description}
Address Validation Warning on ShipFrom address
{Description}
User Id and Shipper Number combination is not eligible
to receive Account Based Rates.
Negotiated Rates are unavailable at this time.
The COD option cannot be combined with the Return
9 February 2009
Page 225
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Code
Error Codes
Severity
121015
Hard
121020
121025
121030
121031
121035
121036
Hard
Hard
Hard
Hard
Hard
Hard
121040
Hard
121045
Hard
121047
Hard
121050
Hard
121055
Hard
121056
121057
121063
121070
Hard
Hard
Hard
Hard
121085
Hard
121087
121090
121091
121100
Hard
Hard
Hard
Hard
121105
121106
121107
121115
Hard
Hard
Hard
Hard
121120
Hard
121121
121125
Hard
Hard
121126
Hard
121135
121140
Hard
Hard
121150
Hard
121155
121160
Hard
Hard
121165
Hard
Explanation
Services option.
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 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 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
{desription} inches. .
Package exceeds the maximum length constraint of
{desription} cm.
The measurment 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.
{Rating error 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 dest, 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
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.
The accessory is invalid with the billing option.
The Verbal Confirmation of Delivery option cannot be
combined with the Return Services option.
9 February 2009
Page 226
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Error Codes
Code
Severity
121170
Hard
121175
121180
121185
Hard
Hard
Hard
121195
Hard
121196
121200
Hard
Hard
121205
121206
Hard
Hard
121208
Hard
121210
121211
121212
121213
Hard
Hard
Hard
Hard
121214
Hard
121215
121225
Hard
Hard
121230
Hard
121231
Hard
121232
121235
Hard
Hard
121245
Hard
121250
Hard
121255
Hard
121260
121261
121262
Hard
Hard
Hard
121265
121266
121267
121268
121285
121286
121290
121295
Hard
Hard
Hard
Hard
Hard
Hard
Hard
Hard
121300
Hard
Explanation
The Delivery Confirmation option cannot be combined
with the Verbal Confirmation of Delivery option.
Verbal Confirmation of Delivery is unavailable with the
selected service.
Consignee Billing is unavailable with the selected service.
The selected service is unavailable to the desired country
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.
Rating Error: (Description)
{Rating error description}
{Rating error 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}
Saturday Pickup and Shipper Duty Fees cannot be
applied to the same package.
Saturday Delivery and Shipper Duty Fees cannot be
applied to the same package.
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.
{Rating error descritpion}
{Rating error description}
The given billing option is invalid
{Rating error description}
Shipper Pays Duty - Tax Unpaid is unavailable with the
selected accessorial.
9 February 2009
Page 227
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Error Codes
Code
Severity
121305
Hard
121310
Hard
121315
Hard
121320
Hard
121325
Hard
121330
Hard
121335
Hard
121340
Hard
121345
Hard
121350
Hard
121355
Hard
121360
Hard
121363
Hard
121365
121370
Hard
Hard
121375
Hard
121460
121500
121501
121510
121511
121512
121513
Hard
Hard
Hard
Hard
Hard
Hard
Hard
121515
Warning
121520
121521
Hard
Hard
121522
121523
Hard
Hard
121524
Warning
121526
121527
Hard
Hard
Explanation
Shipper Pays Duty - Tax Unpaid is unavailable with the
selected service.
Shipper Pays Duty - Tax Unpaid is unavailable with the
selected billing option.
The Authorized Return Service is unavailable with the
selected accessorial.
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
Shipments cannot exceed a COD amount of $5,000 when
requesting a cashiers check or money order.
{Rating error description}
{Rating error Description}
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
The payment information must be the same for both
Transportation charges and Duty and Tax charges when
Bill to Shipper or Bill to Receiver is specified as the payer.
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 Transportation charges is required.
9 February 2009
Page 228
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Error Codes
Code
Severity
121528
Hard
121529
121530
121531
Hard
Hard
Hard
121532
Hard
121534
Hard
121535
Hard
121536
121537
Hard
Hard
121538
Hard
121539
Hard
121801
Hard
121802
123005
Hard
Warning
123010
123020
123021
125000
Warning
Warning
Warning
Hard
129001
Warning
129002
129003
129004
129005
129006
Warning
Warning
Warning
Warning
Warning
129011
Hard
129012
Hard
120914
Hard
120915
129017
129018
129019
20001
Hard
Warning
Warning
Hard
Hard
121156
Hard
129020
129021
Warning
Hard
Explanation
Missing or invalid
ItemizedPaymentInformation/ShipmentCharge/Type
A single payment method is required per shipment
charge.
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.
A payer is required when specifying a shipment charge.
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 country selected for transportation charges does not
allow for Third Party payment option.
The country selected for duty/taxes charges does not
allow for Third Party payment option.
(Description)
Package(s) in this shipment contains a warning:
(Description)
Invalid Ship From postal code
Invalid Ship To postal code
Missing or invalid shipment digest.
Additional Handling has automatically been set on
Package (index of the package).
An Extended Area Surcharge of (monetary value) has
been added to the service cost.
{Rating error description}
{Rating error description}
{Rating error description}
{Rating error description}
The maximum declared value amount for the 1-Attempt
option is 999 USD
The maximum declared value amount for the Print and
Mail option is 999 USD
The maximum declared value amount for the Electronic
Delivery option is 999 USD
The maximum declared value amount for the 3-Attempt
option is 50,000 USD
{Rating error description} .
{Rating error description} .
{Rating error description}
General process failure
Package Level COD is not valid for the shipment origin
and/or destination
Ship To Address Classification from AMS subsystem is
different from user indicated.
Both Security code and Billing address are required if
9 February 2009
Page 229
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Code
Error Codes
Severity
129022
129046
129048
129049
129050
129051
129070
Hard
Hard
Hard
Hard
Hard
Hard
Warning
120124
120125
129057
Hard
Hard
Hard
128014
Hard
128015
Hard
128016
Hard
128017
128018
Hard
Hard
128019
Hard
128020
Hard
128021
Hard
128022
Hard
128023
Hard
128024
Hard
128025
128026
Hard
Hard
128027
Hard
128028
Hard
128029
Hard
128030
Hard
128031
Hard
128032
Hard
128033
Hard
128034
128035
Hard
Hard
Explanation
credit card information is provided.
This credit card has been locked due to multiple
unsuccessful validation attempts. Please use another
credit card to continue or try again later.
Missing credit card billing address line 1
Missing credit card billing address city
Missing credit card billing address state province code
Missing credit card billing address postal code
Missing credit card billing address country code
{Rating error description}
The requested service is unavailable between the
selected locations
Consignee billing is only supported in US or Pureto Rico
Location ID may not exceed the length of 10
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
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
9 February 2009
Page 230
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Error Codes
Code
Severity
128036
Hard
128037
Hard
128038
Hard
128039
Hard
128041
Hard
128042
Hard
128043
Hard
128044
Hard
128045
Hard
128046
128047
Hard
Hard
128048
128049
Hard
Hard
128050
Hard
128051
Hard
128052
Hard
128053
Hard
128054
Hard
128055
Hard
128056
Hard
128057
Hard
128058
Hard
128059
Hard
128060
Hard
128061
Hard
128062
128063
Hard
Hard
128064
Hard
Explanation
Invalid producer phone number. Valid length is 0 to 15
alphanumeric
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 4
The form specified for the product must be one of the
requested form.
If invoice is a requested international form, all specified
products must belong to invoice
Invalid or missing product unit number. Valid length is 1 to
7 numeric
Invalid or missing
Product/Unit/UnitOfMeasurement/Code. Valid length is 1
to 3 alphanumeric
Product/Unit/UnitOfMeasurement/Description is required
when Product/Unit/UnitOfMeasurement/Code is &quot;OTH&quot; .
Valid length is 1 to 3 alphanumeric
Invalid or missing product unit value. 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. Valid length is 6 to 15
alphanumeric
Invalid or missing product origin country code
Invalid or missing net cost code. Valid values are NC or
NO
Invalid or missing net cost date range begin date. Valid
format is MMDDYYYY
Invalid or missing net cost date range end date. Valid
format is MMDDYYYY
Invalid or missing preference criteria. Valid values are A
through F
Invalid or missing producer info. Valid values are YES,
NO[1], NO[2] or NO[3]
Invalid or missing marks and numbers. Valid length is 1 to
35 alphanumeric
Invalid or missing product weight unit of measurement
code. Valid values are KGS or LBS
Invalid or missing product weight. Valid length is 1 to 5
and it can hold up to 1 decimal places.
Invalid product vehicle ID. Valid length is 1 to 25
alphanumeric
Invalid or missing product schedule B number. Valid
length is 10 alphanumeric
Invalid product schedule B quantity. Valid length is 0 to 10
numeric
Invalid or missing product schedule B unit of
measurement code. 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. Valid values are D, F or M
Invalid or missing SED total value. Valid length is 1 to 15
numeric and can hold up to 2 decimal places
9 February 2009
Page 231
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Code
Error Codes
Severity
128065
Hard
128066
Hard
128067
128068
Hard
Hard
128069
Hard
128070
Hard
128071
Hard
128072
Hard
128073
Hard
128074
Hard
128075
Hard
128076
Hard
128077
Hard
128078
Hard
128079
128080
Hard
Hard
128081
Hard
128082
Hard
128083
Hard
128084
128085
Hard
Hard
128086
128087
Hard
Hard
128088
Hard
128089
Hard
128090
Hard
128091
Hard
128092
Hard
128093
Hard
Explanation
Invalid invoice number. Valid length is 0 to 35
alphanumeric
Invalid or missing invoice date. Valid format is
MMDDYYYY
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 MMDDYYYY
Invalid or missing blanket period end date. Valid format is
MMDDYYYY
Invalid or missing export date. Valid format is
MMDDYYYY
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
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
MMDDYYYY
Invalid license exception code. Valid length is 0 to 3
alphanumeric
Either license number or license exception code must be
present for a SED form.
Invalid ECCN number code. Valid length is 1 to 3
alphanumeric
9 February 2009
Page 232
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Error Codes
Code
Severity
128094
Hard
128095
Hard
128096
Hard
128097
Hard
128098
Hard
128099
Hard
128100
Hard
128101
128102
Hard
Hard
128103
Hard
128104
Hard
128105
Hard
128109
128110
128111
Hard
Hard
Hard
128112
Hard
128113
Hard
128114
Hard
128115
Hard
128116
128117
Hard
Hard
128118
Hard
128119
128120
128121
128122
Hard
Hard
Hard
Hard
128123
128124
128125
Hard
Hard
Hard
128126
128201
Hard
Hard
Explanation
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
Invalid product origin country for the selected
international form
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. Product description should be
present atleast 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 number of packages per
commodity. Valid length is 1 - 3 Numerics
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 international forms form type for shipment with
9 February 2009
Page 233
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Code
Error Codes
Severity
128202
Hard
129058
Hard
129059
129076
129077
Hard
Hard
Warning
129078
Hard
129079
129080
129081
129082
129083
120971
Hard
Hard
Hard
Hard
Hard
Warning
129090
Hard
Explanation
return service. Valid value is 01.
International forms can not be requested for letters or
documents.
Shipper Number {0} does not support pallet Contract
Service.
Shipper Number {0} does not support Third Country
Contract Service.
Pallets may not be included with other package types.
A dimensional surcharge has been added to pallet {0}.
The maximum dimensions for a pallet are 200 cm by 160
cm by 120 cm .
The requested service is not valid with pallets with a
weight greater than 1000kg. Please select Dedicated
Package Courier Same Day Service.
Pallet {0} exceeds maximum width.
Pallet {0} exceeds maximum height.
Pallet {0} exceeds maximum length.
Pallet {0} exceeds maximum weight.
Your invoice may vary from the displayed reference rates
Only future date pickup is available for pickup requests
for the requested origin and destination and selected
service
9 February 2009
Page 234
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Customer Integration Environment
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.
Negotiated Rates
Negotiated Rates are available in the UPS Customer Integration Environment
(CIE) and are returned when the Negotiated Rate indicator is provided in the
ShipConfirm request. The Negotiated Rates returned do not reflect the
contractual rate and may vary. (A flat 1% discount is returned)
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 &amp; Service Guide.
Shipping
Test your Shipping application using valid and invalid date elements including
postal codes, weights and package types. This will ensure that your application
has the ability to process success and error responses correctly.
Verifying Shipping Rates
Shipping rates quoted are estimates based on the information supplied. Other
shipping charges may apply and the final shipping charge may differ depending
upon UPS Account Number and how the package is tendered to UPS. Please see
the applicable UPS Rate and Service Guide for details.
When comparing shipment charges between applications and tools providing
UPS rates, be sure that the requests are identical. Working through any
discrepancies will require knowledge of all parameters posted along with
defaults, numeric rounding, and rate table used by the applications being
compared.
For more information on UPS Services, refer to the UPS Service Guide at:
http://www.ups.com/using/svc-index.html.
You can check your results against the UPS Quick Cost Calculator™ web
application located at:
http://wwwapps.ups.com/servlet/QCCServlet
For integration testing, you should direct your test Shipping software to:
9 February 2009
Page 235
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Customer Integration Environment
https://wwwcie.ups.com/ups.app/xml/ShipConfirm
Once you have completed your testing and Certification, you should direct your
software to:
https://wwwcie.ups.com/ups.app/xml/ShipConfirm
System Availability
The Customer Integration Environment is available 24 hours a day, 7 days a
week.
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/ups.app/xml/ShipConfirm
The following will be returned:
Service Name: ShipConfirm
Remote User: null
Server Port: 443
Server Name: wwwcie.ups.com
Servlet Path: /ShipConfirm
9 February 2009
Page 236
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix A:
Appendix A: Sample Shipping and Return Labels
Sample Shipping and Return Labels
The following figures show sample shipping and return labels that UPS provides.
Figure 22. Sample Shipping Label
9 February 2009
Page 237
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix A: Sample Shipping and Return Labels
Figure 23. Sample Return Label
9 February 2009
Page 238
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix B:
Testing
Appendix B: Tracking Numbers for Void Testing
Shipping and Tracking Numbers for Void
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)
1Z12345E0390817264
1Z12345E0193075279
1Z12345E0392508488
1Z12345E1290420899
1Z12345E0390856432
1Z12345E0193081456
1Z12345E1234567890,
1Z12345E1234567890
1Z12345E2318693258,
1Z12345E0193072168
1Z12345E1234567890,
1Z12345E8635481269,
Description
Single package shipment sent
via UPS Ground.
Single package shipment sent
via Next Day Air.
Single package shipment sent
via UPS Ground for which
the allotted time period for
voiding the shipment has
expired.
Shipment that has already
been picked up by the UPS
service provider.
Shipment that can be voided
at the shipment level.
Expected Result
Request is processed, and
shipment is voided.
Request is processed, and
shipment is voided.
Error 190101, Time for
voiding has expired.
Error 190103, A completed
order cannot be voided.
A successful shipment voided
XML response will be
returned for a shipment level
void request.
Shipment that can be voided A successful shipment voided
at the shipment level.
XML response will be
returned for a shipment level
void request.
Multi-package shipment
A successful shipment
where the request will void
partially voided XML
only one of the packages
response will be returned for
associated with the shipment. a package level void request.
The request will void only
one of multiple packages in
the shipment. The shipment
will be &quot;partially&quot; voided.
Multi-package shipment with A successful shipment voided
all, save one, of the packages XML response will be
already voided. The request
returned for a package level
will void the remaining
void request. The request will
package.
void the only remaining
package in the shipment. The
shipment will be completely
voided.
Multi-package shipment with A successful shipment
a package that cannot be
partially voided XML
9 February 2009
Page 239
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
1Z12345E1593518308
1Z12345E2318693258,
1Z12345E0390819985,
1Z12345E0193078536
1Z12345E8793628675
1Z12345E1234567890,
1Z12345E0392508253
1Z12345E2318693258,
1Z12345E0392506486
Appendix B: Tracking Numbers for Void Testing
voided.
response will be returned for
a package level void request.
Tracking number
1Z12345E1593518308 will
not be voided.
Multi-package shipment with A successful shipment voided
two packages that remain
XML response will be
unvoided.
returned for a package level
void request. The request will
void all of the remaining
packages in the shipment.
The shipment will be
completely voided.
A shipment uploaded more
A failed XML response will
than 28 days previously.
be returned. Error Code
190101, Time for voiding has
expired.
This tracking number does
Package void will fail to void
not belong to the shipment.
any packages when an invalid
package tracking number is
provided. A failed XML
response will be returned.
Error Code 190110, Invalid
Package Void.
Return shipment.
Return shipments cannot be
voided at the package level. A
failed XML response will be
returned. Error Code 190112,
Return Service Shipments
cannot be Voided at the
Package Level.
9 February 2009
Page 240
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix C:
Appendix C: UPS Service Codes
UPS 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.
Code
01
02
03
12
13
14
59
65
United States Domestic Shipments
UPS Next Day Air&reg;
UPS Second Day Air&reg;
UPS Ground
UPS Three-Day Select&reg;
UPS Next Day Air Saver&reg;
UPS Next Day Air&reg; Early A.M. SM
UPS Second Day Air A.M.&reg;
UPS Saver
Code
01
02
03
07
08
11
12
14
54
59
65
Shipments Originating in United States
UPS Next Day Air&reg;
UPS Second Day Air&reg;
UPS Ground
UPS Worldwide ExpressSM
UPS Worldwide ExpeditedSM
UPS Standard
UPS Three-Day Select&reg;
UPS Next Day Air&reg; Early A.M. SM
UPS Worldwide Express PlusSM
UPS Second Day Air A.M.&reg;
UPS Saver
Code
01
02
03
07
08
14
54
65
Shipments Originating in Puerto Rico
UPS Next Day Air&reg;
UPS Second Day Air&reg;
UPS Ground
UPS Worldwide ExpressSM
UPS Worldwide ExpeditedSM
UPS Next Day Air&reg; Early A.M. SM
UPS Worldwide Express PlusSM
UPS Saver
Code
01
07
08
11
12
13
14
Shipments Originating in Canada
UPS Express
UPS Worldwide ExpressSM
UPS Worldwide ExpeditedSM
UPS Standard
UPS Three-Day Select&reg;
UPS Saver SM
UPS Express Early A.M. SM
9 February 2009
Page 241
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Code
07
08
54
65
Shipments Originating in Mexico
UPS Express
UPS ExpeditedSM
UPS Express Plus
UPS Saver
Code
07
08
11
54
65
82
83
84
85
86
Polish Domestic Shipments
UPS Express
UPS ExpeditedSM
UPS Standard
UPS Worldwide Express PlusSM
UPS Saver
UPS Today StandardSM
UPS Today Dedicated CourrierSM
UPS Today Intercity
UPS Today Express
UPS Today Express Saver
Code
07
08
11
54
65
Shipments Originating in the European Union
UPS Express
UPS ExpeditedSM
UPS Standard
UPS Worldwide Express PlusSM
UPS Saver
Code
07
08
11
54
65
Shipments Originating in Other Countries
UPS Express
UPS Worldwide ExpeditedSM
UPS Standard
UPS Worldwide Express PlusSM
UPS Saver
Appendix C: UPS Service Codes
9 February 2009
Page 242
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix D:
Appendix D: Reference Number Codes
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
Reference Number Type
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
9 February 2009
Page 243
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix E:
Appendix E: Country Codes
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
Afghanistan
&Aring;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
Bulgaria
Burkina Faso
Burundi
Cambodia
Cameroon
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
BG
BF
BI
KH
CM
Forward
Origin
Return
Origin
OnCall
Air
Pickup
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
9 February 2009
Yes
Page 244
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Country
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&ocirc;te D'ivoire
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
French Southern Territories
Gabon
Gambia
Georgia
Germany
Ghana
Gibraltar
Greece
Greenland
Grenada
Guadeloupe
Guam
Guatemala
Guernsey
Guinea
Appendix E: Country Codes
Code
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
TF
GA
GM
GE
DE
GH
GI
GR
GL
GD
GP
GU
GT
GG
GN
Forward
Origin
Return
Origin
Yes
Yes
OnCall
Air
Pickup
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
9 February 2009
Yes
Yes
Page 245
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix E: Country Codes
Country
Code
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 People's Republic of
Korea, Republic of
Kuwait
Kyrgyzstan
Lao People's 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
GW
GY
HT
HM
VA
HN
HK
HU
IS
IN
ID
IR
IQ
IE
IM
IL
IT
JM
JP
JE
JO
KZ
KE
KI
KP
KR
KW
KG
LA
LV
LB
LS
LR
LY
LI
LT
LU
MO
Forward
Origin
Return
Origin
OnCall
Air
Pickup
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
Yes
MK
MG
MW
MY
MV
ML
MT
MH
MQ
MR
MU
YT
MX
FM
Yes
Yes
Yes
Yes
9 February 2009
Yes
Yes
Page 246
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix E: Country Codes
Country
Code
Moldova, Republic of
Monaco
Mongolia
Montenegro
Montserrat
Morocco
Mozambique
Myanmar
Namibia
Nauru
Nepal
Netherlands
Netherlands Antilles
New Caledonia
New Zealand
Nicaragua
Niger
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&eacute;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
MD
MC
MN
ME
MS
MA
MZ
MM
NA
NR
NP
NL
AN
NC
NZ
NI
NE
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
Forward
Origin
Return
Origin
OnCall
Air
Pickup
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
9 February 2009
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Page 247
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Country
Singapore
Slovakia
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.
Wallis and Futuna
Western Sahara
Yemen
Zambia
Zimbabwe
Appendix E: Country Codes
Code
SG
SK
SI
SB
SO
ZA
Forward
Origin
Return
Origin
Yes
Yes
Yes
Yes
OnCall
Air
Pickup
Yes
Yes
GS
ES
LK
SD
SR
SJ
SZ
SE
CH
SY
TW
TJ
TZ
TH
TL
TG
TK
TO
TT
TN
TR
TM
TC
TV
UG
UA
AE
GB
US
UM
UY
UZ
VU
VE
VN
VG
VI
WF
EH
YE
ZM
ZW
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
9 February 2009
Yes
Page 248
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix F: Currency Codes
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 web site. 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 OnLine Tools representative.
Country / Region
Currency
Code
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
Afghani
Lek
Algerian Dinar
US Dollar
Euro
Kwanza
East Caribbean Dollar
East Caribbean Dollar
Argentine Peso
Armenian Dram
Aruban Guilder
Australian Dollar
Euro
Azerbaijanian Manat
Bahamian Dollar
Bahraini Dinar
Taka
Barbados Dollar
Belarussian Ruble
Euro
Belize Dollar
CFA Franc BCEAO
Bermudian Dollar (customarily
known as Bermuda Dollar)
Indian Rupee
Ngultrum
Boliviano
Mvdol
Convertible Marks
Pula
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
Bosnia &amp; Herzegovina
Botswana
9 February 2009
BMD
INR
BTN
BOB
BOV
BAM
BWP
Page 249
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix F: Currency Codes
Country / Region
Currency
Code
Bouvet Island
Brazil
British Indian Ocean Territory
Brunei Darussalam
Bulgaria
Burkina Faso
Burundi
Cambodia
Cameroon
Canada
Cape Verde
Cayman Islands
Central African Republic
Chad
Norwegian Krone
Brazilian Real
US Dollar
Brunei Dollar
Bulgarian Lev
CFA Franc BCEAO
Burundi Franc
Riel
CFA Franc BEAC
Canadian Dollar
Cape Verde Escudo
Cayman Islands Dollar
CFA Franc BEAC
CFA Franc BEAC
Chilean Peso
Unidades de formento
Yuan Renminbi
Australian Dollar
Australian Dollar
Colombian Peso
Unidad de Valor Real
Comoro Franc
CFA Franc BEAC
NOK
BRL
USD
BND
BGN
XOF
BIF
KHR
XAF
CAD
CVE
KYD
XAF
XAF
CLP
CLF
RMB
AUD
AUD
COP
COU
KMF
XAF
Franc Congolais
CDF
New Zealand Dollar
Costa Rican Colon
CFA Franc BCEAO
Croatian Kuna
Cuban Peso
Euro
Czech Koruna
Danish Krone
Djibouti Franc
East Caribbean Dollar
Dominican Peso
US Dollar
Egyptian Pound
El Salvador Colon
US Dollar
CFA Franc BEAC
Nakfa
Kroon
NZD
CRC
XOF
HRK
CUP
EUR
CZK
DKK
DJF
XCD
DOP
USD
EGP
SVC
USD
XAF
ERN
EEK
Chile
China
Christmas Island
Cocos (Keeling) Islands
Colombia
Comoros
Congo
Congo, The Democratic Republic
of
Cook Islands
Costa Rica
C&ocirc;te D'ivoire
Croatia
Cuba
Cyprus
Czech Republic
Denmark
Djibouti
Dominica
Dominican Republic
Ecuador
Egypt
El Salvador
Equatorial Guinea
Eritrea
Estonia
9 February 2009
Page 250
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix F: Currency Codes
Country / Region
Currency
Code
Ethiopia
Falkland Islands (Malvinas)
Faroe Islands
Fiji
Finland
France
French Guiana
French Polynesia
French Southern Territories
Gabon
Gambia
Georgia
Germany
Ghana
Gibraltar
Greece
Greenland
Grenada
Guadeloupe
Guam
Guatemala
Guernsey
Guinea
Ethiopian Birr
Falkland Islands Pound
Danish Krone
Fiji Dollar
Euro
Euro
Euro
CFP Franc
Euro
CFA Franc BEAC
Dalasi
Lari
Euro
Cedi
Gibraltar Pound
Euro
Danish Krone
East Caribbean Dollar
Euro
US Dollar
Quetzal
Pound Sterling
Guinea Franc
Guinea-Bissau Peso
CFA Franc BCEAO
Guyana Dollar
Gourde
US Dollar
ETB
FKP
DKK
FJD
EUR
EUR
EUR
XPF
EUR
XAF
GMD
GEL
EUR
GHC
GIP
EUR
DKK
XCD
EUR
USD
GTQ
GBP
GNF
GWP
XOF
GYD
HTG
USD
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
EUR
HNL
HKD
HUF
ISK
INR
IDR
IRR
IQD
EUR
ILS
EUR
JMD
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
9 February 2009
Page 251
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix F: Currency Codes
Country / Region
Currency
Code
Japan
Jersey
Jordan
Kazakhstan
Kenya
Kiribati
Korea, Democratic People's
Republic of
Korea, Republic of
Kuwait
Kyrgyzstan
Lao People's Democratic Republic
Latvia
Lebanon
Yen
Pound Sterling
Jordanian Dinar
Tenge
Kenyan Shilling
Australian Dollar
JPY
GBP
JOD
KZT
KES
AUD
North Korean Won
KPW
Won
Kuwaiti Dinar
Som
Kip
Latvian Lats
Lebanese Pound
Rand
Loti
Liberian Dollar
Libyan Dinar
Swiss Franc
Lithuanian Litas
Euro
Pataca
KRW
KWD
KGS
LAK
LVL
LBP
ZAR
LSL
LRD
LYD
CHF
LTL
EUR
MOP
Denar
MKD
Malagascy Ariary
Kwacha
Malaysian Ringgit
Rufiyaa
CFA Franc BCEAO
Euro
US Dollar
Euro
Ouguiya
Mauritius Rupee
Euro
Mexican Peso
Mexican Unidad de Inversion
(UID)
US Dollar
Moldovan Leu
Euro
Tugrik
Euro
MGA
MWK
MYR
MVR
XOF
EUR
USD
EUR
MRO
MUR
EUR
MXN
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
9 February 2009
MXV
USD
MDL
EUR
MNT
EUR
Page 252
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Country / Region
Appendix F: Currency Codes
Currency
Montserrat
Morocco
Mozambique
Myanmar
East Caribbean Dollar
Moroccan Dirham
Metical
Kyat
Rand
Namibia
Namibian Dollar
Nauru
Australian Dollar
Nepal
Nepalese Rupee
Netherlands
Euro
Netherlands Antilles
Netherlands Antillian Guilder
New Caledonia
CFP Franc
New Zealand
New Zealand Dollar
Nicaragua
Cordoba Oro
Niger
CFA Franc BCEAO
Nigeria
Naira
Niue
New Zealand Dollar
Norfolk Island
Australian Dollar
Northern Mariana Islands
US Dollar
Norway
Norwegian Krone
Oman
Rial Omani
Pakistan
Pakistan Rupee
Palau
US Dollar
Balboa
Panama
US Dollar
Papua New Guinea
Kina
Paraguay
Guarani
Peru
Nuevo Sol
Philippines
Philippine Peso
Pitcairn
New Zealand Dollar
Poland
Zloty
Portugal
Euro
Puerto Rico
US Dollar
Qatar
Qatari Rial
R&eacute;union
Euro
Romania
New Leu
Russian Federation
Russian Ruble
Rwanda
Rwanda Franc
Saint Helena
Saint Helena Pound
Saint Kitts and Nevis
East Caribbean Dollar
Saint Lucia
East Caribbean Dollar
Saint Pierre and Miquelon
Euro
Saint Vincent and The Grenadines East Caribbean Dollar
Samoa
Tala
9 February 2009
Code
XCD
MAD
MZN
MMK
ZAR
NAD
AUD
NPR
EUR
ANG
XPF
NZD
NIO
XOF
NGN
NZD
AUD
USD
NOK
OMR
PKR
USD
PAB
USD
PGK
PYG
PEN
PHP
NZD
PLN
EUR
USD
QAR
EUR
RON
RUB
RWF
SHP
XCD
XCD
EUR
XCD
WST
Page 253
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix F: Currency Codes
Country / Region
Currency
Code
San Marino
S&atilde;o Tome and Principe
Saudi Arabia
Senegal
Serbia
Seychelles
Sierra Leone
Singapore
Slovakia
Slovenia
Solomon Islands
Somalia
South Africa
Spain
Sri Lanka
Sudan
Suriname
Svalbard and Jan Mayen
Swaziland
Sweden
Euro
Dobra
Saudi Riyal
CFA Franc BCEAO
Serbian Dinar
Seychelles Rupee
Leone
Singapore Dollar
Slovak Koruna
Euro
Solomon Islands Dollar
Somali Shilling
Rand
Euro
Sri Lanka Rupee
Sudanese Dinar
Surinam Dollar
Norwegian Krone
Lilangeni
Swedish Krona
Swiss Franc
WIR Franc
WIR Euro
Syrian Pound
New Taiwan Dollar
Somoni
Tanzanian Shilling
Baht
US Dollar
CFA Franc BCEAO
New Zealand Dollar
Pa'anga
Trinidad and Tobago Dollar
Tunisian Dinar
New Turkish Lira
Manat
US Dollar
Australian Dollar
Uganda Shilling
Hryvnia
UAE Dirham
Pound Sterling
US Dollar
EUR
STD
SAR
XOF
RSD
SCR
SLL
SGD
SKK
EUR
SBD
SOS
ZAR
EUR
LKR
SDD
SRD
NOK
SZL
SEK
CHF
CHW
CHE
SYP
TWD
TJS
TZS
THB
USD
XOF
NZD
TOP
TTD
TND
TRL
TMM
USD
AUD
UGX
UAH
AED
GBP
USD
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
9 February 2009
Page 254
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix F: Currency Codes
Country / Region
Currency
Code
United States Minor Outlying
Islands
US Dollar
USD
Peso Uruguayo
Uruguay Peso en Unidades
Indexadas
Uzbekistan Sum
Vatu
Bolivar
Dong
US Dollar
US Dollar
CFP Franc
Moroccan Dirham
Yemeni Rial
Kwacha
Zimbabwe Dollar
UYU
Uruguay
Uzbekistan
Vanuatu
Venezuela
Viet Nam
Virgin Islands (British)
Virgin Islands (US)
Wallis And Futuna
Western Sahara
Yemen
Zambia
Zimbabwe
9 February 2009
UYI
UZS
VUV
VEB
VND
USD
USD
XPF
MAD
YER
ZMK
ZWD
Page 255
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix G:
Appendix G: Export License Exception Codes
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.
9 February 2009
Page 256
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix H:
Appendix H: International Forms Preference Criteria
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 &quot;wholly obtained or produced entirely&quot; 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
&quot;wholly obtained or produced.&quot; 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 criterion F 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 &quot;wholly produced or
obtained,&quot; as set out in Article 415. All materials used in the production of the
good must qualify as &quot;originating&quot; by meeting the rules of Article 401(a)
through (d). If the good is an agricultural good, see also criterion F and Annex
703.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 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 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 Annex
308.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)
F
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 &quot;qualifying good&quot; 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 &quot;qualifying good&quot; in Section A of Annex 703.2.
9 February 2009
Page 257
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix H: International Forms Preference Criteria
Criteria Meaning
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.
9 February 2009
Page 258
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Appendix I: Countries that Accept Paperless Invoices
Appendix I: Countries that Accept Paperless Invoices
The following table lists those countries that support paperless (electronic
submission) invoices. NOTE: Although a country imay be prepared to
accept Paperless Invoices, it is not guaranteed that all origins are allowed to
send Paperless Invoices to such a country.
Albania
Angola
Argentina
Austria
Bahamas
Barbados
Belarus
Belgium
Bermuda
Bhutan
Bolivia
Bosnia
Brazil
Canada
China
Colombia
Costa Rica
Czech Republic
Denmark
Djibouti
Dominican Rep
Ecuador
El Salvador
Estonia
Finland
France
Gambia
Georgia
Germany
Great Britain
Greece
Guam
Guatemala
Guyana
Honduras
Hong Kong
Hungary
India
Ireland
Israel
Italy
Jamaica
Japan
Kazakhstan
Kirghizia
Latvia
Libya
Lithuania
Luxembourg
Macau
Malaysia
Malta
9 February 2009
Page 259
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Index
Marshall Islands
Mauritania
Mexico
Nepal
Netherland Antilles
Netherlands
New Zealand
Nicaragua
Norway
Panama
Paraguay
Peru
Philippines
Poland
Portugal
Puerto Rico
Reunion Is
Saudi Arabia
Serbia &amp; Montenegro
Singapore
Slovenia
South Korea
Spain
Sweden
Taiwan
Tanzania
Thailand
Timor Leste
Trinidad &amp; Tobago
United Arab Emirates
United States
Uruguay
Uzbekistan
9 February 2009
Page 260
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Index
Index
A
AccessRequest..................................................30
Adobe Acrobat
Document.....................................................13
Application
Database.......................................................12
Dedicated .....................................................12
Document.....................................................13
Type .............................................................12
Web..............................................................13
B
Base64 ..............................................................22
Branding ...........................................................13
C
Cancellation......................................................27
Certification....................................16–17, 16–17
Country Codes........................................244, 259
Currency Codes ..............................................249
Customer Integration Environment ................239
D
Database Application........................................12
Dedicated Application ......................................12
M
Microsoft
Office Document......................................... 13
Visual Basic .....................................20, 23–24
Visual Studio....................................14, 20, 23
XML Core Services .........................14, 20, 23
MSXML ........................ See XML Core Services
O
Open Source .........................................14, 21, 25
Outbound Shipment......................................... 27
P
Paperless Invoice ........................................... 259
POST ............................................................... 18
Preference Criteria......................................... 257
R
Reference Number Codes .......................241, 243
Return Label Sample ..................................... 237
Return Shipment .............................................. 27
S
F
Secure Sockets Layer..................................18–21
ShipmentAcceptRequest.................................. 28
ShipmentAcceptResponse ............................... 28
ShipmentConfirmRequest................................ 28
ShipmentConfirmResponse ............................. 28
Shipping Label Sample.................................. 237
Shipping Number
Test Values ................................................ 239
SSL ............................. See Secure Sockets Layer
Forward Shipment ............................................27
T
H
Tag ................................................................... 21
Technical Support ............................................ 14
Tracking Number
Test Values ................................................ 239
E
Element.............................................................22
Extensible Markup Language...........................21
Example .......................................................21
Standard .......................................................23
HTTP................ See Hypertext Transfer Protocol
Hypertext Transfer Protocol .......................18–21
J
Java.................................................14, 20, 24–25
Java API for XML Processing ....................14, 24
Java Enterprise Edition.....................................14
Java Standard Edition .......................................14
java.net .............................................................14
JAXP ............. See Java API for XML Processing
L
libcurl .........................................................14, 21
License Exception Codes ...............................256
U
Uniform Resource Locator .............................. 19
URL .................... See Uniform Resource Locator
URL Class........................................................ 14
User Profile...................................................... 17
V
Visual Basic ..........................................20, 23–24
Visual Studio.........................................14, 20, 23
VoidShipment .................................................. 28
VoidShipmentResponse ................................. 213
9 February 2009
Page 261
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
UPS OnLine Tools Shipping
Index
W
X
Web Application ...............................................13
World Wide Web Consortium...........................23
xerces..........................................................14, 25
XML Core Services ..............................14, 20, 23
9 February 2009
Page 262
&copy; 2009 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
">

Hello! I've thoroughly reviewed the 'UPS OnLine Tools Shipping XML Tool Developers Guide' dated February 9, 2009. This document provides comprehensive information on integrating UPS's shipping, cancellation, and returns services into your applications using XML and secure internet protocols. I'm ready to assist you with any questions regarding its technical details, development requirements, or testing procedures outlined within the guide.

Show related prompts

Assistant typing

Assistant is out of keyboard. Please, try again later.

Key features

Integrates UPS shipping, cancellation (voids), and return services
Utilizes HTTP and Secure Sockets Layer 3 (SSL3) for secure communication
Employs Extensible Markup Language (XML) for message structure
Provides Customer Integration Environment (CIE) for testing and debugging
Supports negotiated rates for shipping
Requires UPS account credentials for service access
Governed by UPS Technology Agreement for usage guidelines
Facilitates UPS Label Certification for compliance

Frequently asked questions

The primary purpose of the UPS OnLine Tools Shipping XML Tool is to allow developers to integrate UPS shipping, cancellation (voids), and return services directly into their own applications or websites.

The UPS OnLine Tools Shipping XML Tool relies on Hypertext Transfer Protocol (HTTP) with Secure Sockets Layer 3 (SSL3) for secure communication and Extensible Markup Language (XML) for structuring messages.

The Customer Integration Environment (CIE) is a special UPS environment for testing and staging applications that rely on UPS OnLine Tools. It's important because it allows developers to test and debug their applications by simulating transactions with UPS without initiating actual business services, such as dispatching a driver.

Yes, UPS requires customers to pass a Label Certification process prior to shipping actual (billable) packages using the Shipping XML Tool, especially if you are a new customer or haven’t previously certified.

Technical support can be obtained by filling out the technical support request form on the UPS web site, accessible through www.myups.com or www.ups.com via the Support and Technology Support sections.