Shipping Package XML Developer Guide

Shipping - Package
XMLDeveloper Guide
July 11, 2016

Important Information
UPS Developer Kit APIs

Your development of an application using UPS Developer Kit APIs is governed by the UPS Technology
Agreement you entered into with UPS. The following are key legal requirements from these agreements for the
UPS Developer Kit APIs. For more information on all requirements for the UPS Developer Kit APIs, please
refer to the UPS Technology Agreement.
Defined terms used but not defined in this document have the meaning set forth in the UPS Technology
Agreement.
Key Legal Requirements for UPS Developer APIs

Permitted Territories
This document can only be used in the countries of the Permitted Territory as defined in the UPS Technology
Agreement, as applicable.
Use
The application must not be designed to allow distribution of information received through the UPS Developer
Kit APIs to third parties, other than to persons having a bona fide interest in such information (e.g., the shipper,
receiver, or the third party payer, or to your service providers authorized by UPS).
Consent to Use of UPS Mark

All screens or forms generated by your application including information received through the UPS Developer
Kit APIs must include (1) the UPS Mark positioned in reasonable proximity to the Information and of an
appropriate size to readily identify the source of the Information as UPS and (2) the following language at the
bottom of every screen that displays the UPS Mark: "UPS, the UPS brand mark, and the Color Brown are
trademarks of United Parcel Service of America, Inc. All Rights Reserved". Except as set forth in the preceding
sentence, you have no right to use the UPS Mark without the prior written approval of UPS.
You shall not use the UPS Mark in association with any third party trademarks in a manner that might suggest
co-branding or otherwise create potential confusion as to source or sponsorship of the application, or
ownership of the UPS Mark.
The UPS Mark shall be used only as provided by UPS electronically or in hard copy form. The UPS Mark may
not be altered in any manner, including proportions, colors, elements, etc., or animated, morphed or otherwise
distorted in perspective or dimensional appearance.
The UPS Mark may not be combined with any other symbols, including words, logos, icons, graphics, photos,
slogans, numbers, or other design elements. A minimum amount of empty space must surround the UPS Mark
separating it from any other object, such as type, photography, borders, edges, etc. The required area of empty
space around the UPS Mark must be 1/3x, where x equals the height of the UPS Mark.
Copyright and Proprietary Notice

In your application and any POD Letters you prepare, you must include a prominent reproduction of UPSs
copyright and proprietary notices in a form and format specified by UPS (See the Copyright section of this
document).
Display of Information
The application must not display information concerning any other provider of shipping services or such other
shipping services on any page, whether comprising one or more frames, displaying information your
application receives from the UPS Developer Kit APIs. Your application must present all data within each field
received through the UPS Developer Kit APIs without amendment, deletion, or modification of any type.
2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary ii
Shipping Package XML Developer Guide July 11, 2016
Notice
In all communications with UPS concerning this document, please refer to the document date located on the
cover.
Copyright
2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary
The use, disclosure, reproduction, modification, transfer, or transmittal of this work for any purpose in any form
or by any means without the written permission of United Parcel Service is strictly prohibited.
Trademarks
Some of the UPS corporate applications use United States city, state, and postal code information obtained by
United Parcel Service of America, Inc. under a non-exclusive license from the United States Postal Service.
2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary iii
Table of Contents
Chapter 1: Introduction 1
Release Features 2
Chapter 2: Understanding the Shipping API 5

Business Processes and Rules 5
Negotiated Rates 5
What Shipping Services Can Do 6
Shipments 6
Voids (Cancellations) 6
Returns 6
How Shipping Services Work 7
Two-Stage Shipping Process 7
Voiding Shipments 8
Label Recovery Services 8
Chapter 3: Customer Integration Environment (CIE) 9

Using Negotiated Rates in CIE 9
Shipping (XML) 10
Integration Testing URL 10
Production URL 10
Server Availability Check 10
Void Package (XML) 11
Integration Testing for Void 11
Production Testing for Void 11
Server Availability Check for Void 11
Shipping and Tracking Numbers for Testing Void 12
Label Recovery (XML) 14
Integration Testing for Label Recovery 14
Production Testing for Label Recovery 14
Server Availability Check for Label Recovery 14
Chapter 4: Shipment Confirm APIElements and Details 15

Element Constraints 15
ShipmentConfirmRequest Top Level Containers 16
ShipmentConfirmRequest XPath Tables 18
Request 18
RequestAction 18
RequestOption 19
SubVersion 19
TransactionReference 19
Shipment 20
Description 20
2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary iv
ReturnService 20
DocumentsOnly 21
Shipper 22
ShipTo 25
AlternateDeliveryAddress 28
ShipFrom 30
SoldTo 34
PaymentInformation 36
ItemizedPaymentInformation 43
GoodsNotInFreeCirculationIndicator 50
RateInformation 50
MovementReferenceNumber 51
ReferenceNumber 52
Service 52
InvoiceLineTotal 54
NumOfPiecesInShipment 54
USPSEndorsement 55
MILabelCN22Indicator 55
SubClassification 55
CostCenter 55
ShipmentServiceOptions 56
PackageID 104
IrregularIndicator 104
Package 104
RatingMethodRequestedIndicator 117
TaxInformationIndicator 117
ShipmentIndicationType 117
LabelSpecification 118
LabelPrintMethod 118
HTTPUserAgent 118
LabelStockSize 119
LabelImageFormat 119
Instruction 120
ReceiptSpecification 121
ImageFormat 121
ShipmentConfirmResponse Top Level Containers (XML) 122
ShipmentConfirmResponse XPath Tables 123
Response 123
ResponseStatusCode 123
ResponseStatusDescription 124
Error 124
ShipmentCharges 126
RateChart 126
2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary v
TransportationCharges 126
ServiceOptionsCharges 126
ItemizedCharges 127
TaxCharges 128
TotalCharges 128
TotalChargesWithTaxes 128
BillingWeight 130
UnitOfMeasurement 130
Weight 130
ShipmentIdentificationNumber 131
BillableWeightCalculationMethod 131
RatingMethod 131
Disclaimer 132
Code 132
Description 132
ShipmentDigest 132
NegotiatedRates 133
ItemizedCharges 133
TaxCharges 134
NetSummaryCharges 134
Chapter 5: Shipment Accept APIElements and Details 136

ShipmentAcceptRequest Top Level Containers 136
ShipmentAcceptRequest XPath Tables 137
Request 137
RequestAction 137
SubVersion 137
ShipmentDigest 139
ShipAcceptResponse Top Level Containers 140
ShipmentAcceptResponse XPath Tables 141
Response 141
ResponseStatusCode 141
ResponseStatusDescription 142
Error 142
ShipmentResults 144
ShipmentCharges 144
Negotiated Rates 147
BillingWeight 150
Disclaimer 150
RatingMethod 151
ControlLogReceipt 152
2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary vi
PackageResults 152
Form 159
CODTurnInPage 160
HighValueReport 161
LabelURL 162
LocalLanguageLabelURL 162
ReceiptURL 162
LocalLanguageReceiptURL 162
Chapter 6: Label Recovery Elements and Details 163

LabelRecoveryRequest Top Level Containers 163
LabelRecoveryRequest XPath Tables 164
Request 164
LabelSpecification 165
Translate 166
LabelDelivery 168
TrackingNumber 168
ReferenceNumber 169
ShipperNumber 169
LabelRecoveryResponse Top Level Containers 170
LabelRecoveryResponse XPath Tables 171
Response 171
LabelResults 174
TrackingCandidate 177
Chapter 7: Void Shipment Elements and Details 179

VoidShipmentRequest Top Level Containers 179
VoidShipmentRequest XPath Tables 180
Request 180
ExpandedVoidShipment 181
VoidShipmentResponse Top Level Containers 182
VoidShipmentResponse XPath Tables 183
Response 183
Status 186
PackageLevelResults 187
Chapter 8: Shipping XML APIExamples 188

ShipmentConfirmRequest Example 188
ShipmentConfirmResponse Example 190
ShipmentAcceptRequest Example 190
ShipmentAcceptResponse Example 191
2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary vii
LabelRecoveryRequest Example 193

LabelRecoveryResponse Example 193
VoidShipmentRequest Example 195
VoidShipmentResponse Example 195
Chapter 9: Shipping Package API FAQs 196
Appendices 204
Error Codes (XML) 205
Common Error Codes 205
Shipping Error Codes 207
120001 - 120318 207
120400 - 120619 210
120620 - 121116 213
121120 - 125000 217
126000 - 128042 220
128043 - 128240 223
128241 - 129204 227
1270092 - 1270125 230
9126004 + 231
Label Recovery Error Codes 232
Void Error Codes 233
Accessorial / Surcharge Codes 234
Accessorial & Surcharge Subtypes 237
COD Supported Countries 238
Country Codes 239
Currency Codes 247
Delivery Confirmation Origin-Destination Pairs 254
Disclaimer Codes and Messages 255
EEI License Codes 256
Department of Commerce/Bureau of Industry and Security (BIS) 256
Department of Energy/National Nuclear Security Administration (DOE/NNSA) 265
Nuclear Regulatory Commission (NRC) 265
Department of State/ Directorate of Defense Trade Control (DDTC) 266
Department of Treasury/Office of Foreign Assets Control (OFAC) 267
Other Partnership Agency 267
EEI License Types and Exemptions 268
Export License Exception Codes 269
Hong Kong District Codes 270
International Forms Preference Criteria 273
Label Examples 274
Shipping Label Sample 274
Return Label Sample 275
2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary viii
Language / Dialect Combinations 276

License Exception Codes 277
Mail Innovations Package Detail Information 278
Paperless Invoice Support Countries 279
North American Free Trade Agreement (NAFTA) Supported Countries 279
Reference Number Codes 280
Service Codes 281
United States 281
Canada 282
European Union 282
Mexico 282
Poland 283
Puerto Rico 283
Undefined countries 283
All Countries 284
Tax Type Values / Abbreviations 285
2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary ix
Chapter 1: Introduction
In this document, you will find guidance and instructions for integrating the Shipping Package XML API into your
application, service, or system.
In this guide, you will find:

New release features
Shipping Package XMLAPI functionality and business rules
XML API request and response schema
FAQs for the Shipping API
Shipping error response code descriptions
Service code references
This guide applies to the following API:

Shipping Package XML API
This guide does not apply to the following APIs:

Shipping Package Web Service API
Shipping Ground Freight or Air Freight API
Intended Audience
This guide is intended for developers who will be integrating the Shipping Package XML API into their application,
service, or system.
Required Knowledge & Skills

This guide assumes you have a basic understanding of the following:
Concepts and instructions in the Introduction to the UPSDeveloper Kit guide.

XML syntax and structure
Software development
How to Use this Guide

If this is your first time working with the UPS Developer Kit, begin with the Introduction to the UPSDeveloper Kit
guide. This guide serves as the foundation for all API-specific developer guides.
If you are experienced with the UPS Developer Kit but have not yet worked with the Shipping API, continue with
Chapter 2: Understanding the Shipping API. There you will find an overview of the Rating functionality and
business rules.
Chapter 3: Customer Integration Environment (CIE)contains information on UPS integration environments.
The Shipment Confirm, Shipment Accept, Label Recovery, and Void Shipment APIElements and Details
chapters contain an overview of the top-level containers and elements that comprise requests and responses.
Request and response examples are located in Chapter 8: Shipping XML API Examples.
Reference tables, services codes, and error codes are located in the Appendices.
2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 1
Release Features
July 2016
Description
Expanded CODService
Shipment level: Russia and United Arab Emirates

Package Level: Argentina, Brazil, Chilie, Mexico
For additional information refer to the topic:COD Supported Countries
New PackageResults Response Containers/Elements
/ShipmentAcceptResponse/ShipmentResults/PackageResults
ItemizedCharges
NegotiatedRates/ItemizedCharges
ItemizedCharges Elements:
Code
Description
CurrencyCode
MonetaryValue
SubType
April 2016
Description
Added support for additional credit card types:
13=Dankort, 14=Hipercard, 15=JCB, 17=Postepay, 18=UnionPay/ExpressPay, 19=Visa Electron, 20=VPAY,
21=Carte Bleue
January 2016
Description
Emerging Market Priority Countries
Expansion of supported countries

Algeria, Angola, Azerbaijan, Bahrain, Burundi, Cameroon, DR of Congo, Djibouti, Ethiopia, Estonia,
Ghana, Ivory Coast, Malawi, Mauritius, Mozambique, Rwanda, Serbia, Slovenia, Sri Lanka, Tanzania,
Uganda , Zambia, Zimbabwe
Updates noted in the Country Code appendix
Refer to UPS.com for additional information
International Rate Type
Support for new General List and Regional Rate charts

New value returned in response
Expand Customer Payment Options
Support PayPal for all forward movements
Description
Rating Granularity
Return itemized published rates for transportation, surcharges and accessorials

New Shipping Request Elements
/Request/SubVersion
New Shipping Response Containers/Elements
/ShipmentCharges/ItemizedCharges/code
/NegotiatedRates/ItemizedCharges
ItemizedCharges Elements:
Code
Description
CurrencyCode
MonetaryValue
SubType
UPS Access Point Lite
Extend currently available UPS Access Point functionality to new countries

Austria, Denmark, Finland, Norway, Sweden, and Switzerland.
New Error Codes
124078 - Hard - The Notification Media Type is invalid for the given country.
124079 - Hard - The Notification Language is invalid for the given Notification Media Type Code.
July 2015
New Features
Emerging Market Priority Countries
Expansion of supported countries

Bangladesh, Bulgaria, Croatia, Egypt, Jordan, Kenya, Kuwait, Latvia, Lithuania, Morocco, Nigeria, Oman,
Pakistan, Qatar, Saudi Arabia, Slovakia, South Africa, Tunisia & United Arab Emirates
Satellite Country Compliance
Expansion of satellite countries

Canary Islands, Ceuta, Melilla and Aland Islands
UPS Access Point Network enhancements
New service UPS Access Point Economy for forward Hold at Pick-up (Contract service), Access Point
Delivery (General Service ) and UPS Return service (Contract service) for Domestic shipments within Access
Point countries
New accessorial - Package Release code
Authorization code provided by shipper used by the receiver for Hold for Pick-up packages
New UPS Access Point addresses listed on the label instructions for ERL & PRLs
Support account level Direct Delivery Only (DDO)
New Features
New Request Element
/Shipment/ShipmentServiceOptions/EPRAReleaseCode
New Error Codes
Chapter 2: Understanding the Shipping API
Business Processes and Rules
UPS expects schema elements/tags as defined in the XPath and presented in the schema structure without
spelling or structural deviations. Elements/tags that are not defined in the schema or do not conform to the
schema structure will be ignored by UPS.
To access API documentation the user must have or create a My UPS profile.
To access testing and production sites the user must have an Access Key. To get an Access Key you must have
a My UPS profile and an associated shipping account. For additional information, refer to the UPS Developer Kit
User Guide.
To bill package shipments, your My UPS profile must have a UPS six digit (package shipping) account number.
To add an account number to your My UPS ID for the US and CA, you must have your Invoice Level Control ID
and a Plan level Control ID, UPS Account Number, Country, Amount due and date of invoice for authentication.
Shipping Rules
UPS Worldwide Express Freight shipments require a minimum of five labels to be printed for each pallet. The
API itself will only produce one label.
You can void a shipment from the following origin countries: US, PR and CA.
Only the first AddressLine is printed on the ShipFrom section of the label. Address Line 1, 2 and 3 will be printed
on the label for the ShipTo Address if provided in the request.
For shipments with Ground Freight Pricing, Ground Freight Pricings grand total can be calculated by adding
NetCharge from FRSShipmentData container with ServiceOptionsCharges from ShipmentCharges container.
Negotiated Rates
The Shipping API provides access to Published Rates and Negotiated Rates. A negotiated rate is established by
contract between the customer and UPS.
If you have a pricing contract with UPS, please contact your sales representative for proper setup.
Once your UPS sales rep has verified your setup you need to do the following:
1. Add your account to your My UPS profile using one of your most recent three invoices.
If you have never generated an invoice or have not generated an invoice in the past 90 days, add the
account using the pickup location postal code for the account.
Because you have not generated an invoice, you will need to contact your sales representative a second
time to enable negotiated rates in UPS systems.
2. When transacting with UPS API servers include the correct My UPS ID/PW + Account + Access Key.
3. Include the NegotiatedRatesIndicator element within your XML request. The element is an empty tag.
IMPORTANT NOTES:
Negotiated rates in the CIE are for test purposes only and are not representative of actual negotiated
rates. A 1% discount is applied when requested.
Post-shipment charges, such as address corrections, dimensional weight adjustments, and other
adjustments will affect the actual rate billed which may differ from the rates returned by the Shipping API.
Make sure that all requests are identical when comparing shipping charges between applications and
APIs that provide UPS Negotiated Rates.
Working through discrepancies requires knowledge of all parameters posted, defaults, numeric rounding,
and the rate table used by the applications being compared.
You can check your results against the UPS Calculate Time and Cost program: https://wwwapps.ups.com/ctc
What Shipping Services Can Do

The Shipping Package API makes UPS shipping services available to client applications that communicate with
UPS using the Internet. With this API, applications can prepare or schedule package shipments, manage returns, or
cancel previously scheduled shipments.
Shipments
The Shipping Package APIgives your applications many ways to manage the shipment of 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 documents to large packages.
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:Shipments are sometimes called forward shipments or outbound shipments to distinguish them from
returns.
Voids (Cancellations)
If you need to void/cancel a previously scheduled shipment, the UPS Void API can be used to void the shipment.
Returns
The Shipping Package API also supports UPS return services. With return services, you can:
Include a label in an outbound shipment

Ask UPS to email or mail the return label to your customer
Request a UPS driver to pick up the package at the your customers location
NOTE: UPS can provide a label for a return shipment even if it did not provide a label for the forward shipment.
How Shipping Services Work

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

The process to use the Shipping API consists of two stages, the ship confirm stage followed by the ship accept
stage. A request/response pair is exchanged between the client and server in each stage.
Stage I. Confirm
1. ShipmentConfirmRequest
The procedure begins when a client application sends a (1) ShipmentConfirmRequest to UPS. This request
provides details of the shipment and the desired UPS services.
After the ShipmentConfirmRequest message is created, it must be sent to the Shipping API

ShipmentConfirm URL address, using a HTTP POST.
2. ShipmentConfirmResponse
After the ShipmentConfirmRequest message is received by the server it is preprocessed and validated. If the
request passes all validation tests, a (2) ShipmentConfirmResponse is returned containing estimated rate
information, the shipment Id, and the shipment digest.
If the ShipmentConfirmRequest message fails validation, a ShipmentConfirmResponse message is returned
containing error information. The majority of the validation is performed in this stage. The actual shipment
has not been created at this point.
Stage II.Accept
3. ShipmentAcceptRequest
If the rates and services are acceptable to the client, it sends a (3)ShipmentAcceptRequest to UPS. This
message authorizes UPS to charge for the shipment and process the shipment data.
In order to create a shipment and receive the shipping label(s), a ShipAcceptRequest message must be
created and sent to the Shipping API ShipAccept connection address URL, using a HTTP POST.
The ShipAcceptRequest message must contain the shipment digest returned in the
ShipmentConfirmResponse message.
4. ShipmentAcceptResponse
UPS acknowledges the request by returning a (4)ShipmentAcceptResponse. For forward shipments and for
preprinted return labels, this response includes a label for the shipment.
After the ShipmentAcceptRequest message is received in the server, additional processing validation is
performed. If the ShipmentAcceptRequest message passes all validation tests, a ShipmentAcceptResponse
message is returned containing detailed rate information, the Shipment Id, package tracking numbers and
the shipping label(s).
If the ShipmentAcceptRequest message fails validation, a ShipmentAcceptResponse message is returned
containing error information.
Preprinted Labels
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.
Voiding Shipments
To void a previously scheduled shipment, the client applications send a (1) VoidShipmentRequest to UPS. As the
figure below illustrates, UPS replies to the request with a (2)VoidShipmentResponse.
Applications may void forward shipments up to 28 days after initially processing them. Return shipments can be
voided until 2 a.m. Eastern Time the following night.
Label Recovery Services

For up to 30 days after customers schedule return shipments, UPS maintains a copy of the shipping labels for the
returned package. If customers need to print additional copies of return labels, the Label Recovery Shipping API
can retrieve those labels.
Merchants typically provide this functionality on their own web site. Their customers access the merchant's web site,
which acts as an intermediary on their behalf to retrieve the label from UPS.
Chapter 3: Customer Integration Environment (CIE)
The Customer Integration Environment allows customers to test their application prior to launch. This environment
is intended for integration testing of customer applications with the UPS servers.
Once your application has been thoroughly tested, you should redirect the application to the UPS Production
Environment.
No stress testing should ever be performed by customers against any UPS systems.
To access testing and production sites the user must have an Access Key. You can request an Access Key after
establishing a UPS profile and associating your shipping account.
Test your Rate and Shipping selections using valid and invalid data elements including postal codes, weights, and
package types. This will ensure that your application has the ability to process success and error responses
correctly.
Verify that your XML can produce the following:
Void Request
High Value Report
Label Recovery
A proportional UPS Address label
Behavior of the Shipping API in CIE mode is as follows:
Shipments created in CIE mode would have Sample watermark across the barcode in labels.
All international forms in CIE mode would have Sample watermark across the forms.
All credit cards are checked for the right format but the credit cards are not authorized in CIE mode.
All other functionality is similar to production mode.
System Availability
The Customer Integration Environment is available 24 hours a day, 7 days a week. Note, the system is occasionally
down for server maintenance.
Using Negotiated Rates in CIE

Negotiated rates are available in the UPS Customer Integration Environment (CIE)and are returned when the
Negotiated Rate indicator is provided in the ship request.
The negotiated rates returned do not reflect the contractual rate and may vary. Typically, they are 1% off the
published rate.
Also in the Customer Integration Environment, the shipper eligibility for negotiated rates is not fully verified.
Negotiated Itemized Charges for UPS Worldwide Express Freight are not returned in CIE.
1% of tax charges and total charges with taxes are returned as negotiated rates in CIE mode if the
TaxInformationIndicator is present in the request and if taxes are applicable.
Shipping (XML)
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.
Integration Testing URL

For integration testing, direct your test Shipping Package XML to:
https://wwwcie.ups.com/ups.app/xml/ShipConfirm
https://wwwcie.ups.com/ups.app/xml/ShipAccept
Production URL
Once testing is complete, direct your Shipping Package XML to the Production URL:
https://onlinetools.ups.com/ups.app/xml/ShipConfirm
https://onlinetools.ups.com/ups.app/xml/ShipAccept
Server Availability Check

All of the UPS services work using HTTPS POST. If the server is available, it will reply with the service name, remote
user, server port, server name, and servlet path.
To see this in action, type the following URL in your web browser:
https://wwwcie.ups.com/ups.app/xml/ShipConfirm
Service Name: ShipConfirm

Remote User: null
Server Port: 443
Server Name: wwwcie.ups.com
Servlet Path: /ShipConfirm
https://wwwcie.ups.com/ups.app/xml/ShipAccept
Service Name: ShipAccept

Remote User: null
Server Port: 443
Servlet Path: /ShipAccept
Void Package (XML)
Integration Testing for Void

For integration testing, direct your test Void Package Shipment XML to:
https://wwwcie.ups.com/ups.app/xml/Void
Test your Void application using the set of 1Zs listed below:
Production Testing for Void

Once testing is complete, direct your Void Package Shipment XML to the production URL:
https://onlinetools.ups.com/ups.app/xml/Void
Server Availability Check for Void

To see this in action, type the following URL in your web browser: https://wwwcie.ups.com/ups.app/xml/Void
Service Name: Void

Remote User: null
Server Port: 443
Servlet Path: /Void
Shipping and Tracking Numbers for Testing Void

UPS has set aside several shipping identification and tracking numbers to help developers test their applications.
These special numbers are only valid in 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) SCENARIO EXPECTED RESULT

1Z12345E0390817264 Single package shipment sent Request is processed, and shipment is voided.
via UPS Ground.
NUMBER(S) SCENARIO Single package shipment sent Request is processed, and shipment is voided.
EXPECTED RESULT via Next Day Air.
1Z12345E0193075279
1Z12345E0392508488 Single package shipment sent Error 190101, Time for voiding has expired.
via UPS Ground for which the
allotted time period for voiding
the shipment has expired.
1Z12345E1290420899 Shipment that has already been Error 190103, A completed order cannot be
picked up by the UPS service voided.
provider.
1Z12345E0390856432 Shipment that can be voided at A successful shipment voided XML response
the shipment level. will be returned for a shipment level void
request.
1Z12345E0193081456 Shipment that can be voided at A successful shipment voided XML response
the shipment level. will be returned for a shipment level void
request.
1Z12345E1234567890, PLEASE NOTE: The two 1Zs are A successful shipment partially voided XML
1Z12345E1234567890 intentionally the same value. The response will be returned for a package level
first one is the Shipment void request. The request will void only one of
Identifier. The second one is the multiple packages in the shipment. The
Package Identifier. shipment will be "partially" voided.
The intention of this test case is to
prove one can void the lead
package in a shipment and the
Shipment ID will survive the void
of the lead package.
1Z12345E2318693258, Multi-package shipment with all, A successful shipment voided XML response
1Z12345E0193072168 save one, of the packages will be returned for a package level void request.
already voided. The request will The request will void the only remaining
void the remaining package. package in the shipment. The shipment will be
completely voided.
NUMBER(S) SCENARIO Multi-package shipment with a A successful shipment partially voided XML
EXPECTED RESULT package that cannot be voided. response will be returned for a package level
1Z12345E1234567890, void request. Tracking number
1Z12345E8635481269, 1Z12345E1593518308 will not be voided.
1Z12345E1593518308

1Z12345E2318693258, Multi-package shipment with two A successful shipment voided XML response
1Z12345E0390819985, packages that remain un-voided. will be returned for a package level void request.
1Z12345E0193078563 The request will void all of the remaining
packages in the shipment. The shipment will be
completely voided.
1Z12345E8793628675 A shipment uploaded more than A failed XML response will be returned. Error
28 days previously. Code 190101, Time for voiding has expired.
1Z12345E1234567890, This tracking number does not Package void will fail to void any packages
1Z12345E0392508253 belong to the shipment. when an invalid package tracking number is
provided. A failed XML response will be
returned. Error Code 190110, Invalid Package
Void.
1Z12345E2318693258, Return shipment. Return shipments cannot be voided at the
1Z12345E0392506486 package level. A failed XML response will be
returned. Error Code 190112, Return Service
Shipments cannot be Voided at the Package
Level.
Label Recovery (XML)

To ensure that your application has the ability to process PDF and html responses correctly test your Label
Recovery application using the set similar to 1Zs listed below:

1Z12345E8791315509 Label returned in PDF format Request is processed, label returned in PDF format
1Z12345E8791315413 Label returned in html format Request is processed, label returned in html format
Integration Testing for Label Recovery

For integration testing, direct your test test Label Recovery XML to:
https://wwwcie.ups.com/ups.app/xml/LabelRecovery
Production Testing for Label Recovery

Once testing is complete, direct yourLabel Recovery XML to the production URL:
https://onlinetools.ups.com/ups.app/xml/LabelRecovery
Server Availability Check for Label Recovery

To see this in action, type the following URL in your web browser:
https://wwwcie.ups.com/ups.app/xml/LabelRecovery
Service Name LabelRecovery

Remote User: null
Server Port: 443
Servlet Path: /LabelRecovery
Chapter 4: Shipment Confirm APIElements and Details
Element Constraints
The Request and Response XPath tables contain the full hierarchy of the API elements.
UPS expects schema elements/tags as defined in the XPath and presented in the schema structure i.e., no
spelling or structural deviations. Elements/tags that are not defined in the schema or do not conform to the
schema structure will be ignored by UPS.
Element constraints are defined as follows:
Required
Yes - indicates the element must be present in the request or response.
Yes* - indicates the element must be present in the request if the parent container is present in the request.
No - indicates the element is optional and may be used if it applies to the request .
Cond indicates the element is required under certain conditions.
Type
Container - holds a group of related elements.
String - consists of alphanumeric characters, spaces, and decimals.
Length
The maximum number of characters that can be present in a String. Length is not applicable (N/A) to Containers.
Max Allowed
The maximum number of elements or containers that can be present in the parent container.
ShipmentConfirmRequest Top Level Containers
ShipmentConfirmRequest XPath Tables
Note: Not all containers/elements are reflected separately in the table of contents.
Name Constraint Description Validation

/ShipmentConfirmRequest
ShipmentConfirmRequest Required: Yes Shipment Confirm request.
Type:
Container
Max Allowed:
1
Length: N/A
Request
/ShipmentConfirmRequest/Request
Request Required: Yes Request container.
Type:
Container
Max Allowed:
1
Length: N/A
RequestAction

/ShipmentConfirmRequest/Request/RequestAction
RequestAction Required: Yes Indicates the action to be taken by Must be ShipConfirm.
Type: String the XML service.
Max Allowed: 1
Length: 11
RequestOption

/ShipmentConfirmRequest/Request/RequestOption
RequestOption Required: Yes Optional Processing. nonvalidate = No Valid values are validate and
Type: String street level address validation would nonvalidate.
Max Allowed: 1 be performed, but Postal Code/State
Length: 1..256 combination validation would still be
performed.
validate = No street level address
validation would be performed, but
City/State/Postal Code combination
validation would still be performed.
Note: Full address validation is not
performed.
Therefore, it is the responsibility of the
Shipping API User to ensure the
address entered is correct to avoid an
address correction fee.
SubVersion

/ShipmentConfirmRequest/Request/SubVersion
SubVersion Required: No Indicates Ship API to display the
Type: String new release features in Ship API
Max Allowed: 1 response based on Ship release.
Length: 4
See the Release Features section
for the latest Ship release.
Supported values: 1601, 1607
Format: YYMM = Year and month of
the release.
Example: 1607 = 2016 July
TransactionReference

/ShipmentConfirmRequest/Request/TransactionReference
TransactionReference Required: No TransactionReference identifies
Type: Container transactions between client and
Max Allowed: 1 server.
Length: N/A
/ShipmentConfirmRequest/Request/TransactionReference/CustomerContext
CustomerContext Required: No Customer context
Type: String
Max Allowed: 1
Length: 1..512
Shipment
/ShipmentConfirmRequest/Shipment
Shipment Required: Yes Container for Shipment.
Type:
Container
Max Allowed:
1
Length: N/A
Description

/ShipmentConfirmRequest/Shipment/Description
Description Required: The Description of Goods for the
Cond shipment. Applies to international and
Type: String domestic shipments.
Max Allowed: 1
Provide a detailed description of items
Length: 1..35
being shipped for documents and
non-documents. Provide specific
descriptions, such as "annual reports"
and "9 mm steel screws".
ReturnService

/ShipmentConfirmRequest/Shipment/ReturnService
ReturnService Required: No Type of Return service. When this container
Type: Container exists, the shipment is a return shipment.
Max Allowed: 1
Length: N/A

/ShipmentConfirmRequest/Shipment/ReturnService/Code
Code Required: Yes* Return Service types:
Type: String
2 = UPS Print and Mail (PNM)
Max Allowed: 1
Length: 1 3 = UPS Return Service 1-Attempt (RS1)
5 = UPS Return Service 3-Attempt (RS3)
8 = UPS Electronic Return Label (ERL)
9 = UPS Print Return Label (PRL)
10 = UPS Exchange Print Return Label
11 = UPS Pack & Collect Service 1-Attempt
Box 1
Box 2
Box 3
Box 4
Box 5
Box 1
Box 2
Box 3
Box 4,
Box 5
DocumentsOnly

/ShipmentConfirmRequest/Shipment/DocumentsOnly
DocumentsOnly Required: No Indicates a shipment contains written, Valid only for shipments with
Type: String typed, or printed communication of no different origin and destination
Max Allowed: 1 commercial value. countries.
Length: 0
If DocumentsOnly is not specified then The origin country is not US, and
it implies that the shipment contains the destination country is not CA,
non documents or documents of PR or MX.
commercial value. Default is a
shipment contains non- documents or
documents of commercial value.
Shipper

/ShipmentConfirmRequest/Shipment/Shipper
Shipper Required: Yes Container tag for Shippers
Type: Container information
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/Shipper/Name
Name Required: Yes Shipper's company name. For
Type: String forward Shipment 35
Max Allowed: 1 characters are accepted, but
Length: 1..35 only 30 characters will be
printed on the label.
/ShipmentConfirmRequest/Shipment/Shipper/AttentionName
AttentionName Required: Cond Shipper's Attention Name. For Required if destination is
Type: String forward Shipment 35 international. Required if
Max Allowed: 1 characters are accepted, but Invoice and CO International
Length: 1..35 only 30 characters will be forms are requested and the
printed on the label. ShipFrom address is not
present.
/ShipmentConfirmRequest/Shipment/Shipper/CompanyDisplayableName
CompanyDisplayableName Required: No Shipper's This is available for Shipper
Type: String CompanyDisplayableName accounts enabled by UPS and
Max Allowed: 1 applies to Forward Shipments.
Length: 1..35
The
CompanyDisplayableName
will be displayed in tracking
results and notification
messages in place of the
name associated with the
shipper account.
The original shipper account
name will be displayed for all
Return Services and Import
Control Shipments.

/ShipmentConfirmRequest/Shipment/Shipper/ShipperNumber
ShipperNumber Required: Yes Shipper's six digit account Size must be six
Type: String number. alphanumeric characters.
Max Allowed: 1 Must be associated with the
Length: 6 UserId specified in the
AccessRequest XML.
The account must be a valid
UPS account number that is
active.
For US, PR and CA accounts,
the account must be either a
daily pickup account, an
occasional account, or a
customer B.I.N account.
Drop Shipper accounts are
valid for return service
shipments only if the account
is Trade Direct (TD) enabled.
All other accounts must be
either a daily pickup account
or an occasional account.
/ShipmentConfirmRequest/Shipment/Shipper/TaxIdentificationNumber
TaxIdentificationNumber Required: Cond Shippers Tax Identification
Type: String Number
Max Allowed: 1
Length: 1..15
/ShipmentConfirmRequest/Shipment/Shipper/PhoneNumber
PhoneNumber Required: Cond Shippers Phone Number Valid values are 0 - 9.
Type: String
If Shipper country is US, PR,
Max Allowed: 1
CA, and VI,the layout is area
Length: 1..15
code, 7 digit PhoneNumber or
area code, 7 digit
PhoneNumber, 4 digit
extension number.
Other countries: the layout is
CountryCode, area code, 7
digit number A phone number
is required if destination is
international.
/ShipmentConfirmRequest/Shipment/Shipper/FaxNumber
FaxNumber Required: No Shippers Fax Number.
Type: String
Max Allowed: 1
Length: 1..14
/ShipmentConfirmRequest/Shipment/Shipper/EMailAddress
EMailAddress Required: No Shippers email address.
Type: String
Max Allowed: 1
Length: 1..50

/ShipmentConfirmRequest/Shipment/Shipper/Address
Address Required: Yes Address of the shipper. The package should be
Type: Container returned to this address if the
Max Allowed: 1 package is undeliverable.
Length: N/A This address appears on the
upper left hand corner of the
label.
Note: If the ShipFrom
container is not present then
this address will be used as
the ShipFrom address. If this
address is used as the
ShipFrom, the shipment will
be rated from this origin
address.
/ShipmentConfirmRequest/Shipment/Shipper/Address/AddressLine1
AddressLine1 Required: Yes Address Line 1 of the shipper.
Type: String For forward Shipment 35
Max Allowed: 1 characters are accepted, but
Length: 1..35 only 30 characters will be
printed on the label.
AddressLine2 Required: No Address Line 2 of the shipper.
Type: String Usually Room/Floor
Max Allowed: 1 information. For forward
Length: 1..35 Shipment 35 characters are
accepted.
AddressLine3 Required: No Address Line 3 of the shipper.
Type: String Usually department
Max Allowed: 1 information. For forward
Length: 1..35 Shipment 35 characters are
accepted.
/ShipmentConfirmRequest/Shipment/Shipper/Address/City
City Required: Yes Shipper's city. For forward
Type: String Shipment 30 characters are
Max Allowed: 1 accepted, but only 15
Length: 1..30 characters will be printed on
the label.
/ShipmentConfirmRequest/Shipment/Shipper/Address/StateProvinceCode
StateProvinceCode Required: Cond Shipper's state or province Required if shipper is in the
Type: String code. For forward Shipment 5 US or CA. If Shipper country is
Max Allowed: 1 characters are accepted, but US or CA, then the value must
Length: 2..5 only 2 characters will be be a valid US State/Canadian
printed on the label. Province code. If the country is
Ireland, the
StateProvinceCode will
contain the county.

/ShipmentConfirmRequest/Shipment/Shipper/Address/PostalCode
PostalCode Required: Cond Shippers postal code. If Shipper country is US or
Type: String Puerto Rico, 5 or 9 digits is
Max Allowed: 1 required. The character - may
Length: 1..10 be used to separate the first
five digits and the last four
digits.
If the Shipper country is CA,
then the postal code is
required and must be 6
alphanumeric characters
whose format is A#A#A#
where A is an uppercase letter
and # is a digit.
For all other countries, the
postal code is optional and
must be no more than 9
alphanumeric characters long.
/ShipmentConfirmRequest/Shipment/Shipper/Address/CountryCode
CountryCode Required: Yes Shippers country code. Refer Must be a valid UPS Billing
Type: String to Origin Country Information country code. For Forward
Max Allowed: 1 table for valid origin countries shipments it must also be an
Length: 2 and their UPS Billing codes. allowable UPS origin country.
For Return Shipment the
country code must meet the
following conditions:
1) At least two of the following
country codes are the same:
ShipTo, ShipFrom, and
Shipper.
2) None of the following
country codes are the same
and are a member of the EU:
Shipper.
3) If any of the two following
country codes: ShipTo/
ShipFrom/ Shipper are
members in EU otherwise
check if the shipper has Third
Country Contract.
ShipTo

/ShipmentConfirmRequest/Shipment/ShipTo
ShipTo Required: Yes Container for ShipTo.
Type: Container
Max Allowed: 1
Length: N/A

/ShipmentConfirmRequest/Shipment/ShipTo/CompanyName
CompanyName Required: Yes Consignees company name.
Type: String
Max Allowed: 1
Length: 1..35
/ShipmentConfirmRequest/Shipment/ShipTo/AttentionName
AttentionName Required: Cond Contact name at the consignees Required for: UPS Next Day
Type: String location. Air Early service, and when
Max Allowed: 1 ShipTo country is different than
Length: 1..35 ShipFrom country.
Required if Invoice
International form is requested.
/ShipmentConfirmRequest/Shipment/ShipTo/TaxIdentificationNumber
TaxIdentificationNumber Required: No Consignees tax identification
Type: String number.
Max Allowed: 1
Length: 1..15
/ShipmentConfirmRequest/Shipment/ShipTo/PhoneNumber
PhoneNumber Required: Cond Consignees phone number. Required for: UPS Next Day
Type: String Air Early service, and when
Max Allowed: 1 Ship To country is different
Length: 1..15 than the ShipFrom country.
If ShipTo country is US, PR,
CA, and VI, the layout is area
code, 7 digit PhoneNumber or
area code, 7 digit
PhoneNumber, 4 digit
extension number.
For other countries, the layout
is CountryCode, area code, 7
digit number .
/ShipmentConfirmRequest/Shipment/ShipTo/FaxNumber
FaxNumber Required: No Consignees fax number. If ShipTo country is US 10
Type: String digits allowed, otherwise 1...15
Max Allowed: 1 digits allowed.
Length: 1..15
/ShipmentConfirmRequest/Shipment/ShipTo/EMailAddress
EMailAddress Required: No Ship To email address.
Type: String
Max Allowed: 1
Length: 1..50
/ShipmentConfirmRequest/Shipment/ShipTo/Address
Address Required: Yes Container for ShipTo address.
Type: Container
Max Allowed: 1
Length: N/A

/ShipmentConfirmRequest/Shipment/ShipTo/Address/AddressLine1
AddressLine1 Required: Yes Address Line 1 of the consignee.
Type: String
Max Allowed: 1
Length: 1..35
AddressLine2 Required: No Address Line 2 of the consignee.
Type: String Usually Room/Floor information.
Max Allowed: 1
Length: 1..35
AddressLine3 Required: No Address Line 3 of the consignee.
Type: String Usuallydepartment information.
Max Allowed: 1
Length: 1..35
/ShipmentConfirmRequest/Shipment/ShipTo/Address/City
City Required: Yes Consignee's city. 30 characters
Type: String are accepted, but only 15 will be
Max Allowed: 1 printed on Label.
Length: 1..30
/ShipmentConfirmRequest/Shipment/ShipTo/Address/StateProvinceCode
StateProvinceCode Required: Cond Consignee's state or province If destination is US or CA, then
Type: String code. Required for US or the value must be a valid US
Max Allowed: 1 Canada. 5 characters are State/Canadian Province code.
Length: 2..5 accepted, but only 2 characters
If the country is Ireland, the
will be printed on Label.
contain the county.
/ShipmentConfirmRequest/Shipment/ShipTo/Address/PostalCode
PostalCode Required: Cond Consignees postal code. If the ShipTo country is US or
Type: String Puerto Rico, 5 or 9 digits is
Max Allowed: 1 required.
Length: 1..10
If the ShipTo country is CA,
and # is a digit. Otherwise
optional.
For all other countries the

/ShipmentConfirmRequest/Shipment/ShipTo/Address/CountryCode
CountryCode Required: Yes Consignees country code. Must be a valid UPS Billing
Type: String country code. For Return
Max Allowed: 1 Shipment the country code
Length: 2 must meet the following
conditions:
Shipper.
Shipper.
3) If any of the two following
members in EU, otherwise
Country Contract.
/ShipmentConfirmRequest/Shipment/ShipTo/Address/ResidentialAddress
ResidentialAddress Required: No Consignee's Residential
Type: String address indicator. The presence
Max Allowed: 1 indicates residential address; the
Length: 0 absence indicates a business
address.
/ShipmentConfirmRequest/Shipment/ShipTo/LocationID
LocationID Required: No Location ID is a unique identifier Location ID must be
Type: String referring to a specific alphanumeric characters. All
Max Allowed: 1 shipping/receiving location. letters must be capitalized.
Length: 310
AlternateDeliveryAddress

/ShipmentConfirmRequest/Shipment/AlternateDeliveryAddress
AlternateDeliveryAddress Required: Cond AlternateDeliveryAddress Alternate Delivery
Type: Container Container. Address (UPS Access
Max Allowed: 1 Point Address) is required
Length: N/A if ShipmentIndicationType
is '01' or '02'.
/ShipmentConfirmRequest/Shipment/AlternateDeliveryAddress/Name
Name Required: Yes* Retail Location Name
Type: String
Max Allowed: 1
Length: 135

/ShipmentConfirmRequest/Shipment/AlternateDeliveryAddress/AttentionName
AttentionName Required: Yes* Attention Name
Type: String
Max Allowed: 1
Length: 135
/ShipmentConfirmRequest/Shipment/AlternateDeliveryAddress/UPSAccessPointID
UPSAccessPointID Required: No UPS Access Point ID
Type: String
Max Allowed: 1
Length: 9
/ShipmentConfirmRequest/Shipment/AlternateDeliveryAddress/Address
Address Required: Yes* Address container
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/AlternateDeliveryAddress/Address/AddressLine1
AddressLine1 Required: Yes* Address Line 1 of the Retail Max Occurrence can be 3
Type: String location
Max Allowed:3
Length: 135
AddressLine2 Required: No Address Line 2 of the Retail Max Occurrence can be 3
Max Allowed:3
Length: 135
AddressLine3 Required: No Address Line 3 of the Retail Max Occurrence can be 3
Max Allowed:3
Length: 135
/ShipmentConfirmRequest/Shipment/AlternateDeliveryAddress/Address/City
City Required: Yes* Retail Location City.
Type: String
Max Allowed: 1
Length: 130
/ShipmentConfirmRequest/Shipment/AlternateDeliveryAddress/Address/StateProvinceCode
StateProvinceCode Required: Cond Retail Location state or If destination is US or CA,
Type: String province code. Required for then the value must be a
Max Allowed: 1 US or Canada. valid US State/ Canadian
Length: 25 Province code. If the
country is Ireland, the
contain the county.

/ShipmentConfirmRequest/Shipment/AlternateDeliveryAddress/Address/PostalCode
PostalCode Required: Cond Retail Location postal code. If the Alternate Delivery
Type: String Address country is US or
Max Allowed: 1 Puerto Rico, 5 or 9 digits
Length: 110 are required. The
character - may be used
to separate the first five
digits and the last four
digits.
If the Alternate Delivery
Address country is CA,
where A is an uppercase
letter and # is a digit.
Otherwise optional.
postal code is optional
and must be no more
than 9 alphanumeric
characters long.
/ShipmentConfirmRequest/Shipment/AlternateDeliveryAddress/Address/CountryCode
CountryCode Required: Yes* Retail Location country
Type: String code.
Max Allowed: 1
Length: 2
/ShipmentConfirmRequest/Shipment/AlternateDeliveryAddress/Address/ResidentialAddressIndicator
ResidentialAddressIndicato Required: No This field is a flag to indicate Empty Tag.
r Type: String if the receiver is a
Max Allowed: 1 residential location. True if
Length: 0 ResidentialAddressIndicato
r tag exists; false otherwise.
/ShipmentConfirmRequest/Shipment/AlternateDeliveryAddress/Address/POBoxIndicator
POBoxIndicator Required: No This field is a flag to indicate POBoxIndicator is not
Type: String if the receiver address has valid for
Max Allowed: 1 PO box indicator. True if AlternateDeliveryAddres
Length: 0 POBoxIndicator tag exists; s.
false otherwise.
ShipFrom

/ShipmentConfirmRequest/Shipment/ShipFrom
ShipFrom Required: Cond Required if pickup location is
Type: Container different from the shippers
Max Allowed: 1 address.
Length: N/A

/ShipmentConfirmRequest/Shipment/ShipFrom/CompanyName
CompanyName Required: Yes* Origin location's company name. Required if ShipFrom tag is in
Type: String 35 characters are accepted, but the XML.
Max Allowed: 1 for return Shipment only 30
Length: 1..35 characters will be printed on the
label.
/ShipmentConfirmRequest/Shipment/ShipFrom/AttentionName
AttentionName Required: Yes* Contact name at the pickup Required if ShipFrom tag is in
Type: String location. 35 characters are the XML and Invoice or CO
Max Allowed: 1 accepted, but for return International forms is
Length: 1..35 Shipment only 30 characters will requested. If not present, will
be printed on the label. default to the Shipper Attention
Name.
/ShipmentConfirmRequest/Shipment/ShipFrom/TaxIdentificationNumber
TaxIdentificationNumber Required: Cond Companys Tax Identification
Type: String Number at the pick up location
Max Allowed: 1
Length: 1..15
/ShipmentConfirmRequest/Shipment/ShipFrom/TaxIDType
TaxIDType Required: Cond Tax Identification Container. Valid for EEI form only
Type: Container Applies to EEI form only.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipFrom/TaxIDType/Code
Code Required: Yes* Company's tax Identification Valid values: EIN, DNS, and
Type: String type. FGN.
Max Allowed: 1
Applies to EEI form only.
Length: 6
/ShipmentConfirmRequest/Shipment/ShipFrom/TaxIDType/Description
Description Required: No Description of TaxID submitted. Applies to EEI form only
Type: String
Max Allowed: 1
Length: 135
/ShipmentConfirmRequest/Shipment/ShipFrom/PhoneNumber
PhoneNumber Required: Yes* Origin location's phone number. If ShipFrom country is US, PR,
Type: String CA, and VI,the layout is area
Max Allowed: 1 code, 7 digit phone number or
Length: 1..15 area code, 7 digit phone
number, 4 digit extension
number.
For other countries, the layout
is CountryCode, area code, 7
digit number.
Required if ShipFrom tag is in
the XML and International
forms is requested.

/ShipmentConfirmRequest/Shipment/ShipFrom/FaxNumber
FaxNumber Required: No Origin location's fax number.
Type: String
Max Allowed: 1
Length: 1..15
/ShipmentConfirmRequest/Shipment/ShipFrom/Address
Address Required: Yes* Address of the pickup location. The package will be
Type: Container originating from or being
Max Allowed: 1 shipped from this address. The
Length: N/A shipment will be rated from this
origin address to the
destination ship to address.
/ShipmentConfirmRequest/Shipment/ShipFrom/Address/AddressLine1
AddressLine1 Required: Yes* Address Line 1 of the pickup Required if ShipFrom tag is in
Type: String location. 35 characters are the XML.
Max Allowed: 1 accepted, but for a return
Length: 1..35 Shipment only 30 characters will
be printed on the label.
AddressLine2 Required: No Address Line 2 of the pickup
Type: String location. Usually Room/Floor
Max Allowed: 1 information.This line is not
Length: 1..35 printed on the label.
AddressLine3 Required: No Address Line 3 of the pickup
Type: String location. Usually Room/Floor
Max Allowed: 1 information.This line is not
Length: 1..35 printed on the label.
/ShipmentConfirmRequest/Shipment/ShipFrom/Address/City
City Required: Yes* Origin location's city. 30 Required if ShipFrom tag is in
Type: String characters are accepted, but for the XML.
Max Allowed: 1 return Shipment only 15
Length: 1..30 characters will be printed on the
label.
/ShipmentConfirmRequest/Shipment/ShipFrom/Address/StateProvinceCode
StateProvinceCode Required: Cond Origin location's state or Required if ShipFrom tag is in
Type: String province code. Only 2 the XML, and
Max Allowed: 1 Characters will be printed on the ShipFrom/Country is US. If
Length: 2..5 Label. ShipFrom country is US or CA,
then the value must be a valid
US State/Canadian Province
code.
If the country is Ireland, the
contain the county.

/ShipmentConfirmRequest/Shipment/ShipFrom/Address/PostalCode
PostalCode Required: Cond Origin location's postal code. 10 Required if ShipFrom tag is in
Type: String characters are accepted. the XML and the ShipFrom
Max Allowed: 1 country is the US, Puerto Rico.
Length: 1..10
For US, Puerto Rico must be
valid 5 or 9 digit postal codes.
The character - may be used to
separate the first five digits and
the last four digits.
If the ShipFrom country is CA,
then the postal code must be 6
and # is a digit.
/ShipmentConfirmRequest/Shipment/ShipFrom/Address/CountryCode
CountryCode Required: Cond Origin location's country code. Required if ShipFrom tag is in
Type: String the XML. For Return Shipment
Max Allowed: 1 the country code must meet
Length: 2 the following conditions:
ShipTo, ShipFrom and
Shipper.
Shipper.
3) 3If any of the two following
members in EU otherwise
Country Contract.
SoldTo

/ShipmentConfirmRequest/Shipment/SoldTo
SoldTo Required: Cond The person or company who Applies to Invoice and NAFTA
Type: Container imports and pays any duties due CO Forms.
Max Allowed: 1 on the current shipment.
Required if Invoice or NAFTA
Length: N/A
CO (International Form) is
requested
/ShipmentConfirmRequest/Shipment/SoldTo/Option
Option Required: No The text associated with the code Applies to NAFTA CO form.
Type: String will be printed in the sold to
Max Allowed: 1 section of the NAFTA CO form.
Length: 110 The values indicate the following:
01 - Unknown; 02 - Various.
/ShipmentConfirmRequest/Shipment/SoldTo/CompanyName
CompanyName Required: Cond Company name. Applies to Invoice form.
Type: String Applies to NAFTA CO form if
Max Allowed: 1 sold to option is empty or not
Length: 1..35 present.
Required for Invoice. Required
for NAFTA CO if sold to option
is not provided.
/ShipmentConfirmRequest/Shipment/SoldTo/AttentionName
AttentionName Required: Cond Contact name. Applies to Invoice form.
Required for Invoice. Required
for NAFTA CO if sold to option
is not provided.
/ShipmentConfirmRequest/Shipment/SoldTo/TaxIdentificationNumber
TaxIdentificationNumber Required: No SoldTo Tax Identification Applies to Invoice form.
Type: String number. Applies to NAFTA CO form if
/ShipmentConfirmRequest/Shipment/SoldTo/PhoneNumber
PhoneNumber Required: Cond Sold To contacts phone number. Applies to Invoice form.
Required for Invoice.
Required for NAFTA CO if sold
to option is not provided.

/ShipmentConfirmRequest/Shipment/SoldTo/Address
Address Required: No Address of the Sold to location. Applies to Invoice form.
Type: Container Applies to NAFTA CO form if
Length: N/A present.
/ShipmentConfirmRequest/Shipment/SoldTo/Address/AddressLine1
AddressLine1 Required: Yes* Address Line 1 of the Sold to Applies to Invoice form.
Type: String location. Applies to NAFTA CO form if
AddressLine2 Required: No Address Line 2 of the pickup Applies to Invoice form.
Type: String location. Usually Room/Floor Applies to NAFTA CO form if
Max Allowed: 1 information. sold to option is empty or not
AddressLine3 Required: No Address Line 3 of the pickup Applies to Invoice form.
Type: String location. Usuallydepartment Applies to NAFTA CO form if
Max Allowed: 1 information. sold to option is empty or not
/ShipmentConfirmRequest/Shipment/SoldTo/Address/City
City Required: Yes* SoldTo locations city. Applies to Invoice form.
/ShipmentConfirmRequest/Shipment/SoldTo/Address/StateProvinceCode
StateProvinceCode Required: Cond SoldTo locations state or Applies to Invoice form.
Type: String province code. Applies to NAFTA CO form if
Length: 1..5 present. Required for certain
countries.
/ShipmentConfirmRequest/Shipment/SoldTo/Address/PostalCode
PostalCode Required: Cond SoldTo locations postal code. Applies to Invoice form.
Length: 1..9 present. Required for certain
countries. The length of the
postal code depends on the
country code.

/ShipmentConfirmRequest/Shipment/SoldTo/Address/CountryCode
CountryCode Required: Cond SoldTo locations country code. Applies to Invoice form.
Length: 2 present.
Required for Invoice
PaymentInformation

/ShipmentConfirmRequest/Shipment/PaymentInformation
PaymentInfor Required: Payment information. This element or its sibling element,
mation Cond ItemizedPaymentInformation, must be present but
no more than one can be present.
Type:
Container
Max Allowed:
1
Length: N/A
/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid
Prepaid Required: Prepaid container for a Required for the Bill Shipper billing option.
Cond billing option.
This element or its sibling element, BillThirdParty
Type: or FreightCollect must be present, but no more
Container than one can be present.
Max Allowed:
1
Length: N/A
/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper
BillShipper Required: Container for the A payment method must be specified for the Bill
Cond BillShipper billing option. Shipper billing option. Therefore, either the
The three payment AlternatePaymentMethod child element or
Type:
methods that are available AccountNumber child element or the CreditCard
Container
for the Bill Shipper billing child element must be provided, but not all of them.
Max Allowed: option are alternate
1 payment method, account
Length: N/A number or credit card.
/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/AccountNumber
AccountNumb Required: UPS Account number. Must be the same UPS account number as the one
er Cond provided in Shipper/ShipperNumber. Either this
element or the sibling elements CreditCard or
Type: String
AlternatePaymentMethod must be provided, but all
Max Allowed: may not be provided.
1
Length: 6

/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/CreditCard
CreditCard Required: Credit card information Required if neither of the following is present:
Cond container.
/ShipmentConfirmRequest/Shipment/PaymentInfor
Type: mation/Prepaid/BillShipper/AccountNumber
Container
or
Max Allowed:
1
mation/Prepaid/BillShipper/AlternatePaymentMeth
Length: N/A od. Credit card payment is valid for shipments
without return service only.
/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/CreditCard/Type
Type Required: Values are:
Yes*
01 = American Express
Type: String
03 = Discover
Max Allowed:
04 = MasterCard
1
05 = Optima
Length: 2
06 = VISA
07 = Bravo
08 = Diners Club
13 = Dankort
14 = Hipercard
15 = JCB
17 = Postepay
18 =
UnionPay/ExpressPay
19 = Visa Electron
20 = VPAY
21 = Carte Bleue
/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/CreditCard/Number
Number Required: Credit Card number.
Yes*
Type: String
Max Allowed:
1
Length: 9..16
/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/CreditCard/ExpirationDate
ExpirationDate Required: Format is MMYYYY where Valid month values: 01-12
Yes* MM is the 2 digit month
Valid year values: Present Year (Present Year +
and YYYY is the 4 digit
Type: String 10 years)
year.
Max Allowed:
1
Length: 6

/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/CreditCard/SecurityCode
SecurityCode Required: Three or four digits that Valid values are 3 or 4 digit.
Cond can be found either on
It is recommended to provide the security code if
front of credit card or on
Type: String credit card information is provided and when the
the back of credit card.
ShipFrom countries are other than the below
Max Allowed: Number of digits varies by
mentioned countries:
1 credit card type.
Argentina, Bahamas, Costa Rica, Dominican Rep,
Length: 3..4
Guatemala, Panama, Puerto Rico and Russia.
/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/CreditCard/Address
Address Container to hold the It is required to provide the billing address if credit
Credit card Billing card information is provided and when the
Address. ShipFrom country is the US, PR, and CA.
/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/CreditCard/Address/AddressLine1
AddressLine1 Required: Address Line 1 of the
Yes* credit card billing address.
Usually Street address
Type: String
information.
Max Allowed:
1
Length: 1..35
AddressLine2 Required: No Address Line 2 of the
credit card billing Address.
Type: String
Usually Room/Floor
Max Allowed: information.
1
Length: 1..35
AddressLine3 Required: No Address Line 3 of the
credit card billing address.
Type: String
Usually department
Max Allowed: information.
1
Length: 1..35
/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/CreditCard/Address/City
City Required: City of the credit card
Yes* billing address.
Type: String
Max Allowed:
1
Length: 1..30

/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/CreditCard/Address/StateProvinc
eCode
StateProvince Required: State or province code of
Code Yes* the credit card billing
address.
Type: String
Max Allowed:
1
Length: 2..5
/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/CreditCard/Address/PostalCode
PostalCode Required: Credit card billing
Yes* addressee postal code.
Type: String
Max Allowed:
1
Length: 1..10
/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/CreditCard/Address/CountryCode
CountryCode Required: Credit card billing address Must be a valid UPS Billing country code.
Yes* country code.
Type: String
Max Allowed:
1
Length: 2
/ShipmentConfirmRequest/Shipment/PaymentInformation/Prepaid/BillShipper/AlternatePaymentMethod
AlternatePaym Required: Valid value for Alternate Paypal 01 : It is valid only for forward shipments. It
entMethod Cond Payment Method is "01" - is not valid for Return or Import Control shipments.
PayPal
Type: String
Max Allowed:
1
Length: 2
/ShipmentConfirmRequest/Shipment/PaymentInformation/BillThirdParty
BillThirdParty Container for the third This element or its sibling element Prepaid or
Required:Con party billing option. FreightCollect must be present, but no more than
d one can be present.
Type:
Container
Max Allowed:
1
Length: N/A

/ShipmentConfirmRequest/Shipment/PaymentInformation/BillThirdParty/BillThirdPartyShipper
BillThirdParty Required:Con Container for the third
Shipper d party shipper billing
option.
Type:
Container
Max Allowed:
1
Length: N/A
/ShipmentConfirmRequest/Shipment/PaymentInformation/BillThirdParty/BillThirdPartyShipper/AccountNumber
AccountNumb Required: The UPS account number The account must be a valid UPS account number
er Yes* of the third party shipper. that is active.
Type: String For US, PR and CA accounts, the account must be
either a daily pickup account, an occasional
Max Allowed:
account, or a customer B.I.N account, or a drop
1
shipper account.
Length: 6
All other accounts must be either a daily pickup
account, an occasional account, a drop shipper
account, or a non-shipping account.
/ShipmentConfirmRequest/Shipment/PaymentInformation/BillThirdParty/BillThirdPartyShipper/ThirdParty
ThirdParty Required:Yes* Container for additional
information for the third
Type:
party shipper's UPS
Container
account.
Max Allowed:
1
Length: N/A
/ShipmentConfirmRequest/Shipment/PaymentInformation/BillThirdParty/BillThirdPartyShipper/ThirdParty/Addres
s
Address Required: Container for additional
Yes* information for the third
party shipper's UPS
Type:
account address.
Container
Max Allowed:
1
Length: N/A

s/PostalCode
PostalCode Required: The postal code for the The postal code must be the same as the UPS
Cond UPS account's pickup account pickup address' postal code. Required if
address. The pickup United States and Canadian UPS accounts and/or
Type: String
postal code was entered if the UPS account pickup address has a postal
Max Allowed: in the UPS system when code.
1 the account was set-up.
If the UPS account's pickup country is US or Puerto
Length: 1..10 Rico, the postal code is 5 or 9 digits. The character
'-' may be used to separate the first five digits and
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.
s/CountryCode
CountryCode Required: The country code for the
Yes* UPS account's pickup
address.
Type: String
Max Allowed:
1
Length: 2
/ShipmentConfirmRequest/Shipment/PaymentInformation/FreightCollect
FreightCollect Required: Container for the Freight This element or its sibling element Prepaid or
Cond Collect billing option. BillThirdParty must be present, but no more than
one can be present. Only allowed for shipment
Type:
without return service.
Container
Max Allowed:
1
Length: N/A
/ShipmentConfirmRequest/Shipment/PaymentInformation/FreightCollect/BillReceiver
BillReceiver Required: Container for billing the
Cond consignee all freight
charges option.
Type:
Container
Max Allowed:
1
Length: N/A

/ShipmentConfirmRequest/Shipment/PaymentInformation/FreightCollect/BillReceiver/AccountNumber
AccountNumb Required: The UPS account number The account must be a valid UPS account number
er Yes* of Freight Collect. that is active.
Type: String For US, PR and CA accounts, the account must be
either a daily pickup account, or an occasional
Max Allowed:
account, a customer B.I.N account, or a dropper
1
shipper account.
Length: 6
/ShipmentConfirmRequest/Shipment/PaymentInformation/FreightCollect/BillReceiver/Address
Address Required: No Container for additional
information for the bill
Type:
receiver's UPS account
Container
address.
Max Allowed:
1
Length: N/A
/ShipmentConfirmRequest/Shipment/PaymentInformation/FreightCollect/BillReceiver/Address/PostalCode
PostalCode Required: The postal code for the The postal code must be the same as the UPS
Cond UPS account's pickup account pickup address postal code. Required for
address. The pickup United States and Canadian UPS accounts and/or
Type: String
postal code was entered if the UPS account pickup address has a postal
Max Allowed: in the UPS system when code.
1 the account was set-up.
Length: 1..10 Rico, the postal code is 5 or 9 digits.
and # is a digit.
/ShipmentConfirmRequest/Shipment/PaymentInformation/ConsigneeBilled
ConsigneeBill Required: Consignee Billing This element or its sibling element Prepaid or
ed Cond payment option indicator. FreightCollect or BillThirdParty must be present,
The presence indicates but no more than one can be present.
Type: String
consignee billing option is
Only applies to US/PR and PR/US shipment
Max Allowed: selected. The absence
origins and destination.
1 indicates one of the other
Length: 0 payment options is
selected.
ItemizedPaymentInformation

/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation
ItemizedPaymentI Required: Cond Payment This element or its sibling element,
nformation Type: Container information PaymentInformation, must be present but no more
Max Allowed: 1 container for than one can be present.
Length: N/A detailed shipment
charges. The two
shipment charges
that are available
for specification
are Transportation
charges and
Duties and Taxes.
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge
ShipmentCharge Required: Yes* Shipment charge If Duty and Tax charges are applicable to a
Type: Container container. shipment and a payer is not specified, the default
Max Allowed: 2 payer of Duty and Tax charges is Bill to Receiver.
Length: N/A
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/Type
Type Required: Yes* Values are: A shipment charge type of 01 = Transportation is
Type: String required.
Max Allowed: 1 01 =
Transportation A shipment charge type of 02 = Duties and Taxes is
Length: 2
not required; however, this charge type is invalid for
02 = Duties Qualified Domestic Shipments.
and Taxes
A Qualified Domestic Shipment is any shipment in
which one of the following applies:
1) The origin and destination country is the same,
2) US to PR shipment,
3) PR to US shipment,
4) The origin and destination country are both
European Union Countries and the
GoodsNotInFreeCirculation indicator is not present,
5) The origin and destination IATA code is the
same.
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillShipper
BillShipper Required: Cond Container for the This element or its sibling element, BillReceiver,
Type: Container BillShipper billing BillThirdParty or ConsigneeBilled, must be present
Max Allowed: 1 option. The three but no more than one can be present.
Length: N/A payment methods
that are available
for the Bill Shipper
billing option are
alternate payment
method, account
number, or credit
card.

/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillShipper/AccountNumber
AccountNumber Required: Cond UPS account Must be the same UPS account number as the one
Type: String number. provided in Shipper/ShipperNumber. Either this
Max Allowed: 1 element or the sibling elements CreditCard or
Length: 6 AlternatePaymentMethod must be provided, but all
may not be provided.
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillShipper/CreditCard
CreditCard Required: Cond Credit card Required if neither of the following is present:
Type: Container information
Max Allowed: 1 container.
mation/Prepaid/BillShipper/AccountNumber
Length: N/A
or
mation/Prepaid/BillShipper/AlternatePaymentMeth
od. Credit card payment is valid for shipments
without return service only.
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillShipper/CreditCard/Type
Type Required: Yes* Values are:
Type: String
Max Allowed: 1 01 = American
Length: 2 Express
03 = Discover
04 =
MasterCard
05 = Optima
06 = VISA
07 = Bravo
08 = Diners
Club
13 = Dankort
1 4 = Hipercard
15 = JCB
17 = Postepay
18 =
UnionPay/Expr
essPay
19 = Visa
Electron
20 = VPAY
21 = Carte
Bleue
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillShipper/CreditCard/Num
ber
Number Required: Yes* Credit Card
Max Allowed: 1
Length: 9..16

/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillShipper/CreditCard/Expi
rationDate
ExpirationDate Required: Yes* Format is Valid month values are 01-12 and valid year values
Type: String MMYYYY where are Present Year (Present Year + 10 years)
Max Allowed: 1 MM is the 2 digit
Length: 6 month and YYYY
is the 4 digit year.
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillShipper/CreditCard/Sec
urityCode
SecurityCode Required: Cond Three or four Valid values are 3 or 4 digit.
Type: String digits that can be
It is recommended to provide the security code if
Max Allowed: 1 found either on
credit card information is provided and when the
Length: 3..4 top of credit card
ShipFrom countries are other than the below
number or on the
mentioned countries:
back of credit
card. Number of Argentina, Bahamas, Costa Rica, Dominican Rep,
digits varies for Guatemala, Panama, Puerto Rico and Russia.
different type of
credit card.
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillShipper/CreditCard/Addr
ess
Address Required: Cond Container to hold Required if credit card information is provided and
Type: Container the Credit card ShipFrom countries are US, CA and PR.
Max Allowed: 1 Billing Address.
Length: N/A
ess/AddressLine1
AddressLine1 Required: Yes* Address Line 1 of
Type: String the credit card
Max Allowed: 1 billing address.
Length: 1..35 Usually Street
address
information.
ess/AddressLine2
AddressLine2 Required: No Address Line 2 of
Max Allowed: 1 billing Address.
Length: 1..35 Usually
Room/Floor
information.
ess/AddressLine3
AddressLine3 Required: No Address Line 3 of
Max Allowed: 1 billing address.
Length: 1..35 Usually
department
information.

ess/City
City Required: Yes* City of the credit
Type: String card billing
Max Allowed: 1 address.
Length: 1..30
ess/StateProvinceCode
StateProvinceCod Required: Yes* State or province
e Type: String code of the credit
Max Allowed: 1 card billing
Length: 2..5 address.
ess/PostalCode
PostalCode Required: Yes* Credit card billing
Type: String addressee postal
Max Allowed: 1 code.
Length: 1..10
ess/CountryCode
CountryCode Required: Yes* Credit card billing Must be a valid UPS Billing country code. For
Type: String address country Discover card it should be US.
Max Allowed: 1 code.
Length: 2
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillShipper/AlternatePayme
ntMethod
AlternatePayment Required: Cond Valid value for Paypal 01: It is valid only for forward shipments. It
Method Type: String Alternate Payment is not valid for Return or Import Control shipments.
Max Allowed: 1 Method is "01" -
Either this element or one of the sibling elements
Length: 2 PayPal
CreditCard or AccountNumber must be provided,
but all of them may not be provided.
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillReceiver
BillReceiver Required: Cond Container for the This element or its sibling element, BillShipper,
Type: Container BillReceiver BillThirdParty or ConsigneeBilled, must be present
Max Allowed: 1 billing option. but no more than one can be present.
Length: N/A
For a return shipment, BillReceiver is invalid for
Transportation charges.
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillReceiver/AccountNumbe
r
AccountNumber Required: Yes* The UPS account The account must be a valid UPS account number
Type: String number. that is active. For US, PR and CA accounts, the
Max Allowed: 1 account must be either a daily pickup account, an
Length: 6 occasional account, a customer B.I.N account, or a
dropper shipper account.

/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillReceiver/Address
Address Required: No Container for
Type: Container additional
Max Allowed: 1 information for the
Length: N/A bill receiver's UPS
account address.
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillReceiver/Address/Postal
Code
PostalCode Required: Cond The postal code The postal code must be the same as the UPS
Type: String for the UPS account pickup address postal code. Required for
Max Allowed: 1 account's pickup United States and Canadian UPS accounts and/or
Length: 1..10 address. The if the UPS account pickup address has a postal
pickup postal code.
code was entered
in the UPS system
Rico, the postal code is 5 or 9 digits. The character
when the account
- may be used to separate the first five digits and
was set-up.
and # is a digit.
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillThirdParty
BillThirdParty Required: Cond Container for the This element or its sibling element, BillShipper,
Type: Container third party billing BillReceiver or ConsigneeBilled, must be present
Max Allowed: 1 option. but no more than one can be present.
Length: N/A
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillThirdParty/BillThirdParty
Shipper
BillThirdPartyShip Required: Cond Container for the This element or its sibling element,
per Type: Container shipper third party BillThirdPartyConsignee, must be present but no
Max Allowed: 1 billing option. more than one can be present.
Length: N/A
Shipper/AccountNumber
Type: String number of the that is active.
Max Allowed: 1 third party shipper.
For US, PR and CA accounts, the account must be
Length: 6
shipper account.
Shipper/ThirdParty
ThirdParty Required: Yes* Container for
Length: N/A third party
shipper's UPS
account.

Shipper/ThirdParty/Address
Address Required: Yes* Container for
shipper's UPS
account address.
Shipper/ThirdParty/Address/PostalCode
Type: String for the UPS account pickup address postal code.
Max Allowed: 1 account's pickup
Required if United States and Canadian UPS
Length: 1..10 address. The
accounts and/or if the UPS account pickup address
pickup postal
has a postal code.
code was entered
in the UPS system If the UPS account's pickup country is US or Puerto
when the account Rico, the postal code is 5 or 9 digits. The character
was set-up. - may be used to separate the first five digits and
and # is a digit.
Shipper/ThirdParty/Address/CountryCode
CountryCode Required: Yes* The country code
Type: String for the UPS
Length: 2 address.
Consignee
BillThirdPartyCon Required: Cond Container for the This element or its sibling element,
signee Type: Container consignee third BillThirdPartyShipper, must be present but no more
Max Allowed: 1 party billing than one can be present.
Length: N/A option.
Consignee/AccountNumber
Type: String number of the that is active.
Max Allowed: 1 third party
For US, PR and CA accounts, the account must be
Length: 6 consignee.
shipper account.

Consignee/ThirdParty
ThirdParty Required: Yes* Container for
consignee's UPS
account.
Consignee/ThirdParty/Address
Address Required: Yes* Container for
consignee's UPS
account address.
Consignee/ThirdParty/Address/PostalCode
Type: String for the UPS account pickup address postal code.
Required for United States and Canadian UPS
Length: 1..10 address. The
accounts and/or if the UPS account pickup address
pickup postal
has a postal code.
code was entered
in the UPS system If the UPS account's pickup country is US or Puerto
when the account Rico, the postal code is 5 or 9 digits. The character
was set-up. - may be used to separate the first five digits and
and # is a digit.
Consignee/ThirdParty/Address/CountryCode
CountryCode Required: Yes* The country code
Type: String for the UPS
Length: 2 address.
/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/ConsigneeBilled
ConsigneeBilled Required: Cond Consignee Billing This element or its sibling element, BillShipper,
Type: String payment option BillReceiver or BillThirdParty, must be present but
Max Allowed: 1 indicator. The no more than one can be present.
Length: 0 presence
This billing option is valid for a shipment charge
indicates
type of Transportation only. Only applies to US/PR
consignee billing
and PR/US shipment origins and destination.
option is selected.
The absence
indicates one of
the other payment
options is
selected.

/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/SplitDutyVATIndicator
SplitDutyVATIndic Required: No Split Duty VAT The payment method for Transportation charges
ator Type: String Indicator. The must be UPS account. The UPS account must be a
Max Allowed: 1 presence daily pickup account or an occasional account.
Length: 0 indicates the
payer specified for
Transportation
Charges will pay
transportation
charges and any
duties that apply
to the shipment.
The payer
specified for
Duties and Taxes
will pay the VAT
(Value-Added
Tax) only.
GoodsNotInFreeCirculationIndicator

/ShipmentConfirmRequest/Shipment/GoodsNotInFreeCirculationIndicator
GoodsNotInFreeCirculationIndicator Required: No Goods Not In Free This indicator is invalid for
Type: String Circulation indicator. a package type of UPS
Max Allowed: 1 Letter and
Length: 0 DocumentsOnly.
RateInformation

/ShipmentConfirmRequest/Shipment/RateInformation
RateInformation Required: No Rate information container.
Type: Container
Max Allowed: 1
Length: N/A

/ShipmentConfirmRequest/Shipment/RateInformation/NegotiatedRatesIndicator
NegotiatedRatesIndicator Required: No Negotiated Rates option Negotiated Rates are of two
Type: String indicator. If the indicator is types Account Based Rates
Max Allowed: 1 present and the Shipper is (ABR) and Web Discount
Length: 0 authorized then Negotiated Rates. Negotiated Rates are
Rates should be returned in the only returned for qualified
response. Shipper Account Numbers.
Eligibility is determined using
the combination of Userid and
the Shipper's Shipper Account
Number.
If the user is qualified, both
Published rates and
Negotiated rates are returned
to the user.
If the Userid and Shipper
Account Number are not
qualified for Negotiated rates,
a warning message is
returned that indicates
ineligibility and only the
Published rates are returned
in the response.
As per discount eligibility of
user, negotiated rates in the
response may contain ABR or
Web discount
rates.Conditionally required
for SDS shipment.
/ShipmentConfirmRequest/Shipment/RateInformation/RateChartIndicator
RateChartIndicator Required: No RateChartIndicator, if present in
Type: String request, response will contain
Max Allowed: 1 RateChart element.
Length: 0
MovementReferenceNumber

/ShipmentConfirmRequest/Shipment/MovementReferenceNumber
MovementReferenceNumber Required: No Movement Reference Number Must contain alphanumeric
Type: String (MRN) information. characters only. Must be a
Max Allowed: 1 length of 18 characters. The
Length: 18 3rd and 4th Characters must
be the Shipper country ISO
Code.
ReferenceNumber

/ShipmentConfirmRequest/Shipment/ReferenceNumber
ReferenceNumber Required: No Reference Number information For Mail Innovation shipments
Type: Container container. reference number is not
Max Allowed: 2 supported.
Length: N/A
/ShipmentConfirmRequest/Shipment/ReferenceNumber/BarCodeIndicator
BarCodeIndicator Required: No If the indicator is present then the Allowed for shipment with return
Type: String reference numbers value will be service only. Only one shipment-
Max Allowed: 1 bar coded on the label. level or package-level reference
Length: 0 number can be bar coded per
shipment.
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/Shipment/ReferenceNumber/Code
Code Required: Yes* Shipment Reference number type Valid if the origin/destination
Type: String code. The code specifies the pair is not US/US or PR/PR, 2
Max Allowed: 1 Reference name. character alpha-numeric.
Length: 2
/ShipmentConfirmRequest/Shipment/ReferenceNumber/Value
Value Required: Yes* Customer supplied reference Valid if the origin/destination
Type: String number. pair is not US/US or PR/PR.
Max Allowed: 1
Length: 1..35
Service

/ShipmentConfirmRequest/Shipment/Service
Service Required: Yes UPS service type.
Type: Container
Max Allowed: 1
Length: N/A

/ShipmentConfirmRequest/Shipment/Service/Code
Code Required: Yes Values are: The following Services are not
Type: String available to return shipment:
Max Allowed: 1 01 = Next Day Air
Length: 2 02 = 2nd Day Air 13 - Next Day Air Saver
03 = Ground 59 - 2nd Day Air A.M.
07 = Express 82 = UPS Today Standard
08 = Expedited 83 = UPS Today Dedicated
Courier 84 = UPS Today
11 = UPS Standard Intercity
12 = 3 Day Select 85 = UPS Today Express
13 = Next Day Air Saver 86 = UPS Today Express
Saver
14 = UPS Next Day Air Early
54 = Express Plus
59 = 2nd Day Air A.M.
65 = UPS Saver
70 = UPS Access Point
Economy
M2= First Class Mail
M3 = Priority Mail
M4 = Expedited MaiI Innovations
M5 = Priority Mail Innovations
M6 = Economy Mail Innovations
82 = UPS Today Standard
83 = UPS Today Dedicated
Courier
84 = UPS Today Intercity
85 = UPS Today Express
86 = UPS Today Express Saver
96 = UPS Worldwide Express
Freight.
/ShipmentConfirmRequest/Shipment/Service/Description
Description Required: No Description of the service code.
Type: String Examples are Next Day Air,
Max Allowed: 1 Worldwide Express, and Ground.
Length: 1..35
InvoiceLineTotal

/ShipmentConfirmRequest/Shipment/InvoiceLineTotal
InvoiceLineTotal Required: Cond Container for Invoice Line Total. Required for forward shipments
Type: Container whose origin is the US and
Max Allowed: 1 destination is Puerto Rico or
Length: N/A Canada. Not available for any
other shipments.
FOR OTHER DESTINATIONS
the InvoiceLineTotal in the
International Forms Container
must be used.
/ShipmentConfirmRequest/Shipment/InvoiceLineTotal/CurrencyCode
CurrencyCode Required: No Invoice Line Total currency type. Refer to Origin Country
Type: String Defaults to the currency used in the Information table.
Max Allowed: 1 shippers country.
Length: 3
/ShipmentConfirmRequest/Shipment/InvoiceLineTotal/MonetaryValue
MonetaryValue Required: Yes* Invoice Line Total amount for the Valid values are from 1 to
Type: String entire shipment. 99999999
Max Allowed: 1
Length: 1..19
NumOfPiecesInShipment

/ShipmentConfirmRequest/Shipment/NumOfPiecesInShipment
NumOfPiecesInShipment Required: Cond Total number of pieces in all Valid values are 1 to 99999.
Type: String pallets in a UPS World Wide
Max Allowed: 1 Express Freight Shipment.
Length: 15
It is required for UPS World Wide
Express Freight Shipment.
USPSEndorsement

/ShipmentConfirmRequest/Shipment/USPSEndorsement
USPSEndorsement Required: Cond USPS Endorsement valid value: Required for Mail Innovations
Type: String forward shipments.
Max Allowed: 1 1 = Return Service Requested
Length: 1 2 = Forwarding Service
Requested
3 = Address Service Requested
4 = Change Service Requested
5 = No Service Selected.
Note: For International Mail
Innovations shipments use No
Service Selected. International Mail
Innovations shipments are
applicable for Priority Mail
Innovations and Mail Innovations
Economy Mail Innovations services
only.
MILabelCN22Indicator

/ShipmentConfirmRequest/Shipment/MILabelCN22Indicator
MILabelCN22Indicator Required: No Indicates single label with both MI International CN22 form is
Type: String label and CN22 form. required.
Max Allowed: 1
Length: 0
SubClassification

/ShipmentConfirmRequest/Shipment/SubClassification
SubClassification Required: A component encoded on the SubClass is only required if the
Cond barcode of the Mail Innovations customers contract have them
Type: String label. Supported values are: subclass the package not UPS.
Max Allowed: 1
IR = Irregular
Length: 2
MA = Machineable
CostCenter

/ShipmentConfirmRequest/Shipment/CostCenter
CostCenter Required: Customer assigned identifier for report Required only for Mail Innovations
Cond and billing summarization, it is forward shipments. Alpha numeric
Type: String displayed to the right of the Cost values only.
Max Allowed: Center title.
1
Length: 130
ShipmentServiceOptions

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions
ShipmentServiceOptions Required: No Container for Shipment Service
Type: Container Options.
Max Allowed: 1
Length: N/A
SaturdayDelivery

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/SaturdayDelivery
SaturdayDelivery Required: No Saturday delivery indicator. The Available to all shipment types.
Type: String presence indicates Saturday
Max Allowed: 1 delivery, the absence indicates
Length: 0 not Saturday delivery.
COD

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/COD
COD Required: No COD container. Indicates COD is requested.
Type: Container Shipment COD is only
Max Allowed: 1 available for EU origin
Length: N/A countries and for shipper's
account type Daily Pickup
and Drop Shipping. Not
available to shipment with
return service.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/COD/CODCode
CODCode Required: Yes* COD type value.
Type: String
Valid value: 3 = Tagless COD
Max Allowed: 1
Length: 1
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/COD/CODFundsCode
CODFundsCode Required: Yes* For valid values, refer toCOD
Type: String Supported Countries in the
Max Allowed: 1 Appendix.
Length: 1
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/COD/CODAmount
CODAmount Required: Yes* COD Amount container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/COD/CODAmount/CurrencyCode
CurrencyCode Required: No COD amount currency code
Type: String type. Defaults to the currency
Max Allowed: 1 used in the destination
Length: 3 country.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/COD/CODAmount/MonetaryValue
MonetaryValue Required: Yes* COD Amount.
Type: String
Max Allowed: 1
Length: 1..8
AccessPointCOD

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/AccessPointCOD
AccessPointCOD Required: No Access Point COD indicates Valid only for "01 - Hold For
Type: Container Access point COD is Pickup At UPS Access Point"
Max Allowed: 1 requested for a shipment. Shipment Indication type.
Length: N/A
Access Point Shipment COD
is valid only for countries
within E.U. Not valid with
(Shipment) COD.
Not available to shipment
with return service.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/AccessPointCOD/CurrencyCode
CurrencyCode Required: Yes* Access Point COD Currency
Type: String Code.
Max Allowed: 1
Length: 3
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/AccessPointCOD/MonetaryValue
MonetaryValue Required: Yes* Access Point COD Monetary
Type: String Value.
Max Allowed: 1
Length: 18
DeliverToAddresseeOnlyIndicator

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/DeliverToAddresseeOnlyIndicator
DeliverToAddresseeOnlyIndica Required: No Presence/Absence Indicator. Only valid for
tor Type: String Any value inside is ignored. Shipment Indication
Max Allowed: 1 DeliverToAddresseeOnlyIndica type "01 - Hold For
Length: 0 tor is shipper specified PickUp at UPS
restriction that requires the Access Point".
addressee to be the one who
takes final delivery of the "Hold
For PickUp at UPS Access
Point" package.
Presence of indicator means
shipper restriction will apply to
the shipment.
DirectDeliveryOnlyIndicator

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/DirectDeliveryOnlyIndicator
DirectDeliveryOnlyIndicator Required: No Presence/Absence This accessorial is not valid
Type: String Indicator. Any value inside with Shipment Indication
Max Allowed: 1 is ignored. Type:
Length: 0
Direct Delivery Only (DDO) "01 - Hold For Pickup At
accessorial in a request UPS Access Point" and
would ensure that delivery
"02 - UPS Access Point
is made only to the ship to
Delivery".
address on the shipping
label.
Notification

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification
Notification Required: No Container for the Quantum The shipment level
Type: Container View Notification (QVN) is notification is valid for
Max Allowed: Many valid for all shipments forward and return
(up to 3) including Return service, international shipments as
Length: N/A Import Control and well as for domestic
Returns Flexible Access. shipments (for US and
PR).
Valid return service types
are: ERL, PRL, PNM, RS1,
or RS3.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/NotificationCode
NotificationCode Required: Yes* The type of notification Return Notification or
Type: String requested.Valid Value: Label Creation Notification
Max Allowed: 1 is allowed for return
Length: 1 2 - Return Notification shipments only.
or Label Creation
Notification, QV In-transit Notification is
allowed for return
5 - QV In-transit shipments only. QV Ship
Notification Notification is allowed for
6 - QV Ship Notification forward moving shipments
only.
7 - QV Exception
VoiceMessage phone
Notification
number or Text message
8 - QV Delivery phone number or email
Notification address should be present
for ADL notification and
012 Alternate Delivery
UAP Shipper Notification.
Location Notification
013 -UAP Shipper
Notification
Note: QVN Exception
notification and return
notification are not
applicable to GFP.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMailMessage
EMailMessage Required: Yes* Container for the eMail
Type: Container message.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMailMessage/EMailAddress
EMailAddress Required: Yes* Email address where the Up to five email addresses
Type: String notification is sent. are allowed in the
Max Allowed: Many shipment for all the
(up to 5) Quantum View TM
Length: 1..50 notification. Up to two
email address for return
notification.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMailMessage/UndeliverableEMailA
ddress
UndeliverableEMailAddre Required: No The address where an The
ss Type: String undeliverable eMail UndeliverableEMailAddre
Max Allowed: 1 message is sent if the ss must occur only once in
Length: 1..50 eMail with the notification the shipment.
is undeliverable.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMailMessage/FromEMailAddress
FromEMailAddress Required: Cond The e-mail address Return Notification only.
Type: String specifies the Reply To E-
Max Allowed: 1 mail address. The From
Length: 1..50 field of the message
header contains
[email protected].
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMailMessage/FromName
FromName Required: No The name the email will The FromName must occur
Type: String appear to be from. only once in the shipment.
Max Allowed: 1 Defaults to the Shipper
Length: 1..35 Name.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMailMessage/Memo
Memo Required: No User defined text that will The Memo must occur only
Type: String be included in the eMail. once in the shipment.
Max Allowed: 1
Length: 1..150
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMailMessage/Subject
Subject Required: No The eMails subject. Return Notification only.
Type: String Defaults to text provided
Max Allowed: 1 by UPS.
Length: 1150

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMailMessage/SubjectCode
SubjectCode Required: No Specifies a reference code For return notification: If the
Type: String and reference number to subject code tag is not
Max Allowed: 1 display in the subject of provided and the subject
Length: 2 the Notification.The valid text is provided, the subject
subject codes are: of the notification will be
the subject text;
01 - Shipment
Reference Number 1 If the subject text is
provided and the subject
02 - Shipment code tag exists, then the
Reference Number 2 subject code value must
03 - package be 08.
Reference Number 1 If Subject code is 08,
04 - package subject text must exist.
Reference Number 2
08 - Subject Text
(Return Notification
only)
If a subject code is not
provided or provided
that refers to a
nonexistent reference
number, the subject will
default to shipment
Identification Number.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/VoiceMessage
VoiceMessage Required: Cond VoiceMessage container Valid only for Alternate
Type: Container is used for specifying Delivery Location
Max Allowed: 1 phone number for notification and UAP
Length: N/A receiving voice Alternate Shipper Notification.
Delivery Location
Notification or or UAP
Shipper Notification.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/VoiceMessage/PhoneNumber
PhoneNumber Required: Yes* Phone number for
Type: String receiving Voice Alternate
Max Allowed: 1 Delivery Location
Length: 115 Notification or UAP
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/TextMessage
TextMessage Required: Cond TextMessage container is VoiceMessage phone
Type: Container used for specifying phone number or Text message
Max Allowed: 1 number for receiving text phone number or email
Length: N/A Alternate Delivery address should be present
Location notification or for ADL notification and
UAP Shipper Notification. UAP Shipper Notification.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/TextMessage/PhoneNumber
PhoneNumber Required: Yes* Phone number for
Type: String receiving Text Alternate
Max Allowed: 1 Delivery Location
Length: 115 notification or UAP
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/Locale
Locale Required: Cond This container is used for Valid only for Alternate
Type: Container providing Language and Delivery Location
Max Allowed: 1 dialect details for Alternate notification and UAP
Length: N/A Delivery Location Shipper Notification.
Notifications or UAP
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/Locale/Language
Language Required: Yes* Valid Language. Refer to Language /
Type: String Dialect Combinations in
Max Allowed: 1 the Appendix for valid
Length: 3 values.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/Notification/Locale/Dialect
Dialect Required: Yes* Valid Dialect. Refer to Language /
Length: 2 values.
LabelDelivery

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery
LabelDelivery Required: No Container for the Label Valid for shipments with an
Type: Container Delivery accessorial. Electronic Return Label
Max Allowed: 1 Return Service.
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMailMessage
EMailMessage Required: No Container for the eMail
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMailMessage/EMailAddress
EMailAddress Required: Yes* The destination eMail
Type: String address for the Label
Max Allowed: 1 Delivery.
Length: 1..50
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMailMessage/UndeliverableEMai
lAddress
UndeliverableEMailAddre Required: No The address where an Defaults to
ss Type: String undeliverable eMail FromEMailAddress.
Max Allowed: 1 message is sent if the
Length: 1..50 Label Delivery email is
undeliverable.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMailMessage/FromEMailAddress
FromEMailAddress Required: Yes* The e-mail address
Type: String specifies the Reply To E-
Max Allowed: 1 mail address. The From
Length: 1..50 field of the message
header contains
[email protected].
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMailMessage/FromName
FromName Required: No The name notification will
Type: String appear to be from.
Max Allowed: 1
Defaults to the Shipper
Length: 1..35
Name.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMailMessage/Memo
Memo Required: No User defined text that will
Type: String be included in the eMail.
Max Allowed: 1
Length: 1..150
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMailMessage/Subject
Subject Required: No The eMails subject.
Type: String Defaults to the 'Label
Max Allowed: 1 Delivery Notification' plus
Length: 1150 the shipment ID. (Defaults
to text provided by UPS).
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMailMessage/SubjectCode
SubjectCode Required: No Specifies a reference code If the subject code tag is
Type: String and reference number to not provided and the
Max Allowed: 1 display in the subject of subject text is provided, the
Length: 2 the Label Delivery subject of the notification
notification. When the will be the subject text;
subject code is provided,
If the subject text is
the subject will contain the
provided, and the subject
following:
code tag exists, then the
. UPS Label Delivery subject code value must
2. The reference code (the be 08;
reference code will be If Subject code is 08,
mapped to the subject text must exist. If a
corresponding ANSI subject code is provided
value) that refers to a nonexistent
3. Plus the reference reference number, the
number subject will default to the
shipment identification
number.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/LabelLinksIndicator
LabelLinksIndicator Required: No Indicates the Label and
Type: String Receipt URL's links that
Max Allowed: 1 needs to be returned in the
Length: 0 XML response.
InternationalForms

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms
InternationalForms Required: No International Forms
Type: Container information.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/FormType
FormType Required: Yes* Indicates the name of the Valid values:
Type: String International Form
Max Allowed: UNB requested. 01 - Invoice
Length: 2 03 - CO
04 - NAFTA CO
05 - Partial Invoice
06 Packing list
07 - Customer
Generated Forms
08 Air Freight Packing
List
09 - CN22 Form
0 UPS Premium Care
Form
1 - EEI. For shipment with
return service
01, 05 or 10 are the only
valid values
Note: 01 and 05 are
mutually exclusive and 05
are only valid for return
shipments only.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UserCreatedForm
UserCreatedForm Required: Cond The data container for Required if Form Type is
Type: Container DocumentID(s). 07.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UserCreatedForm/DocumentI
D
DocumentID Required: Yes* DocumentID represents a
Type: String document uploaded to
Max Allowed: 13 Forms History.
Length: 26

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form
CN22Form Required: Cond Container for the CN22 Required if the customer
Type: Container form. wants to use the UPS
Max Allowed: 1 generated CN22.
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/LabelSize
LabelSize Required: Yes* Provide the legal values 6 Required if the CN22 form
Type: String = 4X6 or 1 = 8.5X11. container is present.
Max Allowed: 1
Length: 2
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/PrintsPerPage
PrintsPerPage Required: Yes* Number of label per page. Required if the CN22 form
Type: String Currently 1 per page is container is present.
Max Allowed: 1 supported.
Length: 1
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/LabelPrintType
LabelPrintType Required: Yes* Legal Values are pdf, png, Required if the CN22 form
Type: String gif, zpl, star, epl2 and spl container is present
Max Allowed: 1
Length: 4
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Type
CN22Type Required: Yes* Legal Values are Required if the CN22 form
Type: String 1 = GIFT container is present
Max Allowed: 1 2 = DOCUMENTS
Length: 1 3 = COMMERCIAL
SAMPLE
4 = OTHER
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22OtherDescri
ption
CN22OtherDescription Required: Cond Required if CN22Type is Required if the Cn22 type
Type: String OTHER is selected as OTHER
Max Allowed: 1
Length: 20
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/FoldHereText
FoldHereText Required: No String will replace default
Type: String "Fold Here" text displayed
Max Allowed: 1 on the label.
Length: 135
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content
CN22Content Required: Yes* Container for CN22 Required if the CN22 form
Type: Container content. container is present.
Max Allowed: 3
Note: The maximum
Length: N/A
number of goods printed
on the CN22 form when a
combined MI package and
CN22 form label is
requested is one

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN
22ContentQuantity
CN22ContentQuantity Required: Yes* Total number of items Required if the CN22 form
Type: String associated with this container is present.
Max Allowed: 1 content.
Length:
22ContentDescription
CN22ContentDescription Required: Yes* Detailed description of the Required if the CN22 form
Type: String content. container is present.
Max Allowed: 1
Length: 1105
22ContentWeight
CN22ContentWeight Required: Yes* Container for CN22
Type: Container content weight.
Max Allowed: 1
Length: N/A
22ContentWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container for UOM.
Type: Container
Max Allowed: 1
Length: N/A
22ContentWeight/UnitOfMeasurement/Code
Code Required: Yes* Required if weight is Required if weight is
Type: String provided, Legal values are provided.
Max Allowed: 1 lbs and ozs.
Length: 3
22ContentWeight/UnitOfMeasurement/Description
Description Required: No Short description for
Type: String UnitOfMeasurement.
Max Allowed: 1
Length: 150
22ContentWeight/Weight
Weight Required: Yes* Total weight of the content. Required if the CN22 form
Type: String Pounds and Ounces are container is present.
Max Allowed: 1 allowed up to 2 decimals.
Length: 7
22ContentTotalValue
CN22ContentTotalValue Required: Yes* Total value of the items Required if the CN22 form
Type: String associated with this container is present.
Max Allowed: 1 content.
Length: 9

22ContentCurrencyCode
CN22ContentCurrencyCo Required: Yes* Currently only USD is Required if the CN22 form
de Type: String supported. container is present.
Max Allowed: 1
Length: 3
22ContentCountryOfOrigin
CN22ContentCountryOfOr Required: No Country of Origin from
igin Type: String where the CN22 contents
Max Allowed: 1 originated.
Length: 2
22ContentTariffNumber
CN22ContentTariffNumber Required: No The tariff number
Type: String associated with the CN22
Max Allowed: 1 contents.
Length: 40

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm
UPSPremiumCareForm Required: Cond UPS Premium Care Form Valid only for Canda to
Type: Container is required if Canada movements.
Max Allowed: 1 UPSPremiumCareIndicato
Length: N/A r is present on a package.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/Ship
mentDate
ShipmentDate Required: Yes* Shipment Date associated
Type: String with UPS Premium Care
Max Allowed: 1 Shipment.
Length: N/A
Valid Format: YYYYMMDD
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/Page
Size
PageSize Required: Yes* Size of Valid values: 01 = A4 Size,
Type: String UPSPremiumCareForm. 02 = Letter Size.
Max Allowed: 1
Length: 2
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/PrintT
ype
PrintType Required: Yes* Format of Valid values: 01 = PNG, 02
Type: String UPSPremiumCareForm. = PDF.
Max Allowed: 1
Length: 2

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/Num
OfCopies
NumOfCopies Required: Yes* Number of Copies of Valid value is 02.
Type: String UPSPremiumCareForm.
Max Allowed: 1
Length: 2
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/Lang
uageForUPSPremiumCare
LanguageForUPSPremiu Required: Yes* Container to hold
mCare Type: Container languages in which
Max Allowed: 1 UPSPremiumCareForm is
Length: N/A required.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/Lang
uageForUPSPremiumCare/Language
Language Required: Yes* Languages for Valid values: eng = US
Type: String UPSPremiumCareForm. English, fra = Canadian
Max Allowed: 2 Two languages are French.
Length: 3 required for UPS Premium
Care Form.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/AdditionalDocumentIndicator
AdditionalDocumentIndica Required:
tor Type: String
Max Allowed: 1
Length:
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/FormGroupIdName
FormGroupIdName Required: No Contains description text
Type: String that identifies the group of
Max Allowed: 1 International forms. This
Length: 1...50 element does not appear
on the forms.
InternationalForms continued, Contacts

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts
Contacts Required: Cond Holds the contact Applicable for EEI and
Type: Container information of various NAFTA CO only. Required
Max Allowed: 1 parties. for NAFTA CO and EEI.
Length: N/A
Ultimate consignee contact
information is required for
EEI. Producer contact
information is required for
NAFTA CO
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent
ForwardAgent Required: No The forwarding agent is Applicable for EEI form
Type: Container the company or person only.
Max Allowed: 1 acting as agent in the
Length: N/A trans-shipping of freight to
the destination country.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Comp
anyName
CompanyName Required: Yes* Company Name or the Applicable for EEI form
Type: String Individual name of the only.
Max Allowed: 1 Forwarding agent.
Length: 135
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/TaxId
entificationNumber
TaxIdentificationNumber Required: Yes* Tax ID of the Forwarding Applicable for EEI form
Type: String agent. only.
Max Allowed: 1
Length: 115
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Addre
ss
Address Required: Yes* Address information of the Applicable for EEI form
Type: Container Forwarding agent. only.
Max Allowed: 1
Length: N/A
ss/AddressLine1
AddressLine1 Required: Yes* Address line 1 of the Applicable for EEI form
Type: String Forwarding agent. only.
Max Allowed: 1
Length: 1..35
ss/AddressLine2
Type: String Forwarding agent. Usually only.
Max Allowed: 1 Room/Floor information.
Length: 135
ss/AddressLine3
Type: String Forwarding agent. Usually only.
Max Allowed: 1 department information.
Length: 135
ss/City
City Required: Yes* City of the Forwarding Applicable for EEI form
Type: String agent. only.
Max Allowed: 1
Length: 130
ss/StateProvinceCode
StateProvinceCode Required: Cond State of the Forwarding Applicable for EEI form
Type: String agent. only. Required for certain
Max Allowed: 1 countries.
Length: 15

ss/PostalCode
PostalCode Required: Yes* Postal code of the Applicable for EEI form
Type: String Forwarding agent. only. Required for certain
Max Allowed: 1 countries. The length of the
Length: 19 postal code depends on
the country code.
ss/CountryCode
CountryCode Required: Yes* Country code of the Applicable for EEI form
Type: String Forwarding agent. only.
Max Allowed: 1
Length: 2
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee
UltimateConsignee Required: Cond The ultimate consignee is Applicable for EEI form
Type: Container the person or company only.
Max Allowed: 1 who receives the goods for
Length: N/A end-use or the person or
company listed on the
export license. This is the
end-user of the goods.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/
CompanyName
Max Allowed: 1 Ultimate consignee.
Length: 135
Address
Type: Container Ultimate consignee. only.
Max Allowed: 1
Length: N/A
Address/AddressLine1
Type: String Ultimate consignee. only.
Max Allowed: 1
Length: 135
Max Allowed: 1 Usually Room/Floor
Length: 135 information.

Max Allowed: 1 Usually department
Address/City
City Required: Yes* City of the Ultimate Applicable for EEI form
Type: String consignee. only.
Max Allowed: 1
Length: 130
Address/StateProvinceCode
StateProvinceCode Required: Cond State of the Ultimate Applicable for EEI form
Type: String consignee. only. Required for certain
Length: 15
Address/PostalCode
PostalCode Required: Cond Postal code of the Ultimate Applicable for EEI form
Type: String consignee. only. Required for certain
the country code.
Address/CountryCode
Max Allowed: 1
Length: 2
UltimateConsigneeType
UltimateConsigneeType Required: No Container for providing Applicable for EEI form
Type: Container Ultimate consignee Type. only.
Max Allowed: 1
Length: N/A
UltimateConsigneeType/Code
Code Required: Yes* Ultimate Consignee Type Applicable for EEI form
Type: String Code. Values are: 'D' = only.
Max Allowed: 1 Direct Consumer;
Length: 1 'G'=Government Entity ;
'R'= Resellr ;
'O'=Other/Unknown

UltimateConsigneeType/Description
Description Required: No Ultimate Consignee Type Applicable for EEI form
Type: String Description. only.
Max Allowed: 1
Length: 120
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsig
nee
IntermediateConsignee Required: No The intermediate Applicable for EEI form
Type: Container consignee is the person or only.
Max Allowed: 1 company in the importing
Length: N/A country that makes final
delivery to the ultimate
consignee.
nee/CompanyName
Max Allowed: 1 Intermediate consignee.
Length: 135
nee/Address
Type: Container Intermediate Consignee. only.
Max Allowed: 1
Length: N/A
nee/Address/AddressLine1
Type: String Intermediate Consignee. only.
Max Allowed: 1
Length: 135
Max Allowed: 1 Usually Room/Floor
Max Allowed: 1 Usually department
nee/Address/City
City Required: Yes* City of the Intermediate Applicable for EEI form
Type: String Consignee. only.
Max Allowed: 1
Length: 130

nee/Address/StateProvinceCode
StateProvinceCode Required: Cond State of the Intermediate Applicable for EEI form
Type: String Consignee. only. Required for certain
Length: 15
nee/Address/PostalCode
PostalCode Required: Cond Postal code of the Applicable for EEI form
Type: String Intermediate Consignee. only. Required for certain
the country code.
nee/Address/CountryCode
Max Allowed: 1
Length: 2
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer
Producer Required: No Information of the Applies to NAFTA CO.
Type: Container producer. The NAFTA Required for NAFTA CO
Max Allowed: 1 Certificate of Origin must forms.
Length: N/A be completed, signed, and
dated by the exporter.
When the Certificate is
completed by the producer
for use by the exporter, it
must be completed,
signed, and dated by the
producer. The date must
be the date the Certificate
was completed and
signed.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Option
Option Required: No The text associated with Applies to NAFTA CO.
Type: String the code will be printed in Possible Values are:
Max Allowed: 1 the producer section
01 - AVAILABLE TO
Length: 2 instead of producer
CUSTOMS UPON
contact information.
REQUEST
Use attached List if more
02 - SAME AS EXPORTER
than one producers good
is included on the 03 - ATTACHED LIST
Certificate, attach a list of 04 - UNKNOWN
additional producers,
including the legal name,
address (including
country), and legal tax
identification number,
cross-referenced to the
goods described in the
Description of Goods field.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Company
Name
CompanyName Required: Yes* Company Name or the Applies to NAFTA CO|Only
Type: String Individual name of the applicable when producer
Max Allowed: 1 Producer. option is empty or not
Length: 135 present. Conditionally
required for: NAFTA CO,
when Producer option is
not specified.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/TaxIdentifi
cationNumber
TaxIdentificationNumber Required: Yes* Tax ID of the Producer. Applies to NAFTA CO.
Type: String Only applicable when
Max Allowed: 1 producer option is empty
Length: 115 or not present.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address
Address Required: No Address information of the Applies to NAFTA CO.
Type: Container Producer. Only applicable if producer
Max Allowed: 1 option is empty or not
Length: N/A present. Conditionally
required for: NAFTA CO,
when Producer option is
not specified.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/A
ddressLine1
AddressLine1 Required: Yes* Address line 1 of the Applies to NAFTA CO.
Type: String Producer.
Max Allowed: 1
Length: 135
ddressLine2
Type: String Producer. Usually
Max Allowed: 1 Room/Floor information.
Length: 135
ddressLine3
Type: String Producer. Usually
Max Allowed: 1 department information.
Length: 135
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/Ci
ty
City Required: Yes* City of the Producer. Applies to NAFTA CO.
Type: String Conditionally required for:
Max Allowed: 1 NAFTA CO, when
Length: 130 Producer option is not
specified.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/St
ateProvinceCode
StateProvinceCode Required: Cond State of the Producer. Applies to NAFTA CO.
Type: String Required for certain
Length: 15
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/P
ostalCode
PostalCode Required: Cond Postal code of the Applies to NAFTA CO.
Type: String Producer. Required for certain
the country code.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/C
ountryCode
CountryCode Required: Yes* Country code of the Applies to NAFTA CO.
Max Allowed: 1
Length: 2
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/AttentionN
ame
AttentionName Required: No The contact name of the
Max Allowed: 1
Length: 135
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Phone
Phone Required: No Phone Container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Phone/Nu
mber
Number Required: Yes* Phone Number of the
Max Allowed: 1
Length: 115
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Phone/Ext
ension
Extension Required: No Phone Extension of the
Max Allowed: 1
Length: 14
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/EMailAddr
ess
EMailAddress Required: No Email address of the
Max Allowed: 1
Length: 150
InternationalForms continued, Product

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product
Product Required: Yes* Contains the Applies to EEI, Invoice, Partial
Type: Container commodity/product Invoice, CO and NAFTA CO.
Max Allowed: 150 information. When any International form
Length: N/A is requested, at least one
Product must be present.
Maximum number of products
allowed for different forms are:
Commercial Invoice
NAFTA
CO
EEI 100
package Packing List 50
Air Freight packing list
1000
Note: For Partial Invoice this
container is optional.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Description
Description Required: Yes* Description of the Applies to all International
Type: String product. Forms. Optional for Partial
Max Allowed:3 Invoice. Must be present at
Length: 135 least once and can occur for a
maximum of 3 times.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit
Unit Required: Cond Container tag for the Required for Invoice forms
Type: Container units information of each and optional for Partial
Max Allowed: 1 product. (Also called as Invoice.
Length: N/A commodity)
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/Number
Number Required: Yes* Total quantity of each Required for Invoice forms
Type: String commodity to be shipped, and optional for Partial
Max Allowed: 1 measured in the units Invoice. Must be numeric.
Length: 17 specified in the Unit of Valid characters are 0-9.
Measure field.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/Value
Value Required: Yes* Monetary amount used to Applies to Invoice and Partial
Type: String specify the worth or price Invoice form. Required for
Max Allowed: 1 of the commodity. Amount Invoice forms and Partial
Length: 119 should be greater than Invoice forms.
zero.
Amount should be greater
than zero.
Valid characters are 0-9
and. (Decimal point).
Limit to 6 digits after the
decimal.
The maximum length of the
field is 19 including. and
can hold up to 6 decimal
places.
(#####.######,
######.#####,
#######.####,
########.###,
#########.##,##########.#
,############)
The value of this product

and the other products
should be such that the
invoice line total which is
the sum of (
number*values) of all
products should not
exceed
9999999999999999.99
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/UnitOfMeasurem
ent
UnitOfMeasurement Required: Yes* Container tag for the Unit Required for Invoice forms
Type: Container of measurement for the and optional for Partial
Max Allowed: 1 commodity. Invoice.
Length: N/A
ent/Code
Code Required: Yes* Code for the Unit of Applies to Invoice and partial
Type: String measurement of the invoice forms and is required.
Max Allowed: 1 commodity units.
Refer to Unit of Measure
Length: 13
Codes in the Appendix for
valid values.
ent/Description
Description Required: Cond The Unit of Measure if Applies to Invoice and Partial
Type: String OTH (Other) is entered as Invoice forms. Conditionally
Max Allowed: 1 the UnitOfMeasurement Required for the Invoice and
Length: 13 code. Partial Invoice form if OTH is
entered as the units
UnitOfMeasurement code.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/CommodityCode
CommodityCode Required: Cond 6-to-15-alphanumeric Applies to Invoice, Partial
Type: String commodity code. Invoice and NAFTA CO.
Max Allowed: 1 Customs uses this code
Required for NAFTA CO and
Length: 615 to determine what duties
optional for Partial Invoice.
should be assessed on
the commodity. Should be at least 6
alphanumeric.
For NAFTA CO: For each
good described in Description
of Goods field, identify the
H.S. tariff classification to six
digits.
If the good is subject to a
specific rule of origin in Annex
401 that requires eight digits,
identify to eight digits, using
the H.S. tariff classification of
the country into whose
territory the good is imported.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PartNumber
PartNumber Required: No The part number or Applies to Invoice and Partial
Type: String reference number for the Invoice.
Max Allowed: 1 product contained in the
Length: 110 invoice line, as indicated
on the customs invoice.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/OriginCountryCode
OriginCountryCode Required: Cond The country in which the Applies to Invoice, Partial
Type: String good was manufactured, Invoice, CO and NAFTA CO.
Max Allowed: 1 produced, or grown.
Length: 2 Required for Invoice and
For detailed information CO forms.
on country of origin,
certificate of origin, rules Optional for Partial Invoice.
of origin and any related Conditionally required for
matters, please refer to NAFTA CO if
the U.S. Customs and JointProductionIndicator is
Border Protection Web not present.
site at www.customs.gov
or contact your country's
Customs authority. For NAFTA CO, identify the
name of the country (MX or
US for agricultural and textile
goods exported to Canada;
US or CA for all goods
exported to Mexico; or CA or
MX for all goods exported to
the United States) to which
the preferential rate of
customs duty applies, as set
out in Annex 302.2, in
accordance with the Marking
Rules or in each party's
schedule of tariff elimination.
For all other originating goods
exported to Canada, indicate
appropriately MX or US if the
goods originate in that NAFTA
country, within the meaning of
the NAFTA Rules of Origin
Regulations, and any
subsequent processing in the
other NAFTA country does not
increase the transaction value
of the goods by more than
seven percent; otherwise use
the JointProductionIndicator
for joint production.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/JointProductionIndica
tor
JointProductionIndicator Required: No If present, JNT will be Applies to NAFTA CO only.
Type: String used as the origin of
Max Allowed: 1 country code on the
Length: 0 NAFTA form and the
Product/OriginCountryCo
de tag will be ignored.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NetCostCode
NetCostCode Required: Cond For each good described Applies to NAFTA CO only.
Type: String in the Description of
Required for NAFTA CO.
Max Allowed: 1 Goods field, where the
Length: 2 good is subject to a Possible Values: NC and NO.
regional value content
(RVC) requirement,
indicate NC if the RVC is
calculated according to
the net cost method;
otherwise, indicate NO.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NetCostDateRange
NetCostDateRange Required: No Date Range for regional Applies to NAFTA CO only.
Type: Container value content (RVC).
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NetCostDateRange/B
eginDate
BeginDate Required: Yes* If the RVC is calculated Applies to NAFTA CO only.
Type: String over a period of time, it Format is YYYYMMDD.
Max Allowed: 1 should be identified by
Length: 8 the begin date
(YYYYMMDD) of that
period. (Reference:
Articles 402.1, 402.5).
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NetCostDateRange/E
ndDate
EndDate Required: Yes* If the RVC is calculated Applies to NAFTA CO only.
Type: String over a period of time, it Format is YYYYMMDD.
Max Allowed: 1 should be identified by
Length: 8 the End date
(YYYYMMDD) of that
period. (Reference:
Articles 402.1, 402.5).
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PreferenceCriteria
PreferenceCriteria Required: Cond Indicates the criterion (A Applies to NAFTA CO only.
Type: String through F) for each good
Max Allowed: 1 described in the
Length: 1 Description of Goods field
if applicable.
The rules of origin are
contained in Chapter
Four and Annex 401.
Additional rules are
described in Annex 703.2
(certain agricultural
goods), Annex 300-B,
Appendix 6 (certain
textile goods) and Annex
308.1 (certain automatic
data processing goods
and their parts).

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProducerInfo
ProducerInfo Required: Cond Indicate the following: Applicable for NAFTA CO and
Type: String is required. Possible Values:
Yes - If shipper is the
Max Allowed: 1 Yes, No[1], No[2], No[3]
producer of the good. If
Length: 35
not, state 02, 03, and 04
depending on whether
this certificate was based
upon:
No [1] - Knowledge of
whether the good
qualifies as an originating
good.
No [2] - Reliance on the
producers written
representation (other
than a Certificate of
Origin) that the good
qualifies as an originating
good.
No [3] - A completed and
signed Certificate for the
good voluntarily provided
to the exporter by the
producer.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/MarksAndNumbers
MarksAndNumbers Required: No Any special marks, Applies to CO Only.
Type: String codes, and numbers that
Max Allowed: 1 may appear on package.
Length: 135
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NumberOfPackagesP
erCommodity
NumberOfPackagesPerC Required: Cond The total number of Applicable for CO and is
ommodity Type: String packages, cartons or required. Should be numeric.
Max Allowed: 1 containers for the Valid characters are 0 -9.
Length: 13 commodity.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProductWeight
ProductWeight Required: Cond The shipping weight, Applies to CO and EEI forms
Type: Container including containers, for only. Required for CO and EEI
Max Allowed: 1 each commodity with a forms.
Length: N/A separate Harmonized
Tariff Code / Schedule B
Number. This weight
does not include carrier
equipment.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProductWeight/UnitOf
Measurement
UnitOfMeasurement Required: Yes* Container tag for the Unit Applies to CO and EEI forms
Type: Container of Measurement of only. Required for CO and EEI
Max Allowed: 1 weight. forms.
Length: N/A

Measurement/Code
Code Required: Yes* Code for unit of Applies to CO and EEI forms
Type: String Measurement of weight. only. Possible values:
Max Allowed: 1 KGS/LBS.
Length: 3
Measurement/Description
Description Required: No Description of the Unit of
Type: String Measurement.
Max Allowed: 1
Length: 120
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProductWeight/Weigh
t
Weight Required: Yes* Weight of Product. Applies to CO and EEI forms
Type: String only.
Max Allowed: 1
Valid characters are 0-9 and.
Length: 15
(Decimal point).
Limit to 1 digit after the
decimal.
field is 5 including. and can
hold up to 1 decimal place.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/VehicleID
VehicleID Required: No Includes the following Applies to EEI forms only.
Type: String information for used self-
Max Allowed: 1 propelled vehicles as
Length: 125 defined in Customs
regulations 19 CFR
192.1:
The unique Vehicle
Identification Number
(VIN) in the proper format.
Or The Product
Identification Number
(PIN) for those used self
propelled vehicles for
which there are no VINs.
Or no Vehicle Title
Number.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB
ScheduleB Required: Cond Container tag for the Applies to EEI forms only.
Type: Container schedule B information of Required for EEI form.
Max Allowed: 1 a commodity.
Length: N/A

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/Number
Number Required: Yes* A unique 10-digit Applies to EEI forms only. Has
Type: String commodity classification to be 10 characters.
Max Allowed: 1 code for the item being
Length: 10 exported. (To classify a
commodity access the
following Web page:
http://www.census.gov/for
eign-
trade/schedules/b/#searc
h).
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/Quantity
Quantity Required: Cond The count of how many Applies to EEI forms only.
Type: String Schedule B units of the Conditionally required for EEI
Max Allowed: 1 current good are in the forms if ScheduleB
Length: 110 shipment (EEI only). UnitOfMeasurement is not X.
Should be Numeric. Valid
For example, if the
characters are 0 -9.
Schedule B unit of
measure is dozens and
eight dozen, is being
shipped, indicate 8 in this
field.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/UnitOfMe
asurement
UnitOfMeasurement Required: Yes* The unit of measure Applies to EEI forms only.
Type: Container indicated on the Export
Max Allowed: 1 License.
Length: N/A
asurement/Code
Code Required: Yes* The unit of measure Applies to EEI forms only.
Type: String indicated on the Export Required for the EEI form.
Max Allowed: 1 License.
Refer to EEI Unit of Measure
Length: 13
Enter an X if there is no Codes in the Appendix for
unit of measure in the valid values.
Schedule B Unit field.
asurement/Description
Description Required: Yes* Description of the Unit of Applies to EEI forms only.
Type: String Measure.
Max Allowed: 1
Length: 120

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ExportType
ExportType Required: Cond Code indicating Applies to EEI forms only.
Type: String Domestic: Exports that Required for EEI form.
Max Allowed: 1 have been produced, Possible Values: D -
Length: 1 manufactured or grown in Domestic, F - Foreign.
the United States or
Puerto Rico.
This includes imported
merchandise which has
been enhanced in value
or changed from the form
in which imported by
further manufacture or
processing in the United
States or Puerto Rico.
Foreign: Merchandise
that has entered the
United States and is
being exported again in
the same condition as
when imported.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/SEDTotalValue
SEDTotalValue Required: Cond This amount will always Applies to EEI forms only.
Type: String be USD. This attribute Required for EEI form. Valid
Max Allowed: 1 represents the characters are 0-9 and.
Length: 115 LicenseLineValue for (Decimal point). Limit to 2 digit
EEI. after the decimal.
field is 15 and can hold up to
2 decimal places.
Note: This value is calculated
based on the
Product/Unit/Value and
/Product/Unit/Number
(Number of Units * Price per
Unit).
If the total value is incorrect it
will be replaced by the actual
calculated total value.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ExcludeFromForm
ExcludeFromForm Required: No Container tag for If this container is not present
Type: Container determining whether or we assume that the DEFAULT
Max Allowed: 1 not to exclude product is selected which is "none"
Length: N/A information from a and all products will appear
particular form. on all forms.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ExcludeFromForm/Fo
rmType
FormType Required: Yes* Indicates the name of the Possible Values are 04
Type: String International form NAFTA CO.
Max Allowed:Unbounded requested to NOT have
Please note that if this is used
Length: 1 product information.
and you DO NOT have the
corresponding form type
requested this will be
IGNORED.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PackingListInfo
PackingListInfo Required: Cond Data Container holding Required for packaging list
Type: Container package related and Air Freight Packing list.
Max Allowed: 1 information.
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PackingListInfo/Pack
ageAssociated
PackageAssociated Required: Yes* Data Container holding Total product amount must
Type: Container package/product related equal the product unit value
Max Allowed: UNB information that will break above. Required for
Length: N/A up the product into each packaging list and Air Freight
package on the packing Packing list.
list.
ageAssociated/PackageNumber
PackageNumber Required: Yes* Package number the Required for packaging list
Type: String product should be and Air Freight Packing list.
Max Allowed: 1 allocated to on the
Length: N/A packing list.
ageAssociated/ProductAmount
ProductAmount Required: Yes* Amount of Product Required for packaging list
Type: String associated with a and Air Freight Packing list.
Max Allowed: 1 package.
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation
EEIInformation Required: Cond Required for EEI Form. Applies to EEI form only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/Export
Information
ExportInformation Required: Cond Required for EEI form id it Applies to EEI form only.
Type: String is a SDL product. Required if EEIFilingOption
Max Allowed: 1 code 3 specified for EEI form.
Valid values: LC, LV,
Length: 2
SS,MS, GS, DP, HR, UG,
IC, SC, DD, HH, SR,
TE,TL, IS, CR, GP, RJ,
TP, IP, IR, DB, CH, RS,
OS.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/Licens
e
License Required: Cond Licence information for Applies to EEI form only.
Type: Container SDL commodity.
Max Allowed: 1
Length: N/A
e/Number
Number Required: Cond Represents any one of Applies to EEI form only.
Type: String the following values:
Max Allowed: 1 export license number,
Length: 713 exception code, CFR
citation, KPC Number,
ACM Number.
Refer to EEI License
Codes in the Appendix
for valid values.
e/Code
Code Required: Cond The standard license Applies to EEI form only.
Type: String code published by US
It is required for
Max Allowed: 1 government.
EEIFilingOption code 3.
Length: 3
It is optionally required for all
other filing types; however, it
for valid values.
is used to categorize each
product as SDL or non-SDL.
It is also used to identify which
piece of information is
applicable.
e/LicenseLineValue
LicenseLineValue Required: Cond The export monetary Applies to EEI form only.
Type: String amount allowed per Required if EEIFilingOption
Max Allowed: 1 license. code 1A (only for SDL
Length: 110 shipments) or 3.
Required for a licensable
product when the EEI Format: Whole numbers only.
form is selected.
e/ECCNNumber
ECCNNumber Required: Cond Product ECCN Number Applies to EEI forms only. It is
Type: String issued by BIS (Bureau of required for EEIFilingOption
Max Allowed: 1 Industry and Security). code 3.
Length: 5
If the license number is a ECCN is required one of the
commerce license, ECCN following License Exception
must be provided. Codes is entered: CIV, CTP,
ENC, GBS, KMI, LVS, TSR.
The format is #A### or
EAR99

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTC
Information
DDTCInformation Required: Cond Department of State/ Applies to EEI form only.
Type: Container Directorate of Defense
Max Allowed: 1 Trade Control
Length: N/A Information.
This element is a
container for additional
information that is
applicable to SDL
products. It will only be
evaluated if the provided
license code is an SDL
code.
Information/ITARExemptionNumber
ITARExemptionNumber Required: Cond The specific citation Applies to EEI Form only. This
Type: String (exemption number) field is applicable for EEIFiling
Max Allowed: 1 under the International option 1A and 3.
Length: 310 Traffic in Arms
Regulations (ITAR) from
the Code of Federal
Register (see 22 CFR
120-130) that exempts
the shipment from the
requirements for a
license or other written
authorization from the
Directorate of Trade
Controls (DDTC).
for valid values.
Information/USMLCategoryCode
USMLCategoryCode Required: Cond Digit numeric code (e.g. Applies to EEI form only. It is
Type: String 01-18, 20 or 21). required for EEIFilingOption
Max Allowed: 1 Indicates the U.S. code 3.
Length: 2 Munitions List (USML)
category article, service
or related technical data
as it applies to the article
reported.
Information/EligiblePartyIndicator
EligiblePartyIndicator Required: No Presence/Absent Applies to EEI form only.
Type: String indicator. Certification by
Max Allowed: 1 the U.S. exporter that the
Length: 0 exporter is an eligible
party to participate in the
defense trade.

Information/RegistrationNumber
RegistrationNumber Required: Cond It is a unique registration It is required for
Type: String code assigned to the EEIFilingOption code 3.
Max Allowed: 1 registrant. The DDTC
Length: 6 registration code consist
of a letter prefix, M
(assigned to a
manufacturer and/or
exporter) or K (assigned
to a broker), followed by
four or five digits (e.g. K-
1234 or M12345).
Information/Quantity
Quantity Required: Cond Export Quantity. Applies to EEI form only. It is
Type: String required for EEIFilingOption
Max Allowed: 1 code 3. Only positive integer
Length: 17 value is valid.
Information/UnitOfMeasurement
UnitOfMeasurement Required: Cond Container for unit of Applies to EEI form only. It is
Type: Container measurement. required for EEIFilingOption
Max Allowed: 1 code 3.
Length: N/A
Information/UnitOfMeasurement/Code
Code Required: Cond Required for EEI form. Applies to EEI form only. It is
Type: String Unit of measurement required for EEIFilingOption
Max Allowed: 1 code. The two or three (3) code 1A and 3.
Length: 23 alpha unit of
measurement for the
article being shipped. For
example: BAG/BG - bags.
Information/UnitOfMeasurement/Description
Description Required: No Unit of measurement Applies to EEI form only. It is
Type: String description. required for EEIFilingOption
Max Allowed: 1 code 3.
Length: 115
Information/SignificantMilitaryEquipmentIndicator
SignificantMilitaryEquipm Required: No Presence/Absence Applies to EEI form only.
entIndicator Type: String Indicator.
Max Allowed: 1
Length: 0

Information/ACMNumber
ACMNumber Required: Cond Approved Community Applies to EEI form only. It is
Type: String Member Number (ACM). required for EEIFilingOption
Max Allowed: 1 It is required to be code 1A and 3.
Length: 11 provided along with
ITARExemptionNumber
for some License code
(SGB and SAU).
The ACM# for the United
Kingdom (License code
SGB) must begin with UK
followed by 9 numbers.
The ACM# for Australia
(License Code SAU)
must begin with DTT
followed by 8 numbers.
InternationalForms continued, starting with InvoiceNumber

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/InvoiceNumber
InvoiceNumber Required: No Commercial Invoice Applies to Invoice and
Type: String number assigned by the Partial Invoice forms only.
Max Allowed: 1 exporter.
Length: 135
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/InvoiceDate
InvoiceDate Required: Cond Date when the Invoice is Applies to Invoice and
Type: String created. Ideally this is the Partial Invoice forms only.
Max Allowed: 1 same as the ship date. Optional for Partial Invoice.
Length: 8 Required for Invoice form
for forward shipments.
For shipment with return
service, the user input will
be ignored, and the field
will be blank on the
invoice. Format is
YYYYMMDD
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/PurchaseOrderNumber
PurchaseOrderNumber Required: No The customer's order Applies to Invoice and
Type: String reference number. Partial Invoice forms.
Max Allowed: 1
Length: 135

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/TermsOfShipment
TermsOfShipment Required: No Indicates the rights to the Applies to Invoice and
Type: String seller from the buyer. Also, Partial Invoice forms only.
Max Allowed: 1 it refers to Terms of Sale. Possible values are:
Length: 3
CFR: Cost and Freight
CIF: Cost, Insurance and
Freight
CIP: Carriage and
Insurance Paid
CPT: Carriage Paid To
DAF: Delivered at
Frontier
DDP: Delivery Duty Paid
DDU: Delivery Duty
Unpaid
DEQ: Delivered Ex Quay
DES: Delivered Ex Ship
EXW: Ex Works, FAS:
Free Alongside Ship
FCA: Free Carrier
FOB: Free On Board
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/ReasonForExport
ReasonForExport Required: Cond A reason to export the Applies to Invoice and
Type: String current international Partial Invoice forms.
Max Allowed: 1 shipment. Possible values: Required for Invoice and
Length: 120 SALE, GIFT, SAMPLE, Optional for Partial Invoice.
RETURN, REPAIR, No validation.
INTERCOMPANYDATA,
Any other reason.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Comments
Comments Required: No Any extra information Applies to Invoice and
Type: String about the current Partial Invoice forms only.
Max Allowed: 1 shipment.
Length: 1150

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/DeclarationStatement
DeclarationStatement Required: No This is the legal Applies to Invoice and
Type: String explanation, used by Partial Invoice forms only.
Max Allowed: 1 Customs, for the delivering On the invoice for return
Length: 1550 of this shipment. shipment, the verbiage is
as follows (user input is
It must be identical to the
ignored):
set of declarations actually
used by Customs. The exporter of the
products covered by this
document declares that
Examples of declarations except where otherwise
that might be entered in clearly indicated these
this field are: products are of EEA
I hereby certify that the preferential origin.
goods covered by this
shipment qualify as
originating goods for
purposes of preferential
tariff treatment under the
NAFTA.
I hereby certify that the
information on this invoice
is true and correct and the
contents and value of this
shipment is as stated
above.
EEA statement: The
exporter of the products
covered by this document
declares that except
where otherwise clearly
indicated these products
are of EEA preferential
origin.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Discount
Discount Required: No Container tag that holds Applies to Invoice and
Type: Container the discount. Partial Invoice forms only.
Max Allowed: 1
Length: N/A

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Discount/MonetaryValue
MonetaryValue Required: Yes* The discount to be Applies to Invoice and
Type: String subtracted from the sum of Partial Invoice forms only.
Max Allowed: 1 the total value on the Valid characters are 0-9
Length: 115 invoice. and. (Decimal point). Limit
to 2 digit after the decimal.
The maximum length of
the field is 15 including.
And can hold up to 2
decimal places.
This value should be
greater than or equal to
zero or less than or equal
to the value of all goods
listed on the invoice.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/FreightCharges
FreightCharges Required: No Container tag that holds Applies to Invoice and
Type: Container the Freight Charges. Partial Invoice forms only.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/FreightCharges/MonetaryValu
e
MonetaryValue Required: Yes* Cost to transport the Applies to Invoice and
Type: String shipment. Partial Invoice forms only.
Max Allowed: 1 Valid characters are 0-9
Length: 115 and (Decimal point). Limit
the field is 15 including
and can hold up to 2
decimal places.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/InsuranceCharges
InsuranceCharges Required: No Container tag that holds Applies to Invoice and
Type: Container the Insurance Charges. Partial Invoice forms only.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/InsuranceCharges/MonetaryV
alue
MonetaryValue Required: Yes* The amount the shipper or Applies to Invoice and
Type: String receiver pays to cover the Partial Invoice forms only.
Max Allowed: 1 cost of replacing the Valid characters are 0-9
Length: 115 shipment if it is lost or and. (Decimal point). Limit
damaged. to 2 digit after the decimal.
the field is 15 including.
And can hold up to 2
decimal places.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/OtherCharges
OtherCharges Required: No Container tag that holds Applies to Invoice and
Type: Container the information of amount Partial Invoice forms only.
Max Allowed: 1 that covers additional
Length: N/A charges not already listed
on the invoice.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/OtherCharges/MonetaryValue
MonetaryValue Required: Yes* The Monetary value of Applies to Invoice and
Type: String OtherCharges. Partial Invoice forms only.
Max Allowed: 1 Valid characters are 0-9
Length: 115 and. (Decimal point). Limit
the field is 15 including .
decimal places.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/OtherCharges/Description
Description Required: Yes* Description of what the Applies to Invoice and
Type: String other charges are for. Partial Invoice forms only.
Max Allowed: 1
Length: 110
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CurrencyCode
CurrencyCode Required: Cond Currency code for all the Applies to Invoice and
Type: String monetary values of the Partial Invoice forms only.
Max Allowed: 1 Invoice form.
Length: 3
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/BlanketPeriod
BlanketPeriod Required: Cond This field should be
Type: Container entered if the NAFTA
Max Allowed: 1 Certificate covers multiple
Length: N/A shipments of identical
goods as described in the
Description of Goods field
that are imported into a
NAFTA country for a
specified period of up to
one year (the blanket
period).
The importation of a good
for which preferential
treatment is claimed
based on this certificate
must occur between these
dates.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/BlanketPeriod/BeginDate
BeginDate Required: Yes* Begin date of the blanket Applies to NAFTA CO form
Type: String period. It is the date upon only. Required for NAFTA
Max Allowed: 1 which the Certificate CO. Format is
Length: 8 becomes applicable to the YYYYMMDD. This is not
good covered by the valid for a paperless
blanket Certificate (it may shipment.
be prior to the date of
signing this Certificate).
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/BlanketPeriod/EndDate
EndDate Required: Yes* End Date of the blanket Applies to NAFTA CO form
Type: String period. It is the date upon only. Required for NAFTA
Max Allowed: 1 which the blanket period CO. Format is
Length: 8 expires. YYYYMMDD. This is not
valid for a paperless
shipment.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/ExportDate
ExportDate Required: Cond The date the goods will be Applies to CO and EEI
Type: String exiting the country. forms only. Required for
Max Allowed: 1 CO and EEI forms. Format
Length: 8 is YYYYMMDD
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/ExportingCarrier
ExportingCarrier Required: Cond The name of the carrier Applies to CO and EEI
Type: String that is exporting the forms only. Required for
Max Allowed: 1 shipment. The vessels flag CO and EEI forms.
Length: 135 number should also be
entered, if the carrier is a
vessel.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CarrierID
CarrierID Required: No The four-character Applies to EEI forms only.
Type: String Standard Carrier Alpha No Validations.
Max Allowed: 1 Code (SCAC) for vessel,
Length: 117 rail, and truck shipments.
For air shipment, enter the
two or three character
International Air Transport
Association (IATA) code.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/InBondCode
InBondCode Required: Cond The two-character In Bond Applies to EEI forms only.
Type: String Code. Required for EEI forms.
Max Allowed: 1
Valid values for EEI are:
Length: 2
70: Not in bond;
67: IE from a FTZ;
68: T&E from a FTZ.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EntryNumber
EntryNumber Required: Cond The Import Entry Number Applies to EEI forms only.
Type: String when the export Conditionally Required for
Max Allowed: 1 transaction is used as EEI forms when In bond
Length: 125 proof of export for import code value is other than
transactions (examples: In 70 (Not In Bond).
Bond, Temporary Import
Bond or Drawbacks).
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/PointOfOrigin
PointOfOrigin Required: Cond Contains one of the Applies to EEI forms only.
Type: String following The two-digit Required for EEI.
Max Allowed: 1 U.S. Postal Service
Length: 15 abbreviation for the state
from which the goods
were shipped to the port of
export.
The state that is the source
for the good with the
highest value. The state of
consolidation. The Foreign
Trade Zone number of the
zone from where the
exports are leaving.
If the goods were shipped
from Puerto Rico, enter
PR.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/PointOfOriginType
PointOfOriginType Required: Cond Valid values: S (for state Applies EEI forms only.
Type: String postal code abbrevation), Required for EEI form.
Max Allowed: 1 F: FTZ Identifier.
Length: 1
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/ModeOfTransport
ModeOfTransport Required: Cond Mode of transport by Applies to EEI forms only.
Type: String which the goods are Required for EEI. Only
Max Allowed: 1 exported. allowed values can be
Length: 135 entered. Only 10
Possible values:
Characters can appear on
Air, AirContainerized, the form. Anything greater
Auto, than 10 characters will be
FixedTransportInstallation truncated on the form.
s, Mail,
PassengerHandcarried,
Pedestrian, Rail, Rail,
Containerized,
RoadOther, SeaBarge,
SeaContainerized,
SeaNoncontainerized,
Truck,
TruckContainerized.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/PortOfExport
PortOfExport Required: No Should be one of the Applies to EEI forms only
Type: String following: No validation.
Max Allowed: 1
Length: 135 Overland: The U.S.
Customs port where the
carrier crosses the U.S.
border.
Vessel and Air: The U.S.
Customs port where the
goods are loaded on the
carrier to be exported
from the U.S.
Postal: The U.S. Postal
Office from where the
goods are mailed.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/PortOfUnloading
PortOfUnloading Required: No The country and the port Applies to EEI forms only
Type: String where the goods will be No validation.
Max Allowed: 1 unloaded from the
Length: 135 exporting carrier. For
vessel and air shipments
only.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/LoadingPier
LoadingPier Required: No Pier where goods are Applies to EEI forms only
Type: String loaded. For vessel No validation.
Max Allowed: 1 shipments only.
Length: 135
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/PartiesToTransaction
PartiesToTransaction Required: Cond Information about parties Applies to EEI forms only
Type: String to transaction. Use Valid values:
Max Allowed: 1 Related, if the parties to
R - Related
Length: 1 the transaction are related.
A related party is an export N - Non-related
from a U.S.
businessperson or
business to a foreign
business or from a U.S.
business to a foreign
person or business where
the person has at least 10
percent of the voting
shares of the business
during the fiscal year. If
unincorporated, then an
equivalent interest in the
business.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/RoutedExportTransactionIndi
cator
RoutedExportTransactionI Required: No If Present, indicates that it Applies to EEI forms only.
ndicator Type: String is a routed export
Max Allowed: 1 transaction. A routed
Length: 0 export transaction is one,
where the foreign principal
party in interest authorizes
a U.S. forwarding (or
other) agent to export the
merchandise outside the
U.S.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/ContainerizedIndicator
ContainerizedIndicator Required: No If present indicates that the Applies to EEI forms only.
Type: String goods are containerized.
Max Allowed: 1 This applies to vessel
Length: 0 shipments only.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/ShipperMemo
ShipperMemo Required: No Text for the shipper to add
Type: String additional information.
Max Allowed: 1
Length: 1300
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/OverridePaperlessIndicator
OverridePaperlessIndicato Required: No The application will
r Type: String automatically provide a
Max Allowed: 1 copy of the invoice or
Length: 0 NAFTA/CO with each
response regardless of
whether the user has
enabled Paperless
account. The user now
has the option to print or
ignore the copy provided.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption
EEIFilingOption Required: Cond EEI Filing option. Applicable for EEI form
Type: Container and is required.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/Code
Code Required: Yes* Required for EEI Form. Applicable for EEI form.
Type: String Valid values: 1 - Shipper
Max Allowed: 1 filed; 3- UPS filed
Length: 1
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/EMailAddress
EMailAddress Required: No Email Address where the Applicable for EEI form.
Type: String notification is sent. Valid
Max Allowed: 1 for UPS filed(option 3),
Length: 150 Shipper filed (option 1- A ,
1-C)

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/Description
Description Required: No Optional description of
Type: String Filing Code.
Max Allowed: 1
Length: 120
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/UPSFiled
UPSFiled Required: No Indicates the EEI UPS
Type: Container Filed option. (option 3).
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/UPSFiled/PO
A
POA Required: Yes* Container for POA.
Type: Container
Max Allowed: 1
Length: N/A
A/Code
Code Required: Yes* Indicates the EEI UPS Applicable for EEI form.
Type: String Filed POA filing option. Valid values:
Max Allowed: 1
- One Time POA
Length: 1
2- Blanket POA
A/Description
Description Required: No Description for POA Code.
Type: String
Max Allowed: 1
Length: 120
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/ShipperFiled
ShipperFiled Required: No Indicates the EEI Shipper Applicable for EEI form
Type: Container Filed option. (option 1). and is required for Shipper
Max Allowed: 1 filed option.
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/ShipperFiled/
Code
Code Required: Yes* Indicates the EEI Shipper Applicable for EEI form
Type: String sub option. and is required. Valid
Max Allowed: 1 value are:
Length: 1
'A'- requires the ITN
'B'- requires the Exemption
Legend
'C'- requires the post
departure filing citation

Description
Description Required: No Description of
Type: String ShipperFiled Code.
Max Allowed: 1
Length: 120
PreDepartureITNNumber
PreDepartureITNNumber Required: Cond Input for Shipper Filed Valid and Required for
Type: String option 'A'. The format is Shipper Filed option 'A'.
Max Allowed: 1 available from AESDirect EEI form only.
Length: 17 website.
ExemptionLegend
ExemptionLegend Required: Cond Input for Shipper Filed Valid and Required for
Type: String option 'B'. 30.2(d)(2), Shipper Filed option 'B'.
Max Allowed: 1 30.26(a), 30.36, 30.37(a), EEI form only.
Length: 20 30.37(b), 30.37(c), 30.37
(d), 30.37(e), 30.37(f),
30.37(h), 30.37(i), 30.30(j),
30.37(k), 30.37(i), 30.37(j),
30.37(k), 30.37(l), 30.37
(m), 30.37(n), 30.37(o),
30.37(p), 30.37(q), 30.37
(r), 30.37(s), 30.37(t),
30.37(u), 30.37(x), 30.37
(y)(1), 30.37(y)(2), 30.37
(y)(3), 30.37(y)(4), 30.37
(y)(5), 30.37(y)(6), 30.39,
30.40(a), 30.40(b), 30.40
(c), 30.40(d), 30.8(b)
ReturnOfDocumentIndicator

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/ReturnOfDocumentIndicator
ReturnOfDocumentIndicator Required: No Return of Documents Valid for Poland to Poland
Type: String Indicator. If the flag is shipment without return
Max Allowed: 1 present, the shipper has service.
Length: 0 requested the
ReturnOfDocument
accessorial be added to the
shipment.
DeliveryConfirmation

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/DeliveryConfirmation
DeliveryConfirmation Required: No Container for DCIS Type. Refer to Delivery
Type: Container Confirmation Origin-
Max Allowed: 1 Destination Pairs in the
Length: N/A Appendix for valid values.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/DeliveryConfirmation/DCISType
DCISType Required: Yes* Type of delivery confirmation. Valid values:
Type: String
- Delivery Confirmation
Max Allowed: 1
Signature Required
Length: 1
2 - Delivery Confirmation
Adult Signature Required.
ImportControlIndicator

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/ImportControlIndicator
ImportControlIndicator Required: No Indicates that the Shipment is
Type: String an ImportControl shipment.
Max Allowed: 1
Length: 0
LabelMethod

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelMethod
LabelMethod Required: No Type of ImportControl Label. This container is applicable
Type: Container only for ImportControl
Max Allowed: 1 shipments.
Length: N/A
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelMethod/Code
Code Required: Yes* LabelMethod types:
Type: String
'01' = ImportControl Print and
Max Allowed: 1
Mail
Length: 2
'02' = ImportControl One-
Attempt
'03' = ImportControl Three-
Attempt
'04' = ImportControl Electronic
Label
'05' = ImportControl Print Label
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LabelMethod/Description
Description Required: No Label Method description.
Type: String
Max Allowed: 1
Length: 135
CommercialInvoiceRemovalIndicator

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/CommercialInvoiceRemovalIndicator
CommercialInvoiceRemovalIndi Required: No CommercialInvoiceRemovalIndi
cator Type: String cator allows a shipper to dictate
Max Allowed: 1 that UPS remove the
Length: 0 Commercial Invoice from the
user's shipment before the
shipment is delivered to the
ultimate consignee.
UPScarbonneutralIndicator

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/UPScarbonneutralIndicator
UPScarbonneutralIndicator Required: No UPS carbon neutral
Type: String indicator presence at
Max Allowed: 1 shipment level is required to
Length: 0 create carbon neutral
Shipments.
PreAlertNotification

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification
PreAlertNotification Required: No This container is used for
Type: Container providing Pre-Alert
Max Allowed: UNB Notifications to the
Length: N/A consignee for UPS
Exchange movements and
Pack & Collect shipments.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/EMailMessage
EMailMessage Required: No This container is used for
Type: Container Populating EMailMessage
Max Allowed: 1 details for
Length: N/A PreAlertNotification.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/EMailMessage/EMailAddress
EMailAddress Required: Yes* EMailAddress where
Type: String PreAlertNotification is sent.
Max Allowed: 1
Length: 150
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/EMailMessage/Undeliverable
EMailAddress
UndeliverableEMailAddre Required: No This is used for notification
ss Type: String when EMailAddress for
Max Allowed: 1 PreAlertNotification is
Length: 150 undeliverable.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/VoiceMessage
VoiceMessage Required: No VoiceMessage container
Type: Container is used for specifying
Max Allowed: 1 phone number for
Length: N/A receiving voice
preAlertNotification.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/VoiceMessage/PhoneNumbe
r
PhoneNumber Required: Yes* Phone number for Valid values are 0 9.
Type: String receiving Voice
If the country of the
Max Allowed: 1 PreAlertNotification.
message recipient is US,
Length: 115
PR, CA, and VI, the layout
is "1, areacode, 7 digit
phone number or "1,
areacode, 7 digit phone
number.
For other countries, the
layout is "countrycode,
area code, 7 digit number".
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/TextMessage
TextMessage Required: No TextMessage container is
Type: Container used for specifying phone
Max Allowed: 1 number for receiving text
Length: N/A preAlertNotification.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/TextMessage/PhoneNumber
PhoneNumber Required: Yes* Phone number for Valid values are 0 9.
Type: String receiving Text
If the country of the
Max Allowed: 1 PreAlertNotification.
message recipient is US,
Length: 115
PR, CA, and VI, the layout
is "1, areacode, 7 digit
phone number or "1,
areacode, 7 digit phone
number.
For other countries, the
layout is "countrycode,
area code, 7 digit number".
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/Locale
Locale Required: Yes* This container is used for
Type: Container providing Language and
Max Allowed: 1 dialect details for
Length: N/A PreAlertNotifications.
/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/Locale/Language
Language Required: Yes* Refer to Language /
Length: 3 values.

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/Locale/Dialect
Dialect Required: Yes* Refer to Language /
Length: 2 values.
ExchangeForwardIndicator

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/ExchangeForwardIndicator
ExchangeForwardIndicator Required: No Exchange forward indicator In the label, routing
Type: String presence at shipment level Instruction text by default will
Max Allowed: 1 is required to create be EXCHANGE-LIKE ITEM
Length: 0 exchange forward ONLY.
Shipments.
HoldForPickupIndicator

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/HoldForPickupIndicator
HoldForPickupIndicator Required: No Hold For Pickup indicator. The This accessorial is only valid
Type: String empty tag means indicator is for UPS Worldwide Express
Max Allowed: 1 present. Freight Shipment.
Length: 0
DropoffAtUPSFacilityIndicator

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/DropoffAtUPSFacilityIndicator
DropoffAtUPSFacilityIndicator Required: No Drop off At UPS Facility This accessorial is only
Type: String indicator. The empty tag valid for UPS Worldwide
Max Allowed: 1 means indicator is present. Express Freight Shipment.
Length: 0
LiftGateForPickUpIndicator

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LiftGateForPickUpIndicator
LiftGateForPickUpIndicator Required: No Lift Gate For Pick Up This accessorial is only valid
Type: String indicator. The empty tag for UPS Worldwide Express
Max Allowed: 1 means indicator is present. Freight Shipment.
Length: 0
LiftGateForDeliveryIndicator

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/LiftGateForDeliveryIndicator
LiftGateForDeliveryIndicator Required: No Lift Gate For Delivery This accessorial is only
Type: String indicator. The empty tag valid for UPS Worldwide
Max Allowed: 1 means indicator is present. Express Freight Shipment.
Length: 0
SDLShipmentIndicator

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/SDLShipmentIndicator
SDLShipmentIndicator Required: No The presence of the tag Empty tag.
Type: String SDLShipmentIndicator
Max Allowed: 1 indicates Shipment is SDL.
Length: 0 SDLShipmentIndicator
presence means EEI form/EEI
Filing option required.
EPRAReleaseCode

/ShipmentConfirmRequest/Shipment/ShipmentServiceOptions/EPRAReleaseCode
EPRAReleaseCode Required: No Package Release code allows the The release code must be
Type: String consignee or claimant to pick-up a between length 4 and 6 and
Max Allowed: 1 package at a UPS Access Point. only contain numbers.
Length: 4...6
The shipper must provide the
Package Release Code to the
consignee so that they can provide
the code to the UPS Access
Point personnel as another item
for authentication before the
package is released to them.
Package Release Code is only
valid with ShipmentIndicationType
01 - Hold for Pickup at UPS
Access Point.
PackageID

/ShipmentConfirmRequest/Shipment/PackageID
PackageID Required: Customer-assigned unique piece Required only for Mail Innovations
Cond identifier that returns visibility events. forward shipments. Alpha numeric
Type: String values only.
Max Allowed:
1
Length: 130
IrregularIndicator

/ShipmentConfirmRequest/Shipment/IrregularIndicator
IrregularIndicator Required: No Mail classification defined by the Mail classification defined by the
Type: String USPS Valid values: USPS Valid values: 1 = Balloon,
Max Allowed: 1 2 = Oversize, 3 = Not Applicable.
Length: 1 1 = Balloon
2 = Oversize
3 = Not Applicable.
Package

/ShipmentConfirmRequest/Shipment/Package
Package Required: Yes Package Information. For Return Shipments up
Type: Container to and including 20
Max Allowed: Many (up to packages are allowed.
200) US/PR origin return
Length: N/A movements are limited to
only one package. For Mail
Innovation shipments only
one package is allowed.
/ShipmentConfirmRequest/Shipment/Package/Description
Description Required: Cond Merchandise description Required for shipment with
Type: String of package. return service.
Max Allowed: 1
Length: 135
/ShipmentConfirmRequest/Shipment/Package/PackagingType
PackagingType Required: Yes Container for Packaging
Type: Container Type.
Max Allowed: 1
Length: N/A

/ShipmentConfirmRequest/Shipment/Package/PackagingType/Code
Code Required: Yes Package types. Values Package type24 or 25 is
Type: String are: only allowed for shipment
Max Allowed: 1 without return service
01 = UPS Letter
Length: 2 Packaging type must be
02 = Customer Supplied valid for all the following:
Package
ShipTo country, ShipFrom
03 = Tube country, a shipment going
04 = PAK from ShipTo country to
ShipFrom country, all
21 = UPS Express Box accessorial at both the
24 = UPS 25KG Box shipment and package
level, and the shipment
25 = UPS 10KG Box service type.
30 = Pallet UPS will not accept raw
2a = Small Express Box wood pallets and please
refer the UPS packaging
2b = Medium Express Box guidelines for pallets on
2c = Large Express Box UPS.com.
56 = Flats
57 = Parcels
58 = BPM
59 = First Class
60 = Priority
61 = Machinables
62 = Irregulars
63 = Parcel Post
64 = BPM Parcel
65 = Media Mail
66 = BPM Flat
67 = Standard Flat
/ShipmentConfirmRequest/Shipment/Package/PackagingType/Description
Description Required: No Description of packaging
Type: String type. Examples are letter,
Max Allowed: 1 customer supplied,
Length: 135 express box.
/ShipmentConfirmRequest/Shipment/Package/Dimensions
Dimensions Required: Cond Dimensions information Length + 2*(Width +
Type: Container container. Height) must be less than
Max Allowed: 1 or equal to 130 IN or 330
Note: Currently
Length: N/A CM.
dimensions are not
applicable to Ground
Freight Pricing.

/ShipmentConfirmRequest/Shipment/Package/Dimensions/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Unit of measurement
Type: Container information for dimensions
Max Allowed: 1 of package.
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/Dimensions/UnitOfMeasurement/Code
Code Required: Yes* Package dimensions The unit of measurement
Type: String measurement code. must be valid for the
Max Allowed: 1 Codes are: IN = Inches, Shipper country.
Length: 2 CM = Centimeters, 00 =
Metric Units Of
Measurement, 01 =
English Units of
Measurement.
In Canada-origin
shipments, no defaulting is
performed and a unit of
measurement is required.
service the unit of measure
is defaulted to the
shipper's country unit of
measure.
For all other shipments the
unit of measurement will
default to the unit of
measurement for the origin
country.
/ShipmentConfirmRequest/Shipment/Package/Dimensions/UnitOfMeasurement/Description
Description Required: No Description of the package
Type: String dimensions measurement
Max Allowed: 1 units.
Length: 135
/ShipmentConfirmRequest/Shipment/Package/Dimensions/Length
Length Required: Yes* Package length. Length Valid values are 0 to 108
Type: String must be the longest IN and 0 to 270 CM.
Max Allowed: 1 dimension of the
Length: 9 container.
/ShipmentConfirmRequest/Shipment/Package/Dimensions/Width
Width Required: Yes* Package width.
Type: String
Max Allowed: 1
Length: 9
/ShipmentConfirmRequest/Shipment/Package/Dimensions/Height
Height Required: Yes* Package height.
Type: String
Max Allowed: 1
Length: 9

/ShipmentConfirmRequest/Shipment/Package/PackageWeight
PackageWeight Required: Cond Weight of package.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/PackageWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Unit of measurement
Type: Container information for weight of
Max Allowed: 1 package.
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/PackageWeight/UnitOfMeasurement/Code
Code Required: Cond Package weight unit of
Type: String measurement code.
Max Allowed: 1 Codes are:
Length: 3
LBS = Pounds
KGS = Kilograms
OZS = Ounces
00 = Metric Unit of
Measurements
01 = English Unit of
Measurements
In Canada-origin
shipments, no defaulting is
performed and a unit of
measurement is required.
service, the unit of
measure is defaulted to
the shipper's country unit
of measure.
For all other shipments the
unit of measurement will
default to the unit of
measurement for the origin
country. Unit of
Measurement "OZS" is the
only valid UOM for some of
the Mail Innovations
Forward Shipments.
Refer to Mail Innovations
Package Detail
Information in the
Appendix for valid values.
/ShipmentConfirmRequest/Shipment/Package/PackageWeight/UnitOfMeasurement/Description
Description Required: No Description of the package
Type: String weight measurement units.
Max Allowed: 1
Length: 135

/ShipmentConfirmRequest/Shipment/Package/PackageWeight/Weight
Weight Required: Yes* Packages weight. Weight accepted for
Type: String letters/envelopes.
Max Allowed: 1
Length: 15
/ShipmentConfirmRequest/Shipment/Package/LargePackageIndicator
LargePackageIndicator Required: No Presence of the indicator
Type: String mentions that the package
Max Allowed: 1 is Large Package.
Length: 0
/ShipmentConfirmRequest/Shipment/Package/ReferenceNumber
ReferenceNumber Required: No Package reference For Mail Innovation
Type: Container number information shipments reference
Max Allowed: 2 container. number is not supported.
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/ReferenceNumber/BarCodeIndicator
BarCodeIndicator Required: No If the indicator is present Only one shipment-level or
Type: String then the reference package-level reference
Max Allowed: 1 numbers value will be bar number can be bar coded
Length: 0 coded on the label. per shipment. In order to
barcode a reference
number, its value must be
no longer than 14
or 24 numeric characters
and cannot contain
spaces.
/ShipmentConfirmRequest/Shipment/Package/ReferenceNumber/Code
Code Required: Yes* Reference number type Valid if the
Type: String code, for the entire origin/destination pair is
Max Allowed: 1 shipment. The code US/US or PR/PR character
Length: 2 specifies the Reference alpha-numeric.
name.
/ShipmentConfirmRequest/Shipment/Package/ReferenceNumber/Value
Value Required: Yes* Customer supplied Valid if the
Type: String reference number. origin/destination pair is
Max Allowed: 1 US/US or PR/PR. Supports
Length: 135 up to 2 customer supplied
combinations of Reference
code- value combinations.
/ShipmentConfirmRequest/Shipment/Package/AdditionalHandling
AdditionalHandling Required: No Additional Handling
Type: String indicator. The presence
Max Allowed: 1 indicates additional
Length: 0 handling is required, the
absence indicates no
additional handling is
required.

/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions
PackageServiceOptions Required: No Package service options
Type: Container container.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/DeliveryConfirmation
DeliveryConfirmation Required: No Delivery confirmation Refer to Language/Dialect
Type: Container information container. Combinations for
Max Allowed: 1 additional information.
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/DeliveryConfirmation/DCISType
DCISType Required: Yes* Type of delivery Valid values:
Type: String confirmation.
Max Allowed: 1 1 - Delivery
Length: 1 Confirmation
2 - Delivery
Confirmation Signature
Required
3 - Delivery
Confirmation Adult
Signature Required
4 - USPS Delivery
Confirmation
For Mail Innovations
forward shipments, USPS
Delivery Confirmation is
allowed for Priority, First
Class, Machineables,
Irregulars, Parcel Post,
BPM Parcel and Media
Mail package types.
USPS Delivery
Confirmation is prohibited
for Standard Flats, BPM,
BPM Flats and Parcels
package types.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/DeliveryConfirmation/DCISNumber
DCISNumber Required: No Delivery Confirmation
Type: String Control number
Max Allowed: 1 associated with the
Length: 111 delivery confirmation for
the package.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/InsuredValue
InsuredValue Required: No Insured Value container.
Type: Container
Max Allowed: 1
Length: N/A

/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/InsuredValue/Type
Type Required: No Container for Insured
Type: Container Value Type.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/InsuredValue/Type/Code
Code Required: Yes* Declared value type. Valid The user cannot specify
Type: String values are 01=EVS; different type of declared
Max Allowed: 1 02=DVS Defaults to 01 i.e. value at package level for
Length: 2 EVS if declared value type entire shipment. User can
is not provided. either have shipper
declared value (DVS) or
declared value (EVS) but
not both at package level.
Note: The Shipper
DeclaredValue is
applicable for forward
shipments when the billing
option is freight collect or
third party.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/InsuredValue/Type/Description
Description Required: No Declared value
Type: String Description.
Max Allowed: 1
Length: 135
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/InsuredValue/CurrencyCode
CurrencyCode Required: No Declared value amount Code must represent a
Type: String currency type. Defaults to currency that is a valid for
Max Allowed: 1 the currency used in the Shipper country.
Length: 3 shipper's country.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/InsuredValue/MonetaryValue
MonetaryValue Required: No Declared value amount.
Type: String
Max Allowed: 1
Length: 119
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/COD
COD Required: No COD container. Indicates COD is
Type: Container requested. Package level
Max Allowed: 1 COD is available for
Length: N/A shipment without return
service from US/PR to
US/PR, CA to CA and CA
to US.
CA to US COD is not
allowed for package
Letter/Envelope. COD is
not valid for return service
movements.

/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/COD/CODCode
CODCode Required: Yes* COD type value.
Type: String
Valid value: 3 = Tagless
Max Allowed: 1
COD
Length: 1
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/COD/CODFundsCode
CODFundsCode Required: Yes* For valid values, refer
Type: String toCOD Supported
Max Allowed: 1 Countries in the Appendix.
Length: 1
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/COD/CODAmount
CODAmount Required: Yes* COD amount container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/COD/CODAmount/CurrencyCode
CurrencyCode Required: No COD amount currency
Type: String code type. Defaults to the
Max Allowed: 1 currency used in the
Length: 3 destination country.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/COD/CODAmount/MonetaryValue
MonetaryValue Required: Yes* COD Amount. Valid values:
Type: String
0.01 USD - 50000.00 USD
Max Allowed: 1
Length: 18
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/AccessPointCOD
AccessPointCOD Required: No Access Point COD Valid only for "01 - Hold
Type: Container indicates Package Access For Pickup At UPS Access
Max Allowed: 1 Point COD is requested for Point" Shipment Indication
Length: N/A a shipment. type.
Package Access Point
COD is valid only for
shipment without return
service from US/PR to
US/PR and CA to CA.
Not valid with (Package)
COD.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/AccessPointCOD/CurrencyCode
CurrencyCode Required: Yes* Access Point COD
Type: String Currency Code.
Max Allowed: 1
Length: 3
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/AccessPointCOD/MonetaryValue
MonetaryValue Required: Yes* Access Point COD
Type: String Monetary Value.
Max Allowed: 1
Length: 18

/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation
VerbalConfirmation Required: No Verbal Confirmation Info. Allowed for shipment
Type: Container without return service.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo
ContactInfo Required: Cond Optional if the Shipper's
Type: Container AttentionName,
Max Allowed: 1 PhoneNumber, and
Length: N/A PhoneExtension (optional)
are given and are the
desired name, phone
number and extension,
respectively, to be used for
verbal confirmation.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo/Name
Name Required: Cond Name of the person to be Optional if Shipper/
Type: String contacted for confirmation. AttentionName is given
Max Allowed: 1 Defaults to Shipper and that is the name of the
Length: 135 AttentionName if given. person to be contacted
else required for verbal
confirmation.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo/PhoneN
umber
PhoneNumber Required: Cond Phone number UPS uses Optional if
Type: String to reach the person to give Shipper/PhoneNumber is
Max Allowed: 1 the confirmation. Defaults given and that is the name
Length: 115 to Shipper PhoneNumber of the person to be
if given. contacted else required for
verbal confirmation.
If phone number is in the
US 10 digits allowed,
otherwise 1 to 15 digits
allowed.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/ShipperReleaseIndicator
ShipperReleaseIndicator Required: No The presence indicates Only available for
Type: String that the package may be US50/PR to US50/PR
Max Allowed: 1 released by driver without packages without return
Length: 0 a signature from the service.
consignee.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/Notification
Notification Required: No Package level notification. Applicable for Shipment
Type: Container with returned service also.
Max Allowed: 1
Length: N/A

/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/NotificationCode
NotificationCode Required: Yes* Notification Code. Valid values:
Type: String
3 - Receiver Return
Max Allowed: 1
Notification
Length: 1
6 - QV Email Notification
7 - QV Exception
Notification
8 - QV Delivery
Notification.
forward shipments, QV
Email Notifications are
allowed for First Class,
Priority Mail and Expedited
Mail Innovation services.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMailMessage
EMailMessage Required: Yes* Container for e-mail
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMailMessage/EMailAddres
s
EMailAddress Required: Yes* The destination eMail The shipment can have up
Type: String address of the receiver to two receivers return
Max Allowed: Many (up to returns notification eMail. notification email address
2) for the whole shipment.
Length: 150
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMailMessage/Undeliverabl
eEMailAddress
UndeliverableEMailAddre Required: No The e-mail address where Defaults to
ss Type: String an undeliverable eMail FromEMailAddress. Only
Max Allowed: 1 message is sent if the allowed at the first
Length: 150 Receiver Return package.
Notification email is
undeliverable.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMailMessage/FromEMailAd
dress
FromEMailAddress Required: Yes* The email address listed in Only allowed at the first
Type: String the Reply To field of the package.
Max Allowed: 1 message header, includes
Length: 150 name and e-mail address
of sender. The From field
of the message header
contains
[email protected].
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMailMessage/FromName
FromName Required: No The name the receiver Defaults to the
Type: String return notification will ShipperName. Only
Max Allowed: 1 appear to be from. allowed at the first
Length: 135 package.

/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMailMessage/Memo
Memo Required: No User defined text that will Only allowed at the first
Type: String be included in the eMail. package.
Max Allowed: 1
Length: 1150
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMailMessage/Subject
Subject Required: No Email subject/description.
Type: String
Max Allowed: 1
Length: 150
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMailMessage/SubjectCode
SubjectCode Required: No Specifies a reference code
Type: String and reference number to
Max Allowed: 1 display in the subject of
Length: 2 the Notification.The valid
subject codes are:
01 - Shipment
Reference Number 1
02 - Shipment
Reference Number 2
03 - package
Reference Number 1
04 - package
Reference Number 2
08 - Subject Text
(Return Notification
only)
If a subject code is not
provided or provided that
refers to a nonexistent
reference number, the
subject will default to
shipment Identification
Number
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce
DryIce Required: No Container for Dry Ice. Maximum of 1 per
Type: Container package.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/RegulationSet
RegulationSet Required: Yes* The Regulatory set The following values are
Type: String associated with every valid: IATA,CFR.
Max Allowed: 1 regulated shipment. Valid
Length: 34 values:
"CFR" = Regulated by US
Dept of Transportation
within the U.S. or ground
shipments to Canada,
"IATA" = Worldwide Air
movement.

/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight
DryIceWeight Required: Yes* Container for Dry Ice
Type: Container weight.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container for Dry Ice
Type: Container weight unit of
Max Allowed: 1 measurement.
Length: N/A
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/UnitOfMeasuremen
t/Code
Code Required: Yes* DryIce weight unit of The following values are
Type: String measurement code. valid: 00 , 01, KG , KGS,
Max Allowed: 1 Codes are: LBS.
Length: 23
'00'= KG (Metric Unit of
Measurements),
'01'= LB (English Unit of
Measurements),
'KG' = KG (Metric Unit of
Measurements),
'LB' = LB (English Unit
of Measurements),
'KGS'= KG (Metric Unit
of Measurements),
'LBS' = LB (English Unit
of Measurements)
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/UnitOfMeasuremen
t/Description
Description Required: No Description for Dry Ice
Type: String weight unit of
Max Allowed: 1 measurement.
Length: 120
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/Weight
Weight Required: Yes* The weight in the UnitOf Cannot be more than
Type: String Measurments. package weight. Should
Max Allowed: 1 be more than 0.0.
Valid characters are 0-9
Length: 15
and . (Decimal point).
Limit to 1 digit after the
decimal.
the field is 5 including .
decimal place.

/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/MedicalUseIndicator
MedicalUseIndicator Required: No The presence of the tag
Type: String implies Medical use. Any
Max Allowed: 1 value within the tag is
Length: 0 ignored and not
interpreted. The absence
of the tag implies non
medical use.
MedicalUseInd is valid for
CFR regulation set only
and ignored for IATA, if
present.
/ShipmentConfirmRequest/Shipment/Package/PackageServiceOptions/UPSPremiumCareIndicator
UPSPremiumCareIndicato Required: Cond An Empty Tag means
r Type: String UPSPremiumCareIndicato indicator is present.
Max Allowed: 1 r indicates special
The
Length: 0 handling is required for
UPSPremiumCareIndicato
shipment having
r cannot be requested for
controlled substances.
package with Delivery
Confirmation - Adult
Signature Required and
Delivery Confirmation-
Signature Required.
r is valid for following
Return services:
Returns Exchange
(available with a
contract)
Print Return Label
Print and Mail
Electronic Return Label
Return Service Three
Attempt
The
r can be requested with
following UPS services:
UPS Express Early

UPS Express
UPS Express Saver
UPS Standard
Valid for Canada to
Canada movements only.
RatingMethodRequestedIndicator

/ShipmentConfirmRequest/Shipment/RatingMethodRequestedIndicator
RatingMethodRequestedIndicator Required: No Presence/Absence Indicator. Any
Type: String value inside is ignored.
Max Allowed: 1 RatingMethodRequestedIndicator
Length: 0 is an indicator. If present, Billable
Weight Calculation method
information and Rating Method
information would be returned in
response.
TaxInformationIndicator

/ShipmentConfirmRequest/Shipment/TaxInformationIndicator
TaxInformationIndicator Required: No Presence/Absence Indicator. Any If this indicator is requested with
Type: String value inside is ignored. NegotiatedRatesIndicator, Tax
Max Allowed: 1 TaxInformationIndicator is an related information, if applicable,
Length: 0 indicator. If present, any taxes would be returned only for
that may be applicable to a Negotiated Rates and not for
shipment would be returned in Published Rates.
response.
The Tax related information
includes any type of Taxes,
corresponding Monetary Values,
Total Charges with Taxes and
disclaimers (if applicable) would
be returned in response.
ShipmentIndicationType

/ShipmentConfirmRequest/Shipment/ShipmentIndicationType
ShipmentIndicationType Required: No ShipmentIndicationType is a This container indicates
Type: Container container. whether shipment is "Hold
Max Allowed: 1 For Pickup At UPS Access
Length: N/A Point" shipment or "UPS
Access Point Delivery"
shipment.
/ShipmentConfirmRequest/Shipment/ShipmentIndicationType/Code
Code Required: Yes* Valid value is If '01' code is present
Type: String indicates shipment will be
Max Allowed: 1 '01' - Hold for Pickup at UPS send to Retail location where
Length: 2 Access Point it is held to consignee to
'02' - UPS Access Point claim.
Delivery
/ShipmentConfirmRequest/Shipment/ShipmentIndicationType/Description
Description Required: No Description for the code.
Type: String
Max Allowed: 1
Length: 150
LabelSpecification
/ShipmentConfirmRequest/LabelSpecification
LabelSpecification Required: Container used to define the Required for shipment without
Cond properties required by the user to return service or shipment with
Type: print and/or display the UPS shipping PRL return service.
Container label.
Max Allowed:
1
Length: N/A
LabelPrintMethod

/ShipmentConfirmRequest/LabelSpecification/LabelPrintMethod
LabelPrintMethod Required: Yes* The device used to print a label
Type: Container image.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/LabelSpecification/LabelPrintMethod/Code
Code Required: Yes* Label print method code that the For shipments without return
Type: String labels are to be generated. service the valid value is GIF,
Max Allowed: 1 EPL, ZPL, STARPL and SPL.
Length: 4 EPL2 formatted labels use EPL
For shipments with PRL return
SPL formatted labels use SPL service, the valid values are
ZPL formatted labels use ZPL EPL, ZPL, STARPL, SPL and
GIF.
STAR printer formatted labels
For Mail Innovations forward
use STARPL
shipments STARPL is not
Image formats use GIF supported.
/ShipmentConfirmRequest/LabelSpecification/LabelPrintMethod/Description
Description Required: No Label Specification Code
Type: String description.
Max Allowed: 1
Length: 135
HTTPUserAgent

/ShipmentConfirmRequest/LabelSpecification/HTTPUserAgent
HTTPUserAge Required: Browser Required if
nt Cond HTTPUserAge ShipmentConfirmRequest/LabelSpecification/LabelPrintMethod
Type: String nt String. This /Code = GIF.
Max Allowed: is the
Default to Mozilla/4.5 if this field is missing or has invalid value.
1 preferred way
Length: of identifying
164 GIF image
type to be
generated.
LabelStockSize

/ShipmentConfirmRequest/LabelSpecification/LabelStockSize
LabelStockSize Required: Cond Container for the EPL2, ZPL, For EPL2, ZPL, STARPL and
Type: Container STARPL or SPL label size. SPL labels.
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/LabelSpecification/LabelStockSize/Height
Height Required: Yes* Height of the label image. For IN, For EPL2, ZPL, STARPL and
Type: String use whole inches. SPL Labels. Only valid values is
Max Allowed: 1 4.
Length: 13
Note: Label Image will only scale
up to 4 X 6, even when
requesting 4 X 8.
/ShipmentConfirmRequest/LabelSpecification/LabelStockSize/Width
Width Required: Yes* Width of the label image. For IN, For EPL2, ZPL, STARPL and
Type: String use whole inches. SPL Labels. Only valid values
Max Allowed: 1 are 6 or 8.
Length: 13
Note: Label Image will only scale
up to 4 X 6, even when
requesting 4 X 8.
LabelImageFormat

/ShipmentConfirmRequest/LabelSpecification/LabelImageFormat
LabelImageFor Required: Yes Container for
mat Type: Container Label image
Max Allowed: 1 format.
Length: N/A
/ShipmentConfirmRequest/LabelSpecification/LabelImageFormat/Code
Code Required: Cond Code type that Required if
Type: String the label image ShipmentConfirmRequest/LabelSpecification/LabelPrintMe
Max Allowed: 1 is to be thod/Code = GIF.
Length: 3 generated in.
Valid values are GIF or PNG. Only GIF is supported on the
remote server.
/ShipmentConfirmRequest/LabelSpecification/LabelImageFormat/Description
Description Required: No Description of
Type: String the label image
Max Allowed: 1 format code.
Length: 135
Instruction

/ShipmentConfirmRequest/LabelSpecification/Instruction
Instruction Required: No Routing Instruction Container.
Type: Container
Max Allowed:
UNB
Length: N/A
/ShipmentConfirmRequest/LabelSpecification/Instruction/Code
Code Required: Yes* For Exchange Forward Shipment, by
Type: String default Label will have Exchange
Max Allowed: 1 Routing instruction Text as
Length: 2 EXCHANGE-LIKE ITEM ONLY.
If code value is:
01- EXCHANGE-LIKE ITEM

ONLY
02- EXCHANGE-DRIVER
INSTRUCTIONS INSIDE
/ShipmentConfirmRequest/LabelSpecification/Instruction/Description
Description Required: No Description of the label Instruction
Type: String code.
Max Allowed: 1
Length: 135
ReceiptSpecification
/ShipmentConfirmRequest/ReceiptSpecification
ReceiptSpecification Required: No Container used to allow the user to
Type: choose to print a thermal receipt.
Container
Max Allowed:
1
Length: N/A
ImageFormat

/ShipmentConfirmRequest/ReceiptSpecification/ImageFormat
ImageFormat Required: Yes* ImageFormat Container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentConfirmRequest/ReceiptSpecification/ImageFormat/Code
Code Required: Yes* Print code that determines the Valid Codes are: EPL, SPL, ZPL,
Type: String receipt format. STARPL and HTML.
Max Allowed: 1
Length: 34
/ShipmentConfirmRequest/ReceiptSpecification/ImageFormat/Description
Description Required: No Description of the receipt format
Type: String code.
Max Allowed: 1
Length: 135
ShipmentConfirmResponse Top Level Containers (XML)
ShipmentConfirmResponse XPath Tables

/ShipmentConfirmResponse
ShipmentConfirmResponse Required: Shipment Confirm Response.
Yes
Type:
Container
Max Allowed:
1
Length: N/A
Response
/ShipmentConfirmResponse/Response
Response Required: Yes Response container for Shipment
Type: Confirm Response.
Container
Max Allowed:
1
Length: N/A

/ShipmentConfirmResponse/Response/TransactionReference
TransactionReference Required: Yes TransactionReference identifies
Length: N/A
/ShipmentConfirmResponse/Response/TransactionReference/CustomerContext
CustomerContext Required: No The client uses CustomerContext
Type: String to synchronize request/response
Max Allowed: 1 pairs. The client establishes
Length: 1...512 CustomerContext, which can
contain any information you want,
as long as it is valid XML; it is
echoed back by the server.
ResponseStatusCode

/ShipmentConfirmResponse/Response/ResponseStatusCode
ResponseStatusCode Required: Yes Identifies the success or failure of
Type: String the transaction.
Max Allowed: 1
Valid values are 1 = Successful; 0
Length: 1
= Failure.
ResponseStatusDescription

/ShipmentConfirmResponse/Response/ResponseStatusDescription
ResponseStatusDescription Required: Yes Describes Response Status
Type: String Code.Returns text of Success
Max Allowed: 1 or Failure.
Length: 1
Error

/ShipmentConfirmResponse/Response/Error
Error Required: Yes If an error is encountered
Type: Container during the interchange, the
Max Allowed: 1 Response contains an error.
Length: N/A
If the error is present, then
the ErrorSeverity and
ErrorCode are required.
/ShipmentConfirmResponse/Response/Error/ErrorSeverity
ErrorSeverity Required: Yes Describes the severity of the
Type: String error.
Max Allowed: 1
Transient Error - Customers
Length: 1...20
data has not been processed
due to system unavailability.
The customer has to wait and
try again.
Hard Error - The error was
encountered processing the
customer's data and that the
data needs correction.
Warning - The customer's
data was successfully
processed; however, there
were warnings encountered
during processing.
/ShipmentConfirmResponse/Response/Error/ErrorCode
ErrorCode Required: Yes A numeric value that
Type: String describes the error. Each API
Max Allowed: 1 defines a range of error
Length: 1..15 codes.
/ShipmentConfirmResponse/Response/Error/ErrorDescription
ErrorDescription Required: Yes Describes the error code.
Type: String
Max Allowed: 1
Length: 1..50
/ShipmentConfirmResponse/Response/Error/MinimumRetrySeconds

MinimumRetrySeconds Required: Yes Number of seconds to wait
Type: String until retry. This field is
Max Allowed: 1 populated on special
Length: 1..5 conditions of the Transient
Error only, as defined by the
service. A number between 1
and 86400 (24 hours)
/ShipmentConfirmResponse/Response/Error/ErrorLocation
ErrorLocation Required: Yes Identifies the element in
Type: Container error.
Max Allowed: 1
Length: N/A
/ShipmentConfirmResponse/Response/Error/ErrorLocation/ErrorLocationElementName
ErrorLocationElementName Required: Yes The XPATH name of the
Type: String element in error. This is a
Max Allowed: 1 valid XPATH pointing to an
Length: 1..512 element in the request
document.
/ShipmentConfirmResponse/Response/Error/ErrorLocation/ErrorLocationAttributeName
ErrorLocationAttributeName Required: Yes The name of the attribute in
Type: String error. This is the name of the
Max Allowed: 1 attribute contained by the
Length: 1..50 Error Location Element.
/ShipmentConfirmResponse/Response/Error/ErrorDigest
ErrorDigest Required: Yes The contents of the element
Type: String in error.
Max Allowed: 1
Length: Bound by the
size of the Request
data.
ShipmentCharges
/ShipmentConfirmResponse/ShipmentCharges
ShipmentCharges Required: Shipment charges info.Shipment
Cond charges are only guaranteed to be
Type: returned for shipments whose origin
Container country is US or Puerto Rico.
Max Allowed:
1
Length: N/A
RateChart

/ShipmentConfirmResponse/ShipmentCharges/RateChart
RateChart Required: Cond Rate Type with which Shipment is
Type: String rated. Possible RateChart values for
Max Allowed: 1 different regions will be: US 48 origin:
Length: 1 1 Daily Rates, 3 Standard List
Rates, 4 Retail Rates.
Alaska/Hawaii origin: 1 Daily
Rates, 3 Standard List Rates, 4
Retail Rates. All Other origins: 1
Rates, 5 - Regional Rates, 6 -
General List Rates. 3 and 4 do not
apply.
TransportationCharges

/ShipmentConfirmResponse/ShipmentCharges/TransportationCharges
TransportationCharges Required: Yes* Container for Transportation
Type: Container charges.
Max Allowed: 1
Length: N/A
/ShipmentConfirmResponse/ShipmentCharges/TransportationCharges/CurrencyCode
CurrencyCode Required: Yes* Transportation charges currency
Type: String code type. The currency code
Max Allowed: 1 used in the
Length: 3 ShipmentConfirmRequest is
returned.
/ShipmentConfirmResponse/ShipmentCharges/TransportationCharges/MonetaryValue
MonetaryValue Required: Yes* Transportation and surcharges Valid values are from 0 to
Type: String value amount. 99999999999999.99
Max Allowed: 1
Length: 1..19
ServiceOptionsCharges

/ShipmentConfirmResponse/ShipmentCharges/ServiceOptionsCharges

ServiceOptionsCharges Required: Yes* Container for Service Options
Max Allowed: 1
Length: N/A
/ShipmentConfirmResponse/ShipmentCharges/ServiceOptionsCharges/CurrencyCode
CurrencyCode Required: Yes* Service options charges
Type: String currency code type. The
Max Allowed: 1 currency code used in the
Length: 3 ShipmentConfirmRequest is
returned.
/ShipmentConfirmResponse/ShipmentCharges/ServiceOptionsCharges/MonetaryValue
MonetaryValue Required: Yes* Service options charges value Valid values are from 0 to
Type: String amount. 99999999999999.99
Max Allowed: 1
Length: 119
ItemizedCharges

/ShipmentConfirmResponse/ShipmentCharges/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned only These charges would be
Type: Container when the subversion element is returned only when
Max Allowed: UNB present and greater than or equal subversion is greater than or
Length: N/A to '1601'. equal to 1601
/ShipmentConfirmResponse/ShipmentCharges/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized
Type: String charge.
Max Allowed: 1
Length: 3
/ShipmentConfirmResponse/ShipmentCharges/ItemizedCharges/Description
Description Required: No Description of Itemized Charge that
Type: String had been applied.
Max Allowed: 1
Length: 150
/ShipmentConfirmResponse/ShipmentCharges/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* Itemized Charges currency code
Type: String type. The currency code used in the
Max Allowed: 1 ShipmentConfirmRequest is
Length: 3 returned.
/ShipmentConfirmResponse/ShipmentCharges/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount. Valid values are from 0 to
Type: String 99999999999999.99
Max Allowed: 1
Length: 119
/ShipmentConfirmResponse/ShipmentCharges/ItemizedCharges/SubType
SubType Required: No The sub-type of ItemizedCharge
Type: String type.
Max Allowed: 1
Length: 150
TaxCharges

/ShipmentConfirmResponse/ShipmentCharges/TaxCharges
TaxCharges Required: Cond TaxCharges container are returned
Type: Container only when TaxInformationIndicator
Max Allowed: UNB is present in Shipment Confirm
Length: N/A request and when Negotiated
Rates are not applicable.
TaxCharges container contains Tax
information for a given shipment.
/ShipmentConfirmResponse/ShipmentCharges/TaxCharges/Type
Type Required: Yes* Tax Type code. The code
Type: String represents the type of Tax applied
Max Allowed: 1 to a shipment.
Length: 19
Refer to Tax Type Values /
Abbreviations in the Appendix for
valid values.
/ShipmentConfirmResponse/ShipmentCharges/TaxCharges/MonetaryValue
MonetaryValue Required: Yes* Tax Monetary Value represents the Valid values are from 0 to
Type: String Tax amount. 99999999999999.99
Max Allowed: 1
Length: 119
TotalCharges

/ShipmentConfirmResponse/ShipmentCharges/TotalCharges
TotalCharges Required: Yes* Container for Total Charges.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentConfirmResponse/ShipmentCharges/TotalCharges/CurrencyCode
CurrencyCode Required: Yes* Total charges currency code
Type: String type.The currency code used in the
Length: 3 returned.
/ShipmentConfirmResponse/ShipmentCharges/TotalCharges/MonetaryValue
MonetaryValue Required: Yes* Total charges value amount. Valid values are from 0 to
Type: String 99999999999999.99.
Max Allowed: 1
Length: 1..19
TotalChargesWithTaxes

/ShipmentConfirmResponse/ShipmentCharges/TotalChargesWithTaxes

TotalChargesWithTaxes Required: Cond TotalChargesWithTaxes
Type: Container container would be returned
Max Allowed: 1 only if TaxInformationIndicator is
Length: N/A present in Shipment Confirm
request and when Negotiated
Rates are not applicable.
contains total charges including
total taxes applied to a
shipment.
/ShipmentConfirmResponse/ShipmentCharges/TotalChargesWithTaxes/CurrencyCode
CurrencyCode Required: Yes* TotalChargesWithTaxes
Type: String currency code type.The
Length: 3 Shipment Confirm request is
returned.
/ShipmentConfirmResponse/ShipmentCharges/TotalChargesWithTaxes/MonetaryValue
MonetaryValue Required: Yes* TotalChargesWithTaxes Valid values are from 0 to
Type: String monetary value amount. 99999999999999.99
Max Allowed: 1
Length: 119
BillingWeight
/ShipmentConfirmResponse/BillingWeight
BillingWeight Required: Yes Container for Billing Weight.
Type:
Container
Max Allowed:
1
Length: N/A
UnitOfMeasurement

/ShipmentConfirmResponse/BillingWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes Container for Unit of measurement
Type: Container for Billing Weight.
Max Allowed: 1
Length: N/A
/ShipmentConfirmResponse/BillingWeight/UnitOfMeasurement/Code
Code Required: Yes Billing Weight unit of
Type: String measurement code. The unit of
Max Allowed: 1 measurement used in Shipment
Length: 2..3 Confirm Request is returned.
/ShipmentConfirmResponse/BillingWeight/UnitOfMeasurement/Description
Description Required: No Description of the billing weight
Type: String measurement units. Valid values:
Max Allowed: 1 KGS or LBS
Length: 3
Weight

/ShipmentConfirmResponse/BillingWeight/Weight
Weight Required: Yes Billing weight. Higher of the actual Valid value up to 99999.99
Type: String shipment weight versus the shipment
Max Allowed: 1 dimensional weight.
Length: 8
ShipmentIdentificationNumber
/ShipmentConfirmResponse/ShipmentIdentificationNumber
ShipmentIdentificationNumber Required: Yes Returned UPS shipment ID Z number of the first package
Type: String number. in the shipment.
Max Allowed: 1
Length: 18
BillableWeightCalculationMethod
/ShipmentConfirmResponse/BillableWeightCalculationMethod
BillableWeightCalculationMethod Required: BillableWeightCalculationMethod is Valid values:
Cond to indicate whether the billable
Type: String weight calculation method utilized 01 = Shipment
Max Allowed: 1 was - the package level or shipment Billable Weight
Length: 2 level. 02 = Package
This information will be returned only Billable Weight.
if RatingMethodRequestedIndicator
is present in the request.
RatingMethod
/ShipmentConfirmResponse/RatingMethod
RatingMethod Required: RatingMethod is to indicate whether the Valid values:
Cond Shipment was rated as shipment level or
Type: String package level. This information will be 01 = Shipment level
Max Allowed: returned only if 02 = Package level.
1 RatingMethodRequestedIndicator is present
Length: 2 in the request.
Disclaimer
/ShipmentConfirmResponse/Disclaimer
Disclaimer Required: Disclaimer would be used to provide more
Cond information to shipper regarding the
Type: processed shipment. This would be used
Container to notify shipper about possible taxes and
Max Allowed: duties that might have been added or
UNB might apply to the shipment.
Length: N/A
Refer toDisclaimer Codes and Messages
in the Appendix for valid values.
This field would be returned only if
TaxInformationIndicator is present in a
request.
Code

/ShipmentConfirmResponse/Disclaimer/Code
Code Required: Code representing type of Disclaimer.
Yes*
Refer toDisclaimer Codes and
Type: String
Messages in the Appendix for valid
Max Allowed:
values.
1
Length: 2
Description

/ShipmentConfirmResponse/Disclaimer/Description
Description Required: Yes* Disclaimer description.
Type: String
Refer toDisclaimer Codes and
Max Allowed: 1
Messages in the Appendix for valid
Length:
values.
Unbounded
ShipmentDigest
/ShipmentConfirmResponse/ShipmentDigest
ShipmentDigest Required: Yes Encoded shipment parameters
Type: required to be passed in the accept
Encoded phase.
Max Allowed:
1
Length:
Variable
NegotiatedRates
/ShipmentConfirmResponse/NegotiatedRates
NegotiatedRates Required: No Container for Negotiated Rates. For tiered rates and promotional
Type: discounts, if a particular shipment
Container based on zone, origin, destination
Max Allowed: or even shipment size does not
1 qualify for the existing discount
Length: N/A then no negotiated rates
container will be returned.
Published rates will be the
applicable rate.
ItemizedCharges

/ShipmentConfirmResponse/NegotiatedRates/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned only
Type: Container when the subversion element is
Max Allowed: UNB present and greater than or equal to
Length: N/A '1601'.
/ShipmentConfirmResponse/NegotiatedRates/ItemizedCharges/Code
Max Allowed: 1
Length: 3
/ShipmentConfirmResponse/NegotiatedRates/ItemizedCharges/Description
Type: String had been applied.
Max Allowed: 1
Length: 150
/ShipmentConfirmResponse/NegotiatedRates/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* Itemized Charges currency code
Type: String type. The currency code used in the
Length: 3 returned.
/ShipmentConfirmResponse/NegotiatedRates/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount. Valid values are from 0 to
Type: String 99999999999999.99
Max Allowed: 1
Length: 119
/ShipmentConfirmResponse/NegotiatedRates/ItemizedCharges/SubType
Type: String type.
Max Allowed: 1
Length: 150
TaxCharges

/ShipmentConfirmResponse/NegotiatedRates/TaxCharges
TaxCharges Required: Cond TaxCharges container is returned
Type: Container only when TaxInformationIndicator
Max Allowed: is present in Shipment Confirm
UNB request. TaxCharges container
Length: N/A contains Tax information for a given
shipment.
/ShipmentConfirmResponse/NegotiatedRates/TaxCharges/Type
Type: String represents the type of Tax applied
Max Allowed: 1 to a shipment.
Length: 19
Abbreviations in the Appendix for
valid values.
/ShipmentConfirmResponse/NegotiatedRates/TaxCharges/MonetaryValue
MonetaryValue Required: Yes* Tax Monetary Value represents the Valid values are from 0 to
Type: String Tax amount. 99999999999999.99
Max Allowed: 1
Length: 119
NetSummaryCharges

/ShipmentConfirmResponse/NegotiatedRates/NetSummaryCharges
NetSummaryCharges Required: Cond Negotiated Rates info. Net
Type: Container Summary Charges are
Max Allowed: 1 only returned for shipper
Length: N/A account/UserId
combinations qualified for
Negotiated rates.
/ShipmentConfirmResponse/NegotiatedRates/NetSummaryCharges/GrandTotal
GrandTotal Required: Cond Container for Grand Total
Max Allowed: 1
Length: N/A
/ShipmentConfirmResponse/NegotiatedRates/NetSummaryCharges/GrandTotal/CurrencyCode
CurrencyCode Required: Yes* Net Summary charges
Type: String currency code type.
Max Allowed: 1
Length: 3
/ShipmentConfirmResponse/NegotiatedRates/NetSummaryCharges/GrandTotal/MonetaryValue
MonetaryValue Required: Yes* Net Summary charges Valid values are from 0 to
Type: String monetary value. 9999999999999999.99
Max Allowed: 1
Length: 1..19
/ShipmentConfirmResponse/NegotiatedRates/NetSummaryCharges/TotalChargesWithTaxes

Type: Container container would be
Max Allowed: 1 returned only if
Length: N/A TaxInformationIndicator is
present in Shipment
Confirm request.
contains total charges
including total taxes
applied to a shipment.
/ShipmentConfirmResponse/NegotiatedRates/NetSummaryCharges/TotalChargesWithTaxes/CurrencyCode
Type: String currency code type.The
Length: 3 Shipment Confirm request
is returned.
/ShipmentConfirmResponse/NegotiatedRates/NetSummaryCharges/TotalChargesWithTaxes/MonetaryValue
Max Allowed: 1
Length: 119
Chapter 5: Shipment Accept APIElements and Details
ShipmentAcceptRequest Top Level Containers
ShipmentAcceptRequest XPath Tables
Note: Not all containers/elements are reflected separately in the table of contents

/ShipmentAcceptRequest
ShipmentAcceptRequest Required: Yes Shipment Accept Request.
Type:
Container
Max Allowed:
1
Length: N/A
Request
/ShipmentAcceptRequest/Request
Request Required: Yes Container for Request.
Type: Container
Max Allowed: 1
Length: N/A
RequestAction

/ShipmentAcceptRequest/Request/RequestAction
RequestAction Required: Yes Indicates the action to be Must be ShipAccept.
Type: String taken by the XML service.
Max Allowed: 1
Length: 10
SubVersion

/ShipmentAcceptRequest/Request/SubVersion
SubVersion Required: No Indicates Ship API to display the
Type: String new release features in Ship API
Max Allowed: 1 response based on Ship release.
Length: 4
See the Release Features section
for the latest Ship release.
Supported values: 1601, 1607
Format: YYMM = Year and month of
the release.
Example: 1607 = 2016 July

/ShipmentAcceptRequest/Request/TransactionReference
Length: N/A
/ShipmentAcceptRequest/Request/TransactionReference/CustomerContext
Max Allowed: 1 pairs. The client establishes
Length: 1..50 CustomerContext, which can
contain any information client
want, as long as it is valid XML; it is
ShipmentDigest
/ShipmentAcceptRequest/ShipmentDigest
ShipmentDigest Required: Yes Encoded shipment parameters
Type: String required to be passed in the accept
Max Allowed: phase.
1
Length:
Unbounded
ShipAcceptResponse Top Level Containers
ShipmentAcceptResponse XPath Tables

/ShipmentAcceptResponse
ShipmentAcceptResponse Required: Yes Shipment Accept Response.
Type:
Container
Max Allowed:
1
Length: N/A
Response
/ShipmentAcceptResponse/Response
Response Required: Yes Response container for Ship Accept
Type: Response.
Container
Max Allowed:
1
Length: N/A

/ShipmentAcceptResponse/Response/TransactionReference
TransactionReference Required: Yes Transaction Reference
Type: Container Container.
Max Allowed: 1
Length: N/A
/ShipmentAcceptResponse/Response/TransactionReference/CustomerContext
Max Allowed: 1 pairs.
Length: 1...512
The client establishes
CustomerContext, which can
contain any information clients
want, as long as it is valid XML; it
is echoed back by the server.
ResponseStatusCode

/ShipmentAcceptResponse/Response/ResponseStatusCode
ResponseStatusCode Required: Yes Identifies the success or failure of
Type: String the transaction.
Max Allowed: 1 1 = Successful
Length: 1 0 = Failure
ResponseStatusDescription

/ShipmentAcceptResponse/Response/ResponseStatusDescription
ResponseStatusDescription Required: Yes Describes Response Status
Type: String Code. Returns text of Success
Max Allowed: 1 or Failure
Length: 1...10
Error

/ShipmentAcceptResponse/Response/Error
Error Required: Yes If an error is encountered
Length: N/A If the error is present, then the
ErrorSeverity and ErrorCode
are required.
/ShipmentAcceptResponse/Response/Error/ErrorSeverity
ErrorSeverity Required: Yes Describes the severity of the
Type: String error.
Max Allowed: 1
Transient Error - Customers
Length: 1..15
data has not been processed
due to system unavailability.
The customer has to wait and
try again.
Hard Error - The error was
encountered processing the
customer's data and that the
data needs correction.
Warning - The customer's
data was successfully
processed; however, there
were warnings encountered
during processing.
/ShipmentAcceptResponse/Response/Error/ErrorCode
ErrorCode Required: Yes A numeric value that
Length: 1..15 codes.
/ShipmentAcceptResponse/Response/Error/ErrorDescription
ErrorDescription Required: Yes Describes the error code.
Type: String
Max Allowed: 1
Length: 1..50

/ShipmentAcceptResponse/Response/Error/MinimumRetrySeconds
MinimumRetrySeconds Required: Yes Number of seconds to wait
Type: String until retry.
Max Allowed: 1
This field is populated on
Length: 1..5
special conditions of the
Transient Error only, as
defined by the service. A
number between 1 and
86400 (24 hours)
/ShipmentAcceptResponse/Response/Error/ErrorLocation
ErrorLocation Required: Yes Identifies the element in error.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentAcceptResponse/Response/Error/ErrorLocation/ErrorLocationElementName
ErrorLocationElementName Required: Yes The XPATH name of the
Max Allowed: 1 valid XPATH pointing to an
Length: 1...50 element in the request
document.
/ShipmentAcceptResponse/Response/Error/ErrorLocation/ErrorLocationAttributeName
ErrorLocationAttributeName Required: Yes The name of the attribute in
Length: 1..50 Error Location Element.
/ShipmentAcceptResponse/Response/Error/ErrorDigest
ErrorDigest Required: Yes The contents of the element
Type: String in error.
Max Allowed: 1
Length: Bound by the
size of the Request
data.
ShipmentResults
/ShipmentAcceptResponse/ShipmentResults
ShipmentResults Required: Yes Container for Shipment Results.
Type:
Container
Max Allowed:
1
Length: N/A
ShipmentCharges

/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges
ShipmentCharges Required: Cond Shipment charges
Type: Container Container. Shipment
Max Allowed: 1 charges info. Shipment
Length: N/A charges are only
guaranteed to be returned
for shipments whose origin
country is US or Puerto
Rico.
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/RateChart
RateChart Required: Cond Rate Type with which
Type: String Shipment is rated. Possible
Max Allowed: 1 RateChart values for
Length: 1 different regions will be:
US 48 origin:
1 Daily Rates
3 Standard List Rates
4 Retail Rates
Alaska/Hawaii origin
1 Daily Rates
3 Standard List Rates
4 Retail Rates
All Other origins:
1 Rates
5 - Regional Rates
6 - General List Rates
3 and 4 do not apply
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/TransportationCharges
TransportationCharges Required: Yes* Container for
Type: Container Transportation charges.
Max Allowed: 1
Length: N/A

/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/TransportationCharges/CurrencyCode
CurrencyCode Required: Yes* Transportation charges
Length: 3 ShipmentConfirmRequest
is returned.
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/TransportationCharges/MonetaryValue
MonetaryValue Required: Yes* Transportation and Valid values are from 0 to
Type: String surcharges value amount. 99999999999999.99
Max Allowed: 1
Length: 1...19
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/ServiceOptionsCharges
ServiceOptionsCharges Required: Yes* Container for Service
Type: Container Options charges.
Max Allowed: 1
Length:
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/ServiceOptionsCharges/CurrencyCode
CurrencyCode Required: Yes* Accessorial charges
is returned.
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/ServiceOptionsCharges/MonetaryValue
MonetaryValue Required: Yes* Accessorial charges value Valid values are from 0 to
Max Allowed: 1
Length: 119
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are These charges would be
Type: Container returned only when the returned only when
Max Allowed: UNB subversion element is subversion is greater than
Length: N/A present and greater than or or equal to 1601
equal to '1601'.
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/Code
Code Required: Yes* Identification code for
Type: String itemized charge.
Max Allowed: 1
Length: 3
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/Description
Description Required: No Description of Itemized
Type: String Charge that had been
Max Allowed: 1 applied.
Length: 150
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* Itemized Charges currency
Type: String code type. The currency
Max Allowed: 1 code used in the
is returned.

/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value Valid values are from 0 to
Max Allowed: 1
Length: 119
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/SubType
SubType Required: No The sub-type of
Type: String ItemizedCharge type.
Max Allowed: 1
Length: 150
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/TaxCharges
TaxCharges Required: Cond TaxCharges container are
Type: Container returned only when
Max Allowed: UNB TaxInformationIndicator is
Length: N/A present in Shipment
Confirm request and when
Negotiated Rates are not
applicable. TaxCharges
container contains Tax
information for a given
shipment.
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/TaxCharges/Type
Type: String represents the type of Tax
Max Allowed: 1 applied to a shipment.
Length: 19
Abbreviations in the
Appendix for valid values.
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/TaxCharges/MonetaryValue
MonetaryValue Required: Yes* Tax Monetary Value Valid values are from 0 to
Type: String represent the Tax amount. 99999999999999.99
Max Allowed: 1
Length: 119
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/TotalCharges
TotalCharges Required: Yes* Container for Total
Type: Container Charges.
Max Allowed: 1
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/TotalCharges/CurrencyCode
CurrencyCode Required: Yes* Total charges currency
Type: String code type. The currency
Max Allowed: 1 code used in the
is returned.
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/TotalCharges/MonetaryValue
MonetaryValue Required: Yes* Total charges value Valid values are from 0 to
Max Allowed: 1
Length: 1..19

/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/TotalChargesWithTaxes
present in Shipment
Confirm request and when
Negotiated Rates are not
applicable.
including total taxes applied
to a shipment.
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/TotalChargesWithTaxes/CurrencyCode
is returned.
/ShipmentAcceptResponse/ShipmentResults/ShipmentCharges/TotalChargesWithTaxes/MonetaryValue
Max Allowed: 1
Length: 1..19
Negotiated Rates

/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates
NegotiatedRates Required: Cond Container for Negotiated Rates. For tiered rates and promotional
Type: Container discounts, if a particular shipment
Max Allowed: 1 based on zone, origin,
Length: N/A destination or even shipment size
doesn't qualify for the existing
discount then no negotiated rates
container will be returned.
Published rates will be the
applicable rate.
ItemizedCharges

/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned
Type: Container only when the subversion
Max Allowed: UNB element is present and greater
Length: N/A than or equal to '1601'.
/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/ItemizedCharges/Code
Max Allowed: 1
Length: 3

/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/ItemizedCharges/Description
Description Required: No Description of Itemized Charge
Type: String that had been applied.
Max Allowed: 1
Length: 150
/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* Itemized Charges currency
code type. The currency code
used in the
ShipmentConfirmRequest is
returned.
/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value Valid values are from 0 to
Max Allowed: 1
Length: 119
/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/ItemizedCharges/SubType
Max Allowed: 1
Length: 150
TaxCharges

/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/TaxCharges
TaxCharges Required: Cond TaxCharges container are
Type: Container returned only when
Max Allowed: UNB TaxInformationIndicator is
Length: N/A present in Shipment Confirm
request. TaxCharges container
contains Tax information for a
given shipment.
/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/TaxCharges/Type
Type: String represents the type of Tax
Max Allowed: 1 applied to a shipment.
Length: 19
Abbreviations in the Appendix
for valid values.
/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/TaxCharges/MonetaryValue
MonetaryValue Required: Yes* Tax Monetary Value represent Valid values are from 0 to
Type: String the Tax amount. 99999999999999.99
Max Allowed: 1
Length: 119
NetSummaryCharges

/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/NetSummaryCharges
NetSummaryCharges Required: Cond Account Based Rates info.
Type: Container Net Summary Charges are
Max Allowed: 1 only returned for ABR
Length: N/A eligible shipper
account/UserId
combinations when the
user includes the
NegotiatedRates indicator
in the ShipConfirm
request.
/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/NetSummaryCharges/GrandTotal
GrandTotal Required: Yes* Container for Grand Total.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/NetSummaryCharges/GrandTotal/CurrencyCode
CurrencyCode Required: Yes* Net Summary charges
Type: String currency code.
Max Allowed: 1
Length: 3
/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/NetSummaryCharges/GrandTotal/MonetaryValue
MonetaryValue Required: Yes* Net Summary charges Valid values are from 0 to
monetary value. 9999999999999999.99
/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/NetSummaryCharges/TotalChargesWithTaxes
present in Shipment
Confirm request.
including total taxes
applied to a shipment.
/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/NetSummaryCharges/TotalChargesWithTaxes/C
urrencyCode
is returned.
/ShipmentAcceptResponse/ShipmentResults/NegotiatedRates/NetSummaryCharges/TotalChargesWithTaxes/M
onetaryValue
Max Allowed: 1
Length: 119
BillingWeight

/ShipmentAcceptResponse/ShipmentResults/BillingWeight
BillingWeight Required: Yes Container for Billing Weight.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/BillingWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes Container for Unit of
Type: Container measurement for Billing
Max Allowed: 1 Weight.
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/BillingWeight/UnitOfMeasurement/Code
Code Required: Yes Billing weight unit of
Type: String measurement code. The unit of
Max Allowed: 1 measurement used in
Length: 2...3 ShipmentConfirmRequest is
returned.
/ShipmentAcceptResponse/ShipmentResults/BillingWeight/UnitOfMeasurement/Description
Description Required: No Description of the billing weight
Type: String measurement units. Values are:
Max Allowed: 1 KGS or LBS
Length: 3
/ShipmentAcceptResponse/ShipmentResults/BillingWeight/Weight
Weight Required: Yes Billing weight. Higher of the
Type: String actual shipment weight versus
Max Allowed: 1 the shipment dimensional
Length: 8 weight.
Disclaimer

/ShipmentAcceptResponse/ShipmentResults/Disclaimer
Disclaimer Required: Cond Disclaimer would be used to
Type: Container provide more information to shipper
Max Allowed: regarding the processed shipment.
UNB This would be used to notify
Length: N/A shipper about possible taxes and
duties that might have been added
or might apply to the shipment.
Refer to Disclaimer Codes and
Messages in the Appendix for
various disclaimers that would be
possible for a given shipment.
This field would be returned only if
TaxInformationIndicator is present
in a Shipment Confirm request.

/ShipmentAcceptResponse/ShipmentResults/Disclaimer/Code
Code Required: Yes* Code representing type of
Type: String Disclaimer.
Max Allowed: 1
Length: 2
possible code values.
/ShipmentAcceptResponse/ShipmentResults/Disclaimer/Description
Description Required: Yes* Disclaimer description.
possible descriptions.

/ShipmentAcceptResponse/ShipmentResults/ShipmentIdentificationNumber
ShipmentIdentificationNumber Required: Yes Returned UPS shipment ID 1Z Number of the first
Type: String number. package in the shipment.
Max Allowed: 1
Length: 18
RatingMethod

/ShipmentAcceptResponse/ShipmentResults/RatingMethod
RatingMethod Required: Cond RatingMethod is to indicate whether the Valid values are 01 =
Type: String Shipment was rated as shipment level or Shipment level, 02 =
Max Allowed: 1 package level. This information will be Package level.
Length: 2 returned only if
RatingMethodRequestedIndicator was
present in the ship confirm request.

/ShipmentAcceptResponse/ShipmentResults/BillableWeightCalculationMethod
BillableWeightCalculationMethod Required: Cond BillableWeightCalculationMethod Valid values:
is to indicate whether the billable
01 = Shipment
weight calculation method utilized
Billable Weight
was - the package or shipment
level. This information will be 02 = Package
returned only if Billable Weight
RatingMethodRequestedIndicator
was present in the ship confirm
request.
ControlLogReceipt

/ShipmentAcceptResponse/ShipmentResults/ControlLogReceipt
ControlLogReceipt Required: Cond Container for the High Value When forward shipments
Type: Container reports. declared value between $999
Max Allowed: 1 and $50,000 USD. Two
Length: N/A copies of high value report
needs to be printed out.
/ShipmentAcceptResponse/ShipmentResults/ControlLogReceipt/ImageFormat
ImageFormat Required: Cond Container for the High Value
Type: Container report format, required if
Max Allowed: 1 parent exist.
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/ControlLogReceipt/ImageFormat/Code
Code Required: Yes* Code for the type of Graphic Values are: EPL = EPL2
Type: String Image for the High Value (when user requests label in
Max Allowed: 1 Report. EPL2 format), SPL = SPL
Length: 4 (when user requests label in
SPL format), ZPL = ZPL (when
user requests label in ZPL
format), HTML= HTML (when
user requests label in HTML
format).
/ShipmentAcceptResponse/ShipmentResults/ControlLogReceipt/ImageFormat/Description
Description Required: No Description of the format code
Type: String
Max Allowed: 1
Length: 1..35
/ShipmentAcceptResponse/ShipmentResults/ControlLogReceipt/GraphicImage
GraphicImage Required: Yes* Base 64 encoded html, EPL2,
Type: Base64 ZPL or SPL image.
encoded
Max Allowed: 1
Length: UNB
PackageResults

/ShipmentAcceptResponse/ShipmentResults/PackageResults
PackageResults Required: No Returned Package
Type: Container Information.
Max Allowed: Many (up
to 200)
Length: N/A

/ShipmentAcceptResponse/ShipmentResults/PackageResults/TrackingNumber
TrackingNumber Required: Yes* Package 1Z number.
Type: String
Max Allowed: 1
shipments, please use
Length: 18
the USPSPICNumber
when tracking packages
(a non-1Z number Mail
Manifest Id is returned).
/ShipmentAcceptResponse/ShipmentResults/PackageResults/ServiceOptionsCharges
ServiceOptionsCharges Required: Cond Shipment charges info.
Type: Container Shipment charges are
Max Allowed: 1 only guaranteed to be
Length: N/A returned for shipments
whose origin country is
US or Puerto Rico.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/ServiceOptionsCharges/CurrencyCode
CurrencyCode Required: Yes* Package accessorial
Type: String charges currency code
Max Allowed: 1 type. The currency code
Length: 3 used in the
ShipmentConfirmReque
st is returned.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/ServiceOptionsCharges/MonetaryValue
MonetaryValue Required: Yes* Package accessorial Valid values are from 0
Type: String charges value amount. to 99999999999999.99
Max Allowed: 1
Length: 1..19
/ShipmentAcceptResponse/ShipmentResults/PackageResults/LabelImage
LabelImage Required: Cond The container for UPS Shipment without return
Type: Container shipping label service or with PRL
Max Allowed: 1 return service.
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/PackageResults/LabelImage/LabelImageFormat
LabelImageFormat Required: Yes* Container for Label
Type: Container Image Format.
Max Allowed: 1
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/PackageResults/LabelImage/LabelImageFormat/Code
Code Required: Yes* Label image code that Only EPL, SPL, ZPL and
Type: String the labels are generated. GIF are currently
Max Allowed: 1 Values: supported.
Length: 3
EPL = EPL2 For multi piece COD
shipments, the label
SPL = SPL
image format for the first
ZPL = ZPL package will always be
GIF = gif images a GIF for any form of
label requested.
PNG for PNG images

/ShipmentAcceptResponse/ShipmentResults/PackageResults/LabelImage/LabelImageFormat/Description
Description Required: No Description of the label
Type: String image format code.
Max Allowed: 1
Length: 1..35
/ShipmentAcceptResponse/ShipmentResults/PackageResults/LabelImage/GraphicImage
GraphicImage Required: Yes* Base 64 encoded
Type: Base 64 Encoded graphic image.
Max Allowed: 1
Length: Unbounded
/ShipmentAcceptResponse/ShipmentResults/PackageResults/LabelImage/InternationalSignatureGraphicImage
InternationalSignatureGraphicIm Required: Cond Base 64 encoded EPL2, ZPL and SPL
age Type: Base 64 Encoded graphic image of the labels. The image will be
Max Allowed: 1 Warsaw text and returned for non-US
Length: Unbounded signature box. based shipments. One
image will be given per
shipment and it will be in
the first PackageResults
container.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/LabelImage/HTMLImage
HTMLImage Required: Cond Base 64 encoded html This is only returned for
Type: Base 64 Encoded browser image rendering gif and png image
Max Allowed: 1 software. formats.
Length: Unbounded
/ShipmentAcceptResponse/ShipmentResults/PackageResults/LabelImage/PDF417
PDF417 Required: Cond PDF-417 is a two- Returned for shipment
Type: Base 64 Encoded dimensional barcode, with PRL return service
Max Allowed: 1 which can store up to only
Length: Unbounded about 1,800 printable
ASCII characters or
1,100 binary characters
per symbol. The symbol
is rectangular. The
image is Base 64
encoded and returned if
the LabelImageFormat
code is GIF.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Receipt
Receipt Required: Cond Container for the receipt Not supported for ERL
Type: Container and the receipt link. shipments.
Max Allowed: 1
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Receipt/Image
Image Required: Cond Container for the receipt
Type: Container of a return shipment
Max Allowed: 1
Length: N/A

/ShipmentAcceptResponse/ShipmentResults/PackageResults/Receipt/Image/ImageFormat
ImageFormat Required: Yes* Container for a receipt
Type: String format
Max Allowed: 1
Length: 4
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Receipt/Image/ImageFormat/Code
Code Required: Yes* Code representing the
Type: String format in which a receipt
Max Allowed: 1 is returned. Valid values:
Length: 4 HTML = HTML format
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Receipt/Image/ImageFormat/Description
Description Required: No Description of the image
Type: String format code.
Max Allowed: 1
Length: 1..35
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Receipt/Image/GraphicImage
GraphicImage Required: Yes* Base 64 encoded PRL
Type: Base 64 Encoded receipt in HTML format
Max Allowed: 1
Length: Unbounded
/ShipmentAcceptResponse/ShipmentResults/PackageResults/USPSPICNumber
USPSPICNumber Required: Cond USPSPICNumber is
Type: String USPS Package
Max Allowed: 1 Identification; it should
Length: Unbounded be used for tracking Mail
Innovations shipments.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/CN22Number
CN22Number Required: Cond USPS defined CN22 ID
Type: String number format varies
Max Allowed: 1 based on destination
Length: N/A country. Not applicable
as of Jan 2015. Mail
Innovations shipments
US to VI, PR, and GU are
not considered
international.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Form
Form Required: Cond Container tag for the Currenlty this container
Type: Container International forms would be returned for
Max Allowed: 1 image. UPS Premium Care
Length: N/A shipments.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Form/Code
Code Required: Yes* Code that indicates the Possible Values: 01 - All
Type: String type of form. Requested International
Max Allowed: 1 Forms.
Length: 2

/ShipmentAcceptResponse/ShipmentResults/PackageResults/Form/Description
Description Required: No Description that indicates Possible Values - All
Type: String the type of form. Requested International
Max Allowed: 1 Forms.
Length: 1....35
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Form/Image
Image Required: Cond Container tag for the
Type: Container International forms
Max Allowed: 1 image.
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Form/Image/ImageFormat
ImageFormat Required: Cond Container tag for the
Type: Container International forms
Max Allowed: 1 image format
Length: N/A information.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Form/Image/ImageFormat/Code
Code Required: Cond Code representing the Possible Values: PDF =
Type: String format in which the forms pdf , PNG = png.
Max Allowed: 1 are generated.
Length: 3
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Form/Image/ImageFormat/Description
Description Required: No Description of the form
Type: String image format code.
Max Allowed: 1
Length: 1...35
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Form/Image/GraphicImage
GraphicImage Required: Cond Base 64 encoded
Type: Base 64 Encoded International forms
Max Allowed: 1 image
Length: Unbounded
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Form/FormGroupId
FormGroupId Required: No Unique Id for later
Type: String retrieval of saved version
Max Allowed: 1 of the completed
Length: 1...26 international forms.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Form/FormGroupIdName
FormGroupIdName Required: No Contains description text
Type: String which identifies the
Max Allowed: 1 group of International
Length: 1...50 forms. This element is
part of both request and
response. This element
does not appear on the
forms.

/ShipmentAcceptResponse/ShipmentResults/PackageResults/Accessorial
Accessorial Required: Cond The container for This is valid only for UPS
Type: Container Accessorial indicators. Worldwide Express
Max Allowed: 1 This information would Freight Service.
Length: N/A be returned only if
ItemizedChargesReques
ted was present during
Ship Confirm request
phase.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Accessorial/Code
Code Required: Yes* Code for Accessorial
Type: String Indicator.
Max Allowed: 1
Length: 3
/ShipmentAcceptResponse/ShipmentResults/PackageResults/Accessorial/Description
Description Required: No Description for
Type: String Accessorial Indicator.
Max Allowed: 1
Length: 1...50
ItemizedCharges

/ShipmentAcceptResponse/ShipmentResults/PackageResults/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned only
Type: Container when the subversion element is
Max Allowed: UNB present and greater than or equal to
Length: N/A '1607'.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/ItemizedCharges/Code
Max Allowed: 1
Length: 3
/ShipmentAcceptResponse/ShipmentResults/PackageResults/ItemizedCharges/Description
Type: String had been charged.
Max Allowed: 1
Length: 150
/ShipmentAcceptResponse/ShipmentResults/PackageResults/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code associated
Type: String with the Itemized Charge costs for
Max Allowed: 1 the shipment.
Length: 3
/ShipmentAcceptResponse/ShipmentResults/PackageResults/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount.
Type: String
Max Allowed: 1
Length: 16.2

/ShipmentAcceptResponse/ShipmentResults/PackageResults/ItemizedCharges/SubType
Type: String type.
Max Allowed: 1
Length: 150
NegotiatedCharges

/ShipmentAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges
NegotiatedRateCharges Required: Cond Negotiated Rates Charge These charges would be
Type: Container Container. returned only when -
Max Allowed: 1 1) subversion is greater
Length: N/A than or equal to 1607
2) if negotiated rates were
requested for GFP
shipments and account
number is eligible to
receive negotiated rates.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges
ItemizedCharges Required: Cond Negotiated Itemized
Type: Container Accessorial and Sur
Max Allowed: UNB Charges.
Length: N/A
These charges would be
returned only when
Subversion is greater than
or equal to 1607.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/Code
Code Required: Yes* Identification code for
Type: String itemized charge.
Max Allowed: 1
Length: 3
/ShipmentAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/Description
Description Required: No Description of Itemized
Type: String Charge that had been
Max Allowed: 1 charged.
Length: 150
/ShipmentAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/CurrencyC
ode
CurrencyCode Required: Yes* The IATA currency code
Type: String associated with the
Max Allowed: 1 Itemized Charge costs for
Length: 3 the shipment.
/ShipmentAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/MonetaryV
alue
MonetaryValue Required: Yes* Itemized Charges value
Type: String amount.
Max Allowed: 1
Length: 16.2

/ShipmentAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/SubType
Max Allowed: 1
Length: 150
Form

/ShipmentAcceptResponse/ShipmentResults/Form
Form Required: Cond Container tag for the
Type: Container International forms image.
Max Allowed: 1
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/Form/Code
Code Required: Yes* Code that indicates the type of Possible Values: 01 - All
Type: String form. Requested International Forms.
Max Allowed: 1
Length: 2
/ShipmentAcceptResponse/ShipmentResults/Form/Description
Description Required: Yes* Description that indicates the Possible Values - All
Type: String type of form. Requested International Forms.
Max Allowed: 1
Length: 1....35
/ShipmentAcceptResponse/ShipmentResults/Form/Image
Image Required: Cond Container tag for the
Type: Container International forms image.
Max Allowed: 1
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/Form/Image/ImageFormat
ImageFormat Required: Cond Container tag for the
Type: Container International forms image
Max Allowed: 1 format information.
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/Form/Image/ImageFormat/Code
Code Required: Cond Code representing the format Only PDF is supported
in which the forms are currently.
generated Possible Values
PDF = pdf.
/ShipmentAcceptResponse/ShipmentResults/Form/Image/ImageFormat/Description
Description Required: No Description of the form image
Type: String format code.
Max Allowed: 1
Length: 1..35

/ShipmentAcceptResponse/ShipmentResults/Form/Image/GraphicImage
GraphicImage Required: Cond Base 64 encoded International
Type: Base 64 forms image.
Encoded
Max Allowed: 1
Length: Unbounded
/ShipmentAcceptResponse/ShipmentResults/Form/FormGroupId
FormGroupId Required: Cond Unique Id for later retrieval of Always returned when code =
Type: String saved version of the completed 01. 01 represents international
Max Allowed: 1 international forms. forms.
Length: 1...26
/ShipmentAcceptResponse/ShipmentResults/Form/FormGroupIdName
FormGroupIdName Required: No Contains description text which
Type: String identifies the group of
Max Allowed: 1 International forms. This
Length: 1...50 element is part of both request
and response. This element
does not appear on the forms.
CODTurnInPage

/ShipmentAcceptResponse/ShipmentResults/CODTurnInPage
CODTurnInPage Required: No The container for COD Turn
Type: Container In Page. COD info block is
Max Allowed: 1 included in HTML label
Length: N/A instruction. Only supports
HTML format. Only supports
EU countries.
/ShipmentAcceptResponse/ShipmentResults/CODTurnInPage/Image
Image Required: Yes* The container of the image
for COD Turn In Page.
/ShipmentAcceptResponse/ShipmentResults/CODTurnInPage/Image/ImageFormat
ImageFormat Required: Yes* The container for format of
Type: Container COD Turn In Page
Max Allowed: 1
Length: N/A
/ShipmentAcceptResponse/ShipmentResults/CODTurnInPage/Image/ImageFormat/Code
Code Required: Yes* Format code of the generated Only HTML format is
Type: String COD Turn In Page. Valid supported for COD Turn In
Max Allowed: 1 values: HTML = HTML Page.
Length: 4 format.
/ShipmentAcceptResponse/ShipmentResults/CODTurnInPage/Image/ImageFormat/Description
Description Required: No Description of the format
Type: String code of generated COD Turn
Max Allowed: 1 In page.
Length: 1...35

/ShipmentAcceptResponse/ShipmentResults/CODTurnInPage/Image/GraphicImage
GraphicImage Required: Yes* Base 64 encoded html
Type: Base 64 browser image rendering
Encoded software.
Max Allowed: 1
Length: Unbounded
HighValueReport

/ShipmentAcceptResponse/ShipmentResults/HighValueReport
HighValueReport Required: No Container for the HighValue
Type: Container Report generated for
Max Allowed: 1 ImportControl or Return
Length: N/A shipments with high package
declared value.
/ShipmentAcceptResponse/ShipmentResults/HighValueReport/Image
Image Required: Yes* Container for the HighValue
Report image for Import
Control or Return Shipments.
/ShipmentAcceptResponse/ShipmentResults/HighValueReport/Image/ImageFormat
ImageFormat Required: Yes* Container for the HighValue
Type: Container Report image format
Max Allowed: 1 information for Import Control
Length: N/A or Return Shipments.
/ShipmentAcceptResponse/ShipmentResults/HighValueReport/Image/ImageFormat/Code
Code Required: Yes* Code for Image Format in Valid value is PDF.
Type: String which High Value Report
Max Allowed: 1 would be returned.
Length: 3
/ShipmentAcceptResponse/ShipmentResults/HighValueReport/Image/ImageFormat/Description
Description Required: Yes* Description for Image
Type: String Format.
Max Allowed: 1
Length: 1...35
/ShipmentAcceptResponse/ShipmentResults/HighValueReport/Image/GraphicImage
GraphicImage Required: Yes* Base 64 encoded High
Type: Base 64 Value Report.
Encoded
Max Allowed: 1
Length: Unbounded
LabelURL

/ShipmentAcceptResponse/ShipmentResults/LabelURL
LabelURL Required: Cond LabelURL is returned only if the
Type: String LabelLinksIndicator is requested for
Max Allowed: 1 an ImportControl shipment or for a
Length: Return shipment. URL will point to a
Unbounded label and can also point to
HighValueReport, CustomsInvoice
and ImportControl instructions.
LocalLanguageLabelURL

/ShipmentAcceptResponse/ShipmentResults/LocalLanguageLabelURL
LocalLanguageLabelURL Required: Cond LocalLanguageLabelURL is
Type: String returned only if the
Max Allowed: 1 LabelLinksIndicator is requested
Length: for an ImportControl shipment or
Unbounded for a Return shipment. URL will
point to a label and can also point
to HighValueReport,
CustomsInvoice and
ImportControl instructions in the
Country's local language if
supported by UPS.
ReceiptURL

/ShipmentAcceptResponse/ShipmentResults/ReceiptURL
ReceiptURL Required: Cond ReceiptURL is returned if the
Type: String LabelLinksIndicator is requested for
Max Allowed: 1 an ImportControl shipment or a
Length: Return shipment.
Unbounded
LocalLanguageReceiptURL

/ShipmentAcceptResponse/ShipmentResults/LocalLanguageReceiptURL
LocalLanguageReceiptURL Required: Cond LocalLanguageReceiptURL is
Type: String returned if the
Max Allowed: 1 LabelLinksIndicator is requested
Length: for an ImportControl shipment or
Unbounded a Return shipment. The URL will
contain the receipt in the
Country's local language if
supported by UPS.
Chapter 6: Label Recovery Elements and Details
Only Return Shipments support Label Recovery. The label for the return shipment can be recovered using the
Tracking Number.
For up to 30 days after customers schedule return shipments, UPS maintains a copy of the shipping labels for the
returned package. If customers need to print additional copies of return labels, the Label Recovery Shipping API
can retrieve those labels.
Merchants typically provide this functionality on their own web site. Their customers access the merchant's web site,
which acts as an intermediary on their behalf to retrieve the label from UPS.
LabelRecoveryRequest Top Level Containers
LabelRecoveryRequest XPath Tables
/LabelRecoveryRequest
LabelRecoveryRequest Required: Yes Label Recovery Request Container.
Type: Only available for ERL return types.
Container
Max Allowed:
1
Length: N/A
Request
/LabelRecoveryRequest/Request
Request Required: Yes Request Container.
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryRequest/Request/TransactionReference
Length: N/A
/LabelRecoveryRequest/Request/RequestAction
RequestAction Required: Yes Indicates the action to be taken by
Type: String the XML service. Must be
Max Allowed: 1 LabelRecovery.
Length: 113
LabelSpecification
/LabelRecoveryRequest/LabelSpecification
LabelSpecification Required: No Container used to define the
Type: Container properties required by the user to
Max Allowed: 1 print and/or display the label.
Length: N/A
/LabelRecoveryRequest/LabelSpecification/HTTPUserAgent
HTTPUserAgent Required: No Browser HTTPUserAgent String.
Type: String
This is the preferred way of
Max Allowed: 1
identifying GIF image type to be
Length: 1..64
generated. If not specified, default
to Mozilla/4.5
/LabelRecoveryRequest/LabelSpecification/LabelImageFormat
LabelImageFormat Required: No The file format of the label and
Type: Container receipt.
Max Allowed: 1
Default to HTML format if this node
Length: N/A
does not exist.
/LabelRecoveryRequest/LabelSpecification/LabelImageFormat/Code
Code Required: No File type that the label and receipt
Type: String is to be generated in. Valid values:
Max Allowed: 1
GIF - The generated label and
Length: 3
receipt are in HTML format.
PDF - The generated label and
receipt are in PDF format.
If the Label contains Customs
Invoice then the Label and receipt
will always be returned in PDF
format.
Translate
/LabelRecoveryRequest/Translate
Translate Required: No Translate container allows the user to
Type: specify the language he/she would
Container like a specific portion of response to
Max Allowed: 1 return.
Length: N/A
The language is specified by the
combination of language code and
dialect code.
Valid combinations are:
LanguageCode + DialectCode.
Languages:
eng GB = Queen's English
spa 97 = Castilian Spanish
ita 97 = Italian
fra 97 = France French
fra CA = Canadian French
deu 97 = German
por 97 = Portugal Portuguese
nld 97 = Dutch
dan 97 = Danish
fin 97 = Finnish
swe 97 = Swedish
eng CA = Canadian English
Eng US = US English
Default language is Queen's English.
If the Ship from country is Canada, the
Language defaults to Canadian
English.
If the ship from country is US, the
language defaults to US English.
If shipping from some other country,
the language defaults to Queens
English.

/LabelRecoveryRequest/Translate/LanguageCode
LanguageCode Required: Yes* The Language code. The language
Type: String codes are three letter language
Max Allowed: 1 codes.
Length: 2...3
Supported languages are:
eng - English
spa - Spanish
ita - Italian
fra - French
deu - German
por - Portuguese
nld - Dutch
dan - Danish
fin - Finnish
swe - Swedish
nor - Norwegian
/LabelRecoveryRequest/Translate/DialectCode
DialectCode Required: Yes* Valid dialect codes are:
Type: String
CA - Canada
Max Allowed: 1
Length: 2 GB - Great Britain
97 - Not Applicable
US - United States
/LabelRecoveryRequest/Translate/Code
Code Required: Yes* Used to specify what will be
Type: String translated. Valid codes are: 01. Code
Max Allowed: 1 Definitions: 01 = label direction
Length: 2 instructions and receipt.
LabelDelivery
/LabelRecoveryRequest/LabelDelivery
LabelDelivery Required: No Container for the Label Delivery
Type: Container accessorial. One Label Delivery per
Length: N/A
/LabelRecoveryRequest/LabelDelivery/LabelLinkIndicator
LabelLinkIndicator Required: No Indicates the Label Recovery and Valid for shipments with a Web
Type: String Receipt Recovery URL links are to Return Label Return Service.
Max Allowed: 1 be returned in the XML Response.
Length: 0
TrackingNumber
/LabelRecoveryRequest/TrackingNumber
TrackingNumber Required: Package Tracking Number. If the
Cond TrackingNumber is not provided, then the
Type: String ReferenceNumber/Value and
Max Allowed: ShipperNumber have to be provided.
1
Length: 1..18
ReferenceNumber
/LabelRecoveryRequest/ReferenceNumber
ReferenceNumber Required: Yes Reference Number Container.
Type:
Container
Max Allowed:
1
Length: N/A
/LabelRecoveryRequest/ReferenceNumber/Value
Value Required: Required if TrackingNumber is not
Cond populated. Customer supplied
Type: String reference number.
Max Allowed:
Supports up to 2 customer supplied
1
combinations of Reference code-
Length: 1..35
value combinations.
ShipperNumber
/LabelRecoveryRequest/ShipperNumber
ShipperNumber Required: Required if ReferenceNumber/Value is
Cond populated.
Type: String
Shipper's six digit account number.
Max Allowed:
1 Must be six alphanumeric characters.
Length: 6 Must be associated with the Internet
account used to login.
LabelRecoveryResponse Top Level Containers
LabelRecoveryResponse XPath Tables
/LabelRecoveryResponse
LabelRecoveryResponse Required: Yes Label Recovery Response
Type: Container.
Container
Max Allowed:
1
Length: N/A
Response
/LabelRecoveryResponse/Response
Response Required: Yes Response Container.
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryResponse/Response/TransactionReference
TransactionReference Required: Yes TransactionReference
Type: Container identifies transactions
Max Allowed: 1 between client and server.
Length: N/A
/LabelRecoveryResponse/Response/TransactionReference/CustomerContext
CustomerContext Required: No Customer provided data. May
Type: String be XML. If this data is present
Max Allowed: 1 in the request, it is echoed
Length: 0..512 back to the customer.
/LabelRecoveryResponse/Response/TransactionReference/XpciVersion
XpciVersion Required: No Identifies the version of the
Type: String message. Current version is
Max Allowed: 1 1.0001
Length: 1..50

/LabelRecoveryResponse/Response/ResponseStatusCode
ResponseStatusCode Required: Yes Identifies the success or
Type: String failure of the interchange. 1 =
Max Allowed: 1 Success0 = Failure
Length: 1
/LabelRecoveryResponse/Response/ResponseStatusDescription
ResponseStatusDescription Required: No Describes the Response
Type: String Status Code.
Max Allowed: 1
Length: 1..15
/LabelRecoveryResponse/Response/Error
Error Required: No If an error is encountered
Length: N/A If the error is present, then the
are required.
/LabelRecoveryResponse/Response/Error/ErrorSeverity
ErrorSeverity Required: Yes* Describes the severity of the
Type: String error.
Max Allowed: 1
Length: 1..15
/LabelRecoveryResponse/Response/Error/ErrorCode
ErrorCode Required: Yes* A numeric value that
Length: 1..15 codes. Refer to error
conditions, in the appropriate
chapter, for a complete list of
interchange errors.
/LabelRecoveryResponse/Response/Error/ErrorDescription
ErrorDescription Required: No Describes the error code.
Type: String
Max Allowed: 1
Length: 1..50
/LabelRecoveryResponse/Response/Error/MinimumRetrySeconds
MinimumRetrySeconds Required: No Number of seconds to wait
Type: String until retry. This entry is
Max Allowed: 1 populated on special
Length: 1..5 conditions of the Transient
Error only, as defined by the
service. A number between 1
and 86400 (24 hours)
/LabelRecoveryResponse/Response/Error/ErrorLocation
ErrorLocation Required: No Identifies the element in error.
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryResponse/Response/Error/ErrorLocation/ErrorLocationElementName

ErrorLocationElementName Required: No The Xpath name of the
Max Allowed: 1 valid Xpath pointing to an
Length: 1..512 element in the request
document.
/LabelRecoveryResponse/Response/Error/ErrorLocation/ErrorLocationAttributeName
ErrorLocationAttributeName Required: No The name of the attribute in
Length: 1..50 Error Location element.
/LabelRecoveryResponse/Response/Error/ErrorDigest
ErrorDigest Required: No The contents of the element in
Type: String error.
Max Allowed: 1
Length: Bound by
the size of the
Request data.
/LabelRecoveryResponse/ShipmentIdentificationNumber
ShipmentIdentificationNumber Required: Yes Tracking number of the leading
Type: String package in the shipment
Max Allowed: 1
Length: 18
LabelResults
/LabelRecoveryResponse/LabelResults
LabelResults Required: No Information containing
Type: Container the results of the users
Max Allowed: 1 Label Recovery
Length: N/A Request.
/LabelRecoveryResponse/LabelResults/TrackingNumber
TrackingNumber Required: Yes* Package Tracking
Max Allowed: 1
Length: 18
/LabelRecoveryResponse/LabelResults/LabelImage
LabelImage Required: Yes* The elements needed to
Type: Container render a label on a
Max Allowed: 1 printer or in a browser.
Length: N/A Specifies the format in
which GraphicImage is
represented.
If LabelImageFormat is
GIF, LabelImage
contains GraphicImage
and HTMLImage.
Otherwise, it contains
only GraphicImage.
If LabelImageFormat is
PDF, LabelImage is only
returned at the first
package result.
If entered in the request,
the response mirrors,
else the default values
are returned.
/LabelRecoveryResponse/LabelResults/LabelImage/LabelImageFormat
LabelImageFormat Required: Yes* The format of a label
Type: Container image byte stream.
Max Allowed: 1
Length: N/A
/LabelRecoveryResponse/LabelResults/LabelImage/LabelImageFormat/Code
Code Required: Yes* Code type that the label
Type: String image is to be
Max Allowed: 1 generated in. Valid
Length: 3 value returned is GIF or
PDF

/LabelRecoveryResponse/LabelResults/LabelImage/GraphicImage
Type: Base 64 graphic image.
Encoded
Max Allowed: 1
Length: Unbounded
/LabelRecoveryResponse/LabelResults/LabelImage/HTMLImage
HTMLImage Required: Cond Base 64 encoded html
Type: Base 64 browser image
Encoded rendering software. This
Max Allowed: 1 is only returned for GIF
Length: Unbounded image formats.
/LabelRecoveryResponse/LabelResults/LabelImage/PDF417
PDF417 Required: Cond PDF-417 is a two-
Type: Base 64 dimensional barcode,
Encoded which can store up to
Max Allowed: 1 about 1,800 printable
Length: Unbounded ASCII characters or
1,100 binary characters
per symbol. The symbol
is rectangular.
The PDF417 image will
be returned when the
shipment is transborder
and the service option is
one of the following:
Standard, ExpressSaver
or ExpressPlus.
The image is Base 64
encoded and only
returned for GIF image
format
/LabelRecoveryResponse/LabelResults/LabelImage/InternationalSignatureGraphicImage
InternationalSignatureGraphicImage Required: Yes* Base 64 encoded EPL2, ZPL and SPL
Type: String graphic image of the labels. The image will
Max Allowed: 1 Warsaw text and be returned for non-US
Length: Unbounded signature box. based shipments. One
image will be given per
shipment and it will be
in the first
PackageResults
container.
/LabelRecoveryResponse/LabelResults/LabelImage/URL
URL Required: Cond This is only returned if
Type: String the label link is
Max Allowed: 1 requested to be
Length: Unbounded returned and only at the
first package result

/LabelRecoveryResponse/LabelResults/Receipt
Receipt Required: Cond Container for the HTML
Type: Container receipt and the receipt
Max Allowed: 1 link.
Length: N/A
/LabelRecoveryResponse/LabelResults/Receipt/HTMLImage
HTMLImage Required: Cond Base 64 encoded html
Type: String browser image
Max Allowed: 1 rendering software. This
Length: Unbounded is only returned for GIF
image formats.
/LabelRecoveryResponse/LabelResults/Receipt/Image
Image Required: Cond Container for the receipt
Type: Container in the format other than
Max Allowed: 1 HTML.
Length: N/A
/LabelRecoveryResponse/LabelResults/Receipt/Image/ImageFormat
ImageFormat Required: Yes* Container for the format
Type: Container of the receipt
Max Allowed: 1
Length: N/A
/LabelRecoveryResponse/LabelResults/Receipt/Image/ImageFormat/Code
Code Required: Yes* The file type of the
Type: String receipt. Valid value is
Max Allowed: 1 PDF
Length: 3
/LabelRecoveryResponse/LabelResults/Receipt/Image/GraphicImage
Type: Base 64 graphic image.
Encoded
Max Allowed: 1
Length: Unbounded
TrackingCandidate
/LabelRecoveryResponse/TrackingCandidate
TrackingCandidate Required: Cond Information containing the
Type: Container results of the users Label
Max Allowed: 1 Recovery Request.
Length: N/A
Returned in the event the
Shipper Number and Reference
Number are supplied in the
request.
/LabelRecoveryResponse/TrackingCandidate/TrackingNumber
TrackingNumber Required: Yes* Package Tracking number.
Type: String
Max Allowed: 1
Length: 18
/LabelRecoveryResponse/TrackingCandidate/DestinationPostalCode
DestinationPostalCode Required: No Destination Postal Code
Type: String candidate.
Max Allowed: 1
Length: 1..9
/LabelRecoveryResponse/TrackingCandidate/DestinationCountryCode
DestinationCountryCode Required: No Destination Country Code
Type: String candidate.
Max Allowed: 1
Length: 2
/LabelRecoveryResponse/TrackingCandidate/PickupDateRange
PickupDateRange Required: No A range of time the package was
Type: Container picked up.
Max Allowed: 1
Length: N/A
/LabelRecoveryResponse/TrackingCandidate/PickupDateRange/BeginDate
BeginDate Required: No The beginning of the date range
Type: String for the candidate. Format:
Max Allowed: 1 YYYYMMDD
Length: 8

/LabelRecoveryResponse/TrackingCandidate/PickupDateRange/EndDate
EndDate Required: No The end of the date range for the
Type: String candidate. Format: YYYYMMDD
Max Allowed: 1
Length: 8
Chapter 7: Void Shipment Elements and Details
VoidShipmentRequest Top Level Containers
VoidShipmentRequest XPath Tables
/VoidShipmentRequest
VoidShipmentRequest Required: Yes Void Shipment Request Container.
Type:
Container
Max Allowed:
1
Length: N/A
Request
/VoidShipmentRequest/Request
Request Required: Yes Request Container.
Type: Container
Max Allowed: 1
Length: N/A
/VoidShipmentRequest/Request/RequestAction
RequestAction Required: Yes Indicates the action to be taken by Currently, there is only 1 valid
Type: String the XML service. 1 = Void the RequestAction value.
Length: 1
/VoidShipmentRequest/Request/TransactionReference
Length: N/A
/VoidShipmentRequest/Request/TransactionReference/CustomerContext
Max Allowed: 1 pairs.
Length: 1...512
The client establishes
CustomerContext, which can
contain any information you want,
as long as it is valid XML; it is
/VoidShipmentRequest/ShipmentIdentificationNumber
ShipmentIdentificationNumber Required: The shipment's identification Must pass 1Z rules. Must be
Cond number upper case. This element is
Type: String mutually exclusive with the
Max Allowed: 1 Expanded Void Shipment
Length: 18 node.
ExpandedVoidShipment
/VoidShipmentRequest/ExpandedVoidShipment
ExpandedVoidShipment Required: Cond Expanded Void This element is mutually exclusive with
Type: Container Capability the VoidShipment
Max Allowed: 1 Request/ShipmentIdentificationNumbe
Length: N/A r.
/VoidShipmentRequest/ExpandedVoidShipment/ShipmentIdentificationNumber
ShipmentIdentificationNumbe Required: Yes* The shipment's Must pass 1Z rules. Must be upper
r Type: String identification case
Max Allowed: 1 number
Length: 18
/VoidShipmentRequest/ExpandedVoidShipment/TrackingNumber
TrackingNumber Required: No The package's Must pass 1Z rules. Must be upper
Type: String identification case.
Max Allowed:20 number
Length: 18
VoidShipmentResponse Top Level Containers
VoidShipmentResponse XPath Tables
/VoidShipmentResponse
VoidShipmentResponse Required: Yes Void Shipment Response
Type: Container.
Container
Max Allowed:
1
Length: N/A
Response
/VoidShipmentResponse/Response
Response Required: Yes Contains Errors information
Type: Container tags along with the
Max Allowed: 1 success/fail status of the void
Length: N/A request.
/VoidShipmentResponse/Response/TransactionReference
TransactionReference Required: Yes TransactionReference
Type: Container identifies transactions
Max Allowed: 1 between client and server.
Length: N/A
/VoidShipmentResponse/Response/TransactionReference/CustomerContext
CustomerContext Required: No Customer provided data. May
Type: String be XML. If this data is present
Max Allowed: 1 in the request, it is echoed
Length: 1...512 back to the customer.
/VoidShipmentResponse/Response/TransactionReference/XpciVersion
XpciVersion Required: No Identifies the version of the
Type: String message. Current version is
Max Allowed: 1 1.0001
Length: 1...50
/VoidShipmentResponse/Response/ResponseStatusCode
ResponseStatusCode Required: Yes Identifies the success or
Type: String failure of the interchange. 1 =
Max Allowed: 1 Success; 0 = Failure
Length: 1
/VoidShipmentResponse/Response/ResponseStatusDescription
ResponseStatusDescription Required: No Describes the Response
Type: String Status Code.
Max Allowed: 1
Length: 1...15

/VoidShipmentResponse/Response/Error
Error Required: No If an error is encountered
Length: N/A
If the error is present, then the
are required.
/VoidShipmentResponse/Response/Error/ErrorSeverity
ErrorSeverity Required: Yes* Describes the severity of the
Type: String error.
Max Allowed: 1
Length: 1...15
/VoidShipmentResponse/Response/Error/ErrorCode
ErrorCode Required: Yes* A numeric value that
Type: String describes the error.
Max Allowed: 1
Length: 1...15
/VoidShipmentResponse/Response/Error/ErrorDescription
ErrorDescription Required: No Describes the error code.
Type: String
Max Allowed: 1
Length: 1...50
/VoidShipmentResponse/Response/Error/MinimumRetrySeconds
MinimumRetrySeconds Required: No Not Applicable
Type: String
Max Allowed: 1
Length: 110
/VoidShipmentResponse/Response/Error/ErrorLocation
ErrorLocation Required: No Identifies the element in error.
Type: Container
Max Allowed: 1
Length: N/A
/VoidShipmentResponse/Response/Error/ErrorLocation/ErrorLocationElementName
ErrorLocationElementName Required: No The Xpath name of the
Max Allowed: 1 valid Xpath pointing to an
Length: 1...512 element in the request
document.
/VoidShipmentResponse/Response/Error/ErrorLocation/ErrorLocationAttributeName
ErrorLocationAttributeName Required: No The name of the attribute in
Length: 1...50 Error Location element.

/VoidShipmentResponse/Response/Error/ErrorDigest
ErrorDigest Required: No The contents of the element in
Type: String error.
Max Allowed: 1
Length: Bound by
the size of the
Request data.
Status
/VoidShipmentResponse/Status
Status Required: No Contains Status information tags.
Type: Container
Max Allowed: 1
Length: N/A
/VoidShipmentResponse/Status/StatusType
StatusType Required: Yes* Contains the status type tags.
Type: Container
Max Allowed: 1
Length: N/A
/VoidShipmentResponse/Status/StatusType/Code
Code Required: Yes* A numeric value that describes the
Type: String status type. 1 = Success; 0 = Failure
Max Allowed: 1
Length:
/VoidShipmentResponse/Status/StatusType/Description
Description Required: No A text description of the status type.
Type: String
Max Allowed: 1
Length: 1...15
/VoidShipmentResponse/Status/StatusCode
StatusCode Required: Yes* Contains the status code tags.
Type: Container
Max Allowed: 1
Length: N/A
/VoidShipmentResponse/Status/StatusCode/Code
Code Required: Yes* The Shipment level void status code. The Voided and Partially Voided
Type: String A numeric value that describes the status codes are only returned in
Max Allowed: 1 status code. association with the expanded
Length: void functionality.
0 = Failure
1 = Success or Voided
2 = Partially Voided
/VoidShipmentResponse/Status/StatusCode/Description
Description Required: Yes* A text description of the status code.
Type: String
Max Allowed: 1
Length: 1...15
PackageLevelResults
/VoidShipmentResponse/PackageLevelResults
PackageLevelResults Required: No Contains the Package Level This node will be returned for
Type: Container Results for the expanded void package level voids and
Max Allowed: functionality only. partially voided shipments.
UNB
Length: N/A
/VoidShipmentResponse/PackageLevelResults/TrackingNumber
TrackingNumber Required: Yes* The package's identification
Type: String number
Max Allowed: 1
Length: 18
/VoidShipmentResponse/PackageLevelResults/StatusCode
StatusCode Required: Yes* The Package Level void status
Type: String code. A numeric value that
Max Allowed: 1 describes the status code.
Length: 1
0 = Not Voided
1 = Voided or Already Voided
/VoidShipmentResponse/PackageLevelResults/Description
Description Required: Yes* A text description of the status
Type: String code.
Max Allowed: 1
Length: 1...15
Chapter 8: Shipping XML APIExamples
ShipmentConfirmRequest Example
<?xml version="1.0"?>
<AccessRequest xml:lang="en-US">
<AccessLicenseNumber>Your Access License Number</AccessLicenseNumber>
<UserId>Your Username</UserId>
<Password>Your Password</Password>
</AccessRequest>
<ShipmentConfirmRequest xml:lang="en-US">
<Request>
<TransactionReference>
<CustomerContext>Your Customer Context</CustomerContext>
<XpciVersion/>
</TransactionReference>
<RequestAction>ShipConfirm</RequestAction>
<RequestOption>validate</RequestOption>
</Request>
<Shipment>
<Shipper>
<Name>Shipper Name</Name>
<AttentionName>Shipper Attn Name</AttentionName>
<CompanyDisplayableName>CompanyDisplayableName</CompanyDisplayableName>
<PhoneNumber>1234567890</PhoneNumber>
<ShipperNumber>Your Shipper Number</ShipperNumber>
<TaxIdentificationNumber>1234567877</TaxIdentificationNumber>
<Address>
<AddressLine1>AddressLine1</AddressLine1>
<City>City</City>
<StateProvinceCode>StateProvinceCode</StateProvinceCode>
<PostalCode>PostalCode</PostalCode>
<CountryCode>CountryCode</CountryCode>
</Address>
</Shipper>
<ShipTo>
<CompanyName>CompanyName</CompanyName>
<AttentionName>Ship To Attn Name</AttentionName>
<Address>
<City>City</City>
</Address>
</ShipTo>
<ShipFrom>
<CompanyName>CompanyName</CompanyName>
<AttentionName>Ship From Attn Name</AttentionName>
<Address>
<City>City</City>
</Address>
</ShipFrom>
<PaymentInformation>
<Prepaid>
<BillShipper>
<AccountNumber>Your Account Number</AccountNumber>
</BillShipper>
</Prepaid>
</PaymentInformation>
<Service>
<Code>01</Code>
<Description>UPS Express</Description>
</Service>
<Package>
<PackagingType>
<Code>02</Code>
<Description>Package</Description>
</PackagingType>
<Description>Priority</Description>
<Dimensions>
<UnitOfMeasurement>
<Code>IN</Code>
<Description>Inches</Description>
</UnitOfMeasurement>
<Length>5</Length>
<Width>4</Width>
<Height>2</Height>
</Dimensions>
<PackageWeight>
<UnitOfMeasurement>
<Code>LBS</Code>
<Description>Pounds</Description>
<Weight>11</Weight>
</PackageWeight>
</Package>
</Shipment>
<LabelSpecification>
<LabelPrintMethod>
<Code>GIF</Code>
<Description>GIF</Description>
</LabelPrintMethod>
<LabelImageFormat>
<Code>GIF</Code>
<Description>GIF</Description>
</LabelImageFormat>
</LabelSpecification>
</ShipmentConfirmRequest>
ShipmentConfirmResponse Example
<ShipmentConfirmResponse>
<Response>
<ResponseStatusCode>1</ResponseStatusCode>
<ResponseStatusDescription>Success</ResponseStatusDescription>
</Response>
<ShipmentCharges>
<RateChart>5</RateChart>
<TransportationCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>125.82</MonetaryValue>
</TransportationCharges>
<ServiceOptionsCharges>
</ServiceOptionsCharges>
<TotalCharges>
</TotalCharges>
</ShipmentCharges>
<BillingWeight>
<UnitOfMeasurement>
<Code>LBS</Code>
<Weight>11.0</Weight>
</BillingWeight>
<ShipmentIdentificationNumber>1ZAA64281410329426</ShipmentIdentificationNumber>
<ShipmentDigest>rO0ABXNyACpjb20udXBzLmVjaXMuY29yZS5zaGlwbWVudHMuU2hpcG1lbnREaWdlc3
Ri (Truncated)</ShipmentDigest>
</ShipmentConfirmResponse>
ShipmentAcceptRequest Example
</AccessRequest>
<ShipmentAcceptRequest>
<Request>
<CustomerContext>Your Customer Context.</CustomerContext>
<XpciVersion>1.0</XpciVersion>
<RequestAction>ShipAccept</RequestAction>
<RequestOption>01</RequestOption>
</Request>
<ShipmentDigest>rO0ABXNyACpjb20udXBzLmVjaXMuY29yZS5zaGlwbWVud
(Truncated)</ShipmentDigest>
</ShipmentAcceptRequest>
ShipmentAcceptResponse Example
<ShipmentAcceptResponse>
<Response>
</Response>
<ShipmentResults>
<ShipmentCharges>
<RateChart>5</RateChart>
<TransportationCharges>
</TransportationCharges>
<TotalCharges>
</TotalCharges>
</ShipmentCharges>
<BillingWeight>
<UnitOfMeasurement>
<Code>LBS</Code>
<Description>Pounds</Description>
<Weight>11.0</Weight>
</BillingWeight>
<ShipmentIdentificationNumber>1ZAA64281410329426</ShipmentIdentificationNumber>
<PackageResults>
<TrackingNumber>1ZAA64281410329426</TrackingNumber>
<LabelImage>
<LabelImageFormat>
<Code>GIF</Code>
</LabelImageFormat>
<GraphicImage>R0lGODdheAUgA+cAAAAAAAEBAQICAgMDAwQEBAUFBQYGBgcHBwgICA
(Truncated)</GraphicImage>
<HTMLImage>PCFET0NUWVBFIEhUTUwgUFVCTElDICItLy9JRVRGLy9EVEQgSFRNTCAzLj
(Truncated)</HTMLImage>
</LabelImage>
</PackageResults>
</ShipmentResults>
</ShipmentAcceptResponse>
LabelRecoveryRequest Example
<?xml version="1.0" encoding="UTF-8"?>
<UserId>Your User Id</UserId>
</AccessRequest>
<LabelRecoveryRequest>
<Request>
<RequestAction>LabelRecovery</RequestAction>
</Request>
<LabelSpecification>
<LabelPrintMethod>
<Code>GIF</Code>
</LabelPrintMethod>
<LabelImageFormat>
<Code>GIF</Code>
</LabelImageFormat>
</LabelSpecification>
<LabelDelivery>
<LabelLinkIndicator/>
</LabelDelivery>
<TrackingNumber>Your Tracking Number</TrackingNumber>
</LabelRecoveryRequest>
LabelRecoveryResponse Example
<LabelRecoveryResponse>
<Response>
</Response>
<ShipmentIdentificationNumber>1Z1107YY8567985294</ShipmentIdentificationNumber>
<LabelResults>
<TrackingNumber>1Z1107YY8567985294</TrackingNumber>
<LabelImage>
<LabelImageFormat>
<Code>GIF</Code>
</LabelImageFormat>
<GraphicImage>R0lGODdheAUgA+cAAAAAAAEBAQICAgMDAwQEBAUFBQYGBg
<HTMLImage>PCFET0NUWVBFIEhUTUwgUFVCTElDICItLy9JRVRGLy9EVEQgSF
<PDF417>R0lGODdhLAG8AucAAAAAAAEBAQICAgMDAwQEBAUFBQYGBgcHBwgICA
(Truncated)</PDF417>
<URL>https://www.ups.com/u.a/L.class?8RY86r2n6CmK%2B53TmeX42gtY6%2BsAMRcrqsP0M8
</URL>
</LabelImage>
<Receipt>
<HTMLImage>PGh0bWw+PGhlYWQ+PHRpdGxlPlJlY2VpcHQ8L3RpdGxlPjwvaGVhZ
<URL>https://www.ups.com/u.a/L.class?8RY86r2n6CmK%2B53TmeX42gtY6%2BsAMRcrqsPBMi<
/URL>
</Receipt>
</LabelResults>
<LabelResults>
<TrackingNumber>1Z1107YY8586551109</TrackingNumber>
<LabelImage>
<LabelImageFormat>
<Code>GIF</Code>
</LabelImageFormat>
<GraphicImage>R0lGODdheAUgA+cAAAAAAAEBAQICAgMDAwQEBAUFBQYGBg
<HTMLImage>PCFET0NUWVBFIEhUTUwgUFVCTElDICItLy9JRVRGLy9EVEQg
<PDF417>R0lGODdhLAG8AucAAAAAAAEBAQICAgMDAwQEBAUFBQYGBgcHBwgICA
(Truncated)</PDF417>
</LabelImage>
<Receipt>
<HTMLImage>PGh0bWw+PGhlYWQ+PHRpdGxlPlJlY2VpcHQ8L3RpdGxlPjwvaGVhZ
</Receipt>
</LabelResults>
</LabelRecoveryResponse>
VoidShipmentRequest Example
</AccessRequest>
<VoidShipmentRequest>
<Request>
<CustomerContext>Bench Generated Void of </CustomerContext>
<RequestAction>1</RequestAction>
</Request>
<ShipmentIdentificationNumber>Your Shipment Identification Number</ShipmentIdentificationNumber>
</VoidShipmentRequest>
VoidShipmentResponse Example
<VoidShipmentResponse>
<Response>
<CustomerContext>Bench Generated Void of </CustomerContext>
</Response>
<Status>
<StatusType>
<Code>1</Code>
<Description>Success</Description>
</StatusType>
<StatusCode>
<Code>1</Code>
<Description>Success</Description>
</StatusCode>
</Status>
</VoidShipmentResponse>
Chapter 9: Shipping Package API FAQs
Category Question Answer
99 Account How do I associate more Ninety-nine accounts is currently the maximum number
Number Limitation than 99 account numbers available. If the user has more than ninety-nine accounts,
for use with the Shipping they must be spread across multiple User IDs.
APIs?
128 Reference Can the Shipping Package Yes. A Code 128 Reference number barcode can be
Number Barcode API generate a Code 128 generated below the 1Z Tracking number, as the Shipping
Reference number barcode API can print a barcode in reference field 1. The Shipping
below the 1Z? Can it Package API does not support PDF417 barcode types.
generate a PDF417
Reference number barcode
below the 1Z?
Account Based Do the Developer APIs Yes. Shipping and Rating XML and Web Service APIs
Rates (ABR) or support ABR also known as support Negotiated Rates.
Negotiated Rates Negotiated Rates?
Address Validation How do I turn off validation Set the value within the
of addresses with the "ShipmentRequest/Request/RequestOption" tag of the
Shipping API? request to "nonvalidate".
Address Validation Will the Shipping API No, the postal code must be included for validation.
provide validation for
Japanese addresses with
City and Country and no zip
code?
Address Validation What validation is the The Shipping API does not support address validation at the
Shipping API using to street level.
validate addresses for US
The Shipping API does support regional validation of the
and International
city, state, and postal code when validate is specified in the
addresses?
RequestOption element. If nonvalidate is specified then
address validation is not performed.
Batch Processing Does the Shipping API No, the Shipping API only supports transactional requests.
support batch requests?
Certification What is required to certify UPS now grants both test and production access to the
for the Shipping Package Shipping API without any further requests. There are
API? separate URLs for both the test and production
environments. For additional information, refer to Customer
Integration Environment (CIE)
Commercial Can an API customer export The API will return a commercial invoice as part of the
Invoice shipments to print a copy of response file.The customer must save the image from the
the commercial invoice after response file in order to retrieve it later.
the fact?
Commercial Is there an option to remove Yes, the <CommercialInvoiceRemoval> indicator.
Invoice removal the Commercial Invoice
from a shipment before it is
delivered to the consignee?
Consignee Billing Is Consignee Billing Yes, Consignee Billing is supported in the U.S. and PR.
supported in the Shipping
API?
Currency Does the Shipping Package No.
Conversion API support currency
conversion?

CWT and Shipping Is there a solution using the No, there is no solution in place for the Ship API.
API ship API (or other solution)
To obtain the CWT price with the Ship API, the packages
that would prompt UPS
would have to be processed as one shipment.
billing or PLD upload or
other to aggregate single The UserId must be ABR-enabled and you must include the
piece packages into <NegotiatedRatesIndicator> tags to receive the
hundredweight pricing Hundredweight rates.
(shipment) after the
package has been
processed?
Delivery Intercept Is UPS Delivery Intercept No.
available through the
Shipping API?
Dry Ice with WWEF Does Worldwide Express Yes. If they are enabled for this service, but no other
Freight allow Dry Ice dangerous goods services are allowed.
shipments?
There are no user changes; thelogic is on the backend.
Dry Ice - Hazmat Does the Shipping API for Yes, effective with the July 2011 release, the Shipping API
Package support the Dry Ice supports Dry Ice, as long as; it does not include any other
indicator? Hazmat materials in the shipment and meets the
requirements. Please refer to UPS.com for more
information.
Duty & Taxes How do you bill a 3rd Party In order to bill a 3rd Party for D&T, use the noted tags in your
for Duty & Taxes? request:
<ItemizedPaymentInformation>
<ShipmentCharge>
<Type>01</Type>
<BillShipper>
<AccountNumber>XXXXXX</AccountNumber>
</BillShipper>
</ShipmentCharge>
<ShipmentCharge>
<Type>02</Type>
<BillThirdParty>
<BillThirdPartyConsignee>
<AccountNumber>XXXXXX</AccountNumber>
<ThirdParty>
<Address>
<PostalCode>XXXXX</PostalCode>
<CountryCode>XX</CountryCode>
</Address>
</ThirdParty>
</BillThirdPartyConsignee>
</BillThirdParty>
</ShipmentCharge>
</ItemizedPaymentInformation>
Electronic Return Does the customer have to Yes, effective with the July 2010 Release, the time limit for
Label, Days utilize the label recovery retrieving an Electronic Return Label has been extended to
Available capability within the Ship 30 days. The prior limit was 10 days.
API to reprint an electronic
An Electronic Return Label is specified by using
return label?How many
Shipment/ReturnService/Code 8 in the Shipment Confirm
days is the label available
Request.
to reprint?
The ERL email will contain a link to the label so the recipient
can print the label to attach to a package.

From Suite/Apt# on Where does a customer The customer needs to include the suite/apt # in delivery
Label include the Suite/Apt# in the address lines 2 or 3 within the request.
"From" section of the label?
Future Date Does the Shipping Package No. We do not support future shipping dates. All packages
Shipping API support future shipping are considered tendered on the date of their transaction.
dates?
Ground Freight Are dimensions required for Currently dimensions are not applicable to Ground Freight
Pricing (GFP) GFP? Pricing.
High Value Report How does the Shipping The High Value Report is returned in the response in one of
Package APIwork with High the supported formats specified by the developer. In each
Values? case, it will be a base64 encoded file that must be decoded
and printed.
Does the paperwork
comeback as a GIF image Two copies should be printed, both will be signed by the
and get printed on a thermal driver, the driver will leave one copy as a receipt. The file,
printer? once decoded is a simple HTML file that can be locally
printed.
Or, does the customer need
to produce these
themselves?
International How many line items can a When using international forms only 50 line items
Commodities Commercial Invoice (commodities) can be associated with a shipment.
contain?
International Forms Does the Shipping Package Yes.
APIsupport international
forms?
Label Does the Web Service The Web Service and XML APIs behave similarly. The label
version of the Shipping elements returned in the Shipment Accept response consist
Package APIbehave of two parts, both of which are base64-encoded data that
differently than the XML must be decoded.
version when rendering a
Part one consists of the label image and part two contains
label?
the HTML that is used to size the label image in a browser
for display and printing.
When the two parts are combined, they form a unit that will
satisfy the requirements for printing a proper label to apply
to a package. This ensures the label will meet the standards
necessary for UPS to scan and process the label within the
shipping system.
Label Reference Can any of the reference No. However, please note that reference numbers are not
Number fields be blocked from required and may be omitted if there is no need for them.
printing on the label?
Label/Receipt Does the Shipping Package The output of the Shipping API is a label. A receipt is not
API provide an e-mail provided. In addition, the Ship API only provides the ability
version of the label, receipt, to have the label emailed with the ERL (Electronic Return
and confirmation number? Label) service and not for forward shipments.
Labeling Does the Shipping API No, it is a contract service that is not supported.
support ISC BIO labels like
WorldShip?
Mail Innovations Do returns display rates for Rates are not displayed for Mail Innovations shipments.
(MI) Shipments Mail Innovation shipments?
Mail Innovations Can you void an MI No, you cannot void a MI shipment. There is no charge for
Shipments shipment? creating a label. The shipment is not charged until scanned
by the UPS Driver.

Maximum What is the maximum Both versions allow a maximum of two hundred packages.
Packages within a number of packages that
shipment can be included within a
forward movement? Is this
number the same for the
Web Service and XML
versions?
Negotiated Rates How do you get access to To streamline your ability to view your negotiated rates
negotiated Package rates? through the Shipping/Rating API, UPS has implemented a
new process that no longer requires you to wait for a UPS
Sales Person to activate your account.
Simply add a UPS Account to your My UPS ID Account
Summary as you previously would and your account will be
activated within 48 hours for negotiated rates (provided you
have a contract with UPS).
Remember to select the Negotiated Rates Indicator within
the Request to have negotiated rates returned within the
response.
For additional information, refer to Using Negotiated Rates
in CIE.
Negotiated Rates What flags are needed to The NegotiatedRatesIndicator.
return Negotiated rates in
the request?
Oracle Are there any known issues UPS is not aware of any issues at this time.
with implementing Oracle
The UPS Developer APIs are designed so that they can be
with the Shipping Package
implemented in almost any environment as long as the
API?
customer application can open a secure connection of SSL
and perform an HTTP Post.
Paperless Invoice Does the Shipping Package Yes. Refer to the topic Paperless Invoice Support Countries
API support Paperless in the Appendix.
Invoices?
Also, see the AdditionalDocumentIndicator elementin the
XPath.
Once the shipment is processed an EDI (paperless invoice)
or EDI PULL (paperless invoice and additional export
document indicator) displays on the bottom right corner of
the label image returned in the ShipAcceptResponse label
digest.

Paperless Invoice What pre-conditions are The process to support Paperless Invoice using the
Conditions required for a customer to Shipping API are listed below:
be set up on Paperless
1. The Sold To country must be the same as the Ship To
Invoice?
country.
2. The customer must have a paperless invoice contract
and be set up in UPS back end systems. (The UPS
Account Manager should set this up.)
3. The shipment is a non-document package forward
shipment requiring a commercial invoice.
4. The destination country is a valid paperless invoice
destination. Refer to the topic Paperless Invoice
Support Countries in the Appendix.
5. If additional export documents are required for the
movement, the customer must specify an
<AddtionalDocumentIndicator/> in the XML request.
If the above conditions have been met, an EDI (paperless
invoice) or EDI PULL (paperless invoice and additional
export document indicator) will appear on the bottom right
corner of the label, which is returned in the
ShipAcceptResponse XML.
To implement paperless invoicing, an <InternationalForms>
container must be present in the XML to provide the
information necessary to replace a paper invoice with a
paperless (electronic) invoice.
For information on International forms, refer to International
Forms Preference Criteria.
The shipper needs to add the container along with the
necessary international forms information for the shipment.
Paperless Invoice How does Paperless Paperless Invoice customers shipping internationally to a
Shipment Invoice work in terms of the paperless supported country (with the necessary data) will
documentation being have the invoice automatically sent to brokerage.
forwarded?
Paperless Invoice Can a Paperless Invoice Yes, a Paperless Invoice shipment can be voided via the
voids shipment be voided through Shipping Package API. If a shipment is voided and
the Shipping Package API? consequently the package is never tendered to UPS, then
If yes, what happens to the the paperless invoice data that was uploaded with the
invoice information? shipment is not used to create an invoice image and it is
eventually purged.
Pickup request Can a pickup be requested No. All pickup requests must be made through the Pickup
using the Shipping Package Web Service. Details are available at the Developer
API? resource center on UPS.com at:
https://www.ups.com/upsdeveloperkit.
Customers that implemented the Shipping Package API
prior to January 2010 can continue to request a pickup
through the Shipping API as part of their shipping request.
Note: The billing of pickups changed in January 2010 and
the customer will be charged for each request regardless of
the service type shipped.
Please review the Rate & Service Guide for more details
about pickup charges and services.

Package Level How long does it take The numbers below represent the QVM / QVD timeliness of
Detail shipping data to populate manifest information (in minutes).
(PLD)/Quantum the Quantum View API?
Billing Manifest Received can range approximately from 30
View
minutes up to 2.5 hours. The average is approximately 1
hour.
Pre-Alerts What types are supported? UPS Exchange and Pack & Collect shipments.
Print Return Labels For the print return label UPS does not provide a mechanism to "reprint" a Print
option, if a Yahoo merchant Return Label (PRL), the vendor must save the label locally if
needs to reprint the return they wish to reprint. Only the ERL (Electronic Return Label)
label, how much time does option provides that capability.
he have?
Proactive Is Proactive Response No.
Response Supported?
Ref Number 1 - Can the reference values No, the reference field descriptions cannot be modified at
Text Values on be renamed? this time. You must use one of the values provided in the
Label Developers Guide.
Reference Number What does the Shipping Two shipment or two package level reference numbers. You
Rules Package API support in cannot use the shipment and package level reference
terms of reference numbers at the same time.
numbers?
Shipment level reference numbers are only allowed for
shipments that are not US to US (origin/destination) or PR to
PR (origin/destination) .
Package level reference numbers are only allowed for
shipments that are US to US (origin/destination) or PR to PR
(origin/destination).
Reference Number Propagation
If there is no Package Level reference number on the 1st

package of the shipment, the Shipment Level reference
number(s) will be propagated to all packages.
If there is a Package Level reference number and no
Shipment level reference number, the 1st package's
reference number will be propagated up to the Shipment
Level.
Reprinting Labels Can a customer using the No, at this time the Shipping API does not provide the ability
Shipping API reprint a to reprint labels.
label?
Reprint is only possible for Electronic Return Label. Print
Return Labels must be saved locally to allow reprint.
Resi/Comm Does the Shipping API The Shipping API will classify an address based on UPS
Indicator classify addresses as history for that address and the appropriate rate will be
residential or commercial? returned in the response
Resi/Comm How do you indicate the Use the ResidentialAddress element. Refer to the Shipping
Indicator "Ship TO" as residential? APIElements and Details chapter.
Returns Is there a URL ONLY No.
capability for returns within
the Shipping API?

Returns, Void Can a Return be voided? If A customer can void an RS label until 2 a.m. Eastern Time
yes, what is the cutoff timing the following night (e.g., Monday request, Tuesday 2 a.m.
to void a return? void cutoff). This is based on when our batch process starts
sending RS1/RS3 labels to the centers.
If the void is completed by the cutoff time, the customer is not
be charged.
ERL and PRL labels can be voided up to 30 days after
generation.
Note: The Label generation fee, if applied, is not voidable
and unused labels are not billed transportation charges.
Returns, Does the Shipping API Yes. For a list of supported countries, refer to the Country
International support international returns Codes table in the Appendix.
and returns in international
countries where the
Shipping API is supported?
Returns Does the Shipping Package Yes.
API support Return
capabilities?
Returns Are the Web Service and Yes.
XML return capabilities the
same?
Rural & Super Does the Shipping Package Yes, these charges are part of the transportation charge.
Rural API return Rural and Super
Rural charges?
Scan-based Billing Does the Shipping API Yes, it is supported by default, meaning if they are not
support Scan-Based tendered to UPS, they are not billed. This applies to both
Billing? forward and return shipments. The return label charges are
billed when the label is created.
Security for Credit Please describe the security Yes, we use 128-bit encryption for all aspects of the APIs. In
cards on the UPS web server? Is addition, credit card information is tokenized once we
the credit card information receive it, so we never store it in plain text.
submitted over an
encrypted (secure)
connection?
Shipper Release Is Shipper Release Yes.
available with the Shipping
API?
Shipping History Can a customer using the The Shipping API does not provide a 'shipping history'.
Shipping API view shipping However, to review shipping history or reprint labels that
history? were manifested via the API, the customer may log into
UPS.com using their My UPS User ID and password passed
in the XML request, and then navigate to the shipping
history section.
Shipping History on UPS.com can be used to review
shipments and reprint labels.
Signature Required Does the Shipping Package Yes.
API support Signature
Required service?
Smart Pickup Does the Shipping API No, only the Pickup API supports Smart Pickup functionality
support Smart Pickups

Third Party/Freight Does the Ship API validate Yes, it validates if the account is active, valid for Manage
Collect Shipment account numbers when Inbound charges and the postal code of the account billed.
shipping Third Party and
Freight Collect?
Tracking Numbers Can customers create their No, the tracking numbers are automatically created and
own tracking numbers using returned in the response.
the Shipping Package API?
Tracking Ranges How many tracking Shipping API users are given a default range of 1M and as
numbers can be generated long as they do not exceed that range within an 18-month
via the Shipping API before period they will not see any duplicates.
customers receive
duplicates?
Trade Direct Does the Shipping API No.
support Trade Direct?
UPS Account How do I add a UPS As a means of securing customer information, when adding
account to My UPSID an account to their My UPS profile, enrolling in electronic
account summary? It is billing options, or Quantum View, customers are prompted to
stating that I have to have authenticate their account by entering an invoice number,
an invoice # and control ID. invoice amount, and the invoice date from one of their last
three billing cycles along with the Control ID printed just
below the shipper number on their invoice.
This provides is an additional layer of security to protect our
customers information.
The Control ID is currently included in the following U.S. and
Canada Invoice Media types:
Online PDF Images

EDI Domestic and Import
Hard Copy Invoices
For additional information, refer to the UPS Developer Kit
User Guide.
UPS Return Labels Does UPS charge an Yes, the customer will be charged the accessorial fee once
accessorial fee for a return they request a return label.
label when using the API?
UPS World Ease Does the Shipping Package No.
API support UPS World
Ease?
Voids How are voids processed? For forward and return movements send a
VoidShipmentRequest element and UPS will return a
VoidShipmentResponse.
Forward movements must be voided within 28 days of
creating the label.
Return Shipments can be voided until 2a.m. Eastern Time
the following night.
World Ease Does the Shipping Package No.
API support World Ease?
Appendices
Error Codes (XML)

When the UPS system is unable to respond to a request, be it from a malformed request, an illegal or invalid value,
or other issues, the API generates an error response. For examples and additional information on error responses,
refer to Chapter 3:Error Responses, in the Introduction to the UPSDeveloper Kit guide.
To discover errors, check the ResponseStatusCode element. A 1 normally indicates a successful response,
whereas a 0 indicates a Transient or Hard error. The PrimaryErrorCode element contains the error code and
description.
Successful responses may or may not include warnings.

Without warnings - Indicates the request has been processed as anticipated.
With warnings - Indicates the request has been processed with potentially unanticipated results. The
warning contains information in the response that should be passed to the end user.
The severity of an error may be transient or hard.
Transient error - Indicates an error that is temporary in nature. Such errors may be caused by response
timeouts due to high server loads or scheduled maintenance in progress. The request may be issued
successfully at a later time.
Hard error - Indicates the request has a problem that the system is not able to resolve. These errors are
critical and prevent requests from processing.
Do not resubmit requests with Hard Errors until the problems causing the error have been resolved.
Common Error Codes

The following error codes can apply to all Web Services and APIs.
Code Severity Description

10001 Hard The XML document is not well formed.
10002 Hard The XML document is well formed but the document is not valid.
10003 Hard The XML document is either empty or null.
10006 Hard Although the document is well formed and valid, the element content contains values
which do not conform to the rules and constraints contained in this specification.
10013 Hard The message is too large to be processed by the Application.
20001 Transient General process failure.
20002 Hard The specified service name, {0}, and version number, {1}, combination is invalid.
20003 Hard Please check the server environment for the proper J2EE ws apis.
20006 Hard Invalid request action.
20007 Hard Missing Required field, {0}.
20008 Hard The field, {0}, contains invalid data, {1}.
20012 Hard The Client Information exceeds its Maximum Limit of {0}.
250000 Hard No XML declaration in the XML document.
250001 Hard Invalid Access License for the tool. Please re-license.
250002 Hard Invalid UserId/Password.
250003 Hard Invalid Access License number.
250004 Hard Incorrect UserId or Password.
250005 Hard No Access and Authentication Credentials provided.
250006 Hard The maximum number of user access attempts was exceeded.
250007 Hard The UserId is currently locked out; please try again in 24 hours.
Code Severity Description

250009 Hard License Number not found in the UPS database.
250019 Hard Invalid Field value.
250050 Transient License system not available.
Shipping Error Codes

120001 - 120318
Error Code Severity Description

120001 Transient XML Shipping System is unavailable, please try again later.
120014 Warning A Large Air Package Minimum Surcharge has been applied to Package
%package.index%.
120016 Warning Customs Invoice is required when the shipment is tendered to UPS.
120017 Warning If the value of the goods you are shipping is above 6,000 Euro or local equivalent, you
must supply a EUR1 form in addition to signing your invoice.
120018 Hard International Form Data Holder Exception
120019 Warning The location ID you provided is not valid. Valid location ID consists of 3 to 10 alpha
numeric characters.
120020 Hard Max packages per shipment exceeded.
120021 Hard The same shipment cannot be requested to be created more than once.
120022 Warning 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.
120023 Warning Using user generated forms is not permitted. Please attach your user generated forms
with your shipment.
120024 Warning Uploading of your user generated International Forms was not successful. Please
attach the international forms to your shipment.
120026 Hard Lift Gate Accessorial for Pick Up and Delivery are not allowed when both Hold For Pick
Up and Drop off At UPS Facility is requested.
120027 Hard Lift Gate for Pick Up accessorial is not allowed with Drop Off At UPS Facility
accessorial.
120028 Hard Lift Gate for Delivery accessorial is not allowed with Hold For Pick Up accessorial.
120029 Hard World Wide Express Freight Shipment Service Option is not available for Return
Shipments.
120030 Hard Missing or Invalid Total Number of Pieces in all Pallets in a Shipment.
120031 Hard Exceeds Total Number of allowed pieces per World Wide Express Shipment.
120032 Hard The maximum dimensions for a pallet are ({0}) cm by ({1}) cm by ({2}) cm for the
selected origin.
120033 Hard The maximum dimensions for a pallet are ({0}) in by ({1}) in by ({2}) in for the selected
origin.
120034 Hard The maximum dimensions for a pallet are ({0}) cm by ({1}) cm by ({2}) cm for the
selected destination.
120035 Hard The maximum dimensions for a pallet are ({0}) in by ({1}) in by ({2}) in for the selected
destination.
120036 Warning Please contact customer service center for capacity authorization.
120037 Hard Shipment total weight has exceeded the maximum shipment weight limit of 99,999.9
kgs or 99,999.9 pounds.
120041 Hard The maximum per pallet weight for the selected service from the selected origin is ({0})
pounds.

120042 Hard The maximum per pallet weight for the selected service from the selected origin is ({0})
kgs.
120043 Hard The maximum per pallet weight for the selected service to the selected destination is
({0}) pounds.
120044 Hard The maximum per pallet weight for the selected service to the selected destination is
({0}) kgs.
120050 Hard RequestAction has an unsupported value.
120051 Hard Invalid RequestOption
120059 Warning A CN22 form is required for this shipment.
120062 Hard The requested billing option is unavailable with the selected packaging.
120066 Hard Endorsements are not valid for the selected origin, service, and package combination.
120067 Hard An endorsement is required for the selected origin, service, and package combination.
120069 Hard The Mailer ID is required for domestic non-flat Mail Innovations shipments.
120070 Hard The Mail Innovations account number is required on Mail Innovations shipments.
120071 Hard Confirmation Type for Mail Innovations USPS Delivery Confirmation is invalid.
120072 Hard Invalid Number of Packages. Mail Innovations shipments are limited to 1 package.
120073 Hard Missing or Invalid Mail Innovations Package Id.
120074 Hard Missing or Invalid Mail Innovations Cost Center.
120075 Hard Shipper is not authorized for Mail Innovations.
120076 Hard Missing or invalid USPS Endorsement.
120077 Hard CN22 form is required for combined MI package and CN22 label.
120078 Hard Too many characters provided in Mail Innovations Package ID.
120079 Hard Too many characters provided in Mail Innovations Cost Center.
120080 Hard The maximum number of goods printed on CN22 form cannot be more than 1 for
combined MI package and CN22 label.
120081 Hard Shipment Reference Number is not supported for Mail Innovation shipments.
120082 Hard Package Reference Number is not supported for Mail Innovation shipments.
120100 Hard Missing or Invalid shipper number
120101 Hard Missing/Invalid shipper name
120102 Hard Missing/Invalid shipper address line 1
120103 Hard Invalid shipper address line 2
120104 Hard Invalid shipper address line 3
120105 Hard Missing/Invalid Shipper City
120106 Hard Missing/Invalid Shipper StateProvinceCode
120107 Hard Missing/Invalid Shipper PostalCode. (Description)
120108 Hard Missing/Invalid Shipper CountryCode
120109 Hard Missing/Invalid Shipper PhoneNumber
120110 Hard Missing/Invalid Shipper AttentionName
120111 Hard Shipper Email Address cannot exceed a length of 50 characters
120112 Hard Shipper Email Address is an invalid format

120113 Hard Shipper number must contain alphanumeric characters only
120114 Hard Shipper phone extension cannot exceed the length of 4.
120115 Hard Shipper PhoneNumber must be at least 10 alphanumeric characters
120116 Hard Shipper phone extension must contain only numbers
120117 Hard Shipper phone extension is allowed only if the shipper is located in US, Puerto Rico or
Canada
120118 Hard Shipper phone extension is only valid if a phone number is given
120119 Hard Shipper phone number and phone extension together cannot be more than 15 digits
long
120120 Hard The country associated with Shippers ShipperNumber must be the same as the
shipments Shippers country.
120121 Hard The Shippers shipper number cannot be used for the shipment.
120122 Hard Invalid Shipper ShipperNumber
120124 Hard The requested service is unavailable between the selected locations.
120125 Hard Consignee billing is only supported in US or Pureto Rico
120200 Hard Missing/Invalid ShipTo CompanyName
120201 Hard Missing/Invalid ShipTo AttentionName
120202 Hard Missing/Invalid ShipTo AddressLine1
120203 Hard Invalid ShipTo AddressLine2
120204 Hard Invalid ShipTo AddressLine3
120205 Hard Missing/Invalid ShipTo/ City
120206 Hard Missing/Invalid ShipTo StateProvinceCode
120207 Hard Missing/Invalid ShipTo PostalCode. (Description)
120208 Hard Missing/Invalid/Unsupported ShipTo CountryCode
120209 Hard Missing/Invalid ShipTo PhoneNumber
120210 Hard ShipTo EmailAddress cannot exceed a length of 50 characters
120211 Hard ShipTo EmailAddress is an invalid format
120212 Hard ShipTo PhoneExtension cannot exceed the length of 4.
120213 Hard ShipTo PhoneNumber must be at least 10 alphanumeric characters.
120214 Hard ShipTo PhoneExtension must contain only numbers
120216 Hard ShipTo PhoneExtension is only valid if a phone number is given
120217 Hard ShipTo phone number and phone extension together cannot be more than 15 digits
long.
120218 Hard Missing or Invalid ShipTo tax identification. TaxID may not exceed a length of 15.
120300 Hard Missing/Invalid ShipFrom CompanyName
120301 Hard Missing/Invalid ShipFrom AttentionName
120302 Hard Missing/Invalid ShipFrom AddressLine1
120303 Hard Invalid ShipFrom AddressLine2
120304 Hard Invalid ShipFrom AddressLine3
120305 Hard Missing/Invalid ShipFrom City

120306 Hard Missing/Invalid ShipFrom StateProvinceCode
120307 Hard Missing/Invalid ShipFrom PostalCode. (Description)
120308 Hard Missing/Invalid/Unsupported ShipFrom CountryCode
120309 Hard Missing/Invalid ShipFrom PhoneNumber
120310 Hard ShipFrom EmailAddress cannot exceed a length of 50 characters.
120311 Hard ShipFrom EmailAddress is an invalid format
120312 Hard ShipFromPhoneExtension cannot exceed the length of 4.
120313 Hard ShipFrom PhoneNumber must be at least 10 alphanumeric characters
120314 Hard ShipFromPhoneExtension must contain only numbers
120316 Hard ShipFromPhoneExtension is only valid if a phone number is given
120317 Hard The ShipFrom country must be the same as the Shipper country
120318 Hard ShipFrom phone number and phone extension together cannot be more than 15 digits
long
120400 - 120619

120400 Hard Missing/Invalid shipment payment method
120402 Hard Missing/Invalid credit card type
120403 Hard Missing/Invalid credit card number
120404 Hard Missing/Invalid credit card expiration date
120406 Hard creditcard number is not valid for the credit card type
120407 Hard The credit card provided as the payment method has expired.
120408 Hard Missing credit card type
120410 Hard One payment method is required.
120411 Hard Credit card payment is not allowed for this shipment.
120412 Hard {Description}
120413 Hard The UPS account number provided as the payment method cannot be billed, please try
another account.
120414 Hard Credit card authorization failed, contact your financial institution
120415 Hard PaymentInformation/Prepaid/BillShipper/AccountNumber must be the same shipper
number as Shipper/ShipperNumber
120416 Hard A single billing option is required per shipment.
120430 Hard Missing/Invalid country code of billed third party
120437 Hard Missing/Invalid PostalCode of payment account
120444 Hard Invalid Bill-To type
120500 Hard Missing/Invalid Service/Code
120501 Hard Invalid Shipment/ReferenceNumber/Value
120502 Hard InvoiceLineTotal/MonetaryValue must be greater than 0
120503 Hard Shipment Description cannot exceed the length of 35 characters

120504 Hard InvoiceLineTotal is not allowed for this shipment
120505 Hard Saturday Delivery Option cannot be used for this shipment
120506 Hard Invalid Shipment/ReferenceNumber/ Code
120512 Hard Shipment Description is required for this shipment.
120513 Hard The first Email Address used for {Quantum View notification type} exceeds the
maximum length of 50 characters.
120514 Hard Invalid format for first Email Address used for {Quantum View notification type}
120515 Hard {notification type} Memo cannot exceed the length of 150 characters
120516 Hard The first Email Address used for {Quantum View notification type} is missing or
contains invalid characters
120517 Hard The {order} Email Address used for {notification type} exceeds the maximum length of
50 characters
120518 Hard The format of the {order} Email Address entered for {notification type} is invalid
120519 Hard The {order} Email Address entered for {notification type} is missing or contains invalid
characters
120520 Hard For a shipment, the maximum number of Email Addresses allowed for Quantum View
Notification is 5
120521 Hard For a shipment, the maximum number of Memos allowed for {Quantum View
notification type} is 1
120522 Hard Alternate Delivery Time is not valid for any available services
120523 Hard Shipment/Documents Only is invalid with the shipments origin/destination pair
120524 Hard Package Pickup Request is not available with this shipments service
120525 Hard AlternateDeliveryTime error: (Description)
120526 Hard InvoiceLineTotal/MonetaryValue may not exceed the length of 8
120527 Hard Cannot use multiple types of currency in a shipment
120528 Hard A shipment can have only one type of UnitOfMeasurement for Dimensions
120529 Hard A shipment can have only one type of UnitOfMeasurement for a Weight
120530 Hard SuiteRoomID length of shipment pickup cannot exceed 8 characters
120531 Hard FloorID length of shipment pickup cannot exceed 3 characters
120532 Hard Location length of shipment pickup cannot exceed 11 characters
120533 Hard The earliest shipment pickup time is required
120534 Hard The latest shipment pickup time is required
120535 Hard Contact name of shipment pickup is required
120536 Hard Contact phone number of shipment pickup is required
120537 Hard Invalid/Missing the earliest shipment pickup time
120538 Hard Shipment Pickup Error: (further description is provided in XML)
120539 Hard InvoiceLineTotal/ MonetaryValue is required and must be a whole number
120541 Hard Shipment/ReferenceNumber is not allowed for this shipment
120542 Hard Package/ReferenceNumber is not allowed for this shipment
120543 Hard No more than 2 Shipment/ReferenceNumber can be given per shipment

120544 Hard No more than 2 Package/ReferenceNumber can be given per package
120545 Hard Shipment/Description is not valid with this shipment
120546 Hard (UOM Weight) is not a valid unit of measurement for weight for this shipment
120547 Hard (UOM Dimension) is not a valid unit of measurement for dimensions.
120548 Hard A shipment cannot have a KGS/IN or LBS/CM as its unit of measurements
120556 Hard Missing or Invalid Monetary value for Access point COD.
120557 Hard Missing or Invalid Currency code for Access point COD.
120558 Hard Alternate Delivery Address information is required for UPS Access Point Delivery.
120559 Hard UAP shipper notification code (013) and notification data (email or phone number) is
required for UPS Access Point Delivery.
120560 Hard ADL notification code (012) and notification data (email or phone number) is required
for UPS Access Point Delivery.
120561 Hard Missing or Invalid Alternate Payment Method.
120562 Hard PayPal is not supported for this shipment.
120563 Warning UPS Access Point Delivery Rates were applied to a shipment.
120567 Hard Missing or Invalid PayPal Information. Verify your User Id and associated PayPal
information.
120568 Hard The Shipment Level Access Point COD option is unavailable with the selected service,
UPS account type, and/or with the shipments origin/destination.
120569 Hard The Package Level Access Point COD is not valid for the shipment origin and/or
destination.
120570 Hard Total Shipment Charges exceeds the customer's PayPal account limit.
120571 Hard ADL notification and UAP Shipper Notification are required for UPS Access Point
Delivery.
120572 Hard UPS internal security measures prevent the processing of this shipment. If you believe
you have received this message in error, contact UPS {0}
120573 Hard Notification Media Type is missing or invalid.
120574 Hard UPS internal security measures prevent the processing of this shipment. Please
contact your UPS Account Representative for assistance with this issue.
120575 Hard UPS encountered an error while processing shipment request with PayPal Payment
type. Please enter another Payment Type to complete your shipment.
120576 Hard UPS Access Point Economy Service shipments must have a Hold for Pickup at UPS
Access Point or UPS Access Point Delivery Shipment Indication Type or must be a
Return shipment.
120577 Warning Packages not dropped off at a UPS Access Point location may incur additional cost
and/or transit time.
120578 Hard Missing or invalid Package Release Code. The Package Release Code must be 4-6
characters in length and only include numbers.
120583 Warning The account used to create this shipment has Direct Delivery Only preference selected.
120585 Hard Your UPS Account number is not authorized for UPS Access Point Economy Service
when selecting Hold for Pickup at UPS Access Point Shipment Indication Type.
120586 Hard Your UPS Account number is not authorized for UPS Access Point Economy Service
when selecting Returns.

120592 Warning To ensure proper routing, the UPS Access Point location ID must be included on the
shipping label for all UPS Access Point Economy shipments.
120597 Hard Invalid COD currency code. Please use the destination country currency code.
120598 Hard Package Delivery Confirmation is not allowed with the shipment origin/destination
120599 Hard Invalid package Delivery Confirmation type
120600 Hard Missing Package/PackagingType/Code
120601 Hard Missing/Invalid Package weight
120602 Hard Missing/Invalid Combination of package length, width, and height values.
120603 Hard Invalid Package/Reference/Value
120604 Hard Invalid package declared value
120605 Hard Mismatch package dimensions with package type
120607 Hard Invalid Package/Reference/Code
120608 Hard Package weight is required
120609 Hard All Package Dimensions are required and each must be greater than 0
120610 Hard Invalid COD monetary value
120611 Hard The contact name of verbal confirmation cannot exceed a length of 35
120612 Hard The contact phone number of verbal confirmation cannot exceed the length of 15
120613 Hard The contact phone number of verbal confirmation must be at least 10 alphanumeric
characters
120614 Hard The contact phone extension of verbal confirmation cannot exceed the length of 4
120615 Hard The contact phone extension of verbal confirmation must contain numbers only
120616 Hard Package weight cannot exceed a length of 6
120618 Hard Contact name is required for verbal confirmation of delivery
120619 Hard Contact phone number is required for verbal confirmation of delivery
120620 - 121116

120620 Hard Package/PackageWeight, Package/DimensionalWeight, Package/OversizePackage
and Package/Dimensions do not apply to UPS Envelopes
120621 Hard Package declared value cannot be greater than {Monetary Amount} {Currency Code}
120622 Hard Package description is required
120623 Hard Invalid Package description
120624 Hard Only one package is allowed for this movement.
120626 Hard The COD Funds Code is invalid. Please check the value entered
120627 Hard The COD Code is invalid. Please check the value entered
120651 Hard Invalid PackageServiceOptions/LabelDelivery/EMailMessage/SubjectCode
120652 Hard Invalid ShipmentServiceOptionsNotification/EMailMessage/SubjectCode
120653 Hard Invalid PackageServiceOptionsNotification/EMailMessage/SubjectCode
120654 Hard No more than two email addresses for Receiver Return Notification are allowed in a
shipment

120655 Hard {Email field} of Receiver Return Notification is only allowed to be specified at the first
package.
120658 Hard Receiver Return Notification is not allowed for the shipment without return service
120659 Hard ShipmentServiceOptions/ShipmentNotification is not allowed with return service
120660 Hard ShipmentServiceOptions/ShipmentNotification is not allowed with
ShipmentServiceOptions/Notification
120661 Hard For a shipment, the maximum number of {email field} allowed for Quantum View
notification is 1.
120662 Hard Invalid Subject Code of {Notification type}
120663 Hard Invalid From name of {Notification type}
120664 Hard Invalid UndeliverableEMailAddress of {Notification type}
120665 Hard Invalid FromEMailAddress of {Notification type}
120666 Hard Missing/Invalid subject text of {Notification type}
120667 Hard {field} is not allowed in Quantum View Notification
120670 Hard Shipper Release is not allowed with Return Service
120681 Hard Invalid pallet dimensions, the length must be longer than the width.
120683 Hard The maximum Dry Ice for a pallet/shipment is 200 kg or 440 lbs.
120684 Hard Itemized Charges are not valid for this service.
120687 Hard Missing or Invalid Page Size for UPS Premium Care Form.
120688 Hard Missing or Invalid Print Type for UPS Premium Care Form.
120689 Hard UPS Premium Care Form is required if UPS Premium Care Accessorial is requested.
120690 Hard Missing or Invalid Number of Copies for UPS Premium Care Form.
120691 Hard Missing or Invalid Languages for UPS Premium Care Form.
120692 Hard Two Languages are required for UPS Premium Care Form.
120693 Hard Missing or Invalid ShipmentDate for UPS Premium Care Form.
120695 Hard Missing or Invalid Packaging Type Quantity.
120700 Hard Missing/Invalid LabelSpecification/ LabelPrintMethod/Code
120701 Hard Missing/Invalid LabelSpecification/ HTTPUserAgent
120702 Hard Missing/Invalid LabelSpecification/ LabelImageFormat/Code
120703 Hard Missing/Invalid Combination of LabelSpecification/LabelStockSize
120704 Hard Invalid LabelSpecification/ LabelStockSize/Height
120705 Hard Invalid LabelSpecification/LabelStockSize/Width
120759 Hard Invalid MovementReferenceNumber
120801 Hard Address Validation Error on Shipper address
120802 Hard Address Validation Error on ShipTo address
120803 Hard Address Validation Error on ShipFrom address
120804 Warning Address Validation Warning on Shipper address. {Description}

120805 Warning Address Validation Warning on ShipTo address. {Description}
120806 Warning Address Validation Warning on ShipFrom address {Description}
120900 Warning User Id and Shipper Number combination is not eligible to receive Account Based
Rates.
120901 Warning Negotiated Rates are unavailable at this time.
120969 Hard Invalid notification language length.
120970 Hard Only 1 Shipment Indication Type allowed in a request.
120971 Warning Your invoice may vary from the displayed reference rates
120972 Hard UPS Account is not authorized for hold for pickup at UPS Access Point Shipment.
120973 Hard Package exceeds the maximum length constraint of {0} inches. Length is the longest
side of a package
120974 Hard Package exceeds the maximum length constraint of {0} cm. Length is the longest side
of a package.
120975 Hard The maximum per package weight for the selected option is {0} pounds.
120976 Hard The maximum per package weight for the selected option is {0} kg.
120977 Hard The customs value entered exceeds the maximum allowed amount of $2300 USD or
$2500 CAD
120978 Hard The requested billing option/payment option is unavailable with the selected shipment
indication type for a shipment to a UPS Access Point.
120979 Hard The maximum declared value for Flexible Parcel Insurance has been exceeded.
Maximum value per package: {0} {1}.
120980 Hard No more than 3 address line information can be given for alternate delivery address.
120981 Hard Missing or invalid alternate delivery address line information.
120982 Hard Missing or invalid alternate delivery address city.
120983 Hard Missing or invalid alternate delivery address state province code.
120984 Hard Missing or invalid alternate delivery address postal code.
120985 Hard Missing or invalid alternate delivery address country code.
120986 Hard Missing or invalid alternate delivery name.
120987 Hard Missing or invalid alternate delivery address attention name.
120988 Hard Missing or invalid shipment indication type code.
120989 Hard Invalid notification email address.
120990 Hard Missing or invalid alternate delivery address information.
120991 Hard Invalid notification dialect length.
120992 Hard Notification language-dialect pair not valid.
120993 Hard Notification phone number is missing.
120994 Hard Notification phone number may not exceed length of 15.
120995 Hard ADL notification code (012) and notification data (email or phone number) is required
for hold for pickup at access point location shipment.
120996 Hard Invalid alternate delivery address line 2.
120997 Hard Invalid alternate delivery address line 3.
120998 Hard UPS Access Point ID is valid only for for hold for pickup at UPS Access Point Shipment.

120999 Hard Missing or invalid UPS Access Point ID.
121000 Hard Request contains invalid data e.g. special characters etc. Please correct.
121005 Hard The COD option cannot be combined with the Return Services option.
121006 Hard The COD option cannot be combined with the UPS Import Control option.
121011 Hard Dangerous Goods cannot be shipped using UPS Import Control.
121015 Hard The Saturday Delivery option cannot be combined with the Return Services option.
121016 Hard The Saturday Delivery option cannot be combined with the UPS Import Control option.
121020 Hard The Delivery Confirmation option cannot be combined with the Return Services option.
121021 Hard The Delivery Confirmation option cannot be combined with the UPS Import Control
option.
121025 Hard The maximum declared amount $50,000 is exceeded
121027 Hard The maximum declared amount for the selected service was exceeded. Maximum
value for this service is: %maxDeclVal% %currencyCode%. For Declared Value
shipments up to %maxEnhancedDeclVal% %currencyCode%, please select an
applicable service.
121030 Hard Packages must weigh more than zero pounds.
121031 Hard Packages must weigh more than zero kilogram
121035 Hard {description}
121036 Hard {description}
121041 Hard The UPS Import Control accessories are unavailable with the requested service.
121045 Hard The Saturday Delivery option is unavailable with the requested service.
121047 Hard Saturday Delivery may not be combined with the package type for the given product.
121050 Hard Package exceeds the maximum size total constraints {description}
121055 Hard Package exceeds the maximum length constraint of {description} inches.
121056 Hard Package exceeds the maximum length constraint of {description} cm.
121057 Hard The measurement system is not valid
121063 Hard Accessorial cannot be shipped with the selected service.
121070 Hard {Rating error description}.
121085 Hard The requested accessory cannot be added to the shipment.
121090 Hard {Rating error description}
121100 Hard The selected services invalid for the shipment origin.
121105 Hard The given accessory key is invalid for the shipment origin.
121106 Hard The specified country, origin or destination, is not supported.
121107 Hard A blank origin postal was specified.
121109 Hard The Delivery Area Surcharge Tier looked up is invalid
121115 Hard The COD amount must be greater than zero
121116 Hard The declared value amount must be greater than zero.
121120 - 125000

121120 Hard The COD amount cannot exceed $1,000 when a cashiers check or money order is
requested.
121121 Hard The COD value entered exceeds the maximum allowed for cash of {amount}
({currency code})
121125 Hard The COD amount cannot exceed $50,000.
121126 Hard The COD value entered exceeds the maximum allowed for check of {amount}
({currency code})
121128 Hard The Access Point COD amount cannot exceed %COD.APAmountMax%
%COD.APCurrencyDest%.
121129 Hard The currency of the Access Point COD amount must be the same as the Destination
countrys currency: %COD.APCurrencyDest%.
121131 Hard The Saturday Pickup option cannot be combined with the UPS Import Control option.
121135 Hard The Saturday Pickup option cannot be combined with the Saturday Delivery option.
121140 Hard Saturday Pickup is unavailable with the selected service.
121150 Hard Delivery confirmation is unavailable with the selected service.
121155 Hard The COD option is unavailable with the selected service, UPS account type, and/or
with the shipments origin/destination pair.
121156 Hard Package Level COD is not valid for the shipment origin and/or destination
121160 Hard The accessory is invalid with the billing option.
121166 Hard The Verbal Confirmation of Delivery option cannot be combined with the UPS Import
Control option.
121170 Hard The Delivery Confirmation option cannot be combined with the Verbal Confirmation
of Delivery option.
121175 Hard Verbal Confirmation of Delivery is unavailable with the selected service.
121180 Hard Consignee Billing is unavailable with the selected service.
121182 Hard The payer's transportation country is not valid for carbon neutral shipments.
121185 Hard The selected service is unavailable to the desired country
121195 Hard The selected billing option is unavailable with the selected service.
121196 Hard The selected billing option is unavailable with UPS Letters.
121200 Hard Saturday Delivery is unavailable to desired destination.
121205 Hard Additional Handling is unavailable with the selected service.
121206 Hard Additional Handling is unavailable with UPS Letters.
121208 Hard UPS Next Day Air Early service is not available to the requested destination. Please
select UPS Next Day Air service as an alternative.
121210 Hard The selected service is not available from the origin to the destination.
121211 Hard Rating Error: (Description)
121214 Hard UPS cannot ship from the origin country to the destination country
121215 Hard The selected service is not available to residential destinations.

121230 Hard Next Day Air Early Surcharge is unavailable with the selected service.
121231 Hard Switzerland Domestic Container must weigh greater than 2 KG
121232 Hard Worldwide Express Plus from Europe to Switzerland must be UPS Envelope or
document only
121235 Hard {rating error description}
121245 Hard Saturday Pickup and Shipper Duty Fees cannot be applied to the same package.
121250 Hard Saturday Delivery and Shipper Duty Fees cannot be applied to the same package.
121255 Hard Shipper Duty Fee is unavailable with the selected service.
121260 Hard Shipper Duty Fee is unavailable with the selected billing option.
121261 Hard Accessory may not be combined with the product.
121262 Hard Accessory may not be combined with the accessory.
121265 Hard The selected billing option is unavailable to the desired country.
121266 Hard The currency code is invalid for the shipment.
121267 Hard The Ship From Country is invalid for the credit card.
121268 Hard The Billing address Country is invalid for the credit card.
121290 Hard The given billing option is invalid
121300 Hard Shipper Pays Duty - Tax Unpaid is unavailable with the selected accessorial.
121305 Hard Shipper Pays Duty - Tax Unpaid is unavailable with the selected service.
121310 Hard Shipper Pays Duty - Tax Unpaid is unavailable with the selected billing option.
121315 Hard The Authorized Return Service is unavailable with the selected accessorial.
121317 Hard The UPS Import Control option is unavailable with the selected accessory.
121320 Hard The Authorized Return Service is unavailable with the selected service.
121325 Hard The Authorized Return Service is unavailable with the selected billing option.
121330 Hard The Certificate of Origin is unavailable with the selected accessorial.
121335 Hard The Certificate of Origin is unavailable with the selected service.
121340 Hard The Certificate of Origin is unavailable with the selected billing option.
121345 Hard The Shipper Export Declaration is unavailable with the selected accessorial.
121350 Hard The Shipper Export Declaration is unavailable with the selected service.
121355 Hard The Shipper Export Declaration is unavailable with the selected billing option.
121360 Hard The Worldwide Express Plus Surcharge is unavailable with the selected service.
121363 Hard The One Time Pickup Surcharge is unavailable with the selected service.
121365 Hard Accessorial is not available with the selected access method.
121370 Hard Invalid access method.
121375 Hard Letter service is invalid for shipments with more than 1 package. International
shipment cannot be made with multiple 10KG or 25KG packages

121452 Hard An Import Control option and a Return Service option are not valid on the same
shipment.
121453 Hard Hundredweight is not valid with Return Service options
121460 Hard Shipments cannot exceed a COD amount of $5,000 when requesting a cashiers
check or money order.
121501 Hard {Rating error Description}
121502 Hard The selected country does not allow forward movements.
121510 Hard Unsupported package type.
121511 Hard Unsupported accessory type
121512 Hard Unsupported billing option
121513 Hard Unsupported service
121515 Warning Weight of (actual weight) exceeds maximum for rating the requested container. Using
standard package rates
121520 Hard The UPS account number specified for Transportation charges is invalid for Split Duty
VAT shipment.
121521 Hard Invalid payer of Duty and Tax
121522 Hard 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.
121523 Hard Invalid GoodsNotInFreeCirculationIndicator
121524 Warning The payer of Duty and Tax charges is not required for UPS Letter, Documents of No
Commercial Value or Qualified Domestic Shipments.
121526 Hard The payment method specified for Transportation charges is invalid for return service.
121527 Hard The payer of Transportation charges is required.
121528 Hard Missing or invalid ItemizedPaymentInformation/ShipmentCharge/Type
121529 Hard A single payment method is required per shipment charge.
121530 Hard The payer of Duty and Tax charges is required.
121531 Hard Invalid SplitDutyVATIndicator
121532 Hard The payer of Duty and Tax charges is invalid for Split Duty VAT shipment.
121534 Hard The payer of Transportation charges and the payer of Duty and Tax charges must not
be the same for Split Duty VAT shipment.
121535 Hard The payer of Transportation charges is invalid for Split Duty VAT shipment.
121536 Hard Bill Receiver is an invalid payer of an international return movement.
121537 Hard A payer is required when specifying a shipment charge.
121538 Hard For a domestic return movement, the payer of the freight must be in the country of the
return movement.
121539 Hard For an EU return movement, the payer of the freight must be in an EU country.
121630 Hard The requested accessorial is valid only for Hold for Pickup at UPS Access Point
shipment indication type.
121780 Hard Commercial Invoice Removal is valid only for Import Control shipments.
121801 Hard The country selected for transportation charges does not allow for Third Party
payment option.

121802 Hard The country selected for duty/taxes charges does not allow for Third Party payment
option.
123005 Warning (Description)
123010 Warning Package(s) in this shipment contains a warning: (Description)
123020 Warning Invalid Ship From postal code
123021 Warning Invalid Ship To postal code
123060 Warning The weight exceeds the limit for the UPS Letter/Envelope rate and will be rated using
the weight
124022 Hard Invalid number of shipment level notifications
124078 Hard The Notification Media Type is invalid for the given country.
124079 Hard The Notification Language is invalid for the given Notification Media Type Code.
124998 Hard ReceiptSpecification applies only for PRL or Exchange Return Receipt.
124999 Hard Invalid ImageFormat code
125000 Hard Missing or invalid shipment digest.
126000 - 128042

126000 Hard Shipper is not eligible to ship Dry Ice.
126001 Hard Shipper is not eligible to ship Hazardous Material / International Dangerous Goods.
126004 Hard HazMat Quantity is absent or doesn't meet specification.
126006 Hard HazMat TransportationMode has invalid value.
126008 Hard All packages with DryIce RegulationSet must contain the same Regulation Set.
126009 Hard DryIce RegulationSet for non-US PR origins destinations should be IATA.
126010 Hard DryIce DryIceWeight Weight cannot be larger than package weight.
126011 Hard Package/HazMatPackageInformation required with either
AllPackedInOneIndicator/OverPackedIndicator values.
126032 Hard HazMat ClassDivisionNumber is required.
126033 Hard HazMat ClassDivisionNumber exceeds maximum length of 7 characters.
126034 Hard HazMat ClassDivisionNumber violates datatype. Only ASCII allowed.
126035 Hard HazMat Quantity is required.
126036 Hard HazMat Quantity exceeds maximum value.
126038 Hard HazMat UOM not set or invalid.
126039 Hard HazMat UOM value exceeds maximum length of 10 characters.
126040 Hard HazMat UOM violates datatype only ASCII allowed.
126041 Hard HazMat ProperShippingName is required and not set.
126042 Hard HazMat ProperShippingName exceeds maximum length of 150 characters.
126043 Hard HazMat ProperShippingName violates datatype only ASCII allowed.
126045 Hard HazMat ReferenceNumber exceeds maximum of 15 characters.
126046 Hard HazMat ReferenceNumber violates datatype only ASCII allowed.

126047 Hard HazMat ReportableQuantity exceeds maximum length of 2 characters.
126048 Hard HazMat ReportableQuantity violates datatype only ASCII allowed.
126051 Hard HazMat IDNumber Number exceeds maximum length of 6 characters.
126052 Hard HazMat IDNumber Number violates datatype only ASCII allowed.
126055 Hard HazMat PackagingGroupType exceeds maximum length of 5 characters.
126056 Hard HazMat PackagingGroupType violates datatype only ASCII allowed.
126059 Hard HazMat PackagingInstructionCode is Required.
126060 Hard HazMat PackagingInstructionCode exceeds maximum length of 4 characters.
126061 Hard HazMat PackagingInstructionCode violates datatype only ASCII allowed.
126062 Hard HazMat TransportationMode exceeds maximum length of 30 characters.
126063 Hard HazMat TransportationMode violates datatype only ASCII allowed.
126064 Hard HazMat EmergencyPhone required since Regulation Set is TDG
126065 Hard HazMat EmergencyPhone Number exceeds maximum length of 25 characters.
126066 Hard HazMat EmergencyPhone Number violates datatype only ASCII allowed.
126069 Hard HazMat AdditionalDescription Info exceeds maximum length of 255 characters.
126070 Hard HazMat AdditionalDescription Info violates datatype only ASCII allowed.
126071 Hard HazMat PackagingType is required.
126072 Hard HazMat PackagingType exceeds maximum length of 255 characters.
126073 Hard HazMat PackagingType violates datatype only ASCII allowed.
126076 Hard Number of HazMat entities per package cannot be greater than 3.
126077 Hard Number of DryIce items per Package is greater than 1.
126078 Hard DryIce item cannot exist on the same package as another HazMat.
126079 Hard HazMat EmergencyContact Information is required for this shipment
126080 Hard HazMat EmergencyContact Information exceeds maximum length of 35 characters.
126081 Hard HazMat EmergencyContact Information violates datatype only ASCII allowed.
126082 Hard Package HazMatPackageInformation AllPackedInOneIndicator is optional.
126083 Hard Package HazMatPackageInformation OverpackedIndicator is optional.
126084 Hard Package HazMatPackageInformation QValue must exist with RegulationSet IATA
when AllPackedInOneIndicator present.
126085 Hard HazMatPackageInformation QValue must be decimal value with one significant digit.
126086 Hard PreAlertNotification Phone Number is missing
126087 Hard PreAlert Notification Phone Number may not exceed length of 15
126088 Hard PreAlertNotification Dialect length must be less than or equal to 2
126089 Hard PreAlertNotification Language-Dialect Pair not valid
126090 Hard Pre-alert notification is valid only with UPS Returns Exchange and UPS Returns Pack
and Collect shipments
126091 Hard Notification Language is missing
126092 Hard Notification Dialect is missing
126093 Hard Notification Language must be less than or equal to 3

126094 Hard Missing/Invalid Label Instruction Code
126095 Hard Invalid set of Label Instruction Codes
126096 Hard At least one rate information either negotiated rates or rate chart indicator is required.
126097 Hard LabelSpecification/Instruction is not allowed with the shipment
126098 Warning Account authentication is required to be completed to get negotiated rates.
126099 Warning Credit Card is the only valid payment method for this type of account.
127000 Hard Missing or Invalid Form EEIFilingOption Code. Should be UPS filed or shipper filed.
127001 Hard Missing or Invalid Code in UPSFiled. Should indicate one time POA or blanket POA.
127002 Hard Missing or Invalid shipper filed option - 1a requires the ITN, 1b requires the exemption
legend; 1c requires the post departure filing citation.
127003 Hard Missing or Invalid EEIFilingOption. Required for SDLShippingIndicator.
127004 Hard Missing or Invalid ShipFrom TaxIDType Code. Needed for EEI filing.
127005 Hard Shipper has no power of attorney privilege.
127007 Hard Shipper has no SDL contract and is not eligible to ship SDL shipments.
128001 Hard Invalid or missing international forms form type.
128002 Hard Invalid or missing forward agent company name. Valid length is 1 to 35 alphanumeric
128003 Hard Invalid or missing forward agent tax id. Valid length is 1 to 15 alphanumeric
128004 Hard Invalid or missing forward agent address line 1. Valid length is 1 to 35 alphanumeric
128005 Hard Invalid forward agent address line 2. Valid length is 0 to 35 alphanumeric
128006 Hard Invalid forward agent address line 3. Valid length is 0 to 35 alphanumeric
128007 Hard Invalid or missing forward agent city. Valid length is 1 to 30 alphanumeric
128008 Hard Invalid forward agent state province code. Valid length is 0 to 5 alphanumeric
128009 Hard Invalid forward agent postal code. Valid length is 0 to 9 alphanumeric
128010 Hard Invalid or missing forward agent country code
128011 Hard Invalid or missing ultimate consignee company name. Valid length is 1 to 35
alphanumeric
128012 Hard Invalid or missing ultimate consignee addressLine1. Valid length is 1 to 35
alphanumeric
128013 Hard Invalid ultimate consignee address line 2. Valid length is 0 to 35 alphanumeric
128014 Hard Invalid ultimate consignee address line 3. Valid length is 0 to 35 alphanumeric
128015 Hard Invalid or missing ultimate consignee city. Valid length is 1 to 30 alphanumeric
128016 Hard Invalid ultimate consignee state province code. Valid length is 0 to 5 alphanumeric
128017 Hard Invalid ultimate consignee postal code. Valid length is 0 to 9 alphanumeric
128018 Hard Invalid or missing ultimate consignee country code
128019 Hard Invalid or missing intermediate consignee company name. Valid length is 1 to 35
alphanumeric
128020 Hard Invalid or missing intermediate consignee address line 1. Valid length is 1 to 35
alphanumeric
128021 Hard Invalid intermediate consignee address line 2. Valid length is 0 to 35 alphanumeric
128022 Hard Invalid intermediate consignee address line 3. Valid length is 0 to 35 alphanumeric

128023 Hard Invalid or missing intermediate consignee city. Valid length is 1 to 30 alphanumeric
128024 Hard Invalid intermediate consignee state province code. Valid length is 0 to 5 alphanumeric
128025 Hard Invalid intermediate consignee postal code. Valid length is 0 to 9 alphanumeric
128026 Hard Invalid or missing intermediate consignee country code
128027 Hard Invalid or missing producer option. Valid values are 01, 02, 03 or 04
128028 Hard Invalid or missing producer company name. Valid length is 1 to 35 alphanumeric
128029 Hard Invalid or missing producer address line 1. Valid length is 1 to 35 alphanumeric
128030 Hard Invalid producer address line 2. Valid length is 0 to 35 alphanumeric
128031 Hard Invalid producer address line 3. Valid length is 0 to 35 alphanumeric
128032 Hard Invalid or missing producer city. Valid length is 1 to 30 alphanumeric
128033 Hard Invalid producer state province code. Valid length is 0 to 5 alphanumeric
128034 Hard Invalid producer postal code. Valid length is 0 to 9 alphanumeric
128035 Hard Invalid or missing producer country code
128036 Hard Invalid telephone number.
128037 Hard Invalid producer email address. Valid length is 0 to 50 alphanumeric
128038 Hard Invalid producer tax id. Valid length is 0 to 15 alphanumeric
128039 Hard Invalid number of products.
128041 Hard The form specified for the product must be one of the requested form.
128042 Hard If invoice is a requested international form, all specified products must belong to
invoice
128043 - 128240

128043 Hard Invalid or missing product unit number for product number {0}. Valid length is 1 to 7
numeric
128044 Hard Invalid or missing Product/Unit/UnitOfMeasurement/Code for product number {0}. Valid
length is 1 to 3 alphanumeric
128045 Hard Product/Unit/UnitOfMeasurement/Description is required when
Product/Unit/UnitOfMeasurement/Code is ""OTH"" for product number {0}. Valid length
is 1 to 3 alphanumeric
128046 Hard Invalid or missing product unit value for product number {0}. Valid length is 1 to 12
numeric and it can hold up to 6 decimal places
128047 Hard Invalid part number. Valid length is 0 to 10 alphanumeric
128048 Hard Invalid commodity code for product number {0}. Valid length is 6 to 15 alphanumeric
128049 Hard Invalid or missing product origin country code for product number {0}
128050 Hard Invalid or missing net cost code for product number {0}. Valid values are NC or NO
128051 Hard Invalid or missing net cost date range begin date for product number {0}. Valid format is
yyyyMMdd
128052 Hard Invalid or missing net cost date range end date for product number {0}. Valid format is
yyyyMMdd
128053 Hard Invalid or missing preference criteria for product number {0}. Valid values are A
through F

128054 Hard Invalid or missing producer info for product number {0}. Valid values are YES, NO[1],
NO[2] or NO[3]
128055 Hard Invalid or missing marks and numbers for product number {0}. Valid length is 1 to 35
alphanumeric
128056 Hard Invalid or missing product weight unit of measurement code for product number {0}.
Valid values are KGS or LBS
128057 Hard Invalid or missing product weight for product number {0}. Valid length is 1 to 5 and it
can hold up to 1 decimal places.
128058 Hard Invalid product vehicle ID for product number {0}. Valid length is 1 to 25 alphanumeric
128059 Hard Invalid or missing product schedule B number for product number {0}. Valid length is
10 alphanumeric
128060 Hard Invalid product schedule B quantity for product number {0}. Valid length is 0 to 10
numeric
128061 Hard Invalid or missing product schedule B unit of measurement code for product number
{0}. Valid length is 1 to 3 alphanumeric
128062 Hard Schedule B quantity is required when the schedule B unit of measurement code is not
equal to X
128063 Hard Invalid or missing export type for product number {0}. Valid values are D, F or M
128064 Hard Invalid or missing SED total value for product number {0}. Valid length is 1 to 15
numeric and can hold up to 2 decimal places
128065 Hard Invalid invoice number. Valid length is 0 to 35 alphanumeric
128066 Hard Invalid or missing invoice date. Valid format is yyyyMMdd
128067 Hard Invalid purchase order number. Valid length is 0 to 35 alphanumeric
128068 Hard Invalid terms of shipment.
128069 Hard Invalid or missing reason for export. Valid length is 1 to 20 alphanumeric
128070 Hard Invalid additional comments. Valid length is 0 to 150 alphanumeric
128071 Hard Invalid declaration statement. Valid length is 0 to 250 alphanumeric
128072 Hard 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.
128073 Hard Invalid freight charges monetary value. Valid length is 0 to 15 numeric and can hold up
to 2 decimal places.
128074 Hard Invalid other charges monetary value. Valid length is 0 to 15 numeric and can hold up
to 2 decimal places.
128075 Hard Invalid or missing other charges description. Valid length is 1 to 10 alphanumeric
128076 Hard Invalid or missing blanket period begin date. Valid format is yyyyMMdd
128077 Hard Invalid or missing blanket period end date. Valid format is yyyyMMdd
128078 Hard Invalid or missing export date. Valid format is yyyyMMdd
128079 Hard Invalid or missing export carrier. Valid length is 1 to 35 alphanumeric
128080 Hard Invalid carrier ID. Valid length is 0 to 2 alphanumeric
128081 Hard Invalid or missing in bond code. Valid length is 2 alphanumeric
128082 Hard Entry number is required when the in bond code is other than 70. Valid Length is 1 to
25 alpha numeric
128083 Hard Invalid or missing point of origin. Valid length is 1 to 5 alphanumeric

128084 Hard Invalid or missing mode of transport. Valid length is 1 to 35 alphanumeric
128085 Hard Invalid port of export. Valid length is 0 to 35 alphanumeric
128086 Hard Invalid port of unloading. Valid length is 0 to 35 alphanumeric
128087 Hard Invalid loading pier. Valid length is 0 to 35 alphanumeric
128088 Hard Invalid or missing parties to transaction. Valid values are R or N
128089 Hard Invalid license number. Valid length is 0 to 35 alphanumeric
128090 Hard Invalid or missing license date. Valid format is yyyyMMdd
128091 Hard Invalid license exception code. Valid length is 0 to 4 alphanumeric
128093 Hard Invalid ECCN number code. Valid length is 1 to 8 alphanumeric
128094 Hard Sold to information is required when an invoice or NAFTA CO is requested.
128095 Hard Invalid or missing sold to company name. Valid length is 1 to 35 alphanumeric
128096 Hard Invalid or missing sold to address line 1. Valid length is 1 to 35 alphanumeric
128097 Hard Invalid sold to address line 2. Valid length is 0 to 35 alphanumeric
128098 Hard Invalid sold to address line 3. Valid length is 0 to 35 alphanumeric
128099 Hard Invalid or missing sold to city. Valid length is 1 to 30 alphanumeric
128100 Hard Invalid sold to state province code. Valid length is 0 to 5 alphanumeric
128101 Hard Invalid sold to postal code. Valid length is 0 to 9 alphanumeric
128102 Hard Invalid or missing sold to country code
128103 Hard The selected international form is not valid for the shipment origin country
128104 Hard The selected international form is not valid for the shipment origin and product origin
combination.
128105 Hard The selected international form is not valid for the shipment origin and destination
countries
128109 Hard Invalid or missing sold to attention name. Valid value is 1 to 35 alphanumeric
128110 Hard Invalid sold to option. Valid values are 01 or 02
128111 Hard Commodity code is required for NAFTA CO
128112 Hard Invalid insurance monetary value. Valid length is 0 to 15 numeric and can hold up to 2
decimal places.
128113 Hard Invalid product description for product number {0}. Product description should be
present at least once. Valid range is 0 to 35 alphanumeric
128114 Hard Invalid or missing currency code. Valid length is 3 alphanumeric.
128115 Hard Invalid or missing sold to phone number. Valid length is 1 to 15 alphanumeric.
128116 Hard Invalid sold to tax identification number. Valid length is 1 to 15 alphanumeric.
128117 Hard Invalid or missing Shipper tax identification.
128118 Hard 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.
128119 Hard Invalid or missing product NumberOfPackagesPerCommodity. Valid length is 1-3
Numerics.
128120 Hard Origin country must be different than destination country.
128121 Hard Missing value of other unit of measurement.

128122 Hard Invalid net cost date range.
128123 Hard Invoice cannot be requested for non-document forward shipments.
128124 Hard Invalid blanket period.
128125 Hard Invalid or missing ShipFrom tax identification.
128201 Hard Invalid or missing international forms form type for shipment with return service. Valid
value is 01 or 05.
128202 Hard International forms can not be requested for letters or documents.
128203 Hard Duplicate contact information
128204 Hard Invalid form group id name. valid range is 0 to 50 alphanumeric
128205 Hard Duplicate International FormType Information. valid values are 01, 02, 03, 04
128210 Hard Invalid combination of international forms. Both partial and complete invoice form
cannot be selected together.
128211 Hard Invalid Email Address
128212 Hard Invalid or missing ShipTo tax identification.
128213 Hard Invalid or missing producer attention name. Valid value is 1 to 35 alphanumeric
128214 Hard Invalid telephone extension. Valid length is 1 to 4 alphanumeric.
128215 Hard Invalid telephone extension. Valid length is 1 to 4 alphanumeric.
128216 Hard Invalid or missing international forms form type for ExcludeFromForm. Valid values are
04.
128217 Hard A NAFTA Certificate of Origin must have at least one commodity in the request.
128218 Hard A Commercial Invoice must have at least one commodity in the request.
128219 Hard A Blanket Period can not exceed 365 days.
128220 Hard The Total Product units allocated to packages do not match.
128221 Hard Product not associated with a package.
128222 Hard Invalid number of products.
128223 Hard Invalid or missing DocumentID.
128224 Hard Invalid or missing Product Currency Code.
128225 Hard Invalid or missing Invoice Line Total.
128226 Hard Exceeds maximum number of International Forms (13) allowed per Shipment.
128227 Hard Invalid or missing Package Number (Product is selected to be placed in a Package that
does not exist).
128228 Hard Invalid or missing Product number.
128229 Hard Invalid or missing packing list info.
128230 Hard Invalid or missing package associated data.
128231 Hard Invalid Product Id.
128232 Hard Exceeds the maximum number of packages allowed for the packing list
128233 Hard User generated forms size exceeds total allowable limit for shipment of 5MB.
128234 Hard Invalid or missing Shipper Memo.
128235 Hard Invalid PackageInfo object.
128236 Hard Invalid or missing Tracking Number.

128237 Hard No form data found for given formsGroupID.
128238 Hard No PDF found for given documentId.
128239 Hard Exceeds maximum number of Document IDs (13) allowed per Shipment.
128240 Hard Invalid or missing User Created Form Data.
128241 - 129204

128241 Hard A shipment can only contain one Commercial Invoice.
128242 Hard Label Size is not provided in the CN22 form.
128243 Hard Missing the No of Prints per Page value
128244 Hard Missing the Label Print Type
128245 Hard Missing the CN22 form Type
128246 Hard Missing the Cn22 Other Description in the CN22 form
128247 Hard The CN22 Content is not provided in the CN22 form
128248 Hard The Total number of items associated with the content is invalid
128249 Hard The description of the content provided in the CN22 form is invalid
128250 Hard Total Weight of the content provided in the CN22 form is invalid
128251 Hard Total value of the items associated with the content in the CN22 form is invalid
128252 Hard The currency code provided in the CN22 form is invalid
128253 Hard The Weight format provided in the CN22 form is invalid.
128254 Hard The CN22 form cannot be combined with any other form
128255 Hard Air Freight Packing List and package Packing List are not allowed together in same
shipment.
128256 Hard Invalid Fold Here Text length.
128257 Hard The country of origin associated with the content in the CN22 form is invalid.
128258 Hard The tariff number associated with the content in the CN22 form is invalid.
128260 Hard Missing or Invalid Forms PointOfOriginType
128261 Hard Missing or Invalid Forms UltimateConsigneeType
128262 Hard Missing or Invalid Shipment ShipperNumber. Needed for EEI processing
128263 Hard Missing or Invalid Forms EEIFilingOption. EEI form should be filed
128264 Hard Missing or Invalid Shipper or Ship From Tax ID Type. Correct value is needed for EEI
form
128265 Hard Missing or Invalid Form EEIFilingOption Code. Should indicate UPS Filed or Shipper
Filed
128266 Hard Missing or Invalid Forms EEIFilingOption PreDepartureITNNumber
128267 Hard Missing or Invalid Forms EEIFilingOption ExemptionLegend
128268 Hard Missing or Invalid Forms UPSFiled POA Code. Should indicate one time POA or
Balnket POA
128269 Hard Missing or Invalid Forms EEIFilingOption EMailAddress.
128270 Hard Missing or Invalid Forms Product ExportInformation.

128271 Hard Missing or Invalid Forms Product ScheduleB Quantity (line 2)
128272 Hard Missing or Invalid Forms Product ScheduleB UnitOfMeasurement Code (line 2)
128273 Hard Missing or Invalid Forms EEIInformation License Code
128274 Hard Missing or Invalid Forms EEIInformation License Number
128275 Hard Missing or Invalid Forms EEIInformation License ECCNNumber
128276 Hard Missing or Invalid Forms EEIInformation LicenseLineValue
128277 Hard Missing or Invalid Forms DDTCInformation
128278 Hard Missing or Invalid Forms DDTCInformation ITARExemptionNumber
128279 Hard Missing or Invalid Forms DDTCInformation USMLCategoryCode
128280 Hard Missing or Invalid Forms DDTCInformation EligiblePartyIndicator
128281 Hard Missing or Invalid Forms DDTCInformation RegistrationNumber
128282 Hard Missing or Invalid Forms DDTCInformation Quantity
128283 Hard Missing or Invalid Forms DDTCInformation UnitOfMeasurement Code
128284 Hard Missing or Invalid Forms DDTCInformation SignificantMilitaryEquipmentIndicator
128285 Hard Missing or Invalid Forms DDTCInformation ACMNumber
128286 Hard Missing or Invalid Forms EEIInformation is OptOutNotification
128287 Hard Missing or Invalid Forms ExcludeFromEEI
128288 Hard Missing or Invalid Forms Document Account Number not enrolled
128289 Hard Missing or Invalid Forms EEIInformation invalid for SDL shipment
128290 Hard Missing or Invalid Forms EEIInformation ITN or SRN
128291 Hard Missing or Invalid Forms SDL shipment indication for products
128320 Warning Shipper Number is not qualified to receive negotiated rates.
128400 Hard The destination postal code %dest.postal% is not a valid %dest.country% postal code.
Verify your postal code, or select %dest.AdjCountry% as your destination country.
128401 Hard The Pickup From postal code %orig.postal% is not a valid %orig.country% postal code.
Verify your postal code, or select %orig.AdjCountry% as your Pickup From country.
128402 Hard The destination postal code %dest.postal% in %dest.country% can also be
%dest.AdjCityName% in %dest.AdjCountry%. If you want to ship to
%dest.AdjCityName%, select %dest.AdjCountry% and enter the postal code
%dest.AdjPostal%. If you are shipping to a city within %dest.country%, enter the correct
city.
128403 Hard The Pickup From postal code %orig.postal% in %orig.country% can also be
%orig.AdjCityName% in %orig.AdjCountry%. If you want to pickup from
%orig.AdjCityName%, select %orig.AdjCountry% and enter the postal code
%orig.AdjPostal%. If you are picking up from a city within %orig.country%, enter the
correct city.
129001 Warning Additional Handling has automatically been set on Package (index of the package).
129002 Warning An Extended Area Surcharge of (monetary value) has been added to the service cost.
129003 Warning {Rating error description}

129017 Warning {Rating error description} .
129018 Warning {Rating error description} .
129021 Hard Both Security code and Billing address are required if credit card information is
provided. If security code or billing address is provided both of them should be
provided
129022 Hard This credit card has been locked due to multiple unsuccessful validation attempts.
Please use another credit card to continue or try again later.
129023 Hard Line Origin Country is missing or invalid
129024 Hard Invoice Line Total is missing or invalid
129025 Hard Invoice subtotal is missing or invalid
129026 Hard Reason for export is missing or invalid
129027 Hard Invoice line number is missing or invalid
129028 Hard Line Unit Amount Price is missing or invalid
129029 Hard Commodity quantity is missing or invalid
129030 Hard Commodity unit of measure is missing or invalid
129031 Hard Merchandise description1 is missing or invalid
129034 Hard Total Amount is missing or invalid
129035 Hard PO number missing or invalid
129036 Hard Terms of shipment is missing or invalid
129037 Hard Freight Charges is missing or invalid
129038 Hard Insurance is missing or invalid
129039 Hard Discount is missing or invalid
129040 Hard Other charges is missing or invalid
129041 Hard Commodity code is missing or invalid
129042 Hard Commodity part number is missing or invalid
129043 Hard Invoice number is missing or invalid
129044 Hard Commodity currency code is missing or invalid
129045 Hard Commodity comments is missing or invalid
129046 Hard Missing credit card billing address line 1
129048 Hard Missing credit card billing address city
129049 Hard Missing credit card billing address state province code
129050 Hard Missing credit card billing address postal code
129051 Hard Missing credit card billing address country code
129057 Hard Location ID may not exceed the length of 10
129058 Hard Shipper Number {0} does not support pallet Contract Service.
129059 Hard Shipper Number {0} does not support Third Country Contract Service.

129076 Hard Pallets may not be included with other package types.
129077 Warning A dimensional surcharge has been added to pallet {0}.
129078 Hard The maximum dimensions for a pallet are 200 cm by 160 cm by 120 cm.
129079 Hard The requested service is not valid with pallets with a weight greater than 1000kg.
Please select Dedicated Package Courier Same Day Service.
129080 Hard Pallet {0} exceeds maximum width.
129081 Hard Pallet {0} exceeds maximum height.
129082 Hard Pallet {0} exceeds maximum length.
129083 Hard Pallet {0} exceeds maximum weight.
129085 Hard Cannot combine declared value and shipper declared value in a shipment.
129086 Hard GNIFC is not valid for Letters/Envelopes and documents with no commercial value.
129087 Hard Invalid Shipment Delivery Confirmation Type
129088 Hard Package Delivery Confirmation DCISNumber may not exceed a length of 11.
129090 Hard Only future date pickup is available for pickup requests for the requested origin and
destination and selected service
129171 Hard For Import Control movements, BILL RECEIVER is not a valid payer.
129172 Hard Credit card is not a valid payment method for Import Control
129174 Hard A package with a Import Control accessory must have a Merchandise Description.
129175 Hard Invalid Import Control shipment.
129176 Hard Either LabelDelivery Email or LabelLinksIndicator must be provided for this shipment.
129177 Hard LabelMethod is not valid for this shipment.
129180 Hard Missing or Invalid LabelMethod type for ImportControl shipment.
129200 Hard Unable to retrieve Mailer ID from UPS Internet Membership Services system.
129203 Hard Account is not authorized for UPS Exchange service
129204 Hard Account is not authorized for UPS Pack and Collect service
1270092 - 1270125

1270092 Hard Invalid InternationalForms/Product/EEIInformation/ExportInformation.
1270093 Hard Missing InternationalForms/Product/EEIInformation/ExportInformation.
1270103 Hard Missing InternationalForms/Product/ExportType.
1270104 Hard Invalid InternationalForms/Product/ExportType.
1270114 Hard Invalid InternationalForms/InBondCode. Valid values are 67, 68, 70.
1270115 Hard Missing InternationalForms/EntryNumber.
1270116 Hard Missing or Invalid InternationalForms/EEIFilingOption.
1270117 Hard Missing InternationalForms/Contacts/UltimateConsignee/Address/CountryCode.
1270118 Hard Missing InternationalForms/PartiesToTransaction.
1270119 Hard Invalid InternationalForms/PartiesToTransaction.

1270120 Hard Missing InternationalForms/RoutedTransactionIndicator.
1270121 Hard Invalid InternationalForms/RoutedTransactionIndicator.
1270122 Hard Invalid InternationalForms/UPSFiled/POA/Code. Should indicate one time POA or
blanket POA.
1270123 Hard Invalid InternationalForms/Contacts/UltimateConsignee/Address/CountryCode.
1270124 Hard Invalid InternationalForms/PointOfOrigin (If State length should be 2).
1270125 Hard Invalid InternationalForms/PointOfOrigin (If FTZIdentifier length max should be 7).
9126004 +

9126004 Hard PackageServiceOption HazMat Quantity is absent or doesn't meet specification.
9126005 Hard DryIce DryIceWeight Weight is absent or doesn't meet specification.
9126006 Hard PackageServiceOption HazMat TransportationMode has invalid value.
9126007 Hard DryIce DryIceWeight UnitOfMeasurment Code has invalid value.
9126030 Hard PackageServiceOption HazMat Regulation required or has invalid value.
9126044 Hard DryIce Regulation is required or has invalid value.
Label Recovery Error Codes

10001 Hard The XML document is not well formed
10002 Hard The XML document is well formed but the document is not valid
20011 Hard The Integration Indicator is no longer supported
300000 Transient Label Recovery system is currently unavailable
300001 Hard Multiple shipments found for the request
300002 Hard Label is unavailable -- the package has been sent to the destination address
300003 Hard The requested shipment contains more than 100 packages.
300004 Hard Invalid shipments return service for label recovery
300005 Hard Either tracking number or combination of reference plus shipper number required
300006 Hard Label is unavailable -- the label is expired
300007 Hard The shipment for the requested tracking number or the combination of reference
number plus shipper number could not be found. Please check the submitted data or
wait until the shipment is processed.
300008 Hard Invalid Translate/code
300009 Hard Invalid Inquire Method
300013 Hard Invalid Label Print Method
300014 Hard Invalid Tracking Number
300022 Warning Email subsystem is currently unavailable
300023 Hard Invalid LabelSpecification/HTTPUserAgent
300026 Warning The Label Link Email has been sent to the original label delivery email address when
the shipment was placed instead of the requested email address
300030 Hard Invalid Reference Number
300031 Hard Invalid Shipper Number
300032 Hard Label is unavailable -- the shipment has no {0}
300033 Hard The shipment for which you are trying to recover a label or Receipt has been voided.
Please contact the vendor for further information
300034 Hard Label is unavailable -- the shipment has not been processed.
300035 Hard Too many shipments found with the requested Shipper Number and Reference
Number. Please re-submit the request with the Tracking Number.
Void Error Codes

10001 Hard The XML document is not well formed
10002 Hard The XML document is well formed but the document is not valid
190001 Transient Void not available at this time
190002 Transient Invalid/Missing registration ID
190100 Hard Invalid ShipmentIdentificationNumber.
190101 Hard Time for voiding has expired.
190102 Hard No shipment found within the allowed void period
190103 Hard The Pickup Request associated with this shipment has already been completed
190104 Hard Return shipments cannot be voided.
190105 Hard Pickup Cancellation is not Available on this Pickup Request
190106 Hard Pickup Cancellation is not Available on this Pickup Request
190107 Hard The Pickup Request associated with this shipment has previously been canceled
190108 Hard The Pickup Request associated with this shipment cannot be canceled
190109 Hard Invalid TrackingNumber
190110 Hard Invalid Void Package {0}
190111 Hard Package Void Limit Exceeded
190112 Hard Return Service Shipments cannot be Voided at the Package Level
190113 Hard International Shipments cannot be Voided at the Package Level
190114 Hard Invalid Return Service Void Date
190115 Hard Invalid Void Date
190116 Hard A Label cannot be generated for a voided Return Service Shipment
190117 Hard The Shipment has already been voided
190118 Hard Same Day Service Void Not Allowed.
190119 Warning The requested Void was successful, but the associated Pickup was not Cancelled
190121 Hard None of the submitted packages were voided
190122 Hard Package(s) {0} selected to void is(are) invalid
190124 Hard Import Control Shipment cannot be voided later than 3 am of the day after the shipment
uploaded.
190125 Hard Import Control Shipments does not allow package void in a shipment
Accessorial / Surcharge Codes

The following codes corresponds to accessorial/surcharges. The codes are returned in the response when
requested with the Subversion element.
Code Accessorial / Surcharge

100 ADDITIONAL HANDLING
110 COD
120 DELIVERY CONFIRMATION
121 SHIP DELIVERY CONFIRMATION
153 PKG EMAIL SHIP NOTIFICATION
154 PKG EMAIL RETURN NOTIFICATION
155 PKG EMAIL INBOUND RETURN NOTIFICATION
156 PKG EMAIL QUANTUM VIEW SHIP NOTIFICATION
157 PKG EMAIL QUANTUM VIEW EXCEPTION NOTIFICATION
158 PKG EMAIL QUANTUM VIEW DELIVERY NOTIFICATION
165 PKG FAX INBOUND RETURN NOTIFICATION
166 PKG FAX QUANTUM VIEW SHIP NOTIFICATION
171 SHIP EMAIL ERL NOTIFICATION
173 SHIP EMAIL SHIP NOTIFICATION
174 SHIP EMAIL RETURN NOTIFICATION
175 SHIP EMAIL INBOUND RETURN NOTIFICATION
176 SHIP EMAIL QUANTUM VIEW SHIP NOTIFICATION
177 SHIP EMAIL QUANTUM VIEW EXCEPTION NOTIFICATION
178 SHIP EMAIL QUANTUM VIEW DELIVERY NOTIFICATION
179 SHIP EMAIL QUANTUM VIEW NOTIFY
187 SHIP UPS ACCESS POINT NOTIFICATION
188 SHIP EEI FILING NOTIFICATION
189 SHIP UAP SHIPPER NOTIFICATION
190 EXTENDED AREA
200 DRY ICE
220 HOLD FOR PICKUP
240 ORIGIN CERTIFICATE
250 PRINT RETURN LABEL
258 EXPORT LICENSE VERIFICATION
260 PRINT N MAIL
270 RESIDENTIAL ADDRESS
280 RETURN SERVICE 1ATTEMPT
290 RETURN SERVICE 3ATTEMPT
300 SATURDAY DELIVERY
310 SATURDAY PICKUP

330 PKG VERBAL CONFIRMATION
350 ELECTRONIC RETURN LABEL
372 QUANTUM VIEW NOTIFY DELIVERY
374 UPS PREPARED SED FORM
375 FUEL SURCHARGE
376 DELIVERY AREA
377 LARGE PACKAGE
378 SHIPPER PAYS DUTY TAX
379 SHIPPER PAYS DUTY TAX UNPAID
400 INSURANCE
401 SHIP ADDITIONAL HANDLING
402 SHIPPER RELEASE
403 CHECK TO SHIPPER
405 GERMAN PICKUP
406 GERMAN ROAD TAX
407 EXTENDED AREA PICKUP
410 RETURN OF DOCUMENT
430 PEAK SEASON
440 SHIP LARGE PACKAGE
441 CARBON NEUTRAL
442 PKG QV IN TRANSIT NOTIFICATION
443 SHIP QV IN TRANSIT NOTIFICATION
444 IMPORT CONTROL
445 COMMERCIAL INVOICE REMOVAL
446 IMPORT CONTROL ELECTRONIC LABEL
447 IMPORT CONTROL PRINT LABEL
448 IMPORT CONTROL PRINT AND MAIL LABEL
449 IMPORT CONTROL ONE PICK UP ATTEMPT LABEL
450 IMPORT CONTROL THREE PICK UP ATTEMPT LABEL
452 REFRIGERATION
454 PAC 1A BOX1
455 PAC 3A BOX1
456 PAC 1A BOX2
457 PAC 3A BOX2
458 PAC 1A BOX3
459 PAC 3A BOX3
460 PAC 1A BOX4
461 PAC 3A BOX4

462 PAC 1A BOX5
463 PAC 3A BOX5
464 EXCHANGE PRINT RETURN LABEL
465 EXCHANGE FORWARD
466 SHIP PREALERT NOTIFICATION
470 COMMITTED DELIVERY WINDOW
480 SECURITY SURCHARGE
492 CUSTOMER TRANSACTION FEE
500 SHIPMENT COD
510 LIFT GATE FOR PICKUP
511 LIFT GATE FOR DELIVERY
512 DROP OFF AT UPS FACILITY
515 UPS PREMIUM CARE
520 OVERSIZE PALLET
530 FREIGHT DELIVERY SURCHARGE
531 FREIGHT PICKUP SURCHARGE
540 DIRECT TO RETAIL
541 DIRECT DELIVERY ONLY
542 DELIVER TO ADDRESSEE ONLY
543 DIRECT TO RETAIL COD
544 RETAIL ACCESS POINT
545 SHIPPING TICKET NOTIFICATION
546 ELECTRONIC PACKAGE RELEASE AUTHENTICATION
547 PAY AT STORE
Accessorial & Surcharge Subtypes

Accessorial/Surcharge SubType
Freight Delivery Area Surcharge Freight Delivery Area Surcharge
Freight Delivery Area Surcharge Extended
Freight Remote Area Surcharge
Freight Remote Area Surcharge Extended
Freight Pickup Area Surcharge Freight Pickup Area Surcharge
Freight Pickup Area Surcharge Extended
Freight Remote Pickup Area Surcharge
Freight Remote Pickup Area Surcharge Extended
Insurance Accessorial BPI
DVS
EVS
TNT
Ship Delivery Confirmation Accessorial Adult Signature Required
Signature Required
COD Supported Countries

Rating and Shipping Package COD supported countries
Shipment Level
9
1 Check
Country
Cash Cashier's Check
Money Order
All EuropeanUnion (EU)Countries supported by the API, exceptions Yes Yes
noted below.
For additional information, refer to Country Codes in the Appendix.
Russia Yes No
United Arab Emirates Yes No
Package Level
NOTE:No EUcoutries currently support Package level COD.
0 9
Country 8
Check, Cash Personal Check
Cashiers Check
Cashier's Check
Money Order
Money Order
Argentina (AR) Yes
Brazil (BR) Yes
Canada (CA) Yes Yes
Chile (CL) Yes
Mexico (MX) Yes
Puerto Rico (PR) Yes Yes
United States (US) Yes Yes
Country Codes
Rating and Shipping Package APISupported Countries
UPS country code abbreviations generally follow the recommendations of the International Standards Organization
(ISO), which publishes a list of country abbreviations in ISO Standard 3166.
The following table lists the country codes defined by ISO at the time of this publication. The latest information is
available from the ISO web site: http://www.iso.org/.
NOTE: Not all UPS services are available in every country. Refer to the UPS Rate and Service Guide at
UPS.com for more information on UPS services.
Supported Supported
Destination Country Name Country Code
Forward Origin Return Origin
Afghanistan AF X
Aland Islands AX X
Albania AL X X
Algeria DZ X X
American Samoa AS
Andorra AD
Angola AO X
Anguilla AI
Antarctica AQ
Antigua and Barbuda AG X X
Argentina AR X X
Armenia AM X X
Aruba AW X X
Australia AU X X
Austria AT X X
Azerbaijan AZ X X
Bahamas BS X X
Bahrain BH X X
Bangladesh BD X X
Barbados BB X X
Belarus BY X X
Belgium BE X X
Belize BZ
Benin BJ
Bermuda BM X X
Bhutan BT
Bolivia (Plurinational State of) BO X X
Bonaire, St. Eustatius, Saba BQ X X
Bosnia and Herzegovina BA X X
Botswana BW
Supported Supported
Bouvet Island BV
Brazil BR X X
British Indian Ocean Territory IO
Brunei Darussalam BN X X
Bulgaria BG X X
Burkina Faso BF
Burundi BI X X
Cambodia KH X X
Cameroon CM X
Canada CA X X
Canary Islands IC X
Cabo Verde CV
Cayman Islands KY X X
Central African Republic CF
Ceuta XC
Chad TD
Chile CL X X
China CN X X
Christmas Island CX
Cocos (Keeling)Islands CC
Colombia CO X X
Comoros KM
Congo CG
Congo, The Democratic Republic of CD X
Cook Islands CK
Costa Rica CR X X
Cote d' Ivoire (Ivory Coast) CI X
Croatia HR X X
Cuba CU
Curacao CW X X
Cyprus CY X X
Czech Republic CZ X X
Denmark DK X X
Djibouti DJ X X
Dominica DM
Dominican Republic DO X X
Ecuador EC X X
Egypt EG X X
Supported Supported
El Salvador SV X X
England EN X
Equatorial Guinea GQ
Eritrea ER
Estonia EE X X
Ethiopia ET X X
Falken Islands (Malvinas) FK
Faroe Islands FO
Fiji FJ X X
Finland FI X X
France FR X X
French Guiana GF
French Polynesia PF
French Southern Territories TF
Gabon GA
Gambia GM
Georgia GE X X
Germany DE X X
Ghana GH X X
Gibraltar GI X X
Greece GR X X
Greenland GL
Grenada GD
Guadeloupe GP
Guam GU X X
Guatemala GT X X
Guernsey GG X X
Guinea GN X X
Guinea-Bissau GW
Guyana GY
Haiti HT X X
Heard Island and McDonald Islands HM
Holland HO X
Holy See (See Vatican)
Honduras HN X X
Hong Kong HK X X
Hungary HU X X
Iceland IS X X
Supported Supported
India IN X X
Indonesia ID X X
Iran (Islamic Republic of) IR
Iraq IQ X X
Ireland IE X X
Isle of Man IM
Israel IL X X
Italy IT X X
Jamaica JM X X
Japan JP X X
Jersey JE X X
Jordan JO X X
Kazakhstan KZ X X
Kenya KE X X
Kiribati KI
Korea (Democratic People's KP
Republic of)
Korea, South KR X X
Kosrae KO
Kuwait KW X X
Kyrgyzstan KG X
Lao People's Democratic Republic LA X X
(Laos)
Latvia LV X X
Lebanon LB X X
Lesotho LS
Liberia LR
Libya LY X X
Liechtenstein LI X X
Lithuania LT X X
Luxembourg LU X X
Macau (also Macao) MO X X
Macedonia (FYROM) MK X X
Madagascar MG X X
Malawi MW X X
Malaysia MY X X
Maldives MV
Mali ML X X
Supported Supported
Malta MT X X
Marshall Islands MH
Martinique MQ
Mauritania MR X X
Mauritius MU X X
Mayotte YT
Mexico MX X X
Micronesia (Federated States of) FM
Moldova (Republic of) MD X
Monaco MC X X
Mongolia MN
Montenegro ME X X
Montserrat MS
Morocco MA X X
Mozambique MZ X
Myanmar MM
Namibia NA
Nauru NR
Nepal NP X
Netherlands NL X X
New Caledonia NC
New Zealand NZ X X
Nicaragua NI X X
Niger NE
Nigeria NG X X
Norfolk Island NF
Northern Ireland NB X
Northern Mariana Islands MP
Norway NO X X
Oman OM X X
Pakistan PK X X
Palau PW
Palestine, State of PS
Panama PA X X
Papua New Guinea PG
Paraguay PY X X
Peru PE X X
Philippines PH X X
Supported Supported
Pitcairn PN
Poland PL X X
Ponape PO
Portugal PT X X
Puerto Rico PR X X
Qatar QA X X
Reunion RE X X
Romania RO X X
Russia (Russian Federation) RU X X
Rwanda RW X X
Saint Barthelemy BL
Saint Christopher SW X
Saint Croix (see Virgin Islands)
Saint John UV X
Saint Kitts and Nevis KN X X
Saint Lucia LC X X
Saint Maarten and St. Martin SX X X
Saint Thomas VL X
Saint Vincent and the Grenadines VC
Saipan SP
Samoa WS
San Marino SM
Sao Tome and Principe ST
Saudi Arabia SA X X
Scotland SF X
Senegal SN X X
Serbia RS X X
Seychelles SC
Sierra Leone SL
Singapore SG X X
Slovakia SK X X
Slovenia SI X X
Solomon Islands SB
South Africa ZA X X
Spain ES X X
Sri Lanka LK X X
Suriname SR
Swaziland SZ
Supported Supported
Sweden SE X X
Switzerland CH X X
Tahiti TA
Taiwan (Province of China) TW X X
Tajikistan TJ
Tanzania (United Republic of) TZ X X
Thailand TH X X
Timor-Leste TL
Tinian TI
Togo TG
Tonga TO
Tortola ZZ
Trinidad and Tobago TT X X
Truk TU
Tunisia TN X X
Turkey TR X X
Turkmenistan TM
Turks and Caicos Islands TC
Tuvalu TV
Uganda UG X
Ukraine UA X X
Union Island UI
United Arab Emirates AE X X
United Kingdom GB X X
United States US
Uruguay UY X X
Uzbekistan UZ X X
Vanuatu VU
Vatican City State VA X X
Venezuela(Bolvarian Republic of) VE X X
Vietnam (Viet Nam) VN X X
Virgin Islands, British VG
Virgin Islands, US VI X X
Wales WL X
Wallis and Futuna Islands WF
Yap YA
Yemen YE
Zambia ZM X X
Supported Supported
Zimbabwe ZW X
Currency Codes
UPS currency code abbreviations generally follow the recommendations of the International Standards
Organization (ISO), which publishes a list of currency abbreviations in ISO Standard 4217. The following table lists
the currency codes defined by ISO at the time of this publication. The latest information is available from the ISO
web site: http://www.iso.org/.
Countries may sometimes change their official currency. UPS does require time after the introduction of a new
currency before it can fully support that currency. In addition, UPS may continue to support the older currency for an
interim period in order to provide backwards compatibility.
UPS may also require the use of currencies other than the official currency for some countries.
Country/Region Currency Name Currency Code

Afghanistan Afghani AFN
Albania Lek ALL
Algeria Algerian Dinar DZD
American Samoa US Dollar USD
Andorra Euro EUR
Angola Kwanza AOA
Anguilla East Caribbean Dollar XCD
Antigua And Barbuda East Caribbean Dollar XCD
Argentina Argentine Peso ARS
Armenia Armenian Dram AMD
Aruba Aruban Guilder AWG
Australia Australian Dollar AUD
Austria Euro EUR
Azerbaijan Azerbaijanian Manat AZN
Bahamas Bahamian Dollar BSD
Bahrain Bahraini Dinar BHD
Bangladesh Taka BDT
Barbados Barbados Dollar BBD
Belarus Belarussian Ruble BYR
Belgium Euro EUR
Belize Belize Dollar BZD
Benin CFA Franc BCEAO XOF
Bermuda Bermudian Dollar BMD
Bhutan Indian Rupee INR
Bhutan Ngultrum BTN
Bolivia Boliviano BOB
Bolivia Mvdol BOV
Bosnia and Herzegovina Convertible Marks BAM
Botswana Pula BWP
Bouvet Island Norwegian Krone NOK
Brazil Brazilian Real BRL

British Indian Ocean Territory US Dollar USD
Brunei Darussalam Brunei Dollar BND
Bulgaria Bulgarian Lev BGN
Burkina Faso CFA Franc BCEAO XOF
Burundi Burundi Franc BIF
Cambodia Riel KHR
Cameroon US Dollar USD
Canada Canadian Dollar CAD
Cape Verde Cape Verde Escudo CVE
Cayman Islands Cayman Islands Dollar KYD
Central African Republic CFA Franc BEAC XAF
Chad CFA Franc BEAC XAF
Chile Chilean Peso CLP
Chile Unidades de formento CLF
China Yuan Renminbi RMB
Christmas Island Australian Dollar AUD
Cocos (Keeling) Islands Australian Dollar AUD
Colombia Colombian Peso COP
Colombia Unidad de Valor Real COU
Comoros Comoro Franc KMF
Congo CFA Franc BEAC XAF
Congo, The Democratic Republic of Franc Congolais CDF
Cook Islands New Zealand Dollar NZD
Costa Rica Costa Rican Colon CRC
Cte Divoire CFA Franc BCEAO XOF
Croatia Croatian Kuna HRK
Cuba Cuban Peso CUP
Cyprus Euro EUR
Czech Republic Czech Koruna CZK
Denmark Danish Krone DKK
Djibouti Djibouti Franc DJF
Dominica East Caribbean Dollar XCD
Dominican Republic Dominican Peso DOP
Ecuador US Dollar USD
Egypt Egyptian Pound EGP
El Salvador El Salvador Colon SVC
El Salvador US Dollar USD
Equatorial Guinea CFA Franc BEAC XAF

Eritrea Nakfa ERN
Estonia Euro EUR
Ethiopia Ethiopian Birr ETB
Falkland Islands (Malvinas) Falkland Islands Pound FKP
Faroe Islands Danish Krone DKK
Fiji Fiji Dollar FJD
Finland Euro EUR
France Euro EUR
French Guiana Euro EUR
French Polynesia CFP Franc XPF
French Southern Territories Euro EUR
Gabon CFA Franc BEAC XAF
Gambia Dalasi GMD
Georgia Lari GEL
Germany Euro EUR
Ghana Cedi GHS
Gibraltar Gibraltar Pound GIP
Greece Euro EUR
Greenland Danish Krone DKK
Grenada East Caribbean Dollar XCD
Guadeloupe Euro EUR
Guam US Dollar USD
Guatemala Quetzal GTQ
Guernsey Pound Sterling GBP
Guinea Guinea Franc GNF
Guinea-Bissau Guinea-Bissau Peso GWP
Guinea-Bissau CFA Franc BCEAO XOF
Guyana Guyana Dollar GYD
Haiti Gourde HTG
Haiti US Dollar USD
Heard Island ond McDonald Islands Australian Dollar AUD
Holy See (Vatican City State) Euro EUR
Honduras Lempira HNL
Hong Kong Hong Kong Dollar HKD
Hungary Forint HUF
Iceland Iceland Krona ISK
India Indian Rupee INR
Indonesia Rupiah IDR

Iran (Islamic Republic of) Iranian Rial IRR
Iraq Iraqi Dinar IQD
Ireland Euro EUR
Israel New Israeli Sheqel ILS
Italy Euro EUR
Jamaica Jamaican Dollar JMD
Japan Yen JPY
Jersey Pound Sterling GBP
Jordan Jordanian Dinar JOD
Kazakhstan Tenge KZT
Kenya Kenyan Shilling KES
Kiribati Australian Dollar AUD
Korea, Democratic Peoples Republic of North Korean Won KPW
Korea, Republic of Won KRW
Kuwait Kuwaiti Dinar KWD
Kyrgyzstan Som KGS
Lao Peoples Democratic Republic Kip LAK
Latvia Euro EUR
Lebanon Lebanese Pound LBP
Lesotho Rand ZAR
Lesotho Loti LSL
Liberia Liberian Dollar LRD
Libyan Arab Jamahiriya Libyan Dinar LYD
Liechtenstein Swiss Franc CHF
Lithuania Euro EUR
Luxembourg Euro EUR
Macao Pataca MOP
Macedonia, The Former Yugoslav Republic Denar MKD
of
Madagascar Malagascy Ariary MGA
Malawi Kwacha MWK
Malaysia Malaysian Ringgit MYR
Maldives Rufiyaa MVR
Mali CFA Franc BCEAO XOF
Malta Euro EUR
Marshall Islands US Dollar USD
Martinique Euro EUR
Mauritania Ouguiya MRO
Mauritius Mauritius Rupee MUR

Mayotte Euro EUR
Mexico Mexican Peso MXN
Mexico Mexican Unidad de Inversion (UID) MXV
Micronesia (Federated States of) US Dollar USD
Moldova, Republic of Moldovan Leu MDL
Monaco Euro EUR
Mongolia Tugrik MNT
Montenegro Euro EUR
Montserrat East Caribbean Dollar XCD
Morocco Moroccan Dirham MAD
Mozambique Metical MZN
Myanmar Kyat MMK
Namibia Rand ZAR
Namibia Namibian Dollar NAD
Nauru Australian Dollar AUD
Nepal Nepalese Rupee NPR
Netherlands Euro EUR
Netherlands Antilles Netherlands Antillian Guilder ANG
New Caledonia CFP Franc XPF
New Zealand New Zealand Dollar NZD
Nicaragua Cordoba Oro NIO
Niger CFA Franc BCEAO XOF
Nigeria Naira NGN
Niue New Zealand Dollar NZD
Norfolk Island Australian Dollar AUD
Northern Mariana Islands US Dollar USD
Norway Norwegian Krone NOK
Oman Rial Omani OMR
Pakistan Pakistan Rupee PKR
Palau US Dollar USD
Panama Balboa PAB
Panama US Dollar USD
Papua New Guinea Kina PGK
Paraguay Guarani PYG
Peru Nuevo Sol PEN
Philippines Philippine Peso PHP
Pitcairn New Zealand Dollar NZD
Poland Zloty PLN

Portugal Euro EUR
Puerto Rico US Dollar USD
Qatar Qatari Rial QAR
Runion Euro EUR
Romania New Leu RON
Russian Federation Russian Ruble RUB
Rwanda Rwanda Franc RWF
Saint Helena Saint Helena Pound SHP
Saint Kitts and Nevis East Caribbean Dollar XCD
Saint Lucia East Caribbean Dollar XCD
Saint Pierre and Miquelon Euro EUR
Saint Vincent and The Grenadines East Caribbean Dollar XCD
Samoa Tala WST
San Marino Euro EUR
So Tome and Principe Dobra STD
Saudi Arabia Saudi Riyal SAR
Senegal CFA Franc BCEAO XOF
Serbia Serbian Dinar RSD
Seychelles Seychelles Rupee SCR
Sierra Leone Leone SLL
Singapore Singapore Dollar SGD
Slovakia Euro EUR
Slovenia Euro EUR
Solomon Islands Solomon Islands Dollar SBD
Somalia Somali Shilling SOS
South Africa Rand ZAR
Spain Euro EUR
Sri Lanka Sri Lanka Rupee LKR
Sudan Sudanese Dinar SDD
Suriname Surinam Dollar SRD
Svalbard and Jan Mayen Norwegian Krone NOK
Swaziland Lilangeni SZL
Sweden Swedish Krona SEK
Switzerland Swiss Franc CHF
Switzerland WIR Franc CHW
Switzerland WIR Euro CHE
Syrian Arab Republic Syrian Pound SYP
Taiwan, Province of China New Taiwan Dollar TWD

Tajikistan Somoni TJS
Tanzania, United Republic of Tanzanian Shilling TZS
Thailand Baht THB
Timor-Leste US Dollar USD
Togo CFA Franc BCEAO XOF
Tokelau New Zealand Dollar NZD
Tonga Paanga TOP
Trinidad And Tobago Trinidad and Tobago Dollar TTD
Tunisia Tunisian Dinar TND
Turkey New Turkish Lira TRY
Turkmenistan Manat TMM
Turks And Caicos Islands US Dollar USD
Tuvalu Australian Dollar AUD
Uganda Uganda Shilling UGX
Ukraine Hryvnia UAH
United Arab Emirates UAE Dirham AED
United Kingdom Pound Sterling GBP
United States US Dollar USD
United States Minor Outlying Islands US Dollar USD
Uruguay Peso Uruguayo UYU
Uruguay Uruguay Peso en Unidades Indexadas UYI
Uzbekistan Uzbekistan Sum UZS
Vanuatu Vatu VUV
Venezuela Bolivar VEB
Viet Nam Dong VND
Virgin Islands (British) US Dollar USD
Virgin Islands (US) US Dollar USD
Wallis And Futuna CFP Franc XPF
Western Sahara Moroccan Dirham MAD
Yemen Yemeni Rial YER
Zambia Kwacha ZMK
Zimbabwe Zimbabwe Dollar ZWD
Delivery Confirmation Origin-Destination Pairs

The Origin-Destination table defines valid origin and destination combinations for the delivery confirmation
accessorials. These accessorials may be applied at the package-level (P) or at the shipment-level (S). They are
valid for forward shipments only.
Delivery confirmation types are as follows:
Delivery confirmation (DC)

Delivery confirmation with signature required (DC-SR)
Delivery confirmation with adult signature required (DC-ASR)
Origin Destination DC DC-SR DC-ASR
US50 US50, PR P P P
US50 CA, VI S S
US50 Intl other than CA, PR, VI S S
CA US50, PR P P P
CA CA, VI S S
CA Intl other than CA, PR, VI S S
PR US50, PR P P P
PR CA, VI S S
PR Intl other than CA, PR, VI S S
International-supported origin countries International (national, trans S S
(not US, PR, CA, VI) * border, worldwide)
*Refer to Country Codes in the Appendix.
Disclaimer Codes and Messages

Disclaimer Codes Disclaimer Message
01 Taxes are included in the shipping cost and apply to the transportation charges but
additional duties/taxes may apply and are not reflected in the total amount due.
02 Additional duties/taxes may apply and are not reflected in the total amount due.
03 Additional duties/taxes may apply and are not reflected in the total amount due.
04 Taxes were unable to be determined and may apply to the shipment.
05 Rate excludes VAT. Rate includes a fuel Surcharge, but excludes taxes, duties and
other charges that may apply to the shipment.
EEI License Codes

Electronic Export Information (EEI)
Department of Commerce/Bureau of Industry and Security (BIS)

Column definitions:
1: License Code
2: License Description
3: Report: Export License Nbr / CFR Citation /Authorization Symbol / KPC#
4: ECCN
5: Allowed MOT Codes
Code Description Report ECCN Export MOT
C30 Licenses issued by BIS authorizing an export, re- Report Mandatory IW, OS, All
export, or other regulated activity. The term the OI, TL
license does not include authority represented by License
a License Exception. EAR99 may be reported as Number.
an ECCN.
C31 Special Comprehensive License (SCL) Report Mandatory IW, OS, All
the OI, TL
Part 752.
License
EAR99 may be reported as an ECCN. Number.
C32 No License Required (NLR) Part 758 Report Mandatory IW, OS, All except
NLR. OI, TL 70 (Fixed
Those items which are covered by entries on the
Transport)
Commerce Control List that have a reason for
control other than or in addition to Anti-Terrorism
(AT).
For items under 600 series ECCNs with a .y
paragraph, use C60 (DY6).
EAR99 may be reported as an ECCN.
C33 No License Required (NLR) Part 758 Report Allowed All All
NLR. except
All other NLR items filed under the NLR
UG, FS,
provisions of the EAR Part 758 that are not covered
FI
by C32. Use C33 and report the ECCN if the
commodity is controlled ONLY for Anti-Terrorism
(AT).
For items under 600 series ECCNs with a .y
paragraph, use C60 (DY6).
For Census purposes, use C33 for shipments
between the U.S. and Puerto Rico and from the
U.S. to the U.S. Virgin Islands.

C35 Limited Value Shipments (LVS) Part 740.3 Report Mandatory CR, IS, All except
LVS. TE, TL, 70 (Fixed
EAR99 may NOT be reported as an ECCN. Must be one of
CH, CI, Transport)
the
Only allow Countries of Destination from the MS, GS,
Country Group B list following: IP, IR,
Reference: 0A018 OI, OS,
www.access.gpo.gov/bis/ear/pdf/740spir.pdf DD, IW
0A918
1A001
1A002
1A003
1A008
1B001
1B002
1B003
1C002
1C003
1C004
1C005
1C007
1C008
1C009
1C010
2B003
2B005
2B007
3C001
3C003
3C004
4A001
4A004
5A002
6A002
6A006
6A007
6B007
6C002
6C005
8A001
8A018
8B001
9A002
9A003

9A018
9B008
9B009
8A918
3A992
5B991
1B018
1C018
2B018
3B002
4A003
1C006
2A001
3A001
3A002
3B001
3C002
5A001
5B001
6A001
6A003
6A004
6A005
6A008
6B004
6C004
8A002
9B001
9B002
9B003
9B004
9B006
9A610
9A619
9B610
9B619
9C610
9C619

C36 Shipments to B Countries (GBS) Part 740.4 Report Mandatory CR, GP, All except
GBS. IS, TE, 70 (Fixed
TL, MS, Transport)
the following:
Only allow Countries of Destination from the GS, IP,
Country Group B list. 1A005 IR, TP,
Reference: 2B018 OI, OS,
www.access.gpo.gov/bis/ear/pdf/740spir.pdf DD, IW
3B002
4A003
1C006
2A001
3A001
3A002
3B001
3C002
3C005
3C006
5A001
5B001
6A001
6A003
6A004
6A005
6A008
6B004
6C004
8A002
9B001
9B002
9B003
9B004
9B006

C37 Civil End Users (CIV) Part 740.5 Report Mandatory CR, IS, All except
CIV. TE, TL, 70 (Fixed
IP, IR, Transport)
the following:
Only allow Countries of Destination from the OI, OS,
Country Group D1 list 1D001 DD, IW
Reference: 1D002
www.access.gpo.gov/bis/ear/pdf/740spir.pdf
3E002
5D001
6D003
9D003
1C006
2A001
3A001
3A002
3B001
3C002
3C005
3C006
4A003
5A001
5B001
6A001
6A003
6A004
6A005
6A008
6B004
6C004
8A002
9B001
9B002
9B003
9B004
9B006

C38 Restrict Technology and Software (TSR) Report Mandatory CR, GP, All except
TSR. IS, TE, 70 (Fixed
Part 740.6 (AES or EEI filing not required) Must be one of
TL, MS, Transport)
the following:
EAR99 may NOT be reported as an ECCN. GS, IP,
1D001 IR, OI,
Only allow Countries of Destination from the
Country Group B list 1D002 OS, IW
Reference: 3E002
www.access.gpo.gov/bis/ear/pdf/740spir.pdf
5D001
6D003
9D003
1E001
1E002
2D001
2D002
2E001
2E002
2E003
3D001
3D002
3D003
3D004
3E001
3E003
4D002
5E001
6D001
6D002
6E001
6E002
6E003
8D001
8D002
8E001
8E002
9D018
9E018
4D001
4E001
0E018
2D018
2E018

C39 Computers (CTP) Part 740.7
License Exception CTP has been revised and is
now known as License Exception APP. License
Code C39 is replaced with License Code C53.
AES will continue to allow
corrections/replacements/cancellations to
shipments previous accepted in AES under
License Exception C39. All new shipments
covered by this exception being added to AES
must be reported under License Code C53 with
Authorization Symbol APP.
Items under 600 series ECCNs are not eligible
under this license type.
C40 Temporary Imports, Exports, and Re-exports (TMP) Report Allowed CR, GP, All except
Part 740.9 TMP. IS, TE, 70 (Fixed
TL, MS, Transport)
Consolidates the following categories: Temporary
GS, IP,
exports and re-exports; Items temporarily in the
IR, TP,
U.S.; Beta Test Software.
OI, OS,
EAR99 may be reported as an ECCN. DD, IW
C41 Servicing and Replacement of Parts and Report Mandatory GP, IS, All except
Equipment (RPL) Part 740.10 RPL. TE, TL, 70 (Fixed
MS, GS, Transport)
Consolidates the following categories: One-for-one
IP, IR,
replacement of parts; servicing and replacement of
TP, OI,
equipment.
OS, IW
C42 Government and International Organizations (GOV) Report Mandatory GP, IS, All except
Part 740.11 (AES or EEI not required) GOV. TE, TL, 70 (Fixed
CH, CI, Transport)
Consolidates the following categories: International
MS, GS,
safeguards; shipments to U.S. Agencies and
IP, IR,
personnel; shipments to Agencies of cooperating
TP, OI,
governments.
OS, DD,
EAR99 may be reported as an ECCN. IW
C43 Gift Parcels and Humanitarian Donations (GFT) Report Mandatory UG, IW All except
Part 740.12 GFT. 70 (Fixed
Transport)
(AES or EEI not required)
Consolidates the following categories: Gift parcels;
Humanitarian donations.
C44 Technology and Software Unrestricted (TSU) Part Report Mandatory CR, GP, All except
740.13 TSU. IS, TE, 70 (Fixed
TL, MS, Transport)
Consolidates the following categories: Operating
GS, IP,
technology and software; Sales technology and
IR, TP,
software; Software updates; General software.
OI, OS,
EAR99 may be reported as an ECCN. IW

C45 Baggage (BAG) Part 740.14 Report Mandatory OI, OS, All except
BAG. IW 70 (Fixed
Transport)
C46 Aircraft and Vessels (AVS) Part 740.15 Report Mandatory GP, IS, All except
AVS. TE, TL, 70 (Fixed
(AES or EEI not required)
MS, GS, Transport)
Items under 600 series ECCNs are not eligible IP, IR,
under this license type. TP, OI,
EAR99 may be reported as an ECCN. OS, IW
C49 Trans-Alaska Pipeline Authorization Act (TAPS) Report Mandatory OI, OS, 70 (Fixed
Part 754.2 TAPS. IW Transport)
Permits the export of Alaskan North Slope crude
oil.
C50 Encryption Commodities and Software (ENC) Part Report Mandatory CR, GP, All except
740.17 ENC. IS, TE, 70 (Fixed
Must be one of
TL, MS, Transport)
Permits the export and re-export of any key length the following:
GS, IP,
encryption commodities and software after review;
5A002 IR, TP,
permits the export and re-export of any key length
5B002 OI, OS,
encryption to U.S. subsidiaries without review.
IW
EAR99 may NOT be reported as an ECCN. 5D002
5E002
C51 License Exception Agricultural Commodities (AGR) Report Mandatory CH, OI, All except
Part 740.18 License OS, IW 20, 21
Number. (Rail), 30,
Authorizes exports and certain re-exports of
31
agricultural commodities to Cuba.
(Truck),
Items under 600 series ECCNs are not eligible 70 (Fixed
under this license type. Transport)
C53 Computers (APP) Part 740.7 Report Mandatory CR, GP, All except
APP. IS, TE, 70 (Fixed
Adjusted Peak Performance (APP) replaces Must be one of
TL, MS, Transport)
Composite Theoretical Performance (CTP) the following:
GS, IP,
EAR99 may NOT be reported as an ECCN. 4A003 IR, TP,
4D001 OI, OS,
IW
4E001
C54 Short Supply (Western Red Cedar WRC) Part Report Mandatory All All except
754.4 70 (Fixed
SS- Must be
Transport)
EAR99 may NOT be reported as an ECCN. WRC
1C988
C55 Short Supply (Crude Oil Samples SAMPLE) Part Report Mandatory All All
754.2
SS- Must be
EAR99 may NOT be reported as an ECCN. SAMPLE
1C981

C56 Short Supply (Strategic Petroleum Reserves Report Mandatory All All
SPR) Part 754.2
SS- Must be
EAR99 may NOT be reported as an ECCN. SPR.
1C981
C57 Authorization for Validated End-User for Certain Report Mandatory OI, OS, All except
Authorized Exports and Re-exports of Commerce VEU. TL, IW 70 (Fixed
Control List items to the Peoples Republic of Transport)
China and India.
EAR99 may NOT be reported as an ECCN.
C58 Free Exchange of Information allows export and re- Report 4A994, 4D994, OI, OS, All except
export of consumer products related to CCD 5A991, 5D991, CH, CI 70 (Fixed
communications and exchange of information to 5D992,5A992, Transport)
Cuba.
EAR99
C59 Strategic Trade Authorization (STA) allows an Report 600-series OI, OS, All
exception to export specific controlled items to STA ECCNs and CH, CI
certain countries that would otherwise require a other ECCNs are
license because of CCL-based license eligible to the
requirements. extent permitted
under part
740.20 of the
EAR
C60 .y 600 series items to identify the .y subparts to Report Allowed OI, OS, All
ECCNs that are in the 600 series because they DY6 CH, CI
When reported,
have less military significance than other subparts
the ECCN must
to the 600 series.
be one of the
following:
9A610
9A619
9B619
9D610
9D619
9E610
9E619
Department of Energy/National Nuclear Security Administration (DOE/NNSA)

E01 Authorization for Nuclear Security Enterprise of government-owned, Report Not OS All
contractor-operated (GOCO) Management and Operations entities AEA Allowed except
that perform work under the directions and oversight of the National 12,20,
Nuclear Security Administration, to export items authorized by the 21, 70
Atomic Energy Act Authorization/Licensing and as acknowledged in
the International Traffic in Arms Regulations section 123.20 and
125.1.
Nuclear Regulatory Commission (NRC)

N01 NRC Form 250/250A Report the Allowed MS,GS, All except 60 (Passenger Hand
License Number. OI, OS Carried), 70 (Fixed Transport)
Specific export license for
nuclear material and
equipment.
N02 NRC General Export License Report the CFR Allowed MS,GS, All except 60 (Passenger Hand
Citation Number. OI, OS Carried), 70 (Fixed Transport)
Department of State/ Directorate of Defense Trade Control (DDTC)

When the License Code S61, S73, S85 or S94 is reported and accepted in AES, the filer is required to present the
original license and proof of filing to CBP prior to export.
Code Description Report ECCN Export MOT Code

SAG Agreements Report ITAR Report spaces. Allowed MS, All except 70 (Fixed
DDTC GS, OI, Transport)
Agreements (i.e. AG,
Exemption OS
BA, MA, RR, TA and VD)
Citation.
SAU Australia ITAR Report ITAR Report the Allowed MS, All except 70 (Fixed
Exemptions DDTC Approved GS, OI, Transport)
Exemption Community OS
Citation Member #
SCA Canadian ITAR Report ITAR Report spaces. Allowed MS, All except 70 (Fixed
Exemption DDTC GS, OI, Transport)
Exemption OS
Citation.
SGB United Kingdom ITAR Report ITAR Report the Allowed MS, All except 70 (Fixed
Exemptions DDTC Approved GS, OI, Transport)
Exemption Community OS
Citation Member #
S00 License Exemption Report ITAR Report spaces. Allowed MS, All except 70 (Fixed
Citation DDTC GS, OI, Transport)
Exemption OS
Citation.
S05 DSP-5 Report spaces. Report the Allowed MS, All except 70 (Fixed
License Number. GS, OI, Transport)
Permanent export of
OS
unclassified defense
articles and services.
Temporary import of
OS
unclassified articles.
License Number. GS, Transport)
Temporary export of
TP, OI,
unclassified articles.
OS
Temporary or
OS
permanent import or
export of classified
articles.
S94 DSP-94 Report spaces. Report the Allowed MS, All except 60
License Number. GS, (Passenger Hand
Foreign Military Sales
FS, FI Carried), 70 (Fixed
Transport)
Department of Treasury/Office of Foreign Assets Control (OFAC)

T10 OFAC Specific License Report the License Number. Allowed MS,GS, All except
OI, OS 60
Specific export license issued, on
(Passenger
a case-by-case basis, by OFAC for
Hand
certain export shipments that
Carried),
would otherwise be barred by
70 (Fixed
sanctions.
Transport)
T11 OFAC General Export License Report the CFR citation or if Allowed MS,GS, All except
there is no CFR citation, the OI, OS 60
Export shipments permitted under
Federal Register Citation if (Passenger
General license which conform to
there is one, or the General Hand
criteria set forth in an OFAC
License Number. Carried),
authorization published as a
70 (Fixed
regulation (no individual clearance
Transport)
by OFAC) covers certain
shipments that would otherwise be
barred by sanctions.
T12 Kimberley Process Certificate Report the KPC# EAR99 or OI, OS All except
Number blank only 70
The unique identifying number of (Fixed
the Kimberley Process Certificate Transport)
(KPC) issued by the United States
Kimberley Process Authority must
accompany any export (reexport)
of rough diamonds.
See standards, practices, and
procedures of the Kimberley
Process set forth in the Rough
Diamond Control Regulations, 31
CFR part 592, promulgated by
OFAC
(69 FR 56936 dated September
23, 2004).
Other Partnership Agency

OPA Other Partnership Agency License Report the Allowed All except All
License Number UG, FS, FI,
AES filers are required to comply with current paper
or OPA. IW
documentation requirements for agencies not
accommodated in AES
(i.e. DEA, ATF).
EEI License Types and Exemptions

Note: * AES Filing Required Regardless of Value
LicenseTypes
Section I
License Description
Commerce License Usually articles with dual use, Military or Civilian.
1 Letter + 6 Digits Example: D123456
Note: Must have an ECCN.
Drug Enforcement Agency (DEA) Exportation of controlled substances and chemicals.
5 Digits Example: 12345
or
2 Letters + 7 Digits Examples: RA1234567 or PB7654321
Note: Usually starts with R or P.
State Department License (SDL) DDTC enforces the laws and regulations for defense articles, defense
services and related technology such as weapons or manuals for fighter jets.
The commodities are usually military related articles.
9 Digits, but must start with 05 Example: 051234567
Note: Could have DOS in front/behind the digits and/or an expiration date.
License Exemptions
Section II
Exempt from requiring a license, but AES Filing is required and the exemption must be stated on the provided
documents.
License Exemption Description and Examples

10 CFR 110 Nuclear Regulatory Commission (NRC)
Key Entry: Only the digits 110 would be keyed in the License Field in
OPSYS.
22 CFR 120 to 130 State Department License Exemption (SDL Exemption)
Example: 22 CFR 123.16
Key Entry: Only the digits 123.16 would be keyed in the License field in
OPSYS.
See SDL Exception Matrix for AES Filing requirements.
Export License Exception Codes

License exception codes may be used in lieu of an export license in EEI forms.
Code License Exception

AGR Established for agricultural commodities to permit exports and re-exports to Cuba that is not specifically
identified on the Commerce Control List (CCL) and is classified as EAR99.
APR Items for export or re-export not controlled for nuclear nonproliferation, missile technology or crime
control.
AVS U.S. aircraft or foreign sojourn into foreign country.
BAG Individual or exporting carriers crew members baggage.
CIV National security items for civil end users.
CTP Computer and parts of.
ENC Encrypted software and hardware - financial institutions.
GBS Export or re-export of Country Group B; controlledfor national security reasons.
GFT Gift shipments; packages to individuals, religious, charitable or education institutions, donations of basic
needs.
GOV Government shipments, covers shipments for U.S. government agencies, personnel or of cooperating
foreign governments
KMI Encrypted software and hardware.
LVS Value of shipments limited.
NLR No license required.
RPL Servicing and replacement of parts and equipment, onefor one replacement parts service or replacement
of equipment.
TMP Temporary exports, export and re-export of items temporary in U.S., export and re-export of beta test
software.
TSPA Software or technology outside the scope of export regulations.
TSR Technology and software, national security reason, Country Group B.
TSU Technology and software shipments, of basic requirements, data supporting prospective or actual bids,
offers to sell, lease or supply an item. Software update for fixing programs, mass marketed software.
Hong Kong District Codes

The following table lists the codes UPS uses to represent Hong Kong districts.
District Code
ABERDEEN SD1
ADMIRALTY AD
AP LEI CHAU SD2
CAUSEWAY BAY CB
CENTRAL CD
CHA KWO LING KT1
CHAI WAN CW1
CHAK LAP KOK CLK1
CHEUNG CHAU ISL1
CHEUNG SHA WAN CSW
CHOI HUNG CH
CHUNG HOM KOK SD3
DAIMOND HILL DH
DEEP WATER BAY SD4
DISCOVERY BAY ISL2
FANLING FL
FORTRESS HILL NP1
FOTAN ST1
HAPPY VALLEY HV
HO MAN TIN HMT
HUNGHOM HH
JORDAN JD
KAM TIN NT1
KENNEDY TOWN WD1
KOWLOON BAY KLB
KOWLOON CITY KLC
KOWLOON TONG KLT
KWAI CHUNG KC1
KWAI FONG KC2
KWAI HING KC3
KWUN TONG KT2
LAI CHI KOK LCK1
LAI KING LCK2
LAM TIN LT3
LAMMA ISLAND ISL3
LANTAU ISLAND ISL4
District Code
LOK FU LF1
MA ON SHAN ST2
MEI FOO LCK3
MIDDLE BAY SD5
MID-LEVEL ML1
MONGKOK MK1
MOUNT DAVIS WD2
NGAU TAU KOK NTK
NORTH POINT NP2
PING CHAU ISL5
POK FU LAM SD6
PRINCE EDWARD MK2
QUARRY BAY QB
REPULSE BAY SD7
SAI KUNG SK
SAI WAN WD3
SAI WAN HO SWH
SAI YING PUN WD4
SAN PO KONG SPK
SHA TAU KOK SS1
SHAM SHUI PO SSP
SHAM TSENG NT2
SHATIN ST3
SHAU KEI WAN SKW
SHEK KIP MEI SKM
SHEK KONG NT4
SHEK O SD8
SHEK TONG TSUI WD5
SHEUNG SHUI SS2
SHEUNG WAN SW
SHUN LEE SL
SIU LEK YUEN ST4
SIU SAI WAN CW2
SOUTH BAY SD9
SOUTHERN DISTRICT SD10
STANLEY SD11
TAI HANG ML2
TAI KOK TSUI TKT
District Code
TAI LAM CHUNG NT5
TAI PO TP
TAI TAM SD12
TAI WAI ST5
TAP SHEK KOK NT6
THE PEAK ML3
TIN HAU NP3
TIN SHUI WAI NT7
TIN WAN SD13
TO KWA WAN TKW
TSEUNG KWAN O TKO
TSIM SHA TSUI TST1
TSIM SHA TSUI EAST TST2
TSING LUNG TAU NT8
TSING YI TY
TSUEN WAN TW
TSZ WAN SHAN TWS
TUEN MUN NT9
TUNG CHUNG CLK2
WAH FU SD14
WANCHAI WC
WANG TAU HOM LF2
WESTERN DISTRICT WD6
WONG CHUK HANG SD15
WONG TAI SIN WTS
YAU MA TEI YMT
YAU TONG KT3
YUEN LONG NT10
International Forms Preference Criteria

Preference criteria are required in North American Free Trade Agreement Certificate of Origin (NAFTA CO)
documents. The following table lists the defined criteria and their use.
Criteria Meaning
A The good is \"wholly obtained or produced entirely\" in the territory of one or more of the
NAFTA countries as referenced in Article 415.
Note: The purchase of a good in the territory does not necessarily render it\" wholly obtained or
produced.\" If the good is an agricultural good, see also criterion F and Annex 703.2. (Reference: Article
401(a) and 415)
B The good is produced entirely in the territory of one or more of the NAFTA countries and satisfies the
specific rule of origin, set out in Annex 401 that applies to its tariff classification. The rule may include a
tariff classification change, regional value-content requirement, or a combination there-of.
The good must also satisfy all other applicable requirements of Chapter Four. If the good is an
agricultural good, see also criterionF and Annex 703.2. (Reference: Article 401(b))
C The good is produced entirely in the territory of one or more of the NAFTA countries exclusively from
originating materials. Under this criterion, one or more of the materials may not fall within the definition
of \"wholly produced or obtained,\" as set out in Article 415.
All materials used in the production of the good must qualify as \"originating\" by meeting the rules of
Article 401(a) through (d). If the good is an agricultural good, see also criterion F and Annex703.2.
Reference: Article 401(c).
D Goods are produced in the territory of one or more of the NAFTA countries but do not meet the
applicable rule of origin, set out in is an agricultural good, see also criterion F and
Annex703.2.
Reference: Article 401(c). Annex 401, because certain non-originating materials do not undergo the
required change in tariff classification. The goods do nonetheless meet the regional value-content
requirement specified in Article 401 (d). This criterion is limited to the following two circumstances:
1. The good was imported into the territory of a NAFTA country in an unassembled or disassembled
form but was classified as an assembled good, pursuant to H.S. General Rule of Interpretation 2
(a). or (2).
2. The good incorporated one or more non- originating materials, provided for as parts under the
H.S., which could not undergo a change in tariff classification because the originating materials,
provided for as parts under the H.S., which could not undergo a change in tariff classification
because the heading provided for both the good and its parts and was not further subdivided into
subheadings, or the subheading provided for both the good and its parts and was not further
subdivided.
Note: This criterion does not apply to Chapters 61 through 63 of the H.S. (Reference: Article 401(d))
E Certain automatic data processing goods and their parts, specified in Annex308.1,
that do not originate in the territory are considered originating upon importation into the
territory of a NAFTA country from the territory of another NAFTA country when the
most-favored- nation tariff rate of the good conforms to the rate established in Annex 308.1
and is common to all NAFTA countries. (Reference: Annex 308.1)
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 \"qualifying good\" as defined in Annex 703.2, Section A or B (please specify).
A good listed in Appendix 703.2B.7 is also exempt from quantitative restrictions and is
eligible for NAFTA preferential tariff treatment if it meets the definition of \"qualifying good\" in Section A
of Annex 703.2.
Note: This criterion does not apply to goods that wholly originate in Canada or the United States and
are imported into either country. Note: A tariff rate quota is not a quantitative restriction
Label Examples
The following figures are examples of UPS shipping and return labels.
Shipping Label Sample
Return Label Sample
Language / Dialect Combinations

PreAlertNotification and UPS Access Point Notification language/dialect combinations:
Language Dialect
CES 97
DAN 97
DEU 97
ELL 97
ENG GB
ENG US
ENG CA
ENG CA
FIN 97
FRA 97
FRA CA
HEB 97
HUN 97
ITA 97
NLD 97
NLD 97
NOR 97
NOR 97
POL 97
POR 97
RON RO
RUS 97
SLK 97
SPA 97
SPA PR
SWE 97
TUR 97
VIE 97
ZHO TW
License Exception Codes

License exception codes may be used in lieu of an export license in EEI forms.
Values Description
AGR Established for agricultural commodities to permit exports and re-exports to Cuba that is not specifically
identified on the Commerce Control List (CCL) and is classified as EAR99.
APR Items for export or re-export not controlled for nuclear nonproliferation, missile technology or crime
control.
AVS U.S. aircraft or foreign sojourn into foreign country.
BAG Individual or exporting carrier's crew member's baggage.
CIV National security items for civil end users.
CTP Computer and parts of.
ENC Encrypted software and hardware - financial institutions.
GBS Export or re-export of Country Group B; controlled for national security reasons.
GFT Gift shipments; packages to individuals, religious, charitable or education institutions, donations of basic
needs.
GOV Government shipments, covers shipments for U.S. government agencies, personnel or of cooperating
foreign governments.
KMI Encrypted software and hardware.
LVS Value of shipments limited.
NLR No license required.
RPL Servicing and replacement of parts and equipment, one for one replacement parts service or
replacement of equipment.
TMP Temporary exports, export and re-export of items temporary in U.S., export and re-export of beta test
software.
TSPA Software or technology outside the scope of export regulations.
TSR Technology and software, national security reason, Country Group B.
TSU Technology and software shipments, of basic requirements, data supporting prospective or actual bids,
offers to sell, lease or supply an item. Software update for fixing programs, mass marketed software
Mail Innovations Package Detail Information

Priority and First Class Mail - Domestic
Delivery QV Email
Package Endorsement
UOM Weight Type of Endorsement Confirmation Notification
Type Required ?
Allowed ? Allowed ?
Priority LBS 1 to 70 Required ASR, CSR,FSR, and RSR Allowed Allowed
First Class OZS 1 to 13 Required ASR, CSR,FSR, and RSR Allowed Allowed
Expedited Mail Innovations - Domestic
Delivery QV Email
Package Endorsement
Type Required ?
Allowed ? Allowed ?
Machineables OZS 6 to < 16 Required ASR, CSR,FSR, and RSR Allowed Allowed
Irregulars OZS 1 to < 16 Required ASR, CSR,FSR, and RSR Allowed Allowed
Parcel Post LBS 1 to 70 Required ASR, CSR,FSR, and RSR Allowed Allowed
BPM Parcel LBS 1 to 15 Required ASR, CSR,FSR, and RSR Allowed Allowed
Media Mail LBS 1 to 70 Required ASR, CSR,FSR, and RSR Allowed Allowed
Standard Flats OZS 1 to < 16 Prohibited LSR Prohibited Allowed
BPM Flats LBS 1 to 15 Prohibited LSR Prohibited Allowed
Priority and Economy Mail Innovations - International
Delivery QV Email
Package Endorsement
Type Required ?
Allowed ? Allowed ?
BPM, Flats, LBS 1 to 70 Prohibited LSR Prohibited Prohibited
Parcels
BPM, Flats, LBS 1 to 70 Prohibited LSR Prohibited Prohibited
Parcels
Note*: UOM and Weight are specified at the Package Level.
Table 2:
Endorsement Full Text Allowed

ASR Address Service Requested Allowed
CSR Change Service Requested Allowed
FSR Forwarding Service Requested Allowed
RSR Return Service Requested Allowed
LNR No Service Selected Allowed
Paperless Invoice Support Countries

The following table lists those countries that support paperless (electronic submission) invoices.
NOTE: Although a country may be prepared to accept Paperless Invoices, it is not guaranteed that all origins
are allowed to send Paperless Invoices to such a country.
Paperless Invoice countries are updated quarterly however guides are updated semi-annually in January and July.
Changes may occur between releases of the guide.
Australia Scotland Macau Hungary
Canada South Korea Netherlands Ireland
Denmark Switzerland Philippines Japan
France United States Puerto Rico Lithuania
Great Britain Austria Singapore Malaysia
India China Spain New Zealand
Israel Estonia Tai wan Poland
Jersey Germany Vietnam Romania
Luxembourg Hong Kong Belgium Slovenia
Malta Indonesia Czech Republic Sweden
Norway Italy Finland Thailand
Portugal Latvia Guernsey
North American Free Trade Agreement (NAFTA) Supported Countries

The following table lists the NAFTA countries that support paperless (electronic submission).
NOTE: Although a country may be prepared to accept Paperless NAFTA, it is not guaranteed that all origins
are allowed to send Paperless Invoices to such a country.
Mexico as an origin is not currently supported.
Origin Destination
US CA
US MX
CA US
CA PR
CA MX
PR CA
PR MX
Reference Number Codes

Shipments and packages may include a reference number. The type of reference number may be indicated by a
reference number code.
Code Description
AJ Accounts Receivable Customer Account
AT Appropriation Number
BM Bill of Lading Number
9V Collect on Delivery (COD) Number
ON Dealer Order Number
DP Department Number
EI Employers ID Number
TJ Federal Taxpayer ID No.
3Q Food and Drug Administration (FDA) Product Code
IK Invoice Number
MK Manifest Key Number
MJ Model Number
PM Part Number
PC Production Code
PO Purchase Order Number
RQ Purchase Request Number
RZ Return Authorization Number
SA Salesperson Number
SE Serial Number
SY Social Security Number
ST Store Number
TN Transaction Reference Number
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.
For more information on UPS services, refer to the latest UPS Rate and Service Guide available at
http://www.ups.com.
United States
Canada
European Union
Mexico
Poland
Puerto
Undefined Countries
All Countries
United States
Shipments originating in United States
Description Shipping Rating

UPS 2nd Day Air 02 02
UPS 2nd Day Air A.M. 59 59
UPS 3 Day Select 12 12
UPS Ground 03 03
UPS Next Day Air 01 01
UPS Next Day Air Early 14 14
UPS Standard 11 11
UPS Worldwide Expedited 08 08
UPS Worldwide Express 07 07
UPS Worldwide Express Plus 54 54
UPS Worldwide Saver 65 65
United States Domestic Shipments

UPS 2nd Day Air A.M. 59 59
UPS 3 Day Select 12 12
UPS Expedited Mail Innovations M4 M4
UPS First-Class Mail M2 M2
UPS Ground 03 03
UPS Next Day Air Saver 13 13
UPS Priority Mail M3 M3
Canada
Description Category Shipping Rating
UPS 2nd Day Air Canadian domestic shipments 02 02
UPS Next Day Air Saver Canadian domestic shipments 13 13
UPS 3 Day Select Shipments originating in Canada 12 12
UPS Access Point Economy Canadian domestic shipments 70 70
UPS Expedited Shipments originating in Canada to CA, US and Mexico 08 08
UPS Express Shipments originating in Canada 01 01
UPS Express Early Shipments originating in Canada 14 14
UPSExpress Saver Shipment originating in Canada (Domestic and Int'l) 65 65
UPS Standard Shipments originating in Canada to CA and US 48 11 11
UPS Worldwide Expedited International shipments originating in Canada 08 08
UPS Worldwide Express Shipments originating in Canada to the US and Mexico 07 07
UPS Worldwide Express Plus International shipments originating in Canada 54 54
European Union
UPS Access Point Economy Shipments within the European Union 70 70
UPS Expedited Shipments originating in the European Union 08 08
UPS Express Shipments originating in the European Union 07 07
UPS Standard Shipments originating in the European Union 11 11
UPS Worldwide Express Plus Shipments originating in the European Union 54 54
UPS Worldwide Saver Shipments originating in the European Union 65 65
Mexico
UPS Access Point Economy Mexican Domestic Shipments 70 70
UPS Expedited Shipments originating in Mexico 08 08
UPS Express Shipments originating in Mexico 07 07
UPS Express Plus Shipments originating in Mexico 54 54
UPS Standard Shipments originating in Mexico 11 11
UPS Worldwide Saver Shipments originating in Mexico 65 65
Poland
UPS Access Point Economy Polish Domestic Shipments 70 70
UPS Expedited International Shipments originating in Poland 08 08
UPS Express Shipments originating in Poland 07 07
UPS Express Plus Shipments originating in Poland 54 54
UPS Express Saver Shipments originating in Poland 65 65
UPS Standard Shipments originating in Poland 11 11
UPS Today Dedicated Courier Polish Domestic Shipments 83 83
UPS Today Express Polish Domestic Shipments 85 85
UPS Today Express Saver Polish Domestic Shipments 86 86
UPS Today Standard Polish Domestic Shipments 82 82
Puerto Rico
Shipments originating in Puerto Rico

UPS Ground 03 03
UPS Worldwide Express 07 07
Undefined countries
Use for all countries other than United States, Canada, European Union, Mexico, Poland, and Puerto Rico

UPS Express 07 07
UPS Standard 11 11
All Countries
Shipments originating in any country

UPS Worldwide Express Freight 96 96
UPS Priority Mail Innovations M5 M5
UPS Economy Mail Innovations M6 M6
Tax Type Values / Abbreviations

ALV GST MOMS PVN
BTW HST MVA QST
DDS IVA MWST TVA
DDV IVA1 PDV VAT
DPH IVA2 PST VSK
FPA IVA3 PVM
Shipping Package XML Developer Guide
2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary

Shipping Package XML Developer Guide

Uploaded by

Copyright:

Available Formats

Shipping Package XML Developer Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Shipping Package XML Developer Guide

Uploaded by

Copyright:

Available Formats

What are the legal requirements for using UPS APIs?

What are the legal requirements for using UPS APIs?

What are the requirements for displaying UPS branding?

What are the requirements for displaying UPS branding?

Shipping - Package

July 11, 2016

UPS Developer Kit APIs

Key Legal Requirements for UPS Developer APIs

Consent to Use of UPS Mark

Copyright and Proprietary Notice

Chapter 2: Understanding the Shipping API 5

Chapter 3: Customer Integration Environment (CIE) 9

Chapter 4: Shipment Confirm APIElements and Details 15

Chapter 5: Shipment Accept APIElements and Details 136

Chapter 6: Label Recovery Elements and Details 163

Chapter 7: Void Shipment Elements and Details 179

Chapter 8: Shipping XML APIExamples 188

LabelRecoveryRequest Example 193

Chapter 9: Shipping Package API FAQs 196

Language / Dialect Combinations 276

In this guide, you will find:

This guide applies to the following API:

This guide does not apply to the following APIs:

Required Knowledge & Skills

Concepts and instructions in the Introduction to the UPSDeveloper Kit guide.

How to Use this Guide

Shipment level: Russia and United Arab Emirates

Expansion of supported countries

Support for new General List and Regional Rate charts

Support PayPal for all forward movements

Return itemized published rates for transportation, surcharges and accessorials

Extend currently available UPS Access Point functionality to new countries

Expansion of supported countries

Expansion of satellite countries

What Shipping Services Can Do

Include a label in an outbound shipment

How Shipping Services Work

Two-Stage Shipping Process

Label Recovery Services

Using Negotiated Rates in CIE

Integration Testing URL

Server Availability Check

Service Name: ShipConfirm

Service Name: ShipAccept

Void Package (XML)

Integration Testing for Void

Production Testing for Void

Server Availability Check for Void

Service Name: Void

Shipping and Tracking Numbers for Testing Void

NUMBER(S) SCENARIO EXPECTED RESULT

NUMBER(S) SCENARIO EXPECTED RESULT

Label Recovery (XML)

NUMBER(S) SCENARIO EXPECTED RESULT

Integration Testing for Label Recovery

Production Testing for Label Recovery

Server Availability Check for Label Recovery

Service Name LabelRecovery

Element constraints are defined as follows:

Name Constraint Description Validation