Shipping - Package

Web Service Developer Guide

November 1, 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 UPS’s
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
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 11
Release Features 12

Chapter 2: Understanding the Shipping API 16

Business Processes and Rules 16
Negotiated Rates 16
What Shipping Services Can Do 17
Shipments 17
Voids (Cancellations) 17
Returns 17
How Shipping Services Work 18
Two-Stage Shipping Process 18
Single Stage Process 19
Voiding Shipments 19
Label Recovery Services 19

Chapter 3: Customer Integration Environment (CIE) 20

Using Negotiated Rates in CIE 20
Shipping 20
Void Package 21
Shipping and Tracking Numbers for Testing Void 22
Label Recovery 23

Chapter 4: Shipment API Elements and Details 24

Accessing the Shipping Package Web Service API 24
Element Constraints 24
ShipmentRequest Top Level Containers 25
ShipmentRequest XPath Tables 27
Request 27
RequestOption 27
SubVersion 28
TransactionReference 28
Shipment 29
Description 29
ReturnService 29
DocumentsOnlyIndicator 31
Shipper 31
ShipTo 35
AlternateDeliveryAddress 38
ShipFrom 41
PaymentInformation 44
FRSPaymentInformation 52
GoodsNotInFreeCirculationIndicator 56

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary iv
 ShipmentRatingOptions 57
MovementReferenceNumber 58
ReferenceNumber 58
Service 59
InvoiceLineTotal 61
NumOfPiecesInShipment 61
USPSEndorsement 62
MILabelCN22Indicator 62
SubClassification 62
CostCenter 63
PackageID 63
IrregularIndicator 63
ShipmentIndicationType 63
RatingMethodRequestedIndicator 64
TaxInformationIndicator 64
ShipmentServiceOptions 65
Package 121
LabelSpecification 138
LabelImageFormat 138
HTTPUserAgent 139
LabelStockSize 139
Instruction 140
ReceiptSpecification 141
ImageFormat 141
ShipmentResponse Top Level Containers 142
ShipmentResponse XPath Tables 143
Response 143
ResponseStatus 143
Alert 144
TransactionReference 144
ShipmentResults 146
Disclaimer 146
ShipmentCharges 147
NegotiatedRateCharges 151
FRSShipmentData 154
RatingMethod 159
BillableWeightCalculationMethod 159
BillingWeight 160
ShipmentIdentificationNumber 161
ShipmentDigest 161
PackageResults 161
ControlLogReceipt 170
Form 171
CODTurnInPage 172
HighValueReport 174

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary v
 LabelURL 175
LocalLanguageLabelURL 175
ReceiptURL 175
LocalLanguageReceiptURL 176

Chapter 5: Ship Confirm API Elements and Details 177

ShipConfirmRequest Top Level Containers 178
ShipConfirmRequest XPath Tables 180
Request 180
RequestOption 180
SubVersion 181
TransactionReference 181
Shipment 182
Description 182
ReturnService 182
DocumentsOnlyIndicator 184
Shipper 184
ShipTo 188
AlternateDeliveryAddress 191
ShipFrom 194
PaymentInformation 197
FRSPaymentInformation 204
FreightShipmentInformation 206
GoodsNotInFreeCirculationIndicator 209
ShipmentRatingOptions 209
MovementReferenceNumber 210
ReferenceNumber 211
Service 211
InvoiceLineTotal 213
NumOfPiecesInShipment 213
USPSEndorsement 214
MILabelCN22Indicator 214
CostCenter 215
PackageID 215
IrregularIndicator 215
ShipmentIndicationType 215
RatingMethodRequestedIndicator 216
TaxInformationIndicator 216
ShipmentServiceOptions 217
SaturdayDeliveryIndicator 217
COD 217
AccessPointCOD 218
DeliverToAddresseeOnlyIndicator 219
Notification 219
LabelDelivery 222

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary vi
 InternationalForms 225
International Forms continued, Contacts 235
InternationalForms continued, Product 246
International Forms continued 260
DeliveryConfirmation 267
ImportControlIndicator 268
LabelMethod 269
CommercialInvoiceRemovalIndicator 269
UPScarbonneutralIndicator 270
PreAlertNotification 270
ExchangeForwardIndicator 272
HoldForPickupIndicator 272
DropoffAtUPSFacilityIndicator 273
LiftGateForPickUpIndicator 273
SDLShipmentIndicator 273
EPRAReleaseCode 274
Package 275
Label Specification 292
LabelImageFormat 292
HTTPUserAgent 293
LabelStockSize 293
Instruction 294
ReceiptSpecification 295
ImageFormat 295
ShipConfirmResponse Top Level Containers 296
ShipConfirmResponse XPath Tables 297
Response 297
ResponseStatus 297
Alert 298
TransactionReference 298
ShipmentResults 300
Disclaimer 300
ShipmentCharges 301
NegotiatedRateCharges 305
FRSShipmentData 307
RatingMethod 313
BillableWeightCalculationMethod 313
BillingWeight 314
ShipmentIdentificationNumber 315
ShipmentDigest 315

Chapter 6: Ship Accept API Elements and Details 316

ShipAccept Request Top Level Containers 316
ShipAcceptRequest XPath Tables 317
Request 317

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary vii
 RequestOption 317
SubVersion 318
TransactionReference 318
ShipmentDigest 318
ShipAccept ResponseTop Level Containers 319
ShipAcceptResponse XPath Tables 320
Response 320
ResponseStatus 320
Alert 321
Transaction Reference 321
ShipmentResults 323
Disclaimer 323
ShipmentCharges 324
NegotiatedRateCharges 328
FRSShipmentData 330
RatingMethod 336
BillableWeightCalculationMethod 336
BillingWeight 337
ShipmentIdentificationNumber 338
ShipmentDigest 338
PackageResults 338
ControlLogReceipt 347
Form 348
CODTurnInPage 350
HighValueReport 351
LabelURL 352
LocalLanguageLabelURL 352
ReceiptURL 352
LocalLanguageReceiptURL 353

Chapter 7: Label Recovery API Elements and Details 354

Accessing Label Recovery Web Service 354
LabelRecoveryRequest Top Level Containers 354
LabelRecoveryRequest XPath Tables 355
Request 355
LabelSpecification 356
Translate 357
LabelDelivery 359
TrackingNumber 359
ReferenceValues 359
LabelRecoveryResponse Top Level Containers 361
LabelRecoveryResponse XPath Tables 362
Response 362
ShipmentIdentificationNumber 363
LabelResults 364

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary viii
 TrackingCandidate 367

Chapter 8: Void Shipment Elements and Details 369

Accessing Void Web Service 369
VoidShipmentRequest Top Level Containers 369
VoidShipmentRequest XPath Tables 370
Request 370
VoidShipment 371
Void Shipment Response Top Level Containers 372
VoidShipmentResponse XPath Tables 373
Response 373
SummaryResult 375
PackageLevelResult 375

Chapter 9: Shipping Web Service API Examples 377

ShipmentRequest Published Rates 377
ShipmentResponse Published Rates 379
ShipmentRequest Negotiated Rates 380
ShipmentResponse Negotiated Rates 382
LabelRecoveryRequest Example 384
LabelRecoveryResponse Example 385
VoidShipmentRequest Example 386
VoidShipmentResponse Example 386

Chapter 10: Shipping Package API FAQs 387

Appendices 396
Error Codes 397
Common Error Codes 397
Shipping Error Codes 399
Error Codes 20004 - 20011 399
Error Codes 12700 - 127007 399
Error Codes 110001 - 125000 399
Error Codes 126000 - 126099 411
Error Codes 128001 - 150000 413
Error Codes 250010 - 250064 419
Error Codes 1270092 – 1270125 420
Error Codes 9120000 + 421
Label Recovery Error Codes 424
Void Error Codes 426
Accessorial / Surcharge Codes 427
Accessorial & Surcharge Subtypes 430
COD Supported Countries 431
Country Codes 432

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary ix
 Currency Codes 440
Delivery Confirmation Origin-Destination Pairs 447
Disclaimer Codes and Messages 448
EEI License Codes 449
Department of Commerce/Bureau of Industry and Security (BIS) 449
Department of Energy/National Nuclear Security Administration (DOE/NNSA) 458
Nuclear Regulatory Commission (NRC) 458
Department of State/ Directorate of Defense Trade Control (DDTC) 459
Department of Treasury/Office of Foreign Assets Control (OFAC) 460
Other Partnership Agency 460
EEI License Types and Exemptions 461
EEI Unit of Measure Codes 462
Export License Exception Codes 463
Hong Kong District Codes 464
International Forms Preference Criteria 467
Label Examples 468
Shipping Label Sample 468
Return Label Sample 469
Language / Dialect Combinations 470
License Exception Codes 471
Mail Innovations Package Detail Information 472
Paperless Invoice Support Countries 473
North American Free Trade Agreement (NAFTA) Supported Countries 473
Reference Number Codes 474
Service Codes 475
United States 475
Canada 476
European Union 476
Mexico 476
Poland 477
Puerto Rico 477
Undefined countries 477
All Countries 478
Tax Type Values / Abbreviations 479

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary x
Chapter 1: Introduction
In this document, you will find guidance and instructions for integrating the Shipping Package Web Service into
your application, service, or system.

In this guide, you will find:

• New release features
• Shipping Package Web Service API functionality and business rules
• Web service 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:

• SOAP API for the Shipping Package Web Service

This guide does not apply to the following APIs:

• Shipping Package XML API
• Shipping Ground Freight or Air Freight API

Intended Audience
This guide is intended for developers who will be integrating the Shipping Package Web Service 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 UPS Developer Kit guide.
• XML syntax and structure
• Web services
• 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 UPS Developer 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 Package API,
continue with Understanding the Shipping API. There you will find an overview of the Shipping functionality and
business rules.
• Chapter 3: Customer Integration Environment (CIE) contains information on UPS integration environments.
• Chapters 4-8 contain an overview of the top-level containers and elements that comprise Shipping requests and
responses.
• Request and response examples are located in Shipping Web Service 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 11
Shipping Package Web Service Developer Guide November 1, 2016

Release Features
November 2016

Description
Canadian destination values revised in the Delivery Confirmation Origin-Destination Pairs topic in the
Appendix.

July 2016

Description
Expanded COD Service

• Shipment level: Russia and United Arab Emirates

• Package Level: Argentina, Brazil, Chilie, Mexico
For additional information refer to the topic: COD Supported Countries
New FreightShipmentInformation Request Containers/Elements
/FreightShipmentInformation

• FreightDensityInfo
• AdjustedHeightIndicator
• AdjustedHeight
■ Value
■ UnitOfMeasurement
▲ Code

▲ Description

• HandlingUnits
■ Quantity
■ Type
▲ Code

▲ Description

■ Dimensions
▲ UnitOfMeasurement

Code
Description
▲ Length
▲ Width
▲ Height
• DensityEligibleIndicator
New FreightDensityRate Response Container/Elements

• /ShipmentResults/FRSShipmentData/FreightDensityRate
• Density
• TotalCubicFeet

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 12
Shipping Package Web Service Developer Guide November 1, 2016

Description
New HandlingUnitsResponse Containers/Elements

• /ShipmentResults/FRSShipmentData/HandlingUnits
• Quantity
• Type
■ Code
■ Description
• Dimensions
■ UnitOfMeasurement
▲ Code

▲ Description

■ Length
■ Width
■ Height
New error codes: 9120500 - 9120513
For additional information, refer to Shipping Error Codes 9120000+ in the Appendix.

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, and Zimbabwe
■ Updates noted in the Country Code appendix
• Refer to UPS.com for additional information
International Rate Type

• Support new General List and Regional Rate charts

• New value returned in response
Expand Customer Payment Options

• Support PayPal for all forward movements

Rating Granularity

• Return itemized published rates for transportation, surcharges, and accessorials

New Shipping Request Elements

• /Request/SubVersion
• Subversion value: 1607 = 2016 July

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 13
Shipping Package Web Service Developer Guide November 1, 2016

Description
New Shipping Response Container and Elements

• /ShipmentCharges/ItemizedCharges
• /NegotiatedRateCharges/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 - The Notification Media Type is invalid for the given country.
• 124079 - The Notification Language is invalid for the given Notification Media Type Code.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 14
Shipping Package Web Service Developer Guide November 1, 2016

July 2015

Description
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, and United Arab Emirates
■ Updates noted in the Country Code appendix
• Refer to UPS.com for additional information
Satellite Country Compliance

• Expansion of satellite countries

■ Canary Islands, Ceuta, Melilla, and Aland Islands
■ Updates noted in the Country Code appendix
• Refer to UPS.com for additional information
Expanded Web Services

• New JSON API available and ready to use

• Supports full UPS web-services functionality
UPS Access Point ™ Network

• New services:
■ UPS Access Point Economy for forward Hold at Pick-up (Contract service)
■ Access Point Delivery (General Service )
■ UPS Return service (Contract service) for Domestic shipments within Access Point countries
• New Package Release code accessorial
■ Authorization code provided by shipper used by the receiver for Hold for Pick-up packages
• UPS Access Point addresses listed on the label instructions for ERL and PRL’s
• Account level support Direct Delivery Only (DDO)
New Shipping Request Element

• /Shipment/ShipmentServiceOptions/EPRAReleaseCode
New Error Codes

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 15
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 Pricing’s 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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 16
Shipping Package Web Service Developer Guide November 1, 2016

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 API gives 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 customer’s location
NOTE: UPS can provide a label for a return shipment even if it did not provide a label for the forward shipment.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 17
Shipping Package Web Service Developer Guide November 1, 2016

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. ShipConfirmRequest
The procedure begins when a client application sends a (1) ShipConfirmRequest to UPS. This request
provides details of the Ship and the desired UPS services.
After the ShipConfirmRequest message is created, it must be sent to the Shipping API ShipConfirm URL
■
address, using a HTTP POST.
2. ShipConfirmResponse
■ After the ShipConfirmRequest message is received by the server, it is preprocessed and validated. If the
request passes all validation tests, a (2) ShipConfirmResponse is returned containing estimated rate
information, the Ship Id, and the Ship digest.
■ If the ShipConfirmRequest message fails validation, a ShipConfirmResponse message is returned
containing error information. The majority of the validation is performed in this stage. The actual Ship has not
been created at this point.
Stage II. Accept
3. ShipAcceptRequest
When the rates and services are accepted by the client, a (3) ShipAcceptRequest is sent to UPS. This
message authorizes UPS to charge for the Ship and process the Ship data.
■In order to create a Ship 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 Ship digest returned in the ShipConfirmResponse
message.
4. ShipAcceptResponse
UPS acknowledges the request by returning a (4) ShipAcceptResponse. For forward Ships and for preprinted
return labels, this response includes a label for the Ship.
■ After the ShipAcceptRequest message is received in the server, additional processing validation is
performed. If the ShipAcceptRequest message passes all validation tests, a ShipAcceptResponse message
is returned containing detailed rate information, the Ship ID, package tracking numbers and the shipping
label(s).
■ If the ShipAcceptRequest message fails validation, a ShipAcceptResponse message is returned containing
error information.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 18
Shipping Package Web Service Developer Guide November 1, 2016

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

Single Stage Process

In addition to the two-stage process the previous subsection describes, client applications may process a forward or
return shipment with a single request and response. With this process, clients will not have the opportunity to review
estimated rates before accepting the shipment. As the figure below illustrates, clients invoke this process by
sending a (1) ShipmentRequest, to which UPS replies with a (2) ShipmentResponse.

NOTE: Estimated rates are not available when using the single stage process.

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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 19
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
Shipping Integration Testing
For integration testing, direct your Shipping Package Web Service to:
https://wwwcie.ups.com/webservices/Ship

Shipping Production URL

Once your testing is complete, direct your Shipping Package Web Service to the production URL:

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 20
Shipping Package Web Service Developer Guide November 1, 2016

https://onlinetools.ups.com/webservices/Ship

Server Availability Check for Shipping

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

Service Name: ShipWS

Remote User: null
Server Port: 443
Server Name: wwwcie.ups.com
Servlet Path: /Ship

Void Package

Void Package Integration Testing

Testing your Void application will ensure that your application has the ability to process success and error
responses correctly.
For integration testing, direct your Void Package Shipment Web Service to:
https://wwwcie.ups.com/webservices/Void
Test your Void application using the set of 1Zs listed below:

Void Package Production URL

Once testing is complete, direct your Void Package Web Service API to the production URL:
https://onlinetools.ups.com/webservices/Void

Server Availability Check for Void

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/webservices/Void

Server Name: Void

Remote User: null
Server Port: 443
Server Name: wwwcie.ups.com
Servlet Path: /Void

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 21
Shipping Package Web Service Developer Guide November 1, 2016

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) EXPECTED RESULT

1ZISDE016691676846 A successful XML response will be returned for a shipment level void request.
1Z2220060290602143 A successful XML response will be returned for a shipment level void request.
1Z2220060294314162 A successful XML response will be returned for a package level void request. The
and Tracking Number request will void the package in the shipment.
1Z2220060291994175
1Z2220060292690189 A successful XML response will be returned for a package level void request. The
and Tracking Number request will void the package in the shipment.
1Z2220060292002190
1ZISDE016691609089 A successful XML response will be returned for a package level void request. The
with Tracking Numbers request will void all the packages
1ZISDE016694068891
and
1ZISDE016690889305
1Z2220060290530202 A successful XML response will be returned with a partial void for a package level
with Tracking Number void request. The request will void package 1Z2220060293874210 but package
1Z2220060292634221 cannot be voided.
1Z2220060293874210
and
1Z2220060292634221

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 22
Shipping Package Web Service Developer Guide November 1, 2016

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

NUMBER(S) SCENARIO EXPECTED RESULT

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

Label Recovery Integration Testing

For integration testing, direct your Label Recovery Web Service to:
https://wwwcie.ups.com/webservices/LBRecovery

Label Recovery Production URL

Once testing is complete, direct your Label Recovery Web Service to:
https://onlinetools.ups.com/webservices/LBRecovery

Server Availability Check for Label Recovery

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/webservices/LBRecovery

Server Name: LBRecovery

Remote User: null
Server Port: 443
Server Name: wwwcie.ups.com
Servlet Path: /LBRecovery

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 23
Chapter 4: Shipment API Elements and Details
Accessing the Shipping Package Web Service API
Service Operations: Shipment, ShipConfirm, ShipAccept
Type: Type: Request-Response (client sends a request to UPS, and the UPS server
replies with a response)
SOAPAction Header: https://wwwcie.ups.com/webservices/Ship

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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 24
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentRequest Top Level Containers

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 25
Shipping Package Web Service Developer Guide November 1, 2016

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 26
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentRequest XPath Tables

Note: Not all containers/elements are reflected separately in the table of contents.

Name Constraint Description Validation

/ShipmentRequest
ShipmentRequest Required: Yes Shipment Request.
Type: Container
Max Allowed: 1
Length: N/A

Request
Name Constraint Description Validation
/ShipmentRequest/Request
Request Required: Yes Request Container
Type: Container
Max Allowed: 1
Length: N/A

RequestOption

Name Constraint Description Validation

/ShipmentRequest/Request/RequestOption
RequestOption Required: Yes Optional Processing. Valid values are validate and nonvalidate.
Type: String
Max Allowed: 1 • nonvalidate = No street level address validation would be
Length: 1…15 performed, but Postal Code/State 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 Tool User to ensure the
address entered is correct to avoid an address correction fee.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 27
Shipping Package Web Service Developer Guide November 1, 2016

SubVersion

Name Constraint Description Validation

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

TransactionReference

Name Constraint Description Validation

/ShipmentRequest/Request/TransactionReference
TransactionReference Required: No TransactionReference identifies transactions between client and
Type: Container server.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Request/TransactionReference/CustomerContext
CustomerContext Required: No The client uses CustomerContext to synchronize
Type: String request/response pairs.
Max Allowed: 1
The client establishes CustomerContext, which can contain any
Length: 1…512
information client want, as long as it is valid XML; it is echoed
back by the server.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 28
Shipping Package Web Service Developer Guide November 1, 2016

Shipment
Name Constraint Description Validation
/ShipmentRequest/Shipment
Shipment Required: Yes Shipment Container
Type: Container
Max Allowed: 1
Length: N/A

Description

Name Constraint Description Validation

/ShipmentRequest/Shipment/Description
Description Required: Cond The Description of Goods for the shipment. Applies to Required if all of the listed conditions are true:
Type: String international and domestic shipments.
ShipFrom and ShipTo countries are not the same;
Max Allowed: 1
Provide a detailed description of items being shipped for
Length: 1…35 The packaging type is not UPS Letter;
documents and non-documents.
The ShipFrom and or ShipTo countries are not in the
Provide specific descriptions, such as "annual reports" and "9 mm
European Union or the ShipFrom and ShipTo countries
steel screws".
are both in the European Union and the shipments service
type is not UPS Standard.

ReturnService

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 29
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ReturnService/Code
Code Required: Yes* Return Service types:
Type: String
2 = UPS Print and Mail (PNM)
Max Allowed: 1
Length: 1…2 3 = UPS Return Service 1-Attempt (RS1)
5 = UPS Return Service 3-Attempt (RS3)
8 = UPS Electronic Return Label (ERL)
9 = UPS Print Return Label (PRL)
10 = UPS Exchange Print Return Label,
11 = UPS Pack & Collect Service 1-Attempt Box 1
12 = UPS Pack & Collect Service 1-Attempt Box 2
13 = UPS Pack & Collect Service 1-Attempt Box 3
14 = UPS Pack & Collect Service 1-Attempt Box 4
15 = UPS Pack & Collect Service 1-Attempt Box 5
16 = UPS Pack & Collect Service 3-Attempt Box 1
17 = UPS Pack & Collect Service 3-Attempt Box 2
18 = UPS Pack & Collect Service 3-Attempt Box 3
19 = UPS Pack & Collect Service 3-Attempt Box 4
20 = UPS Pack & Collect Service 3-Attempt Box 5

/ShipmentRequest/Shipment/ReturnService/Description
Description Required: No Return Service description
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 30
Shipping Package Web Service Developer Guide November 1, 2016

DocumentsOnlyIndicator

Name Constraint Description Validation

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

Shipper

Name Constraint Description Validation

/ShipmentRequest/Shipment/Shipper
Shipper Required: Yes Container tag for Shipper’s information
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Shipper/Name
Name Required: Yes Shipper's company name. For forward Shipment 35 characters
Type: String are accepted, but only 30 characters will be printed on the label.
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/Shipper/AttentionName
AttentionName Required: Cond Shipper's Attention Name. For forward Shipment 35 characters Required if destination is international. Required if Invoice
Type: String are accepted, but only 30 characters will be printed on the label. and CO International forms are requested and the
Max Allowed: 1 ShipFrom address is not present.
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 31
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Shipper/CompanyDisplayableName
CompanyDisplayableName Required: No Shipper's CompanyDisplayableName This is available for Shipper accounts enabled by UPS
Type: String and applies to Forward Shipments.
Max Allowed: 1
The CompanyDisplayableName will be displayed in
Length: 1..35
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.
/ShipmentRequest/Shipment/Shipper/TaxIdentificationNumber
TaxIdentificationNumber Required: Cond Shipper’s Tax Identification Number Conditionally required if EEI form (International forms) is
Type: String requested and ship From is not mentioned.
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/Shipper/Phone
Phone Required: Cond Container tag for Phone Number
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Shipper/Phone/Number
Number Required: Yes* Shipper’s phone Number. Valid values are 0 - 9.
Type: String
If Shipper country is US, PR, CA, and VI, the layout is
Max Allowed: 1
area code, 7 digit PhoneNumber or area code, 7 digit
Length: 1…15
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.
/ShipmentRequest/Shipment/Shipper/Phone/Extension
Extension Required: No Shipper’s phone extension.
Type: String
Max Allowed: 1
Length: 1…4

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 32
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Shipper/ShipperNumber
ShipperNumber Required: Yes Shipper’s six digit account number. Size must be six alphanumeric characters.
Type: String
Must be associated with the UserId specified in the
Max Allowed: 1
AccessRequest XML The account must be a valid UPS
Length: 6
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.
/ShipmentRequest/Shipment/Shipper/FaxNumber
FaxNumber Required: No Shipper’s Fax Number.
Type: String
Max Allowed: 1
Length: 1…14
/ShipmentRequest/Shipment/Shipper/EMailAddress
EMailAddress Required: No Shipper’s email address.
Type: String
Max Allowed: 1
Length: 1…50
/ShipmentRequest/Shipment/Shipper/Address
Address Required: Yes Address tag Container. The package should be returned to this address if the
Type: Container package is undeliverable. This address appears on the
Max Allowed: 1 upper left hand corner of the label.
Length: N/A
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 33
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Shipper/Address/AddressLine
AddressLine Required: Yes The Shipper street address including name and number (when Maximum Occurrence should be three.
Type: String applicable).
Max Allowed:3
Up to three occurrences are allowed; only the first is printed on
Length: 1…35
the label.
35 characters are accepted, but for the first occurrence, only 30
characters will be printed on the label for return shipments.
/ShipmentRequest/Shipment/Shipper/Address/City
City Required: Yes The shipper's City.
Type: String
For forward Shipment 30 characters are accepted, but only 15
Max Allowed: 1
characters will be printed on the label.
Length: 1…30
/ShipmentRequest/Shipment/Shipper/Address/StateProvinceCode
StateProvinceCode Required: Cond Shipper's state or province code. Required if shipper is in the US or CA.
Type: String
For forward Shipment 5 characters are accepted, but only 2 If Shipper country is US or CA, then the value must be a
Max Allowed: 1
characters will be printed on the label. valid US State/ Canadian Province code.
Length: 2…5
If the country is Ireland, the StateProvinceCode will
contain the county.
/ShipmentRequest/Shipment/Shipper/Address/PostalCode
PostalCode Required: Cond Shipper’s postal code. If Shipper country is US or Puerto Rico, 5 or 9 digits are
Type: String required. .
Max Allowed: 1
The character - may be used to separate the first five
Length: 1…9
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 34
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Shipper/Address/CountryCode
CountryCode Required: Yes Shipper’s country code. Refer to Origin Country Information table Must be a valid UPS Billing country code. For Forward
Type: String for valid origin countries and their UPS Billing codes. shipments it must also be an allowable UPS origin
Max Allowed: 1 country. For Return Shipment the country code must meet
Length: 2 the following conditions:
1) At least two of the following country codes are the
same: ShipTo, ShipFrom, and Shipper.
2) None of the following country codes are the same and
are a member of the EU: ShipTo, ShipFrom, and Shipper.
3) If any of the two following country codes: ShipTo/
ShipFrom/ Shipper are members in EU otherwise check if
the shipper has Third Country Contract.

ShipTo

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipTo
ShipTo Required: Yes Ship To Container
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipTo/Name
Name Required: Yes Consignee’s company name.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/ShipTo/AttentionName
AttentionName Required: Cond Contact name at the consignee’s location. Required for: UPS Next Day Air® Early service, and when
Type: String ShipTo country is different than ShipFrom country.
Max Allowed: 1 Required if Invoice International form is requested
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 35
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipTo/CompanyDisplayableName
CompanyDisplayableName Required: No Not applicable for ShipTo
Type: String
Max Allowed: 1
Length: 1..35
/ShipmentRequest/Shipment/ShipTo/TaxIdentificationNumber
TaxIdentificationNumber Required: No Consignee’s tax identification number.
Type: String
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/ShipTo/Phone
Phone Required: Cond Container for Phone Number
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipTo/Phone/Number
Number Required: Yes* Consignee’s phone Number. Required for:UPS Next Day Air® Early service, and when
Type: String Ship To country is different than the ShipFrom country.
Max Allowed: 1
If ShipTo country is US, PR, CA, and VI, the layout is area
Length: 1…15
code, 7 digit PhoneNumber or area code, 7 digit
PhoneNumber, 4 digit extension number; number.
Other countries, the layout is CountryCode, area code, 7
digit number.
/ShipmentRequest/Shipment/ShipTo/Phone/Extension
Extension Required: No Consignee’s phone extension.
Type: String
Max Allowed: 1
Length: 1…4
/ShipmentRequest/Shipment/ShipTo/FaxNumber
FaxNumber Required: No Consignee’s fax number. If ShipTo country is US 10 digits allowed, otherwise 1-15
Type: String digits allowed.
Max Allowed: 1
Length: 1…15

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 36
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipTo/EMailAddress
EMailAddress Required: No Consignee’s email address.
Type: String
Max Allowed: 1
Length: 1…50
/ShipmentRequest/Shipment/ShipTo/Address
Address Required: Yes Address Container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipTo/Address/AddressLine
AddressLine Required: Yes Address Line of the consignee. Max occurrence: 3
Type: String
Max Allowed:3
Length: 1…35
/ShipmentRequest/Shipment/ShipTo/Address/City
City Required: Yes Consignee’s city. 30 characters are accepted, but only 15
Type: String characters will be printed on the label.
Max Allowed: 1
Length: 1…30
/ShipmentRequest/Shipment/ShipTo/Address/StateProvinceCode
StateProvinceCode Required: Cond Consignee’s state or province code. Required for US or Canada. If destination is US or CA, then the value must be a valid
Type: String US State/ Canadian Province code.
Max Allowed: 1
If the country is Ireland, the StateProvinceCode will
Length: 2…5
contain the county.
/ShipmentRequest/Shipment/ShipTo/Address/PostalCode
PostalCode Required: Cond Consignee’s postal code. If the ShipTo country is US or Puerto Rico, 5 or 9 digits
Type: String are required. If the ShipTo country is CA, then the postal
Max Allowed: 1 code is required and must be 6 alphanumeric characters
Length: 1…9 whose format is A#A#A# where A is an uppercase letter
and # is a digit. Otherwise optional.
For all other countries the postal code is optional and
must be no more than 9 alphanumeric characters long.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 37
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipTo/Address/CountryCode
CountryCode Required: Yes Consignee’s country code. Must be a valid UPS Billing country code. For Return
Type: String Shipment the country code must meet the following
Max Allowed: 1 conditions:
Length: 2
1) At least two of the following country codes are the
same: ShipTo, ShipFrom, and Shipper.
2) None of the following country codes are the same and
are a member of the EU: ShipTo, ShipFrom, and Shipper.
3) If any of the two following country codes: ShipTo/
ShipFrom/ Shipper are members in EU otherwise check if
the shipper has Third Country Contract.
/ShipmentRequest/Shipment/ShipTo/Address/ResidentialAddressIndicator
ResidentialAddressIndicator Required: No This field is a flag to indicate if the receiver is a residential Empty Tag.
Type: String location. True if ResidentialAddressIndicator tag exists; false
Max Allowed: 1 otherwise
Length: 0
/ShipmentRequest/Shipment/ShipTo/LocationID
LocationID Required: No Location ID is a unique identifier referring to a specific Location ID must be alphanumeric characters. All letters
Type: String shipping/receiving location. must be capitalized.
Max Allowed: 1
Length: 3…10

AlternateDeliveryAddress

Name Constraint Description Validation

/ShipmentRequest/Shipment/AlternateDeliveryAddress
AlternateDeliveryAddress Required: Cond AlternateDeliveryAddress Container. Alternate Delivery Address (UPS Access Point Address)
Type: Container required if ShipmentIndicationType is '01' or '02'.
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 38
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/AlternateDeliveryAddress/Name
Name Required: Yes* Retail Location Name.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/AlternateDeliveryAddress/AttentionName
AttentionName Required: Yes* Attention Name.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/AlternateDeliveryAddress/UPSAccessPointID
UPSAccessPointID Required: No UPS Access Point ID.
Type: String
Max Allowed: 1
Length: 9
/ShipmentRequest/Shipment/AlternateDeliveryAddress/Address
Address Required: Yes* Address Container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/AlternateDeliveryAddress/Address/AddressLine
AddressLine Required: Yes* Address Line of the Retail Location. Max occurrence: 3
Type: String
Max Allowed:3
Length: 1…35
/ShipmentRequest/Shipment/AlternateDeliveryAddress/Address/City
City Required: Yes* Retail Location City.
Type: String
Max Allowed: 1
Length: 1…30

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 39
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/AlternateDeliveryAddress/Address/StateProvinceCode
StateProvinceCode Required: Cond Retail Location state or province code. Required for US or If destination is US or CA, then the value must be a
Type: String Canada. valid US State/Canadian Province code. If the country is
Max Allowed: 1 Ireland, the StateProvinceCode will contain the county.
Length: 2…5
/ShipmentRequest/Shipment/AlternateDeliveryAddress/Address/PostalCode
PostalCode Required: Cond If the Alternate Delivery Address country is US or Puerto Rico,
Type: String 5 or 9 digits are required.
Max Allowed: 1
The character - may be used to separate the first five digits
Length: 1…9
and the last four digits. If the Alternate Delivery Address
country is CA, then the postal code is required and must be 6
alphanumeric characters whose format is A#A#A# where A is
an uppercase letter and # is a digit. Otherwise optional.
For all other countries the postal code is optional and must be
no more than 9 alphanumeric characters long.
/ShipmentRequest/Shipment/AlternateDeliveryAddress/Address/CountryCode
CountryCode Required: Yes* Retail Location country code.
Type: String
Max Allowed: 1
Length: 2
/ShipmentRequest/Shipment/AlternateDeliveryAddress/Address/ResidentialAddressIndicator
ResidentialAddressIndicator Required: No This field is a flag to indicate if the receiver is a residential Empty Tag.
Type: String location.
Max Allowed: 1
True if ResidentialAddressIndicator tag exists; false otherwise.
Length: 0
/ShipmentRequest/Shipment/AlternateDeliveryAddress/Address/POBoxIndicator
POBoxIndicator Required: No This field is a flag to indicate if the receiver address has PO POBoxIndicator is not valid for
Type: String box indicator. AlternateDeliveryAddress.
Max Allowed: 1
True if POBoxIndicator tag exists; false otherwise.
Length: 0

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 40
Shipping Package Web Service Developer Guide November 1, 2016

ShipFrom

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipFrom
ShipFrom Required: Cond Ship From Container Required for return shipment. Required if pickup location
Type: Container is different from the shipper’s address.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipFrom/Name
Name Required: Yes* The ship from location’s name or company name. 35 characters Required if ShipFrom tag is in the XML.
Type: String are accepted, but for return Shipment only 30 characters will be
Max Allowed: 1 printed on the label.
Length: 1…35
/ShipmentRequest/Shipment/ShipFrom/AttentionName
AttentionName Required: Cond The ship from Attention name. 35 characters are accepted, but for Required if ShipFrom tag is in the XML and Invoice or CO
Type: String return Shipment only 30 characters will be printed on the label. International forms is requested. If not present, will default
Max Allowed: 1 to the Shipper Attention Name.
Length: 1…35
/ShipmentRequest/Shipment/ShipFrom/CompanyDisplayableName
CompanyDisplayableName Required: No Not applicable for ShipFrom
Type: String
Max Allowed: 1
Length: 1..35
/ShipmentRequest/Shipment/ShipFrom/TaxIdentificationNumber
TaxIdentificationNumber Required: Cond Company’s Tax Identification Number at the pick up location Conditionally required if EEI form (International forms) is
Type: String requested.
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/ShipFrom/TaxIDType
TaxIDType Required: Cond Tax Identification Container. Applies to EEI form only.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 41
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipFrom/TaxIDType/Code
Code Required: Yes* Company's tax Identification type. Valid values: EIN, DNS, and FGN. Applies to EEI form
Type: String only.
Max Allowed: 1
Length: 6
/ShipmentRequest/Shipment/ShipFrom/TaxIDType/Description
Description Required: No Description of TaxID submitted. Applies to EEI form only.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/ShipFrom/Phone
Phone Required: Cond Container for Phone Number If ShipFrom country is US, PR, CA, and VI, the layout is
Type: Container area code, 7 digit phone number or area code, 7 digit
Max Allowed: 1 phone number, 4 digit extension number.
Length: N/A
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.
/ShipmentRequest/Shipment/ShipFrom/Phone/Number
Number Required: Yes* The Ship from phone Number.
Type: String
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/ShipFrom/Phone/Extension
Extension Required: No The Ship from phone extension.
Type: String
Max Allowed: 1
Length: 1…4
/ShipmentRequest/Shipment/ShipFrom/FaxNumber
FaxNumber Required: No The Ship from fax number. If Ship from country is US 10 digits allowed, otherwise 1-
Type: String 15 digits allowed.
Max Allowed: 1
Length: 1…15

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 42
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipFrom/Address
Address Required: Yes* Ship from Address Container. The package will be originating from or being shipped
Type: Container from this address. The shipment will be rated from this
Max Allowed: 1 origin address to the destination ship to address.
Length: N/A
/ShipmentRequest/Shipment/ShipFrom/Address/AddressLine
AddressLine Required: Yes* The Ship from street address including name and number (when Max occurrence: 3
Type: String applicable).
Max Allowed:3
35 characters are accepted, but for return Shipment only 30
Length: 1…35
characters will be printed on the label.
/ShipmentRequest/Shipment/ShipFrom/Address/City
City Required: Yes* The Ship from city. Required if ShipFrom tag is in the XML.
Type: String
30 characters are accepted, but for return Shipment, only 15
Max Allowed: 1
characters will be printed on the label.
Length: 1…30
/ShipmentRequest/Shipment/ShipFrom/Address/StateProvinceCode
StateProvinceCode Required: Cond Origin location's state or province code. Required if ShipFrom tag is in the XML, and
Type: String ShipFrom/Country is US.
Max Allowed: 1
If ShipFrom country is US or CA, then the value must be a
Length: 2…5
valid US State/ Canadian Province code.
If the country is Ireland, the StateProvinceCode will
contain the county.
/ShipmentRequest/Shipment/ShipFrom/Address/PostalCode
PostalCode Required: Cond The ship from location's postal code. 9 characters are accepted. Required if ShipFrom tag is in the XML and the ShipFrom
Type: String country is the US and Puerto Rico.
Max Allowed: 1
For US and Puerto Rico, it must be valid 5 or 9 digit postal
Length: 1…9
code. The character "-" may be used to separate the first
five digits and the last four digits.
If the ShipFrom country is CA, then the postal code must
be 6 alphanumeric characters whose format is A#A#A#
where A is an uppercase letter and # is a digit.
For all other countries the postal code is optional and
must be no more than 9 alphanumeric characters long.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 43
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipFrom/Address/CountryCode
CountryCode Required: Yes* Origin location's country code. Required if ShipFrom tag is in the XML. For Return
Type: String Shipment the country code must meet the following
Max Allowed: 1 conditions:
Length: 2
1) At least two of the following country codes are the
same: ShipTo, ShipFrom, and Shipper.
2) None of the following country codes are the same and
are a member of the EU: ShipTo, ShipFrom, and Shipper.
3) If any of the two following country codes:
ShipTo/ShipFrom/ Shipper are members in EU otherwise
check if the shipper has Third Country Contract.

PaymentInformation

Name Constraint Description Validation

/ShipmentRequest/Shipment/PaymentInformation
PaymentInformation Required: Cond Payment information container for detailed shipment It is required for non-Ground Freight Pricing shipments
Type: Container charges. only.
Max Allowed: 1
The two shipment charges that are available for
Length: N/A
specification are Transportation charges and Duties
and Taxes.
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge
ShipmentCharge Required: Yes* Shipment charge container. If Duty and Tax charges are applicable to a shipment
Type: Container and a payer is not specified, the default payer of Duty
Max Allowed: 1 and Tax charges is Bill to Receiver.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 44
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/Type
Type Required: Yes* Values are 01 = Transportation, 02 = Duties and A shipment charge type of 01 = Transportation is
Type: String Taxes required.
Max Allowed: 1
A shipment charge type of 02 = Duties and Taxes is not
Length: 2
required; however, this charge type is invalid for
Qualified Domestic Shipments.
A Qualified Domestic Shipment is any shipment in which
one of the following applies:
1) The origin and destination country is the 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
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper
BillShipper Required: Cond Container for the BillShipper billing option. This element or its sibling element, BillReceiver,
Type: Container BillThirdParty or ConsigneeBilledIndicator, must be
The three payment methods that are available for the
Max Allowed: 1 present but no more than one can be present.
Bill Shipper billing option are alternate payment
Length: N/A
method, account number or credit card.
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/AccountNumber
AccountNumber Required: Cond UPS account number Must be the same UPS account number as the one
Type: String provided in Shipper/ShipperNumber.
Max Allowed: 1
Either this element or one of the sibling elements
Length: 6
CreditCard or AlternatePaymentMethod must be
provided, but all of them may not be provided.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 45
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard
CreditCard Required: Cond Credit card information container. Required if neither of the following is present:
Type: Container
/ShipmentRequest/Shipment/PaymentInformation/
Max Allowed: 1
ShipmentCharge/BillShipper/AccountNumber
Length: N/A
or
/ShipmentRequest/Shipment/PaymentInformation/
ShipmentCharge/BillShipper/AlternatePaymentMethod.
Credit card payment is valid for shipments without return
service only.
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Type
Type Required: Yes* Values are:
Type: String
01 = American Express
Max Allowed: 1
Length: 2 03 = Discover
04 = MasterCard
05 = Optima
06 = VISA
07 = Bravo
08 = Diners Club
13 = Dankort
1 4 = Hipercard
15 = JCB
17 = Postepay
18 = UnionPay/ExpressPay
19 = Visa Electron
20 = VPAY
21 = Carte Bleue

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 46
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Number
Number Required: Yes* Credit Card number.
Type: String
Max Allowed: 1
Length: 9…16
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/ExpirationDate
ExpirationDate Required: Yes* Format is MMYYYY where MM is the 2 digit month Valid month values are 01-12 and valid year values are
Type: String and YYYY is the 4 digit year. Present Year – (Present Year + 10 years)
Max Allowed: 1
Length: 6
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/SecurityCode
SecurityCode Required: Yes* Three or four digits that can be found either on top of Valid values are 3 or 4 digits. It is required to provide the
Type: String credit card number or on the back of credit card. security code if credit card information is provided and
Max Allowed: 1 when the ShipFrom countries are other than the below
Number of digits varies for different type of credit card.
Length: 3..4 mentioned countries:
Argentina, Bahamas, Costa Rica, Dominican Republic,
Guatemala, Panama, Puerto Rico and Russia.
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Address
Address Required: Cond Container to hold the Credit card Billing Address. It is required to provide billing address if credit card
Type: Container information is provided and when the ShipFrom country
Max Allowed: 1 is the US, PR, and CA.
Length: N/A
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Address/AddressLine
AddressLine Required: Yes* Address Line 1 of the credit card billing address. Max of three AddressLine can be provided.
Type: String Usually Street address information.
Max Allowed:3
Length: 1…35
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Address/City
City Required: Yes* City of the credit card billing address.
Type: String
Max Allowed: 1
Length: 1…30

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 47
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Address/StateProvinceCode
StateProvinceCode Required: Yes* State or province code of the credit card billing
Type: String address.
Max Allowed: 1
Length: 2…5
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Address/PostalCode
PostalCode Required: Yes* Credit card billing addressee postal code.
Type: String
Max Allowed: 1
Length: 1…9
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Address/CountryCode
CountryCode Required: Yes* Credit card billing address country code. Must be a valid UPS Billing country code. .
Type: String
Max Allowed: 1
Length: 2
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/AlternatePaymentMethod
AlternatePaymentMethod Required: Cond Valid values for Alternate Payment Method "01" - Paypal 01: It is valid only for forward shipments. It is not
Type: String PayPal valid for Return or Import Control shipments.
Max Allowed: 1
Either this element or one of the sibling elements
Length: 2
CreditCard or AccountNumber must be provided, but all
of them may not be provided.
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillReceiver
BillReceiver Required: Cond Container for the BillReceiver billing option. This element or its sibling element, BillShipper,
Type: Container BillThirdParty or Consignee Billed, must be present but
Max Allowed: 1 no more than one can be present. For a return shipment,
Length: N/A Bill Receiver is invalid for Transportation charges.
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillReceiver/AccountNumber
AccountNumber Required: Yes* The UPS account number. The account must be a valid UPS account number that
Type: String is active. For US, PR and CA accounts, the account must
Max Allowed: 1 be a daily pickup account, an occasional account, a
Length: 6 customer B.I.N account, or a dropper shipper account.
All other accounts must be either a daily pickup account,
an occasional account, a drop shipper account, or a
non-shipping account.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 48
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillReceiver/Address
Address Required: No Container for additional information for the bill
Type: Container receiver’s UPS accounts address.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillReceiver/Address/PostalCode
PostalCode Required: Cond The postal code for the UPS account's pickup The postal code must be the same as the UPS account
Type: String address. The pickup postal code was entered in the pickup address postal code. Required for United States
Max Allowed: 1 UPS system when the account was set-up. and Canadian UPS accounts and/or if the UPS account
Length: 1…9 pickup address has a postal code. If the UPS account's
pickup country is US or Puerto Rico, the postal code is 5
or 9 digits.
The character '-' may be used to separate the first five
digits and the last four digits.
If the UPS account's pickup country is CA, the postal
code is 6 alphanumeric characters whose format is
A#A#A# where A is an uppercase letter and # is a digit.
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillThirdParty
BillThirdParty Required: Cond Container for the third party billing option. This element or its sibling element, BillShipper,
Type: Container BillReceiver or Consignee Billed, must be present but
Max Allowed: 1 no more than one can be present.
Length: N/A
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillThirdParty/AccountNumber
AccountNumber Required: Cond The UPS account number of the third party shipper. The account must be a valid UPS account number that
Type: String is active.
Max Allowed: 1
For US, PR and CA accounts, the account must be
Length: 6
either a daily pickup account, an occasional account, or
a customer B.I.N account, or a drop shipper account.
All other accounts must be either a daily pickup account,
an occasional account, a drop shipper account, or a
non-shipping account.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 49
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillThirdParty/Address
Address Required: Yes* Container for additional information for the third party
Type: Container UPS accounts address.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillThirdParty/Address/PostalCode
PostalCode Required: Cond The postal code for the UPS account's pickup The postal code must be the same as the UPS account
Type: String address. The pickup postal code is the one that was pickup address postal code. Required for United States
Max Allowed: 1 entered in the UPS system when the account was set- and Canadian UPS accounts and/or if the UPS account
Length: 1…9 up. pickup address has a postal code.
If the UPS account's pickup country is US or Puerto
Rico, the postal code is 5 or 9 digits. The character '-'
may be used to separate the first five digits and the last
four digits.
If the UPS account's pickup country is CA, the postal
code is 6 alphanumeric characters whose format is
A#A#A# where A is an uppercase letter and # is a digit.
/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillThirdParty/Address/CountryCode
CountryCode Required: Yes* The country code for the UPS account's pickup
Type: String address.
Max Allowed: 1
Length: 2

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 50
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/ConsigneeBilledIndicator
ConsigneeBilledIndicator Required: Cond Consignee Billing payment option indicator. The Empty Tag. This element or its sibling element,
Type: String presence indicates consignee billing option is BillShipper, BillReceiver or BillThirdParty, must be
Max Allowed: 1 selected. The absence indicates one of the other present but no more than one can be present.
Length: 0 payment options is selected.
This billing option is valid for a shipment charge type of
Transportation only. Only applies to US/PR and PR/US
shipment origins and destination.
This payment method allows you to bill the charges for a
specified shipment to a consignee who has agreed to
pay the charges. All shipping charges are billed to the
consignee's UPS account number including the
following accessorials: Additional Handling, Delivery
Area Surcharges, Delivery Change Requests, Early AM
Premium, Early AM Out of Territory, Fuel Surcharge,
Hazardous Material Surcharges, Large Package
Surcharge, Over Max Limits, and Saturday Delivery.
Declared Value, Delivery Confirmation, On Call Pickup,
Remote Area Surcharge, Saturday Pickup and Verbal
Confirmation of Delivery fees are not passed to the
consignee and these charges are billed to the shippers
UPS account number.
/ShipmentRequest/Shipment/PaymentInformation/SplitDutyVATIndicator
SplitDutyVATIndicator Required: No Split Duty VAT Indicator. The presence indicates the Empty Tag. The payment method for Transportation
Type: String payer specified for Transportation Charges will pay charges must be UPS account. The UPS account must
Max Allowed: 1 transportation charges and any duties that apply to be a daily pickup account or an occasional account.
Length: 0 the shipment.
The payer specified for Duties and Taxes will pay the
VAT (Value-Added Tax) only.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 51
Shipping Package Web Service Developer Guide November 1, 2016

FRSPaymentInformation

Name Constraint Description Validation

/ShipmentRequest/Shipment/FRSPaymentInformation
FRSPaymentInformation Required: Cond Container to hold the Payment information for the Ground Freight Required for Ground Freight Pricing Shipments only.
Type: Container Pricing Shipments.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/FRSPaymentInformation/Type
Type Required: Yes* Container to hold the Ground Freight Pricing payment type It is required if the request has Ground Freight Pricing
Type: String information. shipment indicator.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/FRSPaymentInformation/Type/Code
Code Required: Yes* Valid codes:
Type: String
Max Allowed: 1 • 01=Prepaid
Length: 2 • 02=FreightCollect
• 03=PrepaidThirdParty
/ShipmentRequest/Shipment/FRSPaymentInformation/Type/Description
Description Required: No Specifies the description for Ground Freight Pricing payment type.
Type: String
Max Allowed: 1
Length: 1...50
/ShipmentRequest/Shipment/FRSPaymentInformation/AccountNumber
AccountNumber Required: Yes* The UPS account number. If the Ground Freight Pricing indicator is present in the
Type: String request, this account number must be validated to check if
Max Allowed: 1 it is Ground Freight Pricing enabled.
Length: 6
/ShipmentRequest/Shipment/FRSPaymentInformation/Address
Address Required: Cond Container to hold the information for the FreightCollect and Note: The Address is required only when the billing option
Type: Container PrepaidThirdParty Address. is Freight collect or ThirdParty.
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 52
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/FRSPaymentInformation/Address/PostalCode
PostalCode Required: Cond The postal code for the Ground Freight Pricing payment
Type: String information address.
Max Allowed: 1
Length: 1…9
/ShipmentRequest/Shipment/FRSPaymentInformation/Address/CountryCode
CountryCode Required: Yes* The country code for the Ground Freight Pricing payment
Type: String information address.
Max Allowed: 1
Length: 2

FreightShipmentInformation

NAME Constraint Description Validation

/ShipmentRequest/Shipment/FreightShipmentInformation
FreightShipmentInformation Required: No Container to hold Freight Shipment information.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo
FreightDensityInfo Required: Cond Freight Density Info container. Required if DensityEligibleIndicator is present.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/AdjustedHeightIndicator
AdjustedHeightIndicator Required: No The presence of the AdjustedHeightIndicator
Type: String indicates that allow the height reduction adjustment
Max Allowed: 1 for density based rate request.
Length: 0
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/AdjustedHeight
AdjustedHeight Required: Cond Container for the adjusted height Required if AdjustedHeightIndicator is present.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 53
Shipping Package Web Service Developer Guide November 1, 2016

NAME Constraint Description Validation

/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/AdjustedHeight/Value
Value Required: Yes* Adjusted height value
Type: String
Max Allowed: 1
Length: 1…19
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/AdjustedHeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container for UnitOfMeasurement for the adjusted
Type: Container height
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/AdjustedHeight/UnitOfMeasurement/Code
Code Required: Yes* Code associated with Unit of Measurement for the Unit of measurement code for Adjusted height is
Type: String Adjusted height. validated only when Handling unit type is SKD =
Max Allowed: 1 Skid or PLT = Pallet.
Valid value: IN
Length: 2
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/AdjustedHeight/UnitOfMeasurement/Description
Description Required: No Description for UnitOfMeasurement for the adjusted
Type: String height
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits
HandlingUnits Required: Cond Handling Unit for Density based rating container.
Type: Container
Max Allowed: 50
Length: N/A
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Quantity
Quantity Required: Yes* Handling Unit Quantity for Density based rating.
Type: String
Max Allowed: 1
Length: 8

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 54
Shipping Package Web Service Developer Guide November 1, 2016

NAME Constraint Description Validation

/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Type
Type Required: Yes* Handling Unit Type for Density based rating. Valid values:
Type: Container SKD = Skid
Max Allowed: 1 CBY = Carboy
Length: N/A PLT = Pallet
TOT = Totes
LOO = Loose
OTH = Other
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Type/Code
Code Required: Yes* The code associated with Handling Unit Type.
Type: String
Max Allowed: 1
Length: 3
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Type/Description
Description Required: No A description of the code for the Handling Unit type.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions
Dimensions Required: Yes* Dimension of the HandlingUnit container for density
Type: Container based pricing.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions/UnitOfMeasurement
UnitOfMeasurement Required: Yes* UnitOfMeasurement container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions/UnitOfMeasurement/Code
Code Required: Yes* Code for UnitOfMeasurement for the line item
Type: String dimension.
Max Allowed: 1
Valid value: IN = Inches
Length: 2

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 55
Shipping Package Web Service Developer Guide November 1, 2016

NAME Constraint Description Validation

/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions/UnitOfMeasurement/Description
Description Required: No Description for UnitOfMeasurement for the line item
Type: String dimension.
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions/Length
Length Required: Yes* The length of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions/Width
Width Required: Yes* The width of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipmentRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions/Height
Height Required: Yes* The height of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipmentRequest/Shipment/FreightShipmentInformation/DensityEligibleIndicator
DensityEligibleIndicator Required: No The presence of the tag indicates that the rate
Type: String request is density based.
Max Allowed: 1
For Density Based Rating (DBR), the customer must
Length: 0
have DBR Contract Service.

GoodsNotInFreeCirculationIndicator

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 56
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentRatingOptions

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentRatingOptions
ShipmentRatingOptions Required: No ShipmentRatingOptions container.
Type: Container
Max Allowed: 1
Length: N/A

/ShipmentRequest/Shipment/ShipmentRatingOptions/NegotiatedRatesIndicator
NegotiatedRatesIndicator Required: No Negotiated Rates option indicator. If the indicator is Negotiated Rates are of two types Account Based Rates (ABR) and
Type: String present and the Shipper is authorized then Web Discount Rates. Negotiated Rates are only returned for qualified
Max Allowed: 1 Negotiated Rates should be returned in the Shipper Account Numbers.
Length: 0 response.
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.
/ShipmentRequest/Shipment/ShipmentRatingOptions/FRSShipmentIndicator
FRSShipmentIndicator Required: No Ground Freight Pricing Rates option indicator. If the The Shipper account number must be qualified to receive Ground
Type: String Ground Freight Pricing Shipment indicator is enabled Freight Pricing Shipment rates. Only the Shipper account number
Max Allowed: 1 and Shipper number is authorized then Ground taken from
Length: 0 Freight Pricing rates should be returned in the /ShipmentRequest/Shipment/FRSPaymentInformation/AccountNumber
response. is used when checking qualification for Ground Freight Pricing rates.
/ShipmentRequest/Shipment/ShipmentRatingOptions/RateChartIndicator
RateChartIndicator Required: No RateChartIndicator, if present in request, response
Type: String will contain RateChart element.
Max Allowed: 1
Length: 0

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 57
Shipping Package Web Service Developer Guide November 1, 2016

MovementReferenceNumber

Name Constraint Description Validation

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

ReferenceNumber

Name Constraint Description Validation

/ShipmentRequest/Shipment/ReferenceNumber
ReferenceNumber Required: No Reference Number information container. For Mail Innovation shipments, reference number is not
Type: Container supported.
Max Allowed: 2
Length: N/A
/ShipmentRequest/Shipment/ReferenceNumber/BarCodeIndicator
BarCodeIndicator Required: No If the indicator is present then the reference number’s value will Empty Tag. Only one shipment-level or package-level
Type: String be bar coded on the label. reference number can be bar coded per shipment. In order
Max Allowed: 1 to barcode a reference number, its value must be no
Length: 0 longer than 14 alphanumeric characters or 24 numeric
characters and cannot contain spaces.
/ShipmentRequest/Shipment/ReferenceNumber/Code
Code Required: No Shipment Reference number type code. The code specifies the Valid if the origin/destination pair is not US/US or PR/PR
Type: String Reference name. and character should be alpha-numeric.
Max Allowed: 1
Refer to Reference Number Codes in the Appendix for valid
Length: 2
values.
/ShipmentRequest/Shipment/ReferenceNumber/Value
Value Required: Yes* Customer supplied reference number. Valid if the origin/destination pair is not US/US or PR/PR
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 58
Shipping Package Web Service Developer Guide November 1, 2016

Service

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 59
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Service/Code
Code Required: Yes Values: The following Services are not available to return
Type: String shipment:
01 = Next Day Air
Max Allowed: 1
13= Next Day Air Saver
Length: 2 02 = 2nd Day Air
59= 2nd Day Air A.M.
03 = Ground
82 = UPS Today Standard
07 = Express
83 = UPS Today Dedicated Courier
08 = Expedited
84 = UPS Today Intercity
11 = UPS Standard
85 = UPS Today Express
12 = 3 Day Select
86 = UPS Today Express Saver
13 = Next Day Air Saver
14 = UPS Next Day Air Early
54 = Express Plus
59 = 2nd Day Air A.M.
65 = UPS Saver
M2 = First Class Mail
M3 = Priority Mail
M4 = Expedited MaiI Innovations
M5 = Priority Mail Innovations
M6 = Economy Mail Innovations
70 = UPS Access Point Economy
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.
Note: Only service code 03 is used for Ground Freight Pricing
shipments

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 60
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Service/Description
Description Required: No Description of the service code. Examples are Next Day Air,
Type: String Worldwide Express, and Ground.
Max Allowed: 1
Length: 1…35

InvoiceLineTotal

Name Constraint Description Validation

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

NumOfPiecesInShipment

Name Constraint Description Validation

/ShipmentRequest/Shipment/NumOfPiecesInShipment
NumOfPiecesInShipment Required: Cond Total number of pieces in all pallets in a UPS Worldwide Express It is required for UPS Worldwide Express Freight Shipment.
Type: String Freight Shipment. Valid values are 1 to 99999.
Max Allowed: 1
Length: 1…5

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 61
Shipping Package Web Service Developer Guide November 1, 2016

USPSEndorsement

Name Constraint Description Validation

/ShipmentRequest/Shipment/USPSEndorsement
USPSEndorsement Required: Cond USPS Endorsement valid values: Required for Mail Innovations forward shipments.
Type: String
1 = Return Service Requested,
Max Allowed: 1
Length: 1 2 = Forwarding Service Requested,
3 = Address Service Requested,
4 = Change Service Requested and
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

Name Constraint Description Validation

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

SubClassification

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 62
Shipping Package Web Service Developer Guide November 1, 2016

CostCenter

Name Constraint Description Validation

/ShipmentRequest/Shipment/CostCenter
CostCenter Required: Cond Customer assigned identifier for report and billing summarization Required only for Mail Innovations forward shipments.
Type: String displays to the right of the Cost Center title. Alpha numeric values only.
Max Allowed: 1
Length: 1…30

PackageID

Name Constraint Description Validation

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

IrregularIndicator

Name Constraint Description Validation

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

ShipmentIndicationType

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentIndicationType
ShipmentIndicationType Required: Cond Container for Shipment Indication Type. Required to indicate whether shipment is "Hold For Pickup
Type: Container At UPS Access Point" shipment or "UPS Access Point™
Max Allowed: 1 Delivery" shipment.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 63
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentIndicationType/Code
Code Required: Yes* Valid values:
Type: String
Max Allowed: 1 • 01 - Hold for Pickup at UPS Access Point
Length: 2 • 02 - UPS Access Point™ Delivery

/ShipmentRequest/Shipment/ShipmentIndicationType/Description
Description Required: No Description for the code.
Type: String
Max Allowed: 1
Length: 1…50

RatingMethodRequestedIndicator

Name Constraint Description Validation

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

TaxInformationIndicator

Name Constraint Description Validation

/ShipmentRequest/Shipment/TaxInformationIndicator
TaxInformationIndicator Required: No Presence/Absence Indicator. Any value inside is ignored.
Type: String TaxInformationIndicator is an indicator.
Max Allowed: 1
If present, any taxes that may be applicable to a shipment would
Length: 0
be returned in response. If this indicator is requested with
NegotiatedRatesIndicator, Tax related information, if applicable,
would be returned only for Negotiated Rates and not for
Published Rates.
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 64
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentServiceOptions

Name Constraint Description Validation

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

SaturdayDeliveryIndicator

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/SaturdayDeliveryIndicator
SaturdayDeliveryIndicator Required: No Saturday delivery indicator. The presence indicates Saturday Empty Tag.
Type: String delivery is requested and the absence indicates Saturday
Max Allowed: 1 delivery is not requested.
Length: 0

COD

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/COD
COD Required: No COD container Indicates COD is requested. Shipment COD is only
Type: Container available for EU origin countries and for shipper's
Max Allowed: 1 account type Daily Pickup and Drop Shipping.
Length: N/A
Not available to shipment with return service.
/ShipmentRequest/Shipment/ShipmentServiceOptions/COD/CODFundsCode
CODFundsCode Required: Yes* For valid values, refer to COD Supported Countries in the
Type: String Appendix.
Max Allowed: 1
Length: 1
/ShipmentRequest/Shipment/ShipmentServiceOptions/COD/CODAmount
CODAmount Required: Yes* COD Amount Container.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 65
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/COD/CODAmount/CurrencyCode
CurrencyCode Required: Yes* COD amount currency code type.
Type: String
Max Allowed: 1
Length: 3
/ShipmentRequest/Shipment/ShipmentServiceOptions/COD/CODAmount/MonetaryValue
MonetaryValue Required: Yes* COD Amount monetary value.
Type: String
Max Allowed: 1
Length: 1…8

AccessPointCOD

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 66
Shipping Package Web Service Developer Guide November 1, 2016
DeliverToAddresseeOnlyIndicator

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/DeliverToAddresseeOnlyIndicator
DeliverToAddresseeOnlyIndicator Required: No Presence/Absence Indicator. Any value inside is ignored. Only valid for Shipment Indication type "01 - Hold For
Type: String DeliverToAddresseeOnlyIndicator is shipper specified PickUp at UPS Access Point".
Max Allowed: 1 restriction that requires the addressee to be the one who
Length: 0 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

Name Constraint Description Validation

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

Notification

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification
Notification Required: No Container for the Quantum View Notification (QVN) is valid
Type: Container for all shipments including Return service, Import Control and
Max Allowed: 1 Returns Flexible Access. Valid return service types are: ERL,
Length: N/A PRL, PNM, RS1, or RS3.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 67
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/NotificationCode
NotificationCode Required: Yes* The type of notification requested. Valid Values: Note: QVN Exception notification and return notification
Type: String are not applicable to GFP.
5 - QV In-transit Notification
Max Allowed: 1
QV In-transit and Return Notifications are only valid for
Length: 1 6 - QV Ship Notification
ImportControl and Return shipment.
7 - QV Exception Notification
QV In-transit Notification is allowed for return
8 - QV Delivery Notification shipments only.
2 - Return Notification or Label Creation Notification QV Ship Notification is allowed for forward moving
012 - Alternate Delivery Location Notification shipments only.

013 - UAP Shipper Notification

/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/EMail
EMail Required: Yes* Container for Email Information.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/EMail/EMailAddress
EMailAddress Required: Yes* Email address where the notification is sent. Up to five email addresses are allowed for each type of
Type: String Quantum View TM shipment notification. Up to two
Max Allowed:2...5 email address for return notification.
Length: 1…50
/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/EMail/UndeliverableEMailAddress
UndeliverableEMailAddress Required: No The address where an undeliverable eMail message is sent There can be only one UndeliverableEMailAddress for
Type: String if the eMail with the notification is undeliverable. each type of Quantum View Shipment Notifications.
Max Allowed: 1
Length: 1…50
/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/EMail/FromEMailAddress
FromEMailAddress Required: Cond The e-mail address specifies the Reply To E-mail address. Valid for Return Notification only.
Type: String The "From" field of the message header contains
Max Allowed: 1 pkginfo@ups.com.
Length: 1…50

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 68
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/EMail/FromName
FromName Required: No The name the email will appear to be from. Defaults to the The FromName must occur only once for each type of
Type: String Shipper Name. Quantum View Shipment Notifications.
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/EMail/Memo
Memo Required: No User defined text that will be included in the eMail. The Memo must occur only once for each type of
Type: String Quantum View Shipment Notifications.
Max Allowed: 1
Length: 1…150
/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/EMail/Subject
Subject Required: No The eMail's subject. Defaults to text provided by UPS Return Notification only.
Type: String
Max Allowed: 1
Length: 1…75
/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/EMail/SubjectCode
SubjectCode Required: No Specifies a reference code and reference number to display For return notification:
Type: String in the subject of the Notification. The valid subject codes are:
If the subject code tag is not provided and the subject
Max Allowed: 1
01 - Shipment Reference Number 1 text is provided, the subject of the notification will be
Length: 2
the subject text.
02 - Shipment Reference Number 2
If the subject text is provided and the subject code tag
03 - package Reference Number 1
exists, then the subject code value must be 08. If
04 - package Reference Number 2 Subject code is 08, subject text must exist.
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.
/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/VoiceMessage
VoiceMessage Required: No VoiceMessage container is used for specifying phone Valid only for Alternate Delivery Location notification
Type: Container number for receiving voice Alternate Delivery Location and UAP Shipper notification. VoiceMessage phone
Max Allowed: 1 notification and UAP Shipper notification. number or TextMessage phone number or email
Length: N/A address is required for ADL notification and UAP
Shipper notification.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 69
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/VoiceMessage/PhoneNumber
PhoneNumber Required: Yes* Phone number for receiving Voice Alternate Delivery
Type: String Location notification and UAP Shipper notification.
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/TextMessage
TextMessage Required: No TextMessage container is used for specifying phone number Valid only for Alternate Delivery Location notification
Type: Container for receiving text Alternate Delivery Location notification and and UAP Shipper notification. VoiceMessage phone
Max Allowed: 1 UAP Shipper notification. number or TextMessage phone number or email
Length: N/A address is required for ADL notification and UAP
Shipper notification.
/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/TextMessage/PhoneNumber
PhoneNumber Required: Yes* Phone number for receiving Text Alternate Delivery Location
Type: String notification and UAP Shipper notification.
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/Locale
Locale Required: Cond This container is used for providing Language and dialect Valid only for Alternate Delivery Location notification
Type: Container details for Alternate Delivery Location notifications and UAP and UAP Shipper notification.
Max Allowed: 1 Shipper notifications.
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/Locale/Language
Language Required: Yes* Refer to Language / Dialect Combinations in the Appendix
Type: String for valid pairs.
Max Allowed: 1
Length: 3
/ShipmentRequest/Shipment/ShipmentServiceOptions/Notification/Locale/Dialect
Dialect Required: Yes* Refer to Language / Dialect Combinations in the Appendix
Type: String for valid pairs.
Max Allowed: 1
Length: 2

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 70
Shipping Package Web Service Developer Guide November 1, 2016
LabelDelivery

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/LabelDelivery
LabelDelivery Required: Cond Container for the Label Delivery accessorial. Note: Currently Valid for shipments with an Electronic Return Label
Type: Container Label delivery accessorial is not applicable to GFP. Return Service.
Max Allowed: 1
Required for shipments with either Electronic Return Label
Length: N/A
Return Service or ImportControl Electronic LabelMethod
type.
If this container is present, either of the LabelLinksIndicator
or Email container should be provided.
/ShipmentRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail
EMail Required: No Container for the email message.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/EMailAddress
EMailAddress Required: Yes* The destination eMail address for the Label Delivery.
Type: String
Max Allowed: 1
Length: 1…50
/ShipmentRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/UndeliverableEMailAddress
UndeliverableEMailAddress Required: No The address where an undeliverable email message is sent Defaults to FromEMailAddress.
Type: String if the Label Delivery email is undeliverable.
Max Allowed: 1
Length: 1…50
/ShipmentRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/FromEMailAddress
FromEMailAddress Required: Yes* The e-mail address specifies the Reply To E-mail address.
Type: String The "From" field of the message header contains
Max Allowed: 1 pkginfo@ups.com.
Length: 1…50

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 71
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/FromName
FromName Required: No The "FrontName" is the name from which notification will
Type: String appear. Defaults to the "Shipper Name".
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/Memo
Memo Required: No User defined text that will be included in the email.
Type: String
Max Allowed: 1
Length: 1…150
/ShipmentRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/Subject
Subject Required: No The eMail's subject. Defaults to the Label Delivery
Type: String Notification plus the shipment ID. Defaults to text provided
Max Allowed: 1 by UPS.
Length: 1…75
/ShipmentRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/SubjectCode
SubjectCode Required: No Specifies a reference code and reference number to display If the subject code tag is not provided and the subject
Type: String in the subject of the Label Delivery notification. When the text is provided, the subject of the notification will be
Max Allowed: 1 subject code is provided, the subject will contain the the subject text.
Length: 2 following: UPS Label Delivery, the reference code (the
If the subject text is provided, and the subject code tag
reference code will be mapped to the corresponding ANSI
exists, then the subject code value must be 08.
value) and the reference number.
If Subject code is 08, subject text must exist. If a
subject code is provided that refers to a nonexistent
reference number, the subject will default to the
shipment identification number.
/ShipmentRequest/Shipment/ShipmentServiceOptions/LabelDelivery/LabelLinksIndicator
LabelLinksIndicator Required: No Indicates the Label and Receipt URL's are to be returned in
Type: String the XML response. Applicable for ImportControl Electronic
Max Allowed: 1 Labels or for ReturnService Electronic Labels.
Length: 0

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 72
Shipping Package Web Service Developer Guide November 1, 2016
InternationalForms

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms
InternationalForms Required: No International Forms information.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/FormType
FormType Required: Yes* Indicates the name of the International Form Valid values:
Type: String requested.
Max Allowed:6 • 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
• 10 - UPS Premium Care Form
• 11 - EEI
For shipment with return service 01, 05 or 10
are the only valid values
Note: 01 and 05 are mutually exclusive and
05 is only valid for return shipments only.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/UserCreatedForm
UserCreatedForm Required: Cond Data container for DocumentID(s). Required if Form Type is 07.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 73
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/UserCreatedForm/DocumentID
DocumentID Required: Yes* DocumentID represents a document uploaded
Type: String to Forms History.
Max Allowed: 13
Length: 26
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm
UPSPremiumCareForm Required: Cond UPS Premium Care Form is required if UPS Valid only for Canda to Canada movements.
Type: Container Premium Care Indicator is present on a
Max Allowed: 1 package.
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/ShipmentDate
ShipmentDate Required: Yes* Shipment Date associated with UPS Premium Valid Format:yyyyMMdd
Type: String Care Shipment.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/PageSize
PageSize Required: Yes* Size of UPS Premium Care Form. Valid values:
Type: String
01 = A4 Size
Max Allowed: 1
Length: 2 02 = Letter Size
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/PrintType
PrintType Required: Yes* Format of UPS Premium Care Form. Valid values:
Type: String
01 = PNG
Max Allowed: 1
Length: 2 02 = PDF
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/NumOfCopies
NumOfCopies Required: Yes* Number of Copies of UPS Premium Care Form. Valid value is 02.
Type: String
Max Allowed: 1
Length: 2

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 74
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/LanguageForUPSPremiumCare
LanguageForUPSPremiumCare Required: Yes* Container to hold languages in which UPS
Type: Container Premium Care Form is required.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/LanguageForUPSPremiumCare/Language
Language Required: Yes* Languages for UPS Premium Care Form. Two Valid values:
Type: String languages are required for UPS Premium Care
eng = US English
Max Allowed:2 Form.
Length: 3 fra = Canadian French
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form
CN22Form Required: Cond Container for the CN22 form. Required if the customer wants to use the
Type: Container UPS generated CN22.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/LabelSize
LabelSize Required: Yes* Valid values: Required if the CN22 form container is
Type: String present.
6 = 4X6
Max Allowed: 1
Length: 2 1 = 8.5X11
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/PrintsPerPage
PrintsPerPage Required: Yes* Number of label per page. Currently 1 per page Required if the CN22 form container is
Type: String is supported. present.
Max Allowed: 1
Length: 1
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/LabelPrintType
LabelPrintType Required: Yes* Valid values: pdf, png, gif, zpl, star, epl2 and Required if the CN22 form container is
Type: String spl. present.
Max Allowed: 1
Length: 1...4

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 75
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Type
CN22Type Required: Yes* Valid values: Required if the CN22 form container is
Type: String present.
Max Allowed: 1 • 1 = GIFT
Length: 1 • 2 = DOCUMENTS
• 3 = COMMERCIAL SAMPLE
• 4 = OTHER
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22OtherDescription
CN22OtherDescription Required: Cond Required if CN22Type is OTHER. Required if the CN22 form container is
Type: String present.
Max Allowed: 1
Length: 20
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/FoldHereText
FoldHereText Required: No String will replace default "Fold Here" text
Type: String displayed on the label.
Max Allowed: 1
Length: 35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content
CN22Content Required: Yes* Container for CN22 content. Required if the CN22 form container is
Type: Container present.
Max Allowed: 3
Note: The maximum number of goods printed
Length: N/A
on the CN22 form when a combined MI
package and CN22 form label is requested is
one.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentQuantity
CN22ContentQuantity Required: Yes* Total number of items associated with this Required if the CN22 form container is
Type: String content. present.
Max Allowed: 1
Length:

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 76
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentDescription
CN22ContentDescription Required: Yes* Detailed description of the content. Required if the CN22 form container is
Type: String present.
Max Allowed: 1
Length: 105
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentWeight
CN22ContentWeight Required: Yes* Container for CN22 content weight.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container for UOM.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentWeight/UnitOfMeasurement/Code
Code Required: Yes* Required if weight is provided, valid values are Required if weight is provided.
Type: String lbs and ozs.
Max Allowed: 1
Length: 3
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentWeight/UnitOfMeasurement/Description
Description Required: No Short description for UnitOfMeasurement.
Type: String
Max Allowed: 1
Length: 1…50
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentWeight/Weight
Weight Required: Yes* Total weight of the content. Pounds and Ounces Required if the CN22 form container is
Type: String are allowed up to 2 decimals. present.
Max Allowed: 1
Length: 7

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 77
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentTotalValue
CN22ContentTotalValue Required: Yes* Total value of the items associated with this Required if the CN22 form container is
Type: String content. present.
Max Allowed: 1
Length: 9
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentCurrencyCode
CN22ContentCurrencyCode Required: Yes* Currently only USD is supported. Required if the CN22 form container is
Type: String present.
Max Allowed: 1
Length: 3
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentCountryOfOrigin
CN22ContentCountryOfOrigin Required: No Country of Origin from where the CN22
Type: String contents originated.
Max Allowed: 1
Length: 2
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentTariffNumber
CN22ContentTariffNumber Required: No The tariff number associated with the CN22
Type: String contents.
Max Allowed: 1
Length: 40
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/AdditionalDocumentIndicator
AdditionalDocumentIndicator Required: No Presence of the indicator means user will This indicator should be set when the shipper
Type: String supply additional document, such as EEI, intends to utilize UPS paperless invoice
Max Allowed: 1 NAFTA_CO or CO. functionality AND the shipper has SELF-
Length: 0 PREPARED other International Forms
(EEI,CO, NAFTACO) to accompany the
shipment. It is evaluated only when:
1. Account is paperless enabled.
2. Movement requires an invoice.
3. Destination country accepts paperless
invoice.
4. Invoice data is supplied by the client and
the data passes validation.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 78
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/FormGroupIdName
FormGroupIdName Required: No Contains description text which identifies the
Type: String group of International forms. This element does
Max Allowed: 1 not appear on the forms.
Length: 1…50
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption
EEIFilingOption Required: Cond EEI Filing option. Applicable for EEI form and is required.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/Code
Code Required: Yes* Required for EEI Form. Applicable for EEI form. Valid values:
Type: String 1 - Shipper filed
Max Allowed: 1 3- UPS filed
Length: 1
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/EMailAddress
EMailAddress Required: Cond Email Address where the notification is sent. Applicable for EEI form.
Type: String
Valid for:
Max Allowed: 1
Length: 1…50 UPS filed (option 3)
Shipper filed (option 1- A 1-C)
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/Description
Description Required: No Optional Description of Filing Code. Applicable for EEI form.
Type: String
Max Allowed: 1
Length: 1…20
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/UPSFiled
UPSFiled Required: No Indicates the EEI UPS Filed option. (option 3) Applicable for EEI form.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 79
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 80
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/ShipperFiled/PreDepartureITNNumber
PreDepartureITNNumber Required: Cond Input for Shipper Filed option 'A'. The format is Valid and Required for Shipper Filed option
Type: String available from AESDirect website. 'A'. EEI form only.
Max Allowed: 1
Length: 17
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/ShipperFiled/ExemptionLegend
ExemptionLegend Required: Cond Input for Shipper Filed option 'B'. Valid and Required for Shipper Filed option
Type: String 'B'. EEI form only.
Max Allowed: 1 30.2(d)(2) 30.26(a) 30.36
Length: 20
30.37(a) 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)

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 81
Shipping Package Web Service Developer Guide November 1, 2016
InternationalForms continued, Contacts

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts
Contacts Required: Cond Holds the contact information of various parties. Applicable for EEI and NAFTA CO only.
Type: Container Required for NAFTA CO and EEI. Ultimate
Max Allowed: 1 consignee contact information is required for
Length: N/A EEI. Producer contact information is required
for NAFTA CO
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent
ForwardAgent Required: No The forwarding agent is the company or person Applicable for EEI form only.
Type: Container acting as agent in the trans-shipping of freight to the
Max Allowed: 1 destination country.
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/CompanyName
CompanyName Required: Yes* Company Name or the Individual name of the Applicable for EEI form only.
Type: String Forwarding agent.
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/TaxIdentificationNumber
TaxIdentificationNumber Required: Yes* Tax ID of the Forwarding agent. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address
Address Required: Yes* Address information of the Forwarding agent. Applicable for EEI form only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address/AddressLine
AddressLine Required: Yes* Address line of the Forwarding agent. Applicable for EEI form only. Max Occurrence
Type: String must be 3.
Max Allowed:3
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 82
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address/City
City Required: Yes* City of the Forwarding agent. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…30
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address/StateProvinceCode
StateProvinceCode Required: Cond State of the Forwarding agent. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…5
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address/Town
Town Required: No Town of the Forwarding Agent. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…30
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address/PostalCode
PostalCode Required: Cond Postal code of the Forwarding agent. Applicable for EEI form only. Required for
Type: String certain countries. The length of the postal code
Max Allowed: 1 depends on the country code
Length: 1…9
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address/CountryCode
CountryCode Required: Yes* Country code of the Forwarding agent. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 2
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee
UltimateConsignee Required: Cond The ultimate consignee is the person or company Applicable for EEI form only.
Type: Container who receives the goods for end-use or the person
Max Allowed: 1 or company listed on the export license. This is the
Length: N/A end-user of the goods.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 83
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/CompanyName
CompanyName Required: Yes* Company Name or the Individual name of the Applicable for EEI form only.
Type: String Ultimate consignee.
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address
Address Required: Yes* Address information of the Ultimate consignee. Applicable for EEI form only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address/AddressLine
AddressLine Required: Yes* Address line of the Ultimate consignee. Applicable for EEI form only. Max Occurrence
Type: String must be 3.
Max Allowed:3
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address/City
City Required: Yes* City of the Ultimate consignee. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…30
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address/StateProvinceCode
StateProvinceCode Required: Cond State of the Ultimate consignee. Applicable for EEI form only. Required for
Type: String certain countries. The length of the postal code
Max Allowed: 1 depends on the country code
Length: 1…5
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address/Town
Town Required: No Town of the Ultimate consignee. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…30

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 84
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address/PostalCode
PostalCode Required: Cond Postal code of the Ultimate consignee. Applicable for EEI form only. Required for
Type: String certain countries.The length of the postal code
Max Allowed: 1 depends on the country code.
Length: 1…9
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address/CountryCode
CountryCode Required: Yes* Country code of the Ultimate consignee. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 2
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/UltimateConsigneeType
UltimateConsigneeType Required: No Container for providing ultimateConsignee Type. Applicable for EEI form only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/UltimateConsigneeType/Code
Code Required: Yes* Ultimate Consignee Type Code. Values are: 'D' = Applicable for EEI form only.
Type: String Direct Consumer; 'G'=Government Entity ; 'R'=
Max Allowed: 1 Reseller ; 'O'=Other/Unknown.
Length: 1
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/UltimateConsigneeType/Description
Description Required: No Ultimate Consignee Type Description. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…20
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee
IntermediateConsignee Required: No The intermediate consignee is the person or Applicable for EEI form only.
Type: Container company in the importing country that makes final
Max Allowed: 1 delivery to the ultimate consignee.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 85
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/CompanyName
CompanyName Required: Yes* Company Name or the Individual name of the Applicable for EEI form only.
Type: String Intermediate consignee.
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/Address
Address Required: Yes* Address information of the Intermediate Consignee. Applicable for EEI form only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/Address/AddressLine
AddressLine Required: Yes* Address line of the Intermediate Consignee. Applicable for EEI form only. Max Occurrence
Type: String must be 3.
Max Allowed:3
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/Address/City
City Required: Yes* City of the Intermediate Consignee. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…30
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/Address/StateProvinceCode
StateProvinceCode Required: Cond State of the Intermediate Consignee. Applicable for EEI form only. Required for
Type: String certain countries.
Max Allowed: 1
Length: 1…5
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/Address/Town
Town Required: No Town of the Intermediate consignee. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…5

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 86
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/Address/PostalCode
PostalCode Required: Cond Postal code of the Intermediate Consignee. Applicable for EEI form only. Required for
Type: String certain countries. The length of the postal code
Max Allowed: 1 depends on the country code.
Length: 1…9
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/Address/CountryCode
CountryCode Required: Yes* Country code of the Intermediate Consignee. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 2
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer
Producer Required: Cond Information of the producer. The NAFTA Certificate Applies to NAFTA CO. Required for NAFTA CO
Type: Container of Origin must be completed, signed, and dated by forms.
Max Allowed: 1 the exporter.
Length: N/A
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.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Option
Option Required: No The text associated with the code will be printed in Applies to NAFTA CO.
Type: String the producer section instead of producer contact
Possible Values are:
Max Allowed: 1 information.
Length: 2 01 - AVAILABLE TO CUSTOMS UPON
Use attached List if more than one producer’s good
REQUEST
is included on the Certificate, attach a list of
additional producers, including the legal name, 02 - SAME AS EXPORTER
address (including country), and legal tax 03 - ATTACHED LIST
identification number, cross-referenced to the goods
described in the Description of Goods field. 04 - UNKNOWN

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/CompanyName
CompanyName Required: Cond Company Name or the Individual name of the Applies to NAFTA CO. Only applicable when
Type: String Producer. producer option is empty or not present.
Max Allowed: 1 Conditionally required for: NAFTA CO, when
Length: 1…35 Producer option is not specified.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 87
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/TaxIdentificationNumber
TaxIdentificationNumber Required: No Tax ID of the Producer. Applies to NAFTA CO. Only applicable when
Type: String producer option is empty or not present
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address
Address Required: Cond Address information of the Producer. Applies to NAFTA CO. Only applicable if
Type: Container producer option is empty or not present.
Max Allowed: 1 Conditionally required for: NAFTA CO, when
Length: N/A Producer option is not specified.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/AddressLine
AddressLine Required: Yes* Address line of the Producer. Max Occurrence must be 3.
Type: String
Max Allowed:3
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/City
City Required: Yes* City of the Producer. Applies to NAFTA CO. Conditionally required
Type: String for: NAFTA CO, when Producer option is not
Max Allowed: 1 specified.
Length: 1…30
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/StateProvinceCode
StateProvinceCode Required: Cond State of the Producer. Applies to NAFTA CO. Required for certain
Type: String countries.
Max Allowed: 1
Length: 1…5
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/Town
Town Required: No Town of the Producer.
Type: String
Max Allowed: 1
Length: 1…30

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 88
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/PostalCode
PostalCode Required: Cond Postal code of the Producer. Applies to NAFTA CO. Required for certain
Type: String countries. The length of the postal code
Max Allowed: 1 depends on the country code.
Length: 1…9
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/CountryCode
CountryCode Required: Yes* Country code of the Producer. Applies to NAFTA CO.
Type: String
Max Allowed: 1
Length: 2
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/AttentionName
AttentionName Required: No Contact name at the Producer location. Applies to NAFTA CO.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Phone
Phone Required: No Phone number information of Producer. Applies to NAFTA CO.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Phone/Number
Number Required: Yes* The location's phone number of the Producer. Applies to NAFTA CO.
Type: String
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Phone/Extension
Extension Required: No The location's phone extension of the Producer. Applies to NAFTA CO.
Type: String
Max Allowed: 1
Length: 1…4

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 89
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/EMailAddress
EMailAddress Required: No Producer email address. Applies to NAFTA CO.
Type: String
Max Allowed: 1
Length: 1…50
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo
SoldTo Required: No SoldTo Container. Applies to Invoice and NAFTA CO Forms.
Type: Container Required if Invoice or NAFTA CO (International
Max Allowed: 1 Form) is requested.
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Name
Name Required: Yes* Company Name.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/AttentionName
AttentionName Required: Yes* Sold to contact name.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/TaxIdentificationNumber
TaxIdentificationNumber Required: No SoldTo Tax Identification Number.
Type: String
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Phone
Phone Required: No Phone Container.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 90
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Phone/Number
Number Required: Yes* Sold To contact's phone number.
Type: String
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Phone/Extension
Extension Required: No Sold To contact's phone extension.
Type: String
Max Allowed: 1
Length: 1…4
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Option
Option Required: No The text associated with the code will be printed in Applies to NAFTA CO form. Possible Values are
Type: String the sold to section of the NAFTA CO form. The 01 and 02.
Max Allowed: 1 values indicate the following: 01 – Unknown.
Length: 2
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address
Address Required: Yes* Sold To Address Container. Applies to NAFTA CO.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address/AddressLine
AddressLine Required: Yes* SoldTo location’s street address. Applies to NAFTA CO.
Type: String
Max Allowed:3
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address/City
City Required: Yes* SoldTo location’s city.
Type: String
Max Allowed: 1
Length: 1…30

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 91
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address/StateProvinceCode
StateProvinceCode Required: Cond SoldTo location’s state or province code. Required for certain countries.
Type: String
Max Allowed: 1
Length: 1…5
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address/Town
Town Required: No SoldTo location’s town code.
Type: String
Max Allowed: 1
Length: 1…30
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address/PostalCode
PostalCode Required: Cond SoldTo location’s postal code.
Type: String
Max Allowed: 1
Length: 1…9
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address/CountryCode
CountryCode Required: Yes* SoldTo location’s country code.
Type: String
Max Allowed: 1
Length: 2
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/EMailAddress
EMailAddress Required: No SoldTo email address.
Type: String
Max Allowed: 1
Length: 1…50

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 92
Shipping Package Web Service Developer Guide November 1, 2016
InternationalForms continued, Products

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product
Product Required: Yes* Contains the commodity/product information. Applies to EEI, Invoice, Partial Invoice, CO
Type: Container and NAFTA CO. When any International form
Max Allowed: 1…50 is requested, at least one Product must be
Length: N/A 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.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Description
Description Required: Yes* Description of the product. Applies to all International Forms. Optional
Type: String for Partial Invoice. Must be present at least
Max Allowed:3 once and can occur for a maximum of 3
Length: 1…35 times.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit
Unit Required: Cond Container tag for the unit's information of each Required for Invoice forms and optional for
Type: Container product. (also called as commodity) Partial Invoice.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/Number
Number Required: Yes* Total quantity of each commodity to be Required for Invoice forms and optional for
Type: String shipped, measured in the units specified in the Partial Invoice. Must be numeric. Valid
Max Allowed: 1 Unit of Measure field. characters are 0-9.
Length: 1…7

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 93
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container tag for the Unit of measurement for Required for Invoice forms and optional for
Type: Container the commodity. Partial Invoice.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/UnitOfMeasurement/Code
Code Required: Yes* Code for the Unit of measurement of the Required for Invoice forms and optional for
Type: String commodity units. Partial Invoice.
Max Allowed: 1
Refer to Unit of Measure Codes in the
Length: 1…3
Appendix for valid values.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/UnitOfMeasurement/Description
Description Required: Cond The Unit of Measure if OTH (Other) is entered Applies to Invoice and Partial Invoice forms.
Type: String as the UnitOfMeasurement code. Conditionally Required for the Invoice and
Max Allowed: 1 Partial Invoice form if OTH is entered as the
Length: 1…3 units UnitOfMeasurement Code.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 94
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/Value
Value Required: Yes* Monetary amount used to specify the worth or Applies to Invoice and Partial Invoice form.
Type: String price of the commodity. Amount should be Required for Invoice forms and optional for
Max Allowed: 1 greater than zero. Partial Invoice.
Length: 1…19
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 is the sum of ( number*values) of all
products and should not exceed:
9999999999999999.99
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/CommodityCode
CommodityCode Required: Cond 6-to-15-alphanumeric commodity code. Applies to Invoice, Partial Invoice and
Type: String NAFTA CO. Required for NAFTA CO and
Customs uses this code to determine what
Max Allowed: 1 optional for Partial Invoice. Should be at
duties should be assessed on the commodity.
Length: 6…15 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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 95
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PartNumber
PartNumber Required: No The part number or reference number for the Applies to Invoice and Partial Invoice.
Type: String product contained in the invoice line, as Required for Invoice forms and optional for
Max Allowed: 1 indicated on the customs invoice. Partial Invoice.
Length: 1…10
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/OriginCountryCode
OriginCountryCode Required: Cond The country in which the good was
Type: String manufactured, produced or grown.
Max Allowed: 1
For detailed information on country of origin,
Length: 2
certificate of origin, rules of origin, and any
related matters, please refer to the U.S.
Customs and Border Protection Web site at
www.customs.gov or contact your country's
Customs authority.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/JointProductionIndicator
JointProductionIndicator Required: No If present, JNT will be used as the origin of Applies to NAFTA CO only.
Type: String country code on the NAFTA form and the
Max Allowed: 1 Product/OriginCountryCode tag will be
Length: 0 ignored.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NetCostCode
NetCostCode Required: Cond For each good described in the Description of Applies to NAFTA CO only. Required for
Type: String Goods field, where the good is subject to a NAFTA CO. Possible Values: NC and NO.
Max Allowed: 1 regional value content (RVC) requirement,
Length: 2 indicate NC if the RVC is calculated according
to the net cost method; otherwise, indicate NO.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NetCostDateRange
NetCostDateRange Required: No Date Range for regional value content (RVC). Applies to NAFTA CO only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NetCostDateRange/BeginDate
BeginDate Required: Yes* If the RVC is calculated over a period of time, it Applies to NAFTA CO only. Format is
Type: String should be identified by the begin date yyyyMMdd.
Max Allowed: 1 (yyyyMMdd) of that period. (Reference: Articles
Length: 8 402.1, 402.5).

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 96
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NetCostDateRange/EndDate
EndDate Required: Yes* If the RVC is calculated over a period of time, it Applies to NAFTA CO only. Format is
Type: String should be identified by the End date yyyyMMdd.
Max Allowed: 1 (yyyyMMdd) of that period. (Reference: Articles
Length: 8 402.1, 402.5).
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PreferenceCriteria
PreferenceCriteria Required: Cond Indicates the criterion (A through F) for each Applies to NAFTA CO only.
Type: String good described in the Description of Goods
Max Allowed: 1 field if applicable.
Length: 1
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).
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProducerInfo
ProducerInfo Required: Cond Indicate the following: Yes - If shipper is the Applicable for NAFTA CO and is required.
Type: String producer of the good. If not, state 02, 03, and
Max Allowed: 1 04 depending on whether this certificate was
Length: 3…5 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.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/MarksAndNumbers
MarksAndNumbers Required: No Any special marks, codes, and numbers that Applies to CO Only.
Type: String may appear on package.
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 97
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NumberOfPackagesPerCommodity
NumberOfPackagesPerCommodity Required: Cond The total number of packages, cartons, or Applicable for CO and is required. Should be
Type: String containers for the commodity. numeric. Valid characters are 0 -9.
Max Allowed: 1
Length: 1…3
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProductWeight
ProductWeight Required: Cond The shipping weight, including containers, for Applies to CO and EEI forms only. Required
Type: Container each commodity with a separate Harmonized for CO and EEI forms.
Max Allowed: 1 Tariff Code / Schedule B Number. This weight
Length: N/A does not include carrier equipment.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProductWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container tag for the Unit of Measurement of Applies to CO and EEI forms only.
Type: Container weight.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProductWeight/UnitOfMeasurement/Code
Code Required: Yes* Code for unit of Measurement of weight. Applies to CO and EEI forms only. Possible
Type: String values: KGS, LBS
Max Allowed: 1
Length: 3
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProductWeight/UnitOfMeasurement/Description
Description Required: No Description of the Unit of Measure.
Type: String
Max Allowed: 1
Length: 1…20
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProductWeight/Weight
Weight Required: Yes* Weight of Product. Applies to CO and EEI forms only.
Type: String
Valid characters are 0-9 and '.' (Decimal
Max Allowed: 1
point). Limit to 1 digit after the decimal.
Length: 1…5
The maximum length of the field is 5
including '.' and can hold up to 1 decimal
place.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 98
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/VehicleID
VehicleID Required: No Includes the following information for used Applies to EEI forms only.
Type: String self-propelled vehicles as defined in Customs
Max Allowed: 1 regulations 19 CFR 192.1:
Length: 1…25
The unique Vehicle Identification Number
(VIN) in the proper format.
Or
The Product Identification Number (PIN) for
those used self propelled vehicles for which
there are no VINs. Or the Vehicle Title
Number.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB
ScheduleB Required: Cond Container tag for the schedule B information of Applies to EEI forms only. Required for EEI
Type: Container a commodity. form
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/Number
Number Required: Yes* A unique 10-digit commodity classification Applies to EEI forms only. Has to be 10
Type: String code for the item being exported. characters.
Max Allowed: 1
(To classify a commodity access the following
Length: 10
Web page: http://www.census.gov/foreign-
trade/schedules/b/#search).
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/Quantity
Quantity Required: Cond The count of how many Schedule B units of the Applies to EEI forms only. Conditionally
Type: String current good are in the shipment (EEI only). required for EEI forms if ScheduleB
Max Allowed:2 For example, if the Schedule B unit of measure UnitOfMeasurement is not X.
Length: 1…10 is dozens and eight dozen, is being shipped,
Should be Numeric.
indicate 8 in this field.
Valid characters are 0 -9.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/UnitOfMeasurement
UnitOfMeasurement Required: Yes* The unit of measure indicated on the Export Applies to EEI forms only.
Type: Container License.
Max Allowed: 2
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 99
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/UnitOfMeasurement/Code
Code Required: Yes* The unit of measure indicated on the Export Applies to EEI forms only. Required for the
Type: String License. EEI form.
Max Allowed: 1
Enter an X if there is no unit of measure in the Refer to EEI Unit of Measure Codes in the
Length: 1…3
Schedule B Unit field. Appendix for valid values.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/UnitOfMeasurement/Description
Description Required: No Description of the Unit of Measure.
Type: String
Max Allowed: 1
Length: 1…20
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ExportType
ExportType Required: Cond Code indicating Domestic: Exports that have Applies to EEI forms only.
Type: String been produced, manufactured, or grown in the
Required for EEI form.
Max Allowed: 1 United States or Puerto Rico.
Length: 1 Possible Values:
This includes imported merchandise which
D: Domestic
has been enhanced in value or changed from
F: Foreign
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 100
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/SEDTotalValue
SEDTotalValue Required: Cond This amount will always be USD. Applies to EEI forms only. Required for EEI
Type: String form. Valid characters are 0-9 and '.'
Max Allowed: 1 (Decimal point). Limit to 2 digit after the
Length: 1…15 decimal.
The maximum length of the field is 15
including '.' and can hold up to 2 decimal
places.
Note: This value is calculated based on the
Product/Unit/Value and
/Product/Unit/Number (Number of Units *
Price per Unit).
If the total value is incorrect it will be
replaced by the actual calculated total value.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ExcludeFromForm
ExcludeFromForm Required: No Container tag for determining whether or not to If this container is not present we assume
Type: Container exclude product information from a particular that the DEFAULT is selected which is
Max Allowed: 1 form. "none" and all products will appear on all
Length: N/A forms.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ExcludeFromForm/FormType
FormType Required: Yes* Indicates the name of the International form Possible Values are 04 – NAFTA CO.
Type: String requested to NOT have product information. Please note that if this is used and you DO
Max Allowed:Unbounded NOT have the corresponding form type
Length: 1…2 requested this will be IGNORED.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PackingListInfo
PackingListInfo Required: Cond Data Container holding package related Required for packaging list and Air Freight
Type: Container information. Packing list.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PackingListInfo/PackageAssociated
PackageAssociated Required: Yes* Data Container holding package/product Required for packaging list and Air Freight
Type: Container related information that will break up the Packing list.
Max Allowed: UNB product into each package on the packing list.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 101
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PackingListInfo/PackageAssociated/PackageNumber
PackageNumber Required: Yes* Package number the product should be Required for packaging list and Air Freight
Type: String allocated to ont he packing list. Packing list.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PackingListInfo/PackageAssociated/ProductAmount
ProductAmount Required: Yes* Amount of Product associated with a package. Required for packaging list and Air Freight
Type: String Packing list.
Max Allowed: 1
Length: N/A
/ShipmentRequest/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
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/ExportInformation
ExportInformation Required: Cond Required for EEI form id it is a SDL product. Applies to EEI form only. Required if
Type: String EEIFilingOption code 3 specified for EEI
Valid values:
Max Allowed: 1 form.
Length: 2 LC, LV, SS,MS, GS, DP, HR, UG, IC, SC, DD,
HH, SR, TE,TL, IS, CR, GP, RJ, TP, IP, IR, DB,
CH, RS, OS
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/License
License Required: Cond Licence information for SDL commodity. Applies to EEI form only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/License/Number
Number Required: Cond Represents any one of the following values: Applies to EEI form only.
Type: String export license number, exception code, CFR
Max Allowed: 1 citation, KPC Number, ACM Number.
Length: 7…13
Refer to EEI License Types and Exemptions in
the Appendix for valid values and formats.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 102
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/License/Code
Code Required: Cond The standard license code published by US Applies to EEI form only. It is required for
Type: String government. EEIFilingOption code 3.
Max Allowed: 1
Refer to EEI License Codes in the Appendix It is optionally required for all other filing
Length: 3
for valid values. types; however, it is used to categorize each
product as SDL or non-SDL. It is also used
to identify which piece of information is
applicable.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/License/LicenseLineValue
LicenseLineValue Required: Cond The export monetary amount allowed per Applies to EEI form only. Required if
Type: String license. EEIFilingOption code 1A (only for SDL
Max Allowed: 1 shipments) or 3.
Required for a licensable product when the
Length: 1…10
EEI form is selected.
Format: Whole numbers only.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/License/ECCNNumber
ECCNNumber Required: Cond Product ECCN Number issued by BIS (Bureau Applies to EEI forms only. It is required for
Type: String of Industry and Security). If the license number EEIFilingOption code 3. ECCN is required
Max Allowed: 1 is a commerce license, ECCN must be one of the following License Exception
Length: 5 provided.The format is #A### or EAR99 Codes is entered: CIV, CTP, ENC, GBS, KMI,
LVS, TSR
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation
DDTCInformation Required: Cond Department of State/ Directorate of Defense Applies to EEI Form only.
Type: Container Trade Control Information. This element is a
Max Allowed: 1 container for additional information that is
Length: N/A applicable to SDL products.
It will only be evaluated if the provided license
code is an SDL code.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 103
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/ITARExemptionNumber
ITARExemptionNumber Required: Cond The specific citation (exemption number) Applies to EEI Form only. This field is
Type: String under the International Traffic in Arms applicable for EEIFiling option 1A and 3.
Max Allowed: 1 Regulations (ITAR) from the Code of Federal
Length: 3…10 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).
Refer to the Appendix for valid ITAR exemption
values.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/USMLCategoryCode
USMLCategoryCode Required: Cond Digit numeric code (e.g. 01-18, 20 or 21). Applies to EEI form only. It is required for
Type: String Indicates the U.S. Munitions List (USML) EEIFilingOption code 3.
Max Allowed: 1 category article, service or related technical
Length: 2 data as it applies to the article reported.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/EligiblePartyIndicator
EligiblePartyIndicator Required: No Presence/Absent indicator. Certification by the
Type: String U.S. exporter that the exporter is an eligible
Max Allowed: 1 party to participate in the defense trade.
Length: 0
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/RegistrationNumber
RegistrationNumber Required: Cond It is a unique registration code assigned to the It is required for EEIFilingOption code 3.
Type: String registrant.
Max Allowed: 1
The DDTC registration code consist of a letter
Length: 6
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).
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/Quantity
Quantity Required: Cond Export Quantity. Applies to EEI form only. It is required for
Type: String EEIFilingOption code 3. Only positive integer
Max Allowed: 1 value is valid.
Length: 1…7

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 104
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/UnitOfMeasurement
UnitOfMeasurement Required: Cond Container for unit of measurement. Applies to EEI form only. It is required for
Type: Container EEIFilingOption code 3.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/UnitOfMeasurement/Code
Code Required: Yes* Required for EEI form. Unit of measurement Applies to EEI form only. It is required for
Type: String code. The two or three (3) alpha unit of EEIFilingOption code 1A and 3.
Max Allowed: 1 measurement for the article being shipped. For
Length: 2…3 example: BAG/BG - bags
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/UnitOfMeasurement/Description
Description Required: No Description for Unit of Measurement. Applies to EEI form only.
Type: String
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/SignificantMilitaryEquipmentIndicator
SignificantMilitaryEquipmentIndicator Required: No Presence/ Absence Indicator. Applies to EEI form only.
Type: String
Max Allowed: 1
Length: 0
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/ACMNumber
ACMNumber Required: Cond Approved Community Member Number (ACM). Applies to EEI form only. It is required for
Type: String It is required to be provided along with EEIFilingOption code 1A and 3.
Max Allowed: 1 ITARExemptionNumber for some License
Length: 11 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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 105
Shipping Package Web Service Developer Guide November 1, 2016
InternationalForms continued

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 106
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/TermsOfShipment
TermsOfShipment Required: No Indicates the rights to the seller from the buyer. Also, it Applies to Invoice and Partial Invoice forms only.
Type: String refers to Terms of Sale.
Possible values are:
Max Allowed: 1
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
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/ReasonForExport
ReasonForExport Required: Cond A reason to export the current international shipment. Applies to Invoice and Partial Invoice forms only.
Type: String Possible values:
Required for Invoice forms and Optional for Partial
Max Allowed: 1
• SALE Invoice.
Length: 1…20
• GIFT No validation.

• SAMPLE
• RETURN
• REPAIR
• INTERCOMPANYDATA
• Any other reason

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 107
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Comments
Comments Required: No Any extra information about the current shipment. Applies to Invoice and Partial Invoice forms only.
Type: String
Max Allowed: 1
Length: 1…150
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/DeclarationStatement
DeclarationStatement Required: No This is the legal explanation, used by Customs, for the Applies to Invoice and Partial Invoice forms only.
Type: String delivering of this shipment. It must be identical to the set
On the invoice for return shipment, the verbiage is
Max Allowed: 1 of declarations actually used by Customs.
as follows (user input is ignored):
Length: 1…550
Examples of declarations that might be entered in this
The exporter of the products covered by this
field are: I hereby certify that the goods covered by this
document declares that except where otherwise
shipment qualify as originating goods for purposes of
clearly indicated these products are of EEA
preferential tariff treatment under the NAFTA. I hereby
preferential origin
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.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Discount
Discount Required: No Container tag that holds the discount. Applies to Invoice and Partial Invoice forms only.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 108
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/Discount/MonetaryValue
MonetaryValue Required: Yes* The discount to be subtracted from the sum of the total Applies to Invoice and Partial Invoice forms only.
Type: String value on the invoice. Required for Invoice forms and optional for Partial
Max Allowed: 1 Invoice.
Length: 1…15
Valid characters are 0-9 and '.' (Decimal point).
Limit to 2 digit after the decimal.
The maximum length of the field is 15 including '.'
and can hold up to 2 decimal places.
This value should be greater than or equal to zero
or less than or equal to the value of all goods listed
on the invoice.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/FreightCharges
FreightCharges Required: No Container tag that holds the Freight Charges. Applies to Invoice and Partial Invoice forms only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/FreightCharges/MonetaryValue
MonetaryValue Required: Yes* Cost to transport the shipment. Applies to Invoice and Partial Invoice forms only.
Type: String
Required for Invoice forms and optional for Partial
Max Allowed: 1
Invoice.
Length: 1…15
Valid characters are 0-9 and '.' (Decimal point).
Limit to 2 digit after the decimal.
The maximum length of the field is 15 including '.'
and can hold up to 2 decimal places.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/InsuranceCharges
InsuranceCharges Required: No Container tag that holds the Insurance Charges. Applies to Invoice and Partial Invoice forms only.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 109
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/InsuranceCharges/MonetaryValue
MonetaryValue Required: Yes* The amount the shipper or receiver pays to cover the Applies to Invoice and Partial Invoice forms only.
Type: String cost of replacing the shipment if it is lost or damaged.
Required for Invoice forms and optional for Partial
Max Allowed: 1
Invoice.
Length: 1…15
Valid characters are 0-9 and '.' (Decimal point).
Limit to 2 digit after the decimal.
The maximum length of the field is 15 including '.'
and can hold up to 2 decimal places.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/OtherCharges
OtherCharges Required: No Container tag that holds the information of amount that Applies to Invoice and Partial Invoice forms only.
Type: Container covers additional charges not already listed on the
Max Allowed: 1 invoice.
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/OtherCharges/MonetaryValue
MonetaryValue Required: Yes* The Monetary value of Other Charges. Applies to Invoice and Partial Invoice forms only.
Type: String
Required for Invoice forms and optional for Partial
Max Allowed: 1
Invoice.
Length: 1…15
Valid characters are 0-9 and '.' (Decimal point).
Limit to 2 digit after the decimal.
The maximum length of the field is 15 including '.'
and can hold up to 2 decimal places.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/OtherCharges/Description
Description Required: Yes* Description of what the other charges are for. Applies to Invoice and Partial Invoice forms only.
Type: String Required for Complete Invoice and Optional for
Max Allowed: 1 Partial Invoice forms.
Length: 1…10
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CurrencyCode
CurrencyCode Required: Cond Currency code for all the monetary values of the Invoice Applies to Invoice and Partial Invoice forms only.
Type: String form.
Max Allowed: 1
Length: 3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 110
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/BlanketPeriod
BlanketPeriod Required: Cond This field should be entered if the NAFTA Certificate Applies to NAFTA CO form only. Required for
Type: Container covers multiple shipments of identical goods as NAFTA CO. This is not valid for a paperless
Max Allowed: 1 described in the Description of Goods field that are shipment.
Length: N/A 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.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/BlanketPeriod/BeginDate
BeginDate Required: Yes* Begin date of the blanket period. It is the date upon Applies to NAFTA CO form only. Required for
Type: String which the Certificate becomes applicable to the good NAFTA CO. Format is yyyyMMdd. This is not valid
Max Allowed: 1 covered by the blanket Certificate (it may be prior to the for a paperless shipment.
Length: 8 date of signing this Certificate).
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/BlanketPeriod/EndDate
EndDate Required: Yes* End Date of the blanket period. It is the date upon which Applies to NAFTA CO form only.
Type: String the blanket period expires.
Required for NAFTA CO.
Max Allowed: 1
Length: 8 Format is yyyyMMdd.
This is not valid for a paperless shipment.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/ExportDate
ExportDate Required: Cond The date the goods will be exiting the country. Applies to CO and EEI forms only. Required for CO
Type: String and EEI forms. Format is yyyyMMdd.
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/ExportingCarrier
ExportingCarrier Required: Cond The name of the carrier that is exporting the shipment. Applies to CO and EEI forms only. Required for CO
Type: String The vessels flag number should also be entered, if the and EEI forms.
Max Allowed: 1 carrier is a vessel.
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 111
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/CarrierID
CarrierID Required: No The four-character Standard Carrier Alpha Code (SCAC) Applies to EEI forms only. No Validations.
Type: String for vessel, rail, and truck shipments.
Max Allowed: 1
For air shipment, enter the two or three character
Length: 1…17
International Air Transport Association (IATA) code.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/InBondCode
InBondCode Required: Cond The two-character In Bond Code. Applies to EEI forms only.
Type: String
Required for EEI forms.
Max Allowed: 1
Length: 2 Valid values:

• 70: Not in bond

• 67: IE from a FTZ
• 68: T&E from a FTZ
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/EntryNumber
EntryNumber Required: Cond The Import Entry Number when the export transaction is Applies to EEI forms only. Conditionally Required
Type: String used as proof of export for import transactions for EEI forms when In bond code value is other
Max Allowed: 1 (examples: In Bond, Temporary Import Bond or than 70 (Not In Bond)
Length: 1…25 Drawbacks).
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/PointOfOrigin
PointOfOrigin Required: Cond Contains one of the following: The two-digit U.S. Postal Applies to EEI forms only. Required for EEI.
Type: String Service abbreviation for the state from which the goods
Max Allowed: 1 were shipped to the port of export.
Length: 1…5
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.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/PointOfOriginType
PointOfOriginType Required: Cond Valid values : Applies EEI forms only. Required for EEI form.
Type: String
S (for state postal code abbrevation)
Max Allowed: 1
Length: 1 F: FTZ Identifier

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 112
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/ModeOfTransport
ModeOfTransport Required: Cond Mode of transport by which the goods are exported. Applies to EEI forms only. Required for EEI. Only
Type: String allowed values can be entered. Only 10 Characters
Possible values:
Max Allowed: 1 can appear on the form. Anything greater than 10
Length: 1…35 Air, AirContainerized, Auto, FixedTransportInstallations, characters will be truncated on the form.
Mail, PassengerHandcarried, Pedestrian, Rail, Rail,
Containerized, RoadOther, SeaBarge,
SeaContainerized, SeaNoncontainerized, Truck,
TruckContainerized.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/PortOfExport
PortOfExport Required: No Should be one of the following: Applies to EEI forms only. No validation is
Type: String performed.
Overland: The U.S. Customs port where the carrier
Max Allowed: 1
crosses the U.S. border
Length: 1…35
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.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/PortOfUnloading
PortOfUnloading Required: The country and the port where the goods will be Applies to EEI forms only. No validation is
Type: String unloaded from the exporting carrier. For vessel and air performed.
Max Allowed: 1 shipments only.
Length: 1…35
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/LoadingPier
LoadingPier Required: No Pier where goods are loaded. For vessel shipments only. Applies to EEI forms only. No validation is
Type: String performed.
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 113
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/PartiesToTransaction
PartiesToTransaction Required: Cond Information about parties to transaction. Applies to EEI forms only.
Type: String
Use Related, if the parties to the transaction are related. Valid values: R - Related, N - Non-related.
Max Allowed: 1
A related party is an export from a U.S. businessperson
Length: 1
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.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/RoutedExportTransactionIndicator
RoutedExportTransactionIndicator Required: No If Present, indicates that it is a routed export transaction. Applies to EEI forms only.
Type: String A routed export transaction is one, where the foreign
Max Allowed: 1 principal party in interest authorizes a U.S. forwarding (or
Length: 0 other) agent to export the merchandise outside the U.S.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/ContainerizedIndicator
ContainerizedIndicator Required: No If present indicates that the goods are containerized. This Applies to EEI forms only.
Type: String applies to vessel shipments only.
Max Allowed: 1
Length: 0
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/OverridePaperlessIndicator
OverridePaperlessIndicator Required: No The application will automatically provide a copy of the
Type: String invoice or NAFTA/CO with each response regardless of
Max Allowed: 1 whether the user has enabled Paperless account. The
Length: 0 user now has the option to print or ignore the copy
provided.
/ShipmentRequest/Shipment/ShipmentServiceOptions/InternationalForms/ShipperMemo
ShipperMemo Required: No Text for the shipper to add additional information. Forward shipment only.
Type: String
Max Allowed: 1
Length: 1…300

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 114
Shipping Package Web Service Developer Guide November 1, 2016
DeliveryConfirmation

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/DeliveryConfirmation
DeliveryConfirmation Required: No Delivery Confirmation container. Valid for forward shipments only.
Type: Container
Refer to Delivery Confirmation Origin-Destination Pairs in the
Max Allowed: 1
Appendix for a list of valid values.
Length: N/A
/ShipmentRequest/Shipment/ShipmentServiceOptions/DeliveryConfirmation/DCISType
DCISType Required: Yes* Type of delivery confirmation. Valid values:
Type: String
1 - Delivery Confirmation Signature Required
Max Allowed: 1
Length: 1 2 - Delivery Confirmation Adult Signature Required
Valid for forward shipments only.
/ShipmentRequest/Shipment/ShipmentServiceOptions/DeliveryConfirmation/DCISNumber
DCISNumber Required: No DCIS Number.
Type: String
Max Allowed: 1
Length: 1…20

ReturnOfDocumentIndicator

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/ReturnOfDocumentIndicator
ReturnOfDocumentIndicator Required: No The flag indicates the ReturnOfDocument accessorial has been Valid for Poland to Poland forward shipment only.
Type: String requested.
Max Allowed: 1
Length: 0

ImportControlIndicator

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 115
Shipping Package Web Service Developer Guide November 1, 2016
LabelMethod

Name Constraint Description Validation

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

CommercialInvoiceRemovalIndicator

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 116
Shipping Package Web Service Developer Guide November 1, 2016
UPScarbonneutralIndicator

Name Constraint Description Validation

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

PreAlertNotification

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 117
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 118
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/Locale/Language
Language Required: Yes* Refer to Language/Dialect Combinations in the Appendix
Type: String for valid pairs.
Max Allowed: 1
Length: 3
/ShipmentRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/Locale/Dialect
Dialect Required: Yes* Refer to Language / Dialect Combinations in the
Type: String Appendix for valid pairs.
Max Allowed: 1
Length: 2

ExchangeForwardIndicator

Name Constraint Description Validation

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

HoldForPickupIndicator

Name Constraint Description Validation

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

DropoffAtUPSFacilityIndicator

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 119
Shipping Package Web Service Developer Guide November 1, 2016
LiftGateForPickUpIndicator

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/LiftGateForPickUpIndicator
LiftGateForPickUpIndicator Required: No Lift Gate For Pick Up indicator. The empty tag means indicator is Lift Gate for Pickup is not allowed with Drop Off At UPS
Type: String present. Facility for a UPS Worldwide Express Freight shipment.
Max Allowed: 1
When both Hold for Pickup and Drop Off At Facility are
Length: 0
selected, neither of the Lift Gate accessorial (Pick Up or
Delivery) are allowed for a UPS Worldwide Express
Freight shipment.
This accessorial is only valid for UPS Worldwide Express
Freight Shipment.

LiftGateForDeliveryIndicator

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/LiftGateForDeliveryIndicator
LiftGateForDeliveryIndicator Required: No Lift Gate For Delivery indicator. The empty tag means indicator Lift Gate for Delivery is not allowed with Hold For Pickup
Type: String is present. for a UPS Worldwide Express Freight shipment.
Max Allowed: 1
When both Hold for Pickup and Drop Off At UPS Facility
Length: 0
are selected, neither of the Lift Gate accessorial (Pick Up
or Delivery) are allowed for a UPS Worldwide Express
Freight shipment.
This accessorial is only valid for UPS Worldwide Express
Freight Shipment.

SDLShipmentIndicator

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 120
Shipping Package Web Service Developer Guide November 1, 2016
EPRAReleaseCode

Name Constraint Description Validation

/ShipmentRequest/Shipment/ShipmentServiceOptions/EPRAReleaseCode
EPRAReleaseCode Required: No Package Release code allows the consignee or claimant to pick- The release code must be between length 4 and 6 and
Type: String up a package at a UPS Access Point™. only contain numbers.
Max Allowed: 1
The shipper must provide the Package Release Code to the
Length: 4...6
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™.

Package

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package
Package Required: Yes Package Information container. For Return Shipments up to and including 20 packages
Type: Container are allowed. US/PR origin return movements are limited to
Max Allowed: 200 only one package. For Mail Innovations shipments only
Length: N/A one package is allowed.

Description

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/Description
Description Required: Cond Merchandise description of package. Required for shipment with return service.
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 121
Shipping Package Web Service Developer Guide November 1, 2016
Packaging

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/Packaging
Packaging Required: Yes Packaging container. Container for Packaging Type.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 122
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/Packaging/Code
Code Required: Yes Package types. Values: Package type 24, or 25 is only allowed for shipment
Type: String without return service. Packaging type must be valid for all
Max Allowed: 1 • 01 = UPS Letter the following:
Length: 2 • 02 = Customer Supplied Package ShipTo country, ShipFrom country, a shipment going from
• 03 = Tube ShipTo country to ShipFrom country, all Accessorials at
both the shipment and package level, and the shipment
• 04 = PAK service type.
• 21 = UPS Express Box UPS will not accept raw wood pallets and please refer the
UPS packaging guidelines for pallets on UPS.com.
• 24 = UPS 25KG Box
• 25 = UPS 10KG Box
• 30 = Pallet
• 2a = Small Express Box
• 2b = Medium Express Box
• 2c = Large Express Box
• 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
Note: Only code 02 is applicable to Ground Freight Pricing.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 123
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/Packaging/Description
Description Required: No Description of packaging type. Examples are letter, customer
Type: String supplied, express box.
Max Allowed: 1
Length: 1…35

Dimensions

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/Dimensions
Dimensions Required: Cond Dimensions information container. Note: Currently dimensions Length + 2*(Width + Height) must be less than or equal to
Type: Container are not applicable to Ground Freight Pricing. 130 IN or 330 CM.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Package/Dimensions/UnitOfMeasurement
UnitOfMeasurement Required: Yes* UnitOfMeasurement container for dimensions.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Package/Dimensions/UnitOfMeasurement/Code
Code Required: Yes* Package dimensions measurement code. The unit of measurement must be valid for the Shipper
Type: String country.
Valid codes are:
Max Allowed: 1
Length: 2 • IN = Inches
• CM = Centimeters
• 00 = Metric Units Of Measurement
• 01 = English Units of Measurement
/ShipmentRequest/Shipment/Package/Dimensions/UnitOfMeasurement/Description
Description Required: No Description of the package dimensions measurement units.
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 124
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/Dimensions/Length
Length Required: Yes* Package length. Length must be the longest dimension of the Valid values are 0 to 108 IN and 0 to 270 CM.
Type: String container.
Max Allowed: 1
Length: 3
/ShipmentRequest/Shipment/Package/Dimensions/Width
Width Required: Yes* Package width.
Type: String
Max Allowed: 1
Length: 3
/ShipmentRequest/Shipment/Package/Dimensions/Height
Height Required: Yes* Package height.
Type: String
Max Allowed: 1
Length: 3

PackageWeight

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/PackageWeight
PackageWeight Required: Cond Container to hold package weight information. Package weight is a required for Ground Freight Pricing
Type: Container shipments.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Package/PackageWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container to hold UnitOfMeasurement information for package
Type: Container weight.
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 125
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/PackageWeight/UnitOfMeasurement/Code
Code Required: Yes* Package weight unit of measurement code.
Type: String
Codes are:
Max Allowed: 1
Length: 3 • LBS = Pounds
• KGS = Kilograms
• OZS = Ounces
Unit of Measurement "OZS" is the only valid UOM for some of the
Mail Innovations Forward Shipments.
Refer to Appendix for more details regarding the valid
combination of Mail Innovation Forward Shipment services,
Package Type and Unit of Measurement.
/ShipmentRequest/Shipment/Package/PackageWeight/UnitOfMeasurement/Description
Description Required: No Description of the unit of measurement for package weight.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/Package/PackageWeight/Weight
Weight Required: Yes* Packages weight. Weight accepted for letters/envelopes. Only average package weight is required for Ground
Type: String Freight Pricing Shipment.
Max Allowed: 1
Length: 1…5

LargePackageIndicator

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/LargePackageIndicator
LargePackageIndicator Required: No Presence of the indicator mentions that the package is Large Empty Tag.
Type: String Package.
Max Allowed: 1
Length: 0

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 126
Shipping Package Web Service Developer Guide November 1, 2016
ReferenceNumber

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/ReferenceNumber
ReferenceNumber Required: No Package reference number information container. For Mail Innovation shipments reference number is not
Type: Container supported.
Max Allowed: 2
Length: N/A
/ShipmentRequest/Shipment/Package/ReferenceNumber/BarCodeIndicator
BarCodeIndicator Required: No If the indicator is present then the reference number's value will Empty Tag. Only one shipment-level or package-level
Type: String be bar coded on the label. reference number can be bar coded per shipment.
Max Allowed: 1
In order to barcode a reference number, its value must be
Length: 0
no longer than 14 alphanumeric characters or 24 numeric
characters and cannot contain spaces.
/ShipmentRequest/Shipment/Package/ReferenceNumber/Code
Code Required: No Reference number type code, for the entire shipment. The code Valid if the origin/destination pair is US/US or PR/PR. It
Type: String specifies the Reference name. needs to be alpha-numeric.
Max Allowed: 1
Refer to the Reference Number Code table.
Length: 2
/ShipmentRequest/Shipment/Package/ReferenceNumber/Value
Value Required: Yes* Customer supplied reference number. Valid if the origin/destination pair is US/US or PR/PR.
Type: String Supports up to 2 customer supplied combinations of
Max Allowed: 1 Reference code- value combinations.
Length: 1…35

AdditionalHandlingIndicator

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/AdditionalHandlingIndicator
AdditionalHandlingIndicator Required: No Additional Handling Required. The presence indicates additional Empty Tag.
Type: String handling is required, the absence indicates no additional
Max Allowed: 1 handling is required.
Length: 0

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 127
Shipping Package Web Service Developer Guide November 1, 2016
PackageServiceOptions

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/PackageServiceOptions
PackageServiceOptions Required: No Package Service Options container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DeliveryConfirmation
DeliveryConfirmation Required: No Delivery Confirmation container. Valid only for forward shipment only.
Type: Container
Refer to Delivery Confirmation Origin-Destination Pairs in
Max Allowed: 1
the Appendix for a list of valid values.
Length: N/A
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DeliveryConfirmation/DCISType
DCISType Required: Yes* Type of delivery confirmation. Valid values:
Type: String
1 - Delivery Confirmation
Max Allowed: 1
Length: 1 2 - Delivery Confirmation Signature Required
3 - Delivery Confirmation Adult Signature Required
Forwards Only
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.
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DeliveryConfirmation/DCISNumber
DCISNumber Required: No Delivery Confirmation Control number associated with the Valid for forward shipments only.
Type: String delivery confirmation for the package.
Max Allowed: 1
Length: 1…11

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 128
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/PackageServiceOptions/DeclaredValue
DeclaredValue Required: No Container for Declared Value.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DeclaredValue/Type
Type Required: No Container for Declared Value Type.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DeclaredValue/Type/Code
Code Required: Yes* Declared value type. The user cannot specify different type of declared
Type: String value for the shipment. User can either have shipper
Valid values:
Max Allowed: 1 declared value (DVS) or declared value (EVS) but
01=EVS
Length: 2 not both at package level. Note: The Shipper
02=DVS
Declared Value is applicable for forward shipments
Defaults to 01 i.e. when the billing option is freight collect or third party.
EVS if declared value type is not provided.
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DeclaredValue/Type/Description
Description Required: No Declared value Description.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DeclaredValue/CurrencyCode
CurrencyCode Required: Yes* Declared value amount currency type. Defaults to the non- Code must represent a currency that is a valid for
Type: String Euro currency used in the shipper's country. Shipper country.
Max Allowed: 1
Length: 3
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DeclaredValue/MonetaryValue
MonetaryValue Required: Yes* Declared value amount.
Type: String
Max Allowed: 1
Length: 1…19

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 129
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/PackageServiceOptions/COD
COD Required: No Container for COD. Indicates COD is requested. Package level COD is
Type: Container available for shipment without return service from
Max Allowed: 1 US/PR to US/PR, CA to CA, and CA to US.
Length: N/A
CA to US COD is not allowed for package Letter/
Envelope. COD is not valid for return service
movements.
/ShipmentRequest/Shipment/Package/PackageServiceOptions/COD/CODFundsCode
CODFundsCode Required: Yes* For valid values, refer to COD Supported Countries in the
Type: String Appendix.
Max Allowed: 1
Length: 1
/ShipmentRequest/Shipment/Package/PackageServiceOptions/COD/CODAmount
CODAmount Required: Yes* COD Amount container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Package/PackageServiceOptions/COD/CODAmount/CurrencyCode
CurrencyCode Required: Yes* COD amount currency code type.
Type: String
Max Allowed: 1
Length: 3
/ShipmentRequest/Shipment/Package/PackageServiceOptions/COD/CODAmount/MonetaryValue
MonetaryValue Required: Yes* COD Amount. Valid values: 0.01 USD to 50000.00 USD
Type: String
Max Allowed: 1
Length: 5
/ShipmentRequest/Shipment/Package/PackageServiceOptions/AccessPointCOD
AccessPointCOD Required: No Access Point COD indicates Package COD is requested Valid only for "01 - Hold For Pickup At UPS Access
Type: Container for a shipment. Point" Shipment Indication type.
Max Allowed: 1
Package Access Point COD is valid only for
Length: N/A
shipment without return service from US/PR to
US/PR and CA to CA.
Not valid with COD at package level.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 130
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/PackageServiceOptions/AccessPointCOD/CurrencyCode
CurrencyCode Required: Yes* Access Point COD Currency Code.
Type: String
Max Allowed: 1
Length: 3
/ShipmentRequest/Shipment/Package/PackageServiceOptions/AccessPointCOD/MonetaryValue
MonetaryValue Required: Yes* Access Point COD Monetary Value.
Type: String
Max Allowed: 1
Length: 1…8
/ShipmentRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation
VerbalConfirmation Required: No Verbal Confirmation Info. Allowed for shipment without return service.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo
ContactInfo Required: Cond Optional if the Shipper's AttentionName, PhoneNumber,
Type: Container and PhoneExtension (optional) are given and are the
Max Allowed: 1 desired name, phone number and extension, respectively,
Length: N/A to be used for verbal confirmation.
/ShipmentRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo/Name
Name Required: Cond Name of the person to be contacted for confirmation. Optional if Shipper/AttentionName is given and that
Type: String is the name of the person to be contacted else
Defaults to Shipper AttentionName if given.
Max Allowed: 1 required for verbal confirmation.
Length: 1…35
/ShipmentRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo/Phone
Phone Required: No Phone container.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 131
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo/Phone/Number
Number Required: Yes* Contact phone number.
Type: String
Max Allowed: 1
Length: 1…15
/ShipmentRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo/Phone/Extension
Extension Required: No Contact phone extension.
Type: String
Max Allowed: 1
Length: 1…4
/ShipmentRequest/Shipment/Package/PackageServiceOptions/ShipperReleaseIndicator
ShipperReleaseIndicator Required: No The presence indicates that the package may be released Empty Tag. Only available for US50/PR to US50/PR
Type: String by driver without a signature from the consignee. packages without return service.
Max Allowed: 1
Length: 0
/ShipmentRequest/Shipment/Package/PackageServiceOptions/Notification
Notification Required: No Receiver Return Notification. Applicable for Shipment with returned service.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Package/PackageServiceOptions/Notification/NotificationCode
NotificationCode Required: Yes* Notification Code. Valid values:
Type: String
3 - Receiver Return Notification
Max Allowed: 1
6 - QV Email Notification
Length: 1
7 - QV Exception Notification
8 - QV Delivery Notification.
For Mail Innovations forward shipments, QV Email
Notifications are allowed for First Class, Priority Mail,
and Expedited Mail Innovation services.
/ShipmentRequest/Shipment/Package/PackageServiceOptions/Notification/EMail
EMail Required: Yes* Container for the e-mail message.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 132
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/EMailAddress
EMailAddress Required: Yes* The destination email address of the receiver returns
Type: String notification email.
Max Allowed: 1
Length: 1…50
/ShipmentRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/UndeliverableEMailAddress
UndeliverableEMailAddress Required: No The e-mail address where an undeliverable email Defaults to FromEMailAddress. Only allowed at the
Type: String message is sent if the Receiver Return Notification email is first package.
Max Allowed: 1 undeliverable.
Length: 1…50
/ShipmentRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/FromEMailAddress
FromEMailAddress Required: No The email address listed in the Reply To field of the Only allowed at the first package.
Type: String message header, includes name and e-mail address of
Max Allowed: 1 sender. The "From" field of the message header contains
Length: 1…50 pkginfo@ups.com.
/ShipmentRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/FromName
FromName Required: No The name the receiver return notification will appear to be Defaults to the Shipper Name. Only allowed at the
Type: String from. first package.
Max Allowed: 1
Length: 1…35
/ShipmentRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/Memo
Memo Required: No User defined text that will be included in the email. Only allowed at the first package.
Type: String
Max Allowed: 1
Length: 1…150
/ShipmentRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/Subject
Subject Required: No The eMail's subject. Defaults to the UPS Receiver Return Only allowed at the first package.
Type: String Notification plus the shipment ID.
Max Allowed: 1
Length: 1…75

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 133
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/SubjectCode
SubjectCode Required: No Specifies a reference code and reference number to If the subject code tag is not provided and the subject
Type: String display in the subject of the Receiver Return Notification. text is provided, the subject of the notification will be
Max Allowed: 1 the subject text.
When the subject code is provided, the subject will contain
Length: 2
the following: UPS Receiver Return Notification. If the subject text is provided, and subject code tag
exists, then the subject code value must be 08. If the
The reference code (the reference code will be mapped to
subject code is 08, the subject text must exist.
the corresponding ANSI value) Plus the reference number.
If a subject code is provided that refers to a
nonexistent reference number, the subject will
default to the tracking number. Only allowed at the
first package.
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DryIce
DryIce Required: No Container for Dry Ice. Maximum 1 Dry Ice is allowed.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DryIce/RegulationSet
RegulationSet Required: Yes* Regulation set for dryIce Shipment. Valid values: CFR = The following values are valid: IATA, CFR.
Type: String HazMat regulated by US Dept. of Transportation within the
Max Allowed: 1 U.S. or ground shipments to Canada, IATA= Worldwide Air
Length: 3…4 movement.
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight
DryIceWeight Required: Yes* Container for Dry Ice weight.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container for Unit of measurement for Dry Ice Weight.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 134
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/UnitOfMeasurement/Code
Code Required: Yes* DryIce weight unit of measurement code. The following values are valid : 00 , 01, KG , KGS ,
Type: String LBS.
Valid values:
Max Allowed: 1
Length: 2…3 00 = KG (Metric Unit of Measurements) or KGS
01 = LB (English Unit of Measurements) or LBS
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/UnitOfMeasurement/Description
Description Required: No Description for unit of measurement for Dry Ice Weight.
Type: String
Max Allowed: 1
Length: 1…20
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/Weight
Weight Required: Yes* Dry Ice Weight. Cannot be more than package weight. Should be
Type: String more than 0.0.
Max Allowed: 1
Valid characters are 0-9 and "." (Decimal point). Limit
Length: 1…5
to 1 digit after the decimal.
The maximum length of the field is 5 including "." and
can hold up to 1 decimal place.
/ShipmentRequest/Shipment/Package/PackageServiceOptions/DryIce/MedicalUseIndicator
MedicalUseIndicator Required: No Presence/Absence Indicator. Any value inside is ignored.
Type: String Relevant only in CFR regulation set.
Max Allowed: 1
If present it is used to designate the dry Ice is for any
Length: 0
medical use and rates are adjusted for DryIce weight more
than 2.5 Kgs or 5.7 Lbs.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 135
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/PackageServiceOptions/UPSPremiumCareIndicator
UPSPremiumCareIndicator Required: No An UPSPremiumCareIndicator indicates special handling Empty Tag means indicator is present. The
Type: String is required for shipment having controlled substances. UPSPremiumCareIndicator cannot be requested for
Max Allowed: 1 package with Delivery Confirmation - Adult Signature
Length: 0 Required and Delivery Confirmation- Signature
Required.
UPSPremiumCareIndicator 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
UPSPremiumCareIndicator can be requested with
following UPS services: UPS Express® Early, UPS
Express, UPS Express Saver, UPS Standard. Valid
only for Canada to Canada movements.

Commodity

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/Commodity
Commodity Required: Cond Container to hold the Commodity information. It is required if the Ground Freight Pricing Shipment
Type: Container indicator is present in the request.
Max Allowed: 1
Length: N/A
/ShipmentRequest/Shipment/Package/Commodity/FreightClass
FreightClass Required: Yes* Freight Classification. Freight class partially determines the freight Required for Ground Freight Pricing Shipments only.
Type: String rate for the article.
Max Allowed: 1
Length: 10
/ShipmentRequest/Shipment/Package/Commodity/NMFC
NMFC Required: No Container to hold the NMFC codes.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 136
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentRequest/Shipment/Package/Commodity/NMFC/PrimeCode
PrimeCode Required: Yes* Specifies the Commodity's NMFC prime code. Required if NMFC Container is present.
Type: String
Max Allowed: 1
Length: 4…6
/ShipmentRequest/Shipment/Package/Commodity/NMFC/SubCode
SubCode Required: No Specifies the Commodity's NMFC sub code. Needs to be provided when the SubCode associated with
Type: String the PrimeCode is other than 00. UPS defaults the sub
Max Allowed: 1 value to 00 if not provided. If provided the Sub Code
Length: 2 should be associated with the PrimeCode of the NMFC.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 137
Shipping Package Web Service Developer Guide November 1, 2016

LabelSpecification
Name Constraint Description Validation
/ShipmentRequest/LabelSpecification
LabelSpecification Required: Cond Container used to define the properties required by the user to Required for shipment without return service or shipments
Type: Container print and/or display the UPS shipping label. with PRL return service.
Max Allowed: 1
Length: N/A

LabelImageFormat

Name Constraint Description Validation

/ShipmentRequest/LabelSpecification/LabelImageFormat
LabelImageFormat Required: Yes* LabelImageFormat Container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/LabelSpecification/LabelImageFormat/Code
Code Required: Yes* Label print method code determines the format in which Labels For shipments without return service the valid value is GIF,
Type: String are to be generated. ZPL, EPL and SPL.
Max Allowed: 1
• EPL2 formatted Labels use EPL For shipments with PRL return service, the valid values are
Length: 4
EPL, ZPL, SPL, STARPL and GIF.
• SPL formatted Labels use SPL
For Mail Innovations forward shipments STARPL is not
• ZPL formatted Labels use ZPL and supported.
• image formats use GIF
• Star Printer format formatted Labels use STARPL
/ShipmentRequest/LabelSpecification/LabelImageFormat/Description
Description Required: No Description of the label image format code.
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 138
Shipping Package Web Service Developer Guide November 1, 2016

HTTPUserAgent

Name Constraint Description Validation

/ShipmentRequest/LabelSpecification/HTTPUserAgent
HTTPUserAgent Required: Cond Browser HTTPUserAgent String. This is the Required if
Type: String preferred way of identifying GIF image type to /ShipmentRequest/LabelSpecificationLabelSpecification/LabelImageFormat/Code
-----------------------
Max Allowed: 1 be generated. = Gif
Length: 1…64
Default to Mozilla/4.5 if this field is missing or has invalid value.
______________

LabelStockSize

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 139
Shipping Package Web Service Developer Guide November 1, 2016

Instruction

Name Constraint Description Validation

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

• 01- EXCHANGE-LIKE ITEM ONLY

• 02- EXCHANGE-DRIVER INSTRUCTIONS INSIDE
/ShipmentRequest/LabelSpecification/Instruction/Description
Description Required: No Description of the label Instruction code.
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 140
Shipping Package Web Service Developer Guide November 1, 2016

ReceiptSpecification
Name Constraint Description Validation
/ShipmentRequest/ReceiptSpecification
ReceiptSpecification Required: No Container used to allow the user to choose to print a
Type: Container thermal receipt.
Max Allowed: 1
Length: N/A

ImageFormat

Name Constraint Description Validation

/ShipmentRequest/ReceiptSpecification/ImageFormat
ImageFormat Required: Yes* ImageFormat Container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentRequest/ReceiptSpecification/ImageFormat/Code
Code Required: Yes* Print code that determines the receipt format. Valid Codes are: EPL, SPL, ZPL, STARPL and HTML.
Type: String
Max Allowed: 1
Length: 3…4
/ShipmentRequest/ReceiptSpecification/ImageFormat/Description
Description Required: No Description of the receipt format code.
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 141
ShipmentResponse Top Level Containers

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 142
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentResponse XPath Tables

Note: Not all containers/elements are reflected separately in the table of contents.

Name Constraint Description Validation

/ShipmentResponse
ShipmentResponse Required: Yes Shipment Response.
Type: Container
Max Allowed: 1
Length: N/A

Response
Name Constraint Description Validation
/ShipmentResponse/Response
Response Required: Yes Response container for Shipment response.
Type: Container
Max Allowed: 1
Length: N/A

ResponseStatus

Name Constraint Description Validation

/ShipmentResponse/Response/ResponseStatus
ResponseStatus Required: Yes Response status container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentResponse/Response/ResponseStatus/Code
Code Required: Yes Identifies the success or failure of the transaction. 1 = Successful
Type: String
Max Allowed: 1
Length: 1

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 143
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/Response/ResponseStatus/Description
Description Required: Yes Describes Response Status Code. Returns text of Success.
Type: String
Max Allowed: 1
Length: 1…35

Alert

Name Constraint Description Validation

/ShipmentResponse/Response/Alert
Alert Required: No Alert Container. There can be zero to many alert containers with
Type: Container code and description.
Max Allowed: UNB
Length: N/A
/ShipmentResponse/Response/Alert/Code
Code Required: Yes* Warning code returned by the system.
Type: String
Max Allowed: 1
Length: 1…10
/ShipmentResponse/Response/Alert/Description
Description Required: Yes* Warning messages returned by the system.
Type: String
Max Allowed: 1
Length: 1…150

TransactionReference

Name Constraint Description Validation

/ShipmentResponse/Response/TransactionReference
TransactionReference Required: No Transaction Reference Container.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 144
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/Response/TransactionReference/CustomerContext
CustomerContext Required: No The CustomerContext Information which will be echoed during
Type: String response.
Max Allowed: 1
Length: 1…512

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 145
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentResults
Name Constraint Description Validation
/ShipmentResponse/ShipmentResults
ShipmentResults Required: Yes Shipment Results container.
Type: Container
Max Allowed: 1
Length: N/A

Disclaimer

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/Disclaimer
Disclaimer Required: Cond Disclaimer would be used to provide more information to shipper
regarding the processed shipment. This would be used to notify
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 request.
/ShipmentResponse/ShipmentResults/Disclaimer/Code
Code Required: Yes* Code representing type of Disclaimer. Refer to Disclaimer Codes
Type: String and Messages in the Appendix for possible code values.
Max Allowed: 1
Length: 2
/ShipmentResponse/ShipmentResults/Disclaimer/Description
Description Required: Yes* Disclaimer description.
Type: String
Refer to Disclaimer Codes and Messages in the Appendix for
Max Allowed: 1
possible descriptions.
Length:
Unbounded

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 146
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentCharges

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/ShipmentCharges
ShipmentCharges Required: Cond Shipment charges Container. Shipment charges info. Shipment
Type: Container charges are only guaranteed to be returned for shipments
Max Allowed: 1 whose origin country is U.S. or Puerto Rico.
Length: N/A
/ShipmentResponse/ShipmentResults/ShipmentCharges/RateChart
RateChart Required: No Rate Type with which Shipment is rated. Possible RateChart
Type: String values for different regions will be:
Max Allowed: 1
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
/ShipmentResponse/ShipmentResults/ShipmentCharges/TransportationCharges
TransportationCharges Required: Yes* Transportation Charges container.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 147
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 148
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipmentResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/SubType
SubType Required: No The sub-type of ItemizedCharge type.
Type: String
Max Allowed: 1
Length: 1…50
/ShipmentResponse/ShipmentResults/ShipmentCharges/ServiceOptionsCharges
ServiceOptionsCharges Required: Yes* Service Option Charges container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/ShipmentCharges/ServiceOptionsCharges/CurrencyCode
CurrencyCode Required: Yes* Accessorial charges currency code type. The currency code
Type: String used in the Shipment request is returned.
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/ShipmentCharges/ServiceOptionsCharges/MonetaryValue
MonetaryValue Required: Yes* Accessorial charges value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipmentResponse/ShipmentResults/ShipmentCharges/TaxCharges
TaxCharges Required: Cond TaxCharges container are returned only when
Type: Container TaxInformationIndicator is present in request and when
Max Allowed: UNB Negotiated Rates are not applicable. TaxCharges container
Length: N/A contains Tax information for a given shipment.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 149
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/ShipmentCharges/TaxCharges/Type
Type Required: Yes* Tax Type code. The code represents the type of Tax applied to
Type: String a shipment.
Max Allowed: 1
Refer to Tax Type Values / Abbreviations in the Appendix for
Length: 1…9
valid values.
/ShipmentResponse/ShipmentResults/ShipmentCharges/TaxCharges/MonetaryValue
MonetaryValue Required: Yes* Tax Monetary Value represent the Tax amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipmentResponse/ShipmentResults/ShipmentCharges/TotalCharges
TotalCharges Required: Yes* Total charges container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/ShipmentCharges/TotalCharges/CurrencyCode
CurrencyCode Required: Yes* Total charges currency code type. The currency code used in
Type: String the Shipment request is returned.
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/ShipmentCharges/TotalCharges/MonetaryValue
MonetaryValue Required: Yes* Total charges value amount. Valid values are from 0 to 99999999999999.99 .
Type: String
Max Allowed: 1
Length: 1…19
/ShipmentResponse/ShipmentResults/ShipmentCharges/TotalChargesWithTaxes
TotalChargesWithTaxes Required: Cond TotalChargesWithTaxes container would be returned only if
Type: Container TaxInformationIndicator is present in request and when
Max Allowed: 1 Negotiated Rates are not applicable. TotalChargesWithTaxes
Length: N/A contains total charges including total taxes applied to a
shipment.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 150
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/ShipmentCharges/TotalChargesWithTaxes/CurrencyCode
CurrencyCode Required: Yes* TotalChargesWithTaxes currency code type. The currency
Type: String code used in the Shipment request is returned.
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/ShipmentCharges/TotalChargesWithTaxes/MonetaryValue
MonetaryValue Required: Yes* TotalChargesWithTaxes monetary value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

NegotiatedRateCharges

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/NegotiatedRateCharges
NegotiatedRateCharges Required: No Negotiated Rates Charge Container. For tiered rates and promotional discounts, if a
Type: Container particular shipment based on zone, origin, destination
Max Allowed: 1 or even shipment size doesn't qualify for the existing
Length: N/A discount then no negotiated rates container will be
returned. Published rates will be the applicable rate.
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned only when the subversion
Type: Container element is present and greater than or equal to '1601'.
Max Allowed: UNB
Length: N/A
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized charge.
Type: String
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/Description
Description Required: No Description of Itemized Charge that had been charged.
Type: String
Max Allowed: 1
Length: 1…50

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 151
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* Itemized Charges currency code type. The currency code
Type: String used in the Shipment request is returned.
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/SubType
SubType Required: No The sub-type of ItemizedCharge type.
Type: String
Max Allowed: 1
Length: 1…50
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/TaxCharges
TaxCharges Required: Cond TaxCharges container are returned only when
Type: Container TaxInformationIndicator is present in request. TaxCharges
Max Allowed: UNB container contains Tax information for a given shipment.
Length: N/A
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/TaxCharges/Type
Type Required: Yes* Tax Type code. The code represents the type of Tax applied to
Type: String a shipment.
Max Allowed: 1
Refer to Tax Type Values / Abbreviations in the Appendix for
Length: 1…9
valid values.
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/TaxCharges/MonetaryValue
MonetaryValue Required: Yes* Tax Monetary Value represent the Tax amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 152
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/TotalCharge
TotalCharge Required: No Total charges container. Account Based Rates info. Total
Type: Container charges are only returned for ABR eligible shipper
Max Allowed: 1 account/UserId combinations when the user includes the
Length: N/A NegotiatedRatesIndicator in the request.
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/TotalCharge/CurrencyCode
CurrencyCode Required: Yes* Total charges currency code.
Type: String
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/TotalCharge/MonetaryValue
MonetaryValue Required: Yes* Total charges monetary value. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/TotalChargesWithTaxes
TotalChargesWithTaxes Required: Cond TotalChargesWithTaxes container would be returned only if
Type: Container TaxInformationIndicator is present in request.
Max Allowed: 1 TotalChargesWithTaxes contains total charges including total
Length: N/A taxes applied to a shipment.
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/TotalChargesWithTaxes/CurrencyCode
CurrencyCode Required: Yes* TotalChargesWithTaxes currency code type. The currency
Type: String code used in the Shipment request is returned.
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/NegotiatedRateCharges/TotalChargesWithTaxes/MonetaryValue
MonetaryValue Required: Yes* TotalChargesWithTaxes monetary value amount. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 153
Shipping Package Web Service Developer Guide November 1, 2016

FRSShipmentData

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/FRSShipmentData
FRSShipmentData Required: Cond Ground Freight Pricing Shipment data container. Ground Freight
Type: Container Pricing shipment data is only guaranteed to be returned for
Max Allowed: 1 Ground Freight Pricing shipments only.
Length: N/A

TransportationCharges

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/FRSShipmentData/TransportationCharges
TransportationCharges Required: Yes* Transportation charges container. Ground Freight Pricing
Type: Container transportation charges. These are only returned for Ground
Max Allowed: 1 Freight Pricing enabled shipper account number when the
Length: N/A user includes the FRSShipmentIndicator in the request.
/ShipmentResponse/ShipmentResults/FRSShipmentData/TransportationCharges/GrossCharge
GrossCharge Required: Yes* Gross Charges container. It indicates the shipment level
Type: Container gross Ground Freight Pricing transportation charges.
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/FRSShipmentData/TransportationCharges/GrossCharge/CurrencyCode
CurrencyCode Required: Yes* Gross charges currency code.
Type: String
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/FRSShipmentData/TransportationCharges/GrossCharge/MonetaryValue
MonetaryValue Required: Yes* Gross charges monetary value. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 154
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/FRSShipmentData/TransportationCharges/DiscountAmount
DiscountAmount Required: Yes* Discount Amount container. It indicates the shipment level
Type: Container Ground Freight Pricing discount amount for transportation
Max Allowed: 1 charges
Length: N/A
/ShipmentResponse/ShipmentResults/FRSShipmentData/TransportationCharges/DiscountAmount/CurrencyCode
CurrencyCode Required: Yes* Discount Amount currency code.
Type: String
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/FRSShipmentData/TransportationCharges/DiscountAmount/MonetaryValue
MonetaryValue Required: Yes* Discount amount monetary value. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipmentResponse/ShipmentResults/FRSShipmentData/TransportationCharges/DiscountPercentage
DiscountPercentage Required: Yes* It indicates the shipment level discount percentage for
Type: String transportation charges.
Max Allowed: 1
Length: 1…5
/ShipmentResponse/ShipmentResults/FRSShipmentData/TransportationCharges/NetCharge
NetCharge Required: Yes* Net Charges container. It indicates the shipment level net
Type: Container Ground Freight Pricing transportation charges.
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/FRSShipmentData/TransportationCharges/NetCharge/CurrencyCode
CurrencyCode Required: Yes* Net Charge currency code.
Type: String
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/FRSShipmentData/TransportationCharges/NetCharge/MonetaryValue
MonetaryValue Required: Yes* Net charges monetary value. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 155
Shipping Package Web Service Developer Guide November 1, 2016
FreightDensityRate

NAME Constarint Description Validation

/ShipmentResponse/ShipmentResults/FRSShipmentData/FreightDensityRate
FreightDensityRate Required: No FreightDensityRate container for Density based rating.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/FRSShipmentData/FreightDensityRate/Density
Density Required: Yes* Density is returned if the Shipper is eligible for Density based rate. Valid values are 0 to 999.9
Type: String
Max Allowed: 1
Length: 1…5
/ShipmentResponse/ShipmentResults/FRSShipmentData/FreightDensityRate/TotalCubicFeet
TotalCubicFeet Required: Yes* TotalCubic feet is returned if the Shipper is eligible for Density based rate. Valid values are 0 to
Type: String 99999.999
Max Allowed: 1
Length: 1…9

HandlingUnits

Name Constraints Description Validation

/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits
HandlingUnits Required: Cond Handling Unit for Density based rating container.
Type: Container
Max Allowed: 50
Length: N/A
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Quantity
Quantity Required: Yes* Handling Unit Quantity for Density based rating.
Type: String
Max Allowed: 1
Length: 8

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 156
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraints Description Validation

/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Type
Type Required: Yes* Handling Unit Type for Density based rating.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Type/Code
Code Required: Yes* The code associated with Handling Unit Type. Valid values:
Type: String SKD = Skid
Max Allowed: 1 CBY = Carboy
Length: 3 PLT = Pallet
TOT = Totes
LOO = Loose
OTH = Other
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Type/Description
Description Required: No A description of the code for the Handling Unit type.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions
Dimensions Required: Yes* Dimension of the HandlingUnit container for density
Type: Container based pricing.
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/UnitOfMeasurement
UnitOfMeasurement Required: Yes* UnitOfMeasurement container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/UnitOfMeasurement/Code
Code Required: Yes* Code for UnitOfMeasurement for the line item
Type: String dimension.
Max Allowed: 1
Valid value: IN = Inches
Length: 3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 157
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraints Description Validation

/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/UnitOfMeasurement/Description
Description Required: No Description for UnitOfMeasurement for the line item
Type: String dimension.
Max Allowed: 1
Length: 1…35
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/Length
Length Required: Yes* The length of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/Width
Width Required: Yes* The width of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/Height
Height Required: Yes* The height of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight
AdjustedHeight Required: Cond Container to hold Adjusted Height information.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight/Value
Value Required: Yes* Adjusted Height value for the handling unit. Height Adjustment is done only when Handling unit
Type: String type is SKD = Skid or PLT = Pallet.
Max Allowed: 1
Length: 1…19

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 158
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraints Description Validation

/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Unit of Measurement container for the Adjusted
Type: Container height.
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight/UnitOfMeasurement/Code
Code Required: Yes* Code associated with Unit of Measurement for the
Type: String Adjusted height.
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight/UnitOfMeasurement/Description
Description Required: No Description for Code associated with Unit of
Type: String Measurement for the Adjusted height.
Max Allowed: 1
Length: 1…35

RatingMethod

Name Constraint Description Validation

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

BillableWeightCalculationMethod

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/BillableWeightCalculationMethod
BillableWeightCalculationMethod Required: Cond BillableWeightCalculationMethod is to indicate whether the Valid values are 01 = Shipment Billable Weight, 02 =
Type: String billable weight calculation method utilized was - the package Package Billable Weight.
Max Allowed: 1 level or shipment level. This information will be returned only if
Length: 2 RatingMethodRequestedIndicator is present in the request.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 159
Shipping Package Web Service Developer Guide November 1, 2016

BillingWeight

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/BillingWeight
BillingWeight Required: Yes Billing Weight container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/BillingWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes Billing weight unit of measurement code. The unit of
Type: Container measurement used in Shipment request is returned.
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/BillingWeight/UnitOfMeasurement/Code
Code Required: Yes Code of the billing weight measurement units. Values are: KGS
Type: String or LBS.
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/BillingWeight/UnitOfMeasurement/Description
Description Required: No Description of the billing weight measurement units.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentResponse/ShipmentResults/BillingWeight/Weight
Weight Required: Yes Billing weight. Higher of the actual shipment weight versus the
Type: String shipment dimensional weight.
Max Allowed: 1
Length: 8

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 160
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentIdentificationNumber

Name Constraint Description Validation

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

ShipmentDigest

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/ShipmentDigest
ShipmentDigest Required: Cond Encoded shipment parameters required to be passed in the
Type: String accept phase.
Max Allowed: 1
Applicable only for ShipConfirmResponse.
Length:
Unbounded

PackageResults

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/PackageResults
PackageResults Required: No Returned Package Information.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: UNB
ShipAcceptResponse.
Length: N/A
/ShipmentResponse/ShipmentResults/PackageResults/TrackingNumber
TrackingNumber Required: Yes* Package 1Z number.
Type: String
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse. For Mail Innovations shipments,
Length: 18
please use the USPSPICNumber when tracking
packages (a non-1Z number Mail Manifest Id is
returned).

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 161
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/PackageResults/ServiceOptionsCharges
ServiceOptionsCharges Required: Cond Shipment charges info. Shipment charges are only
Type: Container guaranteed to be returned for shipments whose origin
Max Allowed: 1 country is US or Puerto Rico.
Length: N/A
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipmentResponse/ShipmentResults/PackageResults/ServiceOptionsCharges/CurrencyCode
CurrencyCode Required: Yes* Package accessorial charges currency code type. The
Type: String currency code used in the Shipment request is returned.
Max Allowed: 1
Applicable only for ShipmentResponse and
Length: 3
ShipAcceptResponse.
/ShipmentResponse/ShipmentResults/PackageResults/ServiceOptionsCharges/MonetaryValue
MonetaryValue Required: Yes* Package accessorial charges value amount. Valid
Type: String values are from 0 to 99999999999999.99
Max Allowed: 1
Applicable only for ShipmentResponse and
Length: 1…19
ShipAcceptResponse.
/ShipmentResponse/ShipmentResults/PackageResults/ShippingLabel
ShippingLabel Required: Cond The container for UPS shipping label. Shipment without
Type: Container return service or with PRL returns service.
Max Allowed: 1
Applicable only for ShipmentResponse and
Length: N/A
ShipAcceptResponse.
/ShipmentResponse/ShipmentResults/PackageResults/ShippingLabel/ImageFormat
ImageFormat Required: Yes* The container image format.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 162
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/PackageResults/ShippingLabel/ImageFormat/Code
Code Required: Yes* Label image code that the labels are generated. For multi piece COD shipments, the label image
Type: String format for the first package will always be a GIF for
Values are:
Max Allowed: 1 any form of label requested.
Length: 3 • EPL = EPL2
• SPL = SPL
• ZPL = ZPL
• GIF = gif images
• PNG for PNG images
Only EPL, SPL, ZPL and GIF are currently supported.
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipmentResponse/ShipmentResults/PackageResults/ShippingLabel/ImageFormat/Description
Description Required: No Description of the label image format code.
Type: String
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: 1…35
/ShipmentResponse/ShipmentResults/PackageResults/ShippingLabel/GraphicImage
GraphicImage Required: Yes* Base 64 encoded graphic image.
Type: Base 64 Encoded
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: Unbounded
/ShipmentResponse/ShipmentResults/PackageResults/ShippingLabel/InternationalSignatureGraphicImage
InternationalSignatureGraphicImage Required: Cond Base 64 encoded graphic image of the Warsaw text and
Type: Base 64 Encoded signature box. EPL2, ZPL and SPL labels.
Max Allowed: 1
The image will be returned for non-US based
Length: Unbounded
shipments. One image will be given per shipment and it
will be in the first PackageResults container.
Applicable only for ShipmentResponse and
ShipAcceptResponse.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 163
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/PackageResults/ShippingLabel/HTMLImage
HTMLImage Required: Cond Base 64 encoded html browser image rendering
Type: Base 64 Encoded software. This is only returned for gif and png image
Max Allowed: 1 formats.
Length: Unbounded
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipmentResponse/ShipmentResults/PackageResults/ShippingLabel/PDF417
PDF417 Required: Cond PDF-417 is a two-dimensional barcode, which can store
Type: Base 64 Encoded up to about 1,800 printable ASCII characters or 1,100
Max Allowed: 1 binary characters per symbol. The symbol is
Length: Unbounded rectangular. The image is Base 64 encoded and
returned if the LabelImageFormat code is GIF.
Shipment with PRL return service only.
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipmentResponse/ShipmentResults/PackageResults/ShippingReceipt
ShippingReceipt Required: Cond Container for the receipt of a return shipment. Not
Type: Container supported for ERL or PRL shipments.
Max Allowed: 1
Applicable only for ShipmentResponse and
Length: N/A
ShipAcceptResponse.
/ShipmentResponse/ShipmentResults/PackageResults/ShippingReceipt/ImageFormat
ImageFormat Required: Yes* Container for a Image Format.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A
/ShipmentResponse/ShipmentResults/PackageResults/ShippingReceipt/ImageFormat/Code
Code Required: Yes* Code representing the format in which a receipt is
Type: String delivered.
Max Allowed: 1
Valid values: HTML = HTML format.
Length: 4
Applicable only for ShipmentResponse and
ShipAcceptResponse.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 164
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/PackageResults/ShippingReceipt/ImageFormat/Description
Description Required: No Description of the image format code.
Type: String
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: 1…35
/ShipmentResponse/ShipmentResults/PackageResults/ShippingReceipt/GraphicImage
GraphicImage Required: Yes* Base 64 encoded PRL receipt in HTML format.
Type: Base 64 Encoded
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: Unbounded
/ShipmentResponse/ShipmentResults/PackageResults/USPSPICNumber
USPSPICNumber Required: Cond USPSPICNumber is USPS Package Identification; it
Type: String should be used for tracking Mail Innovations shipments.
Max Allowed: 1
Length: Unbounded
/ShipmentResponse/ShipmentResults/PackageResults/CN22Number
CN22Number Required: Cond USPS defined CN22 ID number format varies based on
Type: String destination country. Not applicable as of Jan 2015. Mail
Max Allowed: 1 Innovations shipments US to VI, PR, and GU are not
Length: N/A considered international.
/ShipmentResponse/ShipmentResults/PackageResults/Accessorial
Accessorial Required: Cond The container for Accessorial indicators. This This is valid only for UPS Worldwide Express
Type: Container information would be returned only if Freight Service.
Max Allowed: UNB ItemizedChargesRequested was present during request
Length: N/A This is valid only for UPS Worldwide Express Freight
Service.
/ShipmentResponse/ShipmentResults/PackageResults/Accessorial/Code
Code Required: Yes* Code for Accessorial Indicator.
Type: String
Max Allowed: 1
Length: 3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 165
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/PackageResults/Accessorial/Description
Description Required: No Description for Accessorial Indicator.
Type: String
Max Allowed: 1
Length: 1…50
/ShipmentResponse/ShipmentResults/PackageResults/Form
Form Required: Cond Container tag for the International forms image. Currenlty this container would be returned for UPS
Type: Container Premium Care shipments.
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/PackageResults/Form/Code
Code Required: Yes* Code that indicates the type of form. Possible Values 01 - All Requested International
Type: String Forms.
Max Allowed: 1
Length: 2
/ShipmentResponse/ShipmentResults/PackageResults/Form/Description
Description Required: No Description that indicates the type of form. Possible Values : All Requested International
Type: String Forms.
Max Allowed: 1
Length: 1…35
/ShipmentResponse/ShipmentResults/PackageResults/Form/Image
Image Required: Cond Container tag for the International forms image.
Type: Container
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/PackageResults/Form/Image/ImageFormat
ImageFormat Required: Cond Container tag for the International forms image format
Type: Container information.
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 166
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

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

ItemizedCharges

Name Constraints Description Validation

/ShipmentResponse/ShipmentResults/PackageResults/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned only when the Subversion element is present and greater than or equal
Type: Container to '1607'.
Max Allowed: UNB
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 167
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraints Description Validation

/ShipmentResponse/ShipmentResults/PackageResults/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized charge.
Type: String
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/PackageResults/ItemizedCharges/Description
Description Required: No Description of Itemized Charge that had been charged.
Type: String
Max Allowed: 1
Length: 1…50
/ShipmentResponse/ShipmentResults/PackageResults/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code associated with the Itemized Charge costs for the shipment.
Type: String
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/PackageResults/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount.
Type: String
Max Allowed: 1
Length: 16.2
/ShipmentResponse/ShipmentResults/PackageResults/ItemizedCharges/SubType
SubType Required: No The sub-type of ItemizedCharge type.
Type: String
Max Allowed: 1
Length: 1…50

NegotiatedCharges

Name Constraints Description Validation

/ShipmentResponse/ShipmentResults/PackageResults/NegotiatedCharges
NegotiatedRateCharges Required: Cond Negotiated Rates Charge Container. These charges would be returned only when:
Type: Container 1) subversion is greater than or equal to 1607
Max Allowed: 1 2) if negotiated rates were requested for GFP shipments and
Length: N/A account number is eligible to receive negotiated rates.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 168
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraints Description Validation

/ShipmentResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges
ItemizedCharges Required: Cond Negotiated Itemized Accessorial and Sur Charges.
Type: Container
These charges would be returned only when
Max Allowed: UNB
subversion is greater than or equal to 1607
Length: N/A
/ShipmentResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized charge.
Type: String
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/Description
Description Required: No Description of Itemized Charge that had been
Type: String charged.
Max Allowed: 1
Length: 1…50
/ShipmentResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code associated with the
Type: String Itemized Charge costs for the shipment.
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount.
Type: String
Max Allowed: 1
Length: 16.2
/ShipmentResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/SubType
SubType Required: No The sub-type of ItemizedCharge type.
Type: String
Max Allowed: 1
Length: 1…50

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 169
Shipping Package Web Service Developer Guide November 1, 2016

ControlLogReceipt

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 170
Shipping Package Web Service Developer Guide November 1, 2016

Form

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 171
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

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

CODTurnInPage

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/CODTurnInPage
CODTurnInPage Required: No The container of the COD Turn In Page.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 172
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/CODTurnInPage/Image
Image Required: Yes* The container of the image for COD Turn In Page.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A
/ShipmentResponse/ShipmentResults/CODTurnInPage/Image/ImageFormat
ImageFormat Required: Yes* The container for format of COD Turn In Page.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A
/ShipmentResponse/ShipmentResults/CODTurnInPage/Image/ImageFormat/Code
Code Required: Yes* Format code of the generated COD Turn In Page. Valid values:
Type: String
HTML = HTML format.
Max Allowed: 1
Length: 4 Only HTML format is supported for COD Turn In Page.
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipmentResponse/ShipmentResults/CODTurnInPage/Image/ImageFormat/Description
Description Required: No Description of the format code of generated COD Turn In page.
Type: String
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: 1…35
/ShipmentResponse/ShipmentResults/CODTurnInPage/Image/GraphicImage
GraphicImage Required: Yes* Base 64 encoded html browser image rendering software.
Type: Base 64
Applicable only for ShipmentResponse and
Encoded
ShipAcceptResponse.
Max Allowed: 1
Length: Unbounded

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 173
Shipping Package Web Service Developer Guide November 1, 2016

HighValueReport

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/HighValueReport
HighValueReport Required: Cond Container for the HighValue Report generated for ImportControl
Type: Container or Return shipments with high package declared value.
Max Allowed: 1
Applicable for one pass ShipmentResponse and two-pass
Length: N/A
ShipAcceptResponse.
/ShipmentResponse/ShipmentResults/HighValueReport/Image
Image Required: Yes* Container for the HighValue Report image for Import Control
Type: Container Shipments.
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/HighValueReport/Image/ImageFormat
ImageFormat Required: Yes* Container for the HighValue Report image format information for
Type: Container Import Control Shipments.
Max Allowed: 1
Length: N/A
/ShipmentResponse/ShipmentResults/HighValueReport/Image/ImageFormat/Code
Code Required: Yes* Code representing the format in which the HighValueReport is
Type: String generated. Possible Values: PDF = 'pdf'
Max Allowed: 1
Length: 3
/ShipmentResponse/ShipmentResults/HighValueReport/Image/ImageFormat/Description
Description Required: No Description of the image format.
Type: String
Max Allowed: 1
Length: 1…35
/ShipmentResponse/ShipmentResults/HighValueReport/Image/GraphicImage
GraphicImage Required: Yes* Base 64 Encoded PDF Image.
Type: Base 64
Encoded
Max Allowed: 1
Length: Unbounded

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 174
Shipping Package Web Service Developer Guide November 1, 2016

LabelURL

Name Constraint Description Validation

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

LocalLanguageLabelURL

Name Constraint Description Validation

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

ReceiptURL

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 175
Shipping Package Web Service Developer Guide November 1, 2016

LocalLanguageReceiptURL

Name Constraint Description Validation

/ShipmentResponse/ShipmentResults/LocalLanguageReceiptURL
LocalLanguageReceiptURL Required: Cond LocalLanguageReceiptURL is returned if the
Type: String LabelLinksIndicator is requested for an ImportControl shipment
Max Allowed: 1 or a Return shipment.
Length:
The URL will contain the receipt in the Country's local language
Unbounded
if supported by UPS.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 176
Chapter 5: Ship Confirm API Elements and Details

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 177
Shipping Package Web Service Developer Guide November 1, 2016

ShipConfirmRequest Top Level Containers

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 178
Shipping Package Web Service Developer Guide November 1, 2016

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 179
Shipping Package Web Service Developer Guide November 1, 2016

ShipConfirmRequest XPath Tables

Note: Not all containers/elements are reflected separately in the table of contents.

Name Constraint Description Validation

/ShipConfirmRequest
ShipConfirmRequest Required: Yes Request container for Ship Confirm Request.
Type: Container
Max Allowed: 1
Length: N/A

Request
Name Constraint Description Validation
/ShipConfirmRequest/Request
Request Required: Yes Request Container
Type: Container
Max Allowed: 1
Length: N/A

RequestOption

Name Constraint Description Validation

/ShipConfirmRequest/Request/RequestOption
RequestOption Required: Yes Optional Processing. Valid values are validate and nonvalidate.
Type: String
nonvalidate = No street level address validation would be
Max Allowed: 1
performed, but Postal Code/State combination validation would
Length: 1…15
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 Tool User to ensure the address
entered is correct to avoid an address correction fee.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 180
Shipping Package Web Service Developer Guide November 1, 2016

SubVersion

Name Constraint Description Validation

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

TransactionReference

Name Constraint Description Validation

/ShipConfirmRequest/Request/TransactionReference
TransactionReference Required: No TransactionReference identifies transactions between client and
Type: Container server.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Request/TransactionReference/CustomerContext
CustomerContext Required: No The client uses CustomerContext to synchronize
Type: String request/response pairs. The client establishes CustomerContext,
Max Allowed: 1 which can contain any information client want, as long as it is valid
Length: 1…512 XML; it is echoed back by the server.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 181
Shipping Package Web Service Developer Guide November 1, 2016

Shipment
Name Constraint Description Validation
/ShipConfirmRequest/Shipment
Shipment Required: Yes Shipment Container
Type: Container
Max Allowed: 1
Length: N/A

Description

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Description
Description Required: Cond The Description of Goods for the shipment. Applies to Required if all of the listed conditions are true:
Type: String international and domestic shipments.
Max Allowed: 1 • ShipFrom and ShipTo countries are not the same;
Provide a detailed description of items being shipped for
Length: 1…35 • The packaging type is not UPS Letter;
documents and non-documents.
Provide specific descriptions, such as "annual reports" and "9 mm • The ShipFrom and or ShipTo countries are not in the
steel screws". European Union or
• The ShipFrom and ShipTo countries are both in the
European Union and the shipments service type is not
UPS Standard.

ReturnService

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 182
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ReturnService/Code
Code Required: Yes* Return Service types:
Type: String
2 = UPS Print and Mail (PNM)
Max Allowed: 1
Length: 1…2 3 = UPS Return Service 1-Attempt (RS1)
5 = UPS Return Service 3-Attempt (RS3)
8 = UPS Electronic Return Label (ERL)
9 = UPS Print Return Label (PRL)
10 = UPS Exchange Print Return Label
11 = UPS Pack & Collect Service 1-Attempt Box 1
12 = UPS Pack & Collect Service 1-Attempt Box 2
13 = UPS Pack & Collect Service 1-Attempt Box 3
14 = UPS Pack & Collect Service 1-Attempt Box 4
15 = UPS Pack & Collect Service 1-Attempt Box 5
16 = UPS Pack & Collect Service 3-Attempt Box 1
17 = UPS Pack & Collect Service 3-Attempt Box 2
18 = UPS Pack & Collect Service 3-Attempt Box 3
19 = UPS Pack & Collect Service 3-Attempt Box 4
20 = UPS Pack & Collect Service 3-Attempt Box 5
/ShipConfirmRequest/Shipment/ReturnService/Description
Description Required: No Return Service description
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 183
Shipping Package Web Service Developer Guide November 1, 2016

DocumentsOnlyIndicator

Name Constraint Description Validation

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

Shipper

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Shipper
Shipper Required: Yes Container tag for Shipper’s information
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Shipper/Name
Name Required: Yes Shipper's company name. For forward Shipment 35 characters
Type: String are accepted, but only 30 characters will be printed on the label.
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/Shipper/AttentionName
AttentionName Required: Cond Shipper's Attention Name. For forward Shipment 35 characters Required if destination is international. Required if Invoice
Type: String are accepted, but only 30 characters will be printed on the label. and CO International forms are requested and the
Max Allowed: 1 ShipFrom address is not present.
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 184
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Shipper/CompanyDisplayableName
CompanyDisplayableName Required: No Shipper's CompanyDisplayableName This is available for Shipper accounts enabled by UPS
Type: String and applies to Forward Shipments.
Max Allowed: 1
The CompanyDisplayableName will be displayed in
Length: 1…35
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.
/ShipConfirmRequest/Shipment/Shipper/TaxIdentificationNumber
TaxIdentificationNumber Required: Cond Shipper’s Tax Identification Number Conditionally required if EEI form (International forms) is
Type: String requested and ship From is not mentioned.
Max Allowed: 1
Length: 1…15
/ShipConfirmRequest/Shipment/Shipper/Phone
Phone Required: Cond Container tag for Phone Number
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Shipper/Phone/Number
Number Required: Yes* Shipper’s phone Number. Valid values are 0 - 9.
Type: String
If Shipper country is U.S., PR, CA, and VI, the layout is
Max Allowed: 1
area code, 7 digit PhoneNumber or area code, 7 digit
Length: 1…15
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.
/ShipConfirmRequest/Shipment/Shipper/Phone/Extension
Extension Required: No Shipper’s phone extension.
Type: String
Max Allowed: 1
Length: 1…4

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 185
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Shipper/ShipperNumber
ShipperNumber Required: Yes Shipper’s six digit account number. Size must be six alphanumeric characters. Must be
Type: String associated with the UserId specified in the
Max Allowed: 1 AccessRequest XML The account must be a valid UPS
Length: 6 account number that is active.
For U.S., 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.
/ShipConfirmRequest/Shipment/Shipper/FaxNumber
FaxNumber Required: No Shipper’s Fax Number.
Type: String
Max Allowed: 1
Length: 1…14
/ShipConfirmRequest/Shipment/Shipper/EMailAddress
EMailAddress Required: No Shipper’s email address.
Type: String
Max Allowed: 1
Length: 1…50
/ShipConfirmRequest/Shipment/Shipper/Address
Address Required: Yes Address tag Container. The package should be returned to this address if the
Type: Container package is undeliverable.
Max Allowed: 1
This address appears on the upper left hand corner of the
Length: N/A
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 186
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Shipper/Address/AddressLine
AddressLine Required: Yes The Shipper street address including name and number (when Maximum Occurrence should be three.
Type: String applicable).
Max Allowed:3
Up to three occurrences are allowed; only the first is printed on
Length: 1…35
the label.
35 characters are accepted, but for the first occurrence, only 30
characters will be printed on the label for return shipments.
/ShipConfirmRequest/Shipment/Shipper/Address/City
City Required: Yes The shipper's City. For forward Shipment 30 characters are
Type: String accepted, but only 15 characters will be printed on the label.
Max Allowed: 1
Length: 1…30
/ShipConfirmRequest/Shipment/Shipper/Address/StateProvinceCode
StateProvinceCode Required: Cond Shipper's state or province code. For forward Shipment 5 Required if shipper is in the U.S. or CA. If Shipper country
Type: String characters are accepted, but only 2 characters will be printed on is U.S. or CA, then the value must be a valid U.S.
Max Allowed: 1 the label. State/Canadian Province code. If the country is Ireland,
Length: 2…5 the StateProvinceCode will contain the county.
/ShipConfirmRequest/Shipment/Shipper/Address/PostalCode
PostalCode Required: Cond Shipper’s postal code. If Shipper country is U.S. or Puerto Rico, 5 or 9 digits are
Type: String required. The character - may be used to separate the first
Max Allowed: 1 five digits and the last four digits.
Length: 1…9
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 187
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Shipper/Address/CountryCode
CountryCode Required: Yes Shipper’s country code. Refer to Origin Country Information table Must be a valid UPS Billing country code. For Forward
Type: String for valid origin countries and their UPS Billing codes. shipments it must also be an allowable UPS origin
Max Allowed: 1 country. For Return Shipment the country code must meet
Length: 2 the following conditions:
1) At least two of the following country codes are the
same: ShipTo, ShipFrom, and Shipper.
2) None of the following country codes are the same and
are a member of the EU: ShipTo, ShipFrom, and Shipper.
3) If any of the two following country codes: ShipTo/
ShipFrom/ Shipper are members in EU otherwise check if
the shipper has Third Country Contract.

ShipTo

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipTo
ShipTo Required: Yes Ship To Container
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipTo/Name
Name Required: Yes Consignee’s company name.
Type: String
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/ShipTo/AttentionName
AttentionName Required: Cond Contact name at the consignee’s location. Required for: UPS Next Day Air® Early service, and
Type: String when ShipTo country is different than ShipFrom country.
Max Allowed: 1
Required if Invoice International form is requested
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 188
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipTo/CompanyDisplayableName
CompanyDisplayableName Required: No Not applicable for ShipTo
Type: String
Max Allowed: 1
Length: 1..35
/ShipConfirmRequest/Shipment/ShipTo/TaxIdentificationNumber
TaxIdentificationNumber Required: No Consignee’s tax identification number.
Type: String
Max Allowed: 1
Length: 1…15
/ShipConfirmRequest/Shipment/ShipTo/Phone
Phone Required: Cond Container for Phone Number
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipTo/Phone/Number
Number Required: Yes* Consignee’s phone Number. Required for: UPS Next Day Air® Early service, and
Type: String when Ship To country is different than the ShipFrom
Max Allowed: 1 country.
Length: 1…15
If ShipTo country is U.S., PR, CA, and VI, the layout is
area code, 7 digit PhoneNumber or area code, 7 digit
PhoneNumber, 4 digit extension number; number;
For other countries, the layout is CountryCode, area
code, 7 digit number.
/ShipConfirmRequest/Shipment/ShipTo/Phone/Extension
Extension Required: No Consignee’s phone extension.
Type: String
Max Allowed: 1
Length: 1…4
/ShipConfirmRequest/Shipment/ShipTo/FaxNumber
FaxNumber Required: No Consignee’s fax number. If ShipTo country is U.S. 10 digits allowed, otherwise 1-15
Type: String digits allowed.
Max Allowed: 1
Length: 1…15

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 189
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipTo/EMailAddress
EMailAddress Required: No Consignee’s email address.
Type: String
Max Allowed: 1
Length: 1…50
/ShipConfirmRequest/Shipment/ShipTo/Address
Address Required: Yes Address Container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipTo/Address/AddressLine
AddressLine Required: Yes Address Line of the consignee. Max occurrence: 3
Type: String
Max Allowed:3
Length: 1…35
/ShipConfirmRequest/Shipment/ShipTo/Address/City
City Required: Yes Consignee’s city. 30 characters are accepted, but only 15
Type: String characters will be printed on the label.
Max Allowed: 1
Length: 1…30
/ShipConfirmRequest/Shipment/ShipTo/Address/StateProvinceCode
StateProvinceCode Required: Cond Consignee’s state or province code. Required for U.S. or If destination is U.S. or CA, then the value must be a valid
Type: String Canada. U.S. State/Canadian Province code. If the country is
Max Allowed: 1 Ireland, the StateProvinceCode will contain the county.
Length: 2…5
/ShipConfirmRequest/Shipment/ShipTo/Address/PostalCode
PostalCode Required: Cond Consignee’s postal code. If the ShipTo country is U.S. or Puerto Rico, 5 or 9 digits
Type: String are required. If the ShipTo country is CA, then the postal
Max Allowed: 1 code is required and must be 6 alphanumeric characters
Length: 1…9 whose format is A#A#A# where A is an uppercase letter
and # is a digit. Otherwise optional.
For all other countries the postal code is optional and
must be no more than 9 alphanumeric characters long.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 190
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipTo/Address/CountryCode
CountryCode Required: Yes Consignee’s country code. Must be a valid UPS Billing country code. For Return
Type: String Shipment the country code must meet the following
Max Allowed: 1 conditions:
Length: 2
1) At least two of the following country codes are the
same: ShipTo, ShipFrom, and Shipper.
2) None of the following country codes are the same and
are a member of the EU: ShipTo, ShipFrom, and Shipper.
3) If any of the two following country codes: ShipTo/
ShipFrom/ Shipper are members in EU otherwise check if
the shipper has Third Country Contract.
/ShipConfirmRequest/Shipment/ShipTo/Address/ResidentialAddressIndicator
ResidentialAddressIndicator Required: No This field is a flag to indicate if the receiver is a residential Empty Tag.
Type: String location. True if ResidentialAddressIndicator tag exists; false
Max Allowed: 1 otherwise
Length: 0
/ShipConfirmRequest/Shipment/ShipTo/LocationID
LocationID Required: No Location ID is a unique identifier referring to a specific Location ID must be alphanumeric characters. All letters
Type: String shipping/receiving location. must be capitalized.
Max Allowed: 1
Length: 3…10

AlternateDeliveryAddress

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/AlternateDeliveryAddress
AlternateDeliveryAddress Required: Cond AlternateDeliveryAddress Container. Alternate Delivery Address (UPS Access Point
Type: Container Address) required if ShipmentIndicationType is '01' or
Max Allowed: 1 '02'.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 191
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/AlternateDeliveryAddress/Name
Name Required: Yes* Retail Location Name.
Type: String
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/AlternateDeliveryAddress/AttentionName
AttentionName Required: No Attention Name.
Type: String
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/AlternateDeliveryAddress/UPSAccessPointID
UPSAccessPointID Required: No UPS Access Point ID.
Type: String
Max Allowed: 1
Length: 9
/ShipConfirmRequest/Shipment/AlternateDeliveryAddress/Address
Address Required: Yes* Address Container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/AlternateDeliveryAddress/Address/AddressLine
AddressLine Required: Yes* Address Line of the Retail Location. Max occurrence: 3
Type: String
Max Allowed:3
Length: 1…35
/ShipConfirmRequest/Shipment/AlternateDeliveryAddress/Address/City
City Required: Yes* Retail Location City.
Type: String
Max Allowed: 1
Length: 1…30

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 192
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/AlternateDeliveryAddress/Address/StateProvinceCode
StateProvinceCode Required: Cond Retail Location state or province code. Required for U.S. or If destination is U.S. or CA, then the value must be a
Type: String Canada. valid U.S. State/Canadian Province code. If the country
Max Allowed: 1 is Ireland, the StateProvinceCode will contain the
Length: 2…5 county.
/ShipConfirmRequest/Shipment/AlternateDeliveryAddress/Address/PostalCode
PostalCode Required: Cond If the Alternate Delivery Address country is U.S. or Puerto
Type: String Rico, 5 or 9 digits are required.
Max Allowed: 1
The character - may be used to separate the first five digits
Length: 1…9
and the last four digits.
If the Alternate Delivery Address country is CA, then the postal
code is required and must be 6 alphanumeric characters
whose format is A#A#A# where A is an uppercase letter and #
is a digit.
Otherwise optional.
For all other countries the postal code is optional and must be
no more than 9 alphanumeric characters long.
/ShipConfirmRequest/Shipment/AlternateDeliveryAddress/Address/CountryCode
CountryCode Required: Yes* Retail Location country code.
Type: String
Max Allowed: 1
Length: 2
/ShipConfirmRequest/Shipment/AlternateDeliveryAddress/Address/ResidentialAddressIndicator
ResidentialAddressIndicator Required: No This field is a flag to indicate if the receiver is a residential Empty Tag.
Type: String location.
Max Allowed: 1
True if ResidentialAddressIndicator tag exists; false otherwise.
Length: 0
/ShipConfirmRequest/Shipment/AlternateDeliveryAddress/Address/POBoxIndicator
POBoxIndicator Required: No This field is a flag to indicate if the receiver address has PO POBoxIndicator is not valid for
Type: String box indicator. AlternateDeliveryAddress.
Max Allowed: 1
True if POBoxIndicator tag exists; false otherwise.
Length: 0

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 193
Shipping Package Web Service Developer Guide November 1, 2016

ShipFrom

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipFrom
ShipFrom Required: Cond Ship From Container Required for return shipment. Required if pickup location
Type: Container is different from the shipper’s address.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipFrom/Name
Name Required: Yes* The ship from location’s name or company name. 35 characters Required if ShipFrom tag is in the XML.
Type: String are accepted, but for return Shipment only 30 characters will be
Max Allowed: 1 printed on the label.
Length: 1…35
/ShipConfirmRequest/Shipment/ShipFrom/AttentionName
AttentionName Required: Cond The ship from Attention name. 35 characters are accepted, but for Required if ShipFrom tag is in the XML and Invoice or CO
Type: String return Shipment only 30 characters will be printed on the label. International forms is requested. If not present, will default
Max Allowed: 1 to the Shipper Attention Name.
Length: 1…35
/ShipConfirmRequest/Shipment/ShipFrom/CompanyDisplayableName
CompanyDisplayableName Required: No Not applicable for ShipFrom
Type: String
Max Allowed: 1
Length: 1..35
/ShipConfirmRequest/Shipment/ShipFrom/TaxIdentificationNumber
TaxIdentificationNumber Required: Cond Company’s Tax Identification Number at the pick up location Conditionally required if EEI form (International forms) is
Type: String requested.
Max Allowed: 1
Length: 1…15
/ShipConfirmRequest/Shipment/ShipFrom/TaxIDType
TaxIDType Required: Cond Tax Identification Container. Applies to EEI form only.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 194
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipFrom/TaxIDType/Code
Code Required: Yes* Company's tax Identification type. Valid values: EIN, DNS, and FGN. Applies to EEI form
Type: String only.
Max Allowed: 1
Length: 6
/ShipConfirmRequest/Shipment/ShipFrom/TaxIDType/Description
Description Required: No Description of TaxID submitted. Applies to EEI form only.
Type: String
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/ShipFrom/Phone
Phone Required: Cond Container for Phone Number If ShipFrom country is US, PR, CA, and VI, the layout is
Type: Container area code, 7 digit phone number or area code, 7 digit
Max Allowed: 1 phone number, 4 digit extension number; for other
Length: N/A countries, the layout is CountryCode, area code, 7 digit
number.
Required if ShipFrom tag is in the XML and International
forms is requested.
/ShipConfirmRequest/Shipment/ShipFrom/Phone/Number
Number Required: Yes* The Ship from phone Number.
Type: String
Max Allowed: 1
Length: 1…15
/ShipConfirmRequest/Shipment/ShipFrom/Phone/Extension
Extension Required: No The Ship from phone extension.
Type: String
Max Allowed: 1
Length: 1…4
/ShipConfirmRequest/Shipment/ShipFrom/FaxNumber
FaxNumber Required: No The Ship from fax number. If Ship from country is U.S. 10 digits allowed, otherwise 1-
Type: String 15 digits allowed.
Max Allowed: 1
Length: 1…15

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 195
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipFrom/Address
Address Required: Yes* Ship from Address Container. The package will be originating from or being shipped
Type: Container from this address. The shipment will be rated from this
Max Allowed: 1 origin address to the destination ship to address.
Length: N/A
/ShipConfirmRequest/Shipment/ShipFrom/Address/AddressLine
AddressLine Required: Yes* The Ship from street address including name and number (when Max occurrence: 3
Type: String applicable). 35 characters are accepted, but for return Shipment
Max Allowed:3 only 30 characters will be printed on the label.
Length: 1…35
/ShipConfirmRequest/Shipment/ShipFrom/Address/City
City Required: Yes* The Ship from city. 30 characters are accepted, but for return Required if ShipFrom tag is in the XML.
Type: String Shipment only 15 characters will be printed on the label.
Max Allowed: 1
Length: 1…30
/ShipConfirmRequest/Shipment/ShipFrom/Address/StateProvinceCode
StateProvinceCode Required: Cond Origin location's state or province code. Required if ShipFrom tag is in the XML, and
Type: String ShipFrom/Country is U.S..
Max Allowed: 1
If ShipFrom country is U.S. or CA, then the value must be
Length: 2…5
a valid U.S. State/ Canadian Province code.
If the country is Ireland, the StateProvinceCode will
contain the county.
/ShipConfirmRequest/Shipment/ShipFrom/Address/PostalCode
PostalCode Required: Cond The ship from location's postal code. 9 characters are accepted. Required if ShipFrom tag is in the XML and the ShipFrom
Type: String country is the U.S. and Puerto Rico.
Max Allowed: 1
For U.S. and Puerto Rico, it must be valid 5 or 9 digit
Length: 1…9
postal code.
The character "-" may be used to separate the first five
digits and the last four digits. If the ShipFrom country is
CA, then the postal code must be 6 alphanumeric
characters whose format is A#A#A# where A is an
uppercase letter and # is a digit.
For all other countries the postal code is optional and
must be no more than 9 alphanumeric characters long.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 196
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipFrom/Address/CountryCode
CountryCode Required: Yes* Origin location's country code. Required if ShipFrom tag is in the XML. For Return
Type: String Shipment the country code must meet the following
Max Allowed: 1 conditions:
Length: 2
1) At least two of the following country codes are the
same: ShipTo, ShipFrom, and Shipper.
2) None of the following country codes are the same and
are a member of the EU: ShipTo, ShipFrom, and Shipper.
3) If any of the two following country codes:
ShipTo/ShipFrom/ Shipper are members in EU otherwise
check if the shipper has Third Country Contract.

PaymentInformation

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/PaymentInformation
PaymentInformation Required: Cond Payment information container for detailed It is required for non-Ground Freight Pricing shipments
Type: Container shipment charges. The two shipment charges that only.
Max Allowed: 1 are available for specification are Transportation
Length: N/A charges and Duties and Taxes.
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge
ShipmentCharge Required: Yes* Shipment charge container. If Duty and Tax charges are applicable to a shipment and
Type: Container a payer is not specified, the default payer of Duty and Tax
Max Allowed: 1 charges is Bill to Receiver.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 197
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/Type
Type Required: Yes* Values are 01 = Transportation, 02 = Duties and A shipment charge type of 01 = Transportation is
Type: String Taxes required. A shipment charge type of 02 = Duties and
Max Allowed: 1 Taxes is not required; however, this charge type is invalid
Length: 2 for Qualified Domestic Shipments.
A Qualified Domestic Shipment is any shipment in which
one of the following applies:
1) The origin and destination country is the same
2) U.S. to PR shipment
3) PR to U.S. 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.
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper
BillShipper Required: Cond Container for the BillShipper billing option. The This element or its sibling element, BillReceiver,
Type: Container three payment methods that are available for the BillThirdParty or ConsigneeBilledIndicator, must be
Max Allowed: 1 Bill Shipper billing option are alternate payment present but no more than one can be present.
Length: N/A method, account number or credit card.
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/AccountNumber
AccountNumber Required: Cond UPS account number Must be the same UPS account number as the one
Type: String provided in Shipper/ShipperNumber.
Max Allowed: 1
Either this element or one of the sibling elements
Length: 6
CreditCard or AlternatePaymentMethod must be
provided, but all of them may not be provided.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 198
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard
CreditCard Required: Cond Credit card information container. Required if neither of the following is present:
Type: Container
/ShipConfirmRequest/Shipment/PaymentInformation/
Max Allowed: 1
ShipmentCharge/BillShipper/AccountNumber
Length: N/A
or
ShipConfirmRequest/Shipment/PaymentInformation/
ShipmentCharge/BillShipper/AlternatePaymentMethod.
Credit card payment is valid for shipments without return
service only.
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Type
Type Required: Yes* Values are:
Type: String
01 = American Express
Max Allowed: 1
Length: 2 03 = Discover
04 = MasterCard
05 = Optima
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 199
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Number
Number Required: Yes* Credit Card number.
Type: String
Max Allowed: 1
Length: 9…16
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/ExpirationDate
ExpirationDate Required: Yes* Format is MMYYYY where MM is the 2 digit month Valid month values are 01-12 and valid year values are
Type: String and YYYY is the 4 digit year. Present Year – (Present Year + 10 years)
Max Allowed: 1
Length: 6
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/SecurityCode
SecurityCode Required: Yes* Three or four digits that can be found either on top Valid values are 3 or 4 digits. It is required to provide the
Type: String of credit card number or on the back of credit card. security code if credit card information is provided and
Max Allowed: 1 Number of digits varies for different type of credit when the ShipFrom countries are other than the below
Length: 3..4 card. mentioned countries. Argentina, Bahamas, Costa Rica,
Dominican Republic, Guatemala, Panama, Puerto Rico
and Russia.
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Address
Address Required: Cond Container to hold the Credit card Billing Address. It is required to provide billing address if credit card
Type: Container information is provided and when the ShipFrom country
Max Allowed: 1 is the U.S., PR, and CA.
Length: N/A
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Address/AddressLine
AddressLine Required: Yes* Address Line 1 of the credit card billing address. Max of three AddressLine can be provided.
Type: String Usually Street address information.
Max Allowed:3
Length: 1…35
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Address/City
City Required: Yes* City of the credit card billing address.
Type: String
Max Allowed: 1
Length: 1…30

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 200
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Address/StateProvinceCode
StateProvinceCode Required: Yes* State or province code of the credit card billing
Type: String address.
Max Allowed: 1
Length: 2…5
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Address/PostalCode
PostalCode Required: Yes* Credit card billing addressee postal code.
Type: String
Max Allowed: 1
Length: 1…9
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/CreditCard/Address/CountryCode
CountryCode Required: Yes* Credit card billing address country code. Must be a valid UPS Billing country code.
Type: String
Max Allowed: 1
Length: 2
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/AlternatePaymentMethod
AlternatePaymentMethod Required: Cond Valid values for Alternate Payment Method is "01" - Paypal 01 : It is valid only for forward shipments. It is not
Type: String PayPal valid for Return or Import Control shipments.
Max Allowed: 1
Either this element or one of the sibling elements
Length: 2
CreditCard or AccountNumber must be provided, but all
of them may not be provided.
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillReceiver
BillReceiver Required: Cond Container for the BillReceiver billing option. This element or its sibling element, BillShipper,
Type: Container BillThirdParty or Consignee Billed, must be present but
Max Allowed: 1 no more than one can be present. For a return shipment,
Length: N/A Bill Receiver is invalid for Transportation charges.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 201
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillReceiver/AccountNumber
AccountNumber Required: Yes* The UPS account number. The account must be a valid UPS account number that is
Type: String active.
Max Allowed: 1
For U.S., PR and CA accounts, the account must be a
Length: 6
daily pickup account, an occasional account, a customer
B.I.N account, or a dropper shipper account.
All other accounts must be either a daily pickup account,
an occasional account, a drop shipper account, or a non-
shipping account.
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillReceiver/Address
Address Required: No Container for additional information for the bill
Type: Container receiver’s UPS accounts address.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillReceiver/Address/PostalCode
PostalCode Required: Cond The postal code for the UPS account's pickup The postal code must be the same as the UPS account
Type: String address. The pickup postal code was entered in the pickup address postal code. Required for United States
Max Allowed: 1 UPS system when the account was set-up. and Canadian UPS accounts and/or if the UPS account
Length: 1…9 pickup address has a postal code.
If the UPS account's pickup country is U.S. or Puerto
Rico, the postal code is 5 or 9 digits. The character '-' may
be used to separate the first five digits and the last four
digits. If the UPS 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.
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillThirdParty
BillThirdParty Required: Cond Container for the third party billing option. This element or its sibling element, BillShipper,
Type: Container BillReceiver or Consignee Billed, must be present but no
Max Allowed: 1 more than one can be present.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 202
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillThirdParty/AccountNumber
AccountNumber Required: Cond The UPS account number of the third party shipper. The account must be a valid UPS account number that is
Type: String active. For U.S., PR and CA accounts, the account must
Max Allowed: 1 be either a daily pickup account, an occasional account,
Length: 6 or a customer B.I.N account, or a drop shipper account.
All other accounts must be either a daily pickup account,
an occasional account, a drop shipper account, or a non-
shipping account.
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillThirdParty/Address
Address Required: Yes* Container for additional information for the third
Type: Container party UPS accounts address.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillThirdParty/Address/PostalCode
PostalCode Required: Cond The postal code for the UPS account's pickup The postal code must be the same as the UPS account
Type: String address. The pickup postal code is the one that pickup address postal code. Required for United States
Max Allowed: 1 was entered in the UPS system when the account and Canadian UPS accounts and/or if the UPS account
Length: 1…9 was set-up. pickup address has a postal code.
If the UPS account's pickup country is U.S. or Puerto
Rico, the postal code is 5 or 9 digits. The character '-' may
be used to separate the first five digits and the last four
digits.
If the UPS 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.
/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/BillThirdParty/Address/CountryCode
CountryCode Required: Yes* The country code for the UPS account's pickup
Type: String address.
Max Allowed: 1
Length: 2

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 203
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/PaymentInformation/ShipmentCharge/ConsigneeBilledIndicator
ConsigneeBilledIndicator Required: Cond Consignee Billing payment option indicator. The Empty Tag. This element or its sibling element,
Type: String presence indicates consignee billing option is BillShipper, BillReceiver or BillThirdParty, must be
Max Allowed: 1 selected. The absence indicates one of the other present but no more than one can be present.
Length: 0 payment options is selected.
This billing option is valid for a shipment charge type of
Transportation only. Only applies to US/PR and PR/U.S.
shipment origins and destination.
This payment method allows you to bill the charges for a
specified shipment to a consignee who has agreed to
pay the charges. All shipping charges are billed to the
consignee's UPS account number including the following
accessorials: Additional Handling, Delivery Area
Surcharges, Delivery Change Requests, Early AM
Premium, Early AM Out of Territory, Fuel Surcharge,
Hazardous Material Surcharges, Large Package
Surcharge, Over Max Limits, and Saturday Delivery.
Declared Value, Delivery Confirmation, On Call Pickup,
Remote Area Surcharge, Saturday Pickup and Verbal
Confirmation of Delivery fees are not passed to the
consignee and these charges are billed to the shippers
UPS account number.
/ShipConfirmRequest/Shipment/PaymentInformation/SplitDutyVATIndicator
SplitDutyVATIndicator Required: No Split Duty VAT Indicator. The presence indicates Empty Tag. The payment method for Transportation
Type: String the payer specified for Transportation Charges will charges must be UPS account. The UPS account must
Max Allowed: 1 pay transportation charges and any duties that be a daily pickup account or an occasional account.
Length: 0 apply to the shipment.
The payer specified for Duties and Taxes will pay
the VAT (Value-Added Tax) only.

FRSPaymentInformation

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/FRSPaymentInformation
FRSPaymentInformation Required: Cond Container to hold the Payment information for the Ground Freight Required for Ground Freight Pricing Shipments only.
Type: Container Pricing Shipments.
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 204
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/FRSPaymentInformation/Type
Type Required: Yes* Container to hold the Ground Freight Pricing payment type It is required if the request has Ground Freight Pricing
Type: String information. shipment indicator.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/FRSPaymentInformation/Type/Code
Code Required: Yes* Valid codes:
Type: String 01=Prepaid
Max Allowed: 1 02=FreightCollect 03=PrepaidThirdParty
Length: 2
/ShipConfirmRequest/Shipment/FRSPaymentInformation/Type/Description
Description Required: No Specifies the description for Ground Freight Pricing payment type.
Type: String
Max Allowed: 1
Length: 50
/ShipConfirmRequest/Shipment/FRSPaymentInformation/AccountNumber
AccountNumber Required: Yes* The UPS account number. If the Ground Freight Pricing indicator is present in the
Type: String request, this account number must be validated to check if
Max Allowed: 1 it is Ground Freight Pricing enabled.
Length: 6
/ShipConfirmRequest/Shipment/FRSPaymentInformation/Address
Address Required: Cond Container to hold the information for the FreightCollect and
Type: Container PrepaidThirdParty Address.
Note: The Address is required only when the billing option
Max Allowed: 1
is Freight collect or ThirdParty.
Length: N/A
/ShipConfirmRequest/Shipment/FRSPaymentInformation/Address/PostalCode
PostalCode Required: Cond The postal code for the Ground Freight Pricing payment
Type: String information address.
Max Allowed: 1
Length: 1…9
/ShipConfirmRequest/Shipment/FRSPaymentInformation/Address/CountryCode
CountryCode Required: Yes* The country code for the Ground Freight Pricing payment
Type: String information address.
Max Allowed: 1
Length: 2

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 205
Shipping Package Web Service Developer Guide November 1, 2016

FreightShipmentInformation

NAME Constraint Description Validation

/ShipConfirmRequest/Shipment/FreightShipmentInformation
FreightShipmentInformation Required: No Container to hold Freight Shipment information.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo
FreightDensityInfo Required: Cond Freight Density Info container. Required if DensityEligibleIndicator is present.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/AdjustedHeightIndicator
AdjustedHeightIndicator Required: No The presence of the AdjustedHeightIndicator
Type: String indicates that allow the height reduction adjustment
Max Allowed: 1 for density based rate request.
Length: 0
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/AdjustedHeight
AdjustedHeight Required: Cond Container for the adjusted height Required if AdjustedHeightIndicator is present.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/AdjustedHeight/Value
Value Required: Yes* Adjusted height value
Type: String
Max Allowed: 1
Length: 1…19
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/AdjustedHeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container for UnitOfMeasurement for the adjusted
Type: Container height
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 206
Shipping Package Web Service Developer Guide November 1, 2016

NAME Constraint Description Validation

/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/AdjustedHeight/UnitOfMeasurement/Code
Code Required: Yes* Code associated with Unit of Measurement for the Unit of measurement code for Adjusted height is
Type: String Adjusted height. validated only when Handling unit type is SKD =
Max Allowed: 1 Skid or PLT = Pallet.
Valid value: IN
Length: 2
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/AdjustedHeight/UnitOfMeasurement/Description
Description Required: No Description for UnitOfMeasurement for the adjusted
Type: String height
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits
HandlingUnits Required: Cond Handling Unit for Density based rating container.
Type: Container
Max Allowed: 50
Length: N/A
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Quantity
Quantity Required: Yes* Handling Unit Quantity for Density based rating.
Type: String
Max Allowed: 1
Length: 8
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Type
Type Required: Yes* Handling Unit Type for Density based rating. Valid values:
Type: Container SKD = Skid
Max Allowed: 1 CBY = Carboy
Length: N/A PLT = Pallet
TOT = Totes
LOO = Loose
OTH = Other
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Type/Code
Code Required: Yes* The code associated with Handling Unit Type.
Type: String
Max Allowed: 1
Length: 3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 207
Shipping Package Web Service Developer Guide November 1, 2016

NAME Constraint Description Validation

/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Type/Description
Description Required: No A description of the code for the Handling Unit type.
Type: String
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions
Dimensions Required: Yes* Dimension of the HandlingUnit container for
Type: Container density based pricing.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions/UnitOfMeasurement
UnitOfMeasurement Required: Yes* UnitOfMeasurement container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions/UnitOfMeasurement/Code
Code Required: Yes* Code for UnitOfMeasurement for the line item
Type: String dimension.
Max Allowed: 1
Valid value: IN = Inches
Length: 2
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions/UnitOfMeasurement/Description
Description Required: No Description for UnitOfMeasurement for the line item
Type: String dimension.
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions/Length
Length Required: Yes* The length of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 208
Shipping Package Web Service Developer Guide November 1, 2016

NAME Constraint Description Validation

/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions/Width
Width Required: Yes* The width of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipConfirmRequest/Shipment/FreightShipmentInformation/FreightDensityInfo/HandlingUnits/Dimensions/Height
Height Required: Yes* The height of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipConfirmRequest/Shipment/FreightShipmentInformation/DensityEligibleIndicator
DensityEligibleIndicator Required: No The presence of the tag indicates that the rate
Type: String request is density based.
Max Allowed: 1
For Density Based Rating (DBR), the customer
Length: 0
must have DBR Contract Service.

GoodsNotInFreeCirculationIndicator

Name Constraint Description Validation

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

ShipmentRatingOptions

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentRatingOptions
ShipmentRatingOptions Required: No ShipmentRatingOptions container.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 209
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentRatingOptions/NegotiatedRatesIndicator
NegotiatedRatesIndicator Required: No Negotiated Rates option indicator. If the indicator Negotiated Rates are of two types Account Based Rates (ABR) and Web
Type: String is present and the Shipper is authorized then Discount Rates. Negotiated Rates are only returned for qualified Shipper
Max Allowed: 1 Negotiated Rates should be returned in the Account Numbers. Eligibility is determined using the combination of
Length: 0 response. 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.
/ShipConfirmRequest/Shipment/ShipmentRatingOptions/FRSShipmentIndicator
FRSShipmentIndicator Required: No Ground Freight Pricing Rates option indicator. If The Shipper account number must be qualified to receive Ground Freight
Type: String the Ground Freight Pricing Shipment indicator is Pricing Shipment rates. Only the Shipper account number taken from
Max Allowed: 1 enabled and Shipper number is authorized then /ShipConfirmRequest/Shipment/FRSPaymentInformation/AccountNumber
Length: 0 Ground Freight Pricing rates should be returned is used when checking qualification for Ground Freight Pricing rates.
in the response.
/ShipConfirmRequest/Shipment/ShipmentRatingOptions/RateChartIndicator
RateChartIndicator Required: No RateChartIndicator, if present in request,
Type: String response will contain RateChart element.
Max Allowed: 1
Length: 0

MovementReferenceNumber

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 210
Shipping Package Web Service Developer Guide November 1, 2016

ReferenceNumber

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ReferenceNumber
ReferenceNumber Required: No Reference Number information container. For Mail Innovation shipments, reference number is not
Type: Container supported.
Max Allowed: 2
Length: N/A
/ShipConfirmRequest/Shipment/ReferenceNumber/BarCodeIndicator
BarCodeIndicator Required: No If the indicator is present then the reference number’s value will Empty Tag. Only one shipment-level or package-level
Type: String be bar coded on the label. reference number can be bar coded per shipment.
Max Allowed: 1
In order to barcode a reference number, its value must be
Length: 0
no longer than 14 alphanumeric characters or 24 numeric
characters and cannot contain spaces.
/ShipConfirmRequest/Shipment/ReferenceNumber/Code
Code Required: No Shipment Reference number type code. The code specifies the Valid if the origin/destination pair is not US/US or PR/PR
Type: String Reference name. Refer to the Reference Number Code table. and character should be alpha-numeric.
Max Allowed: 1
Length: 2
/ShipConfirmRequest/Shipment/ReferenceNumber/Value
Value Required: Yes* Customer supplied reference number. Valid if the origin/destination pair is not US/US or PR/PR
Type: String
Max Allowed: 1
Length: 1…35

Service

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Service
Service Required: Yes UPS service type.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Service/Code
Code Required: Yes Values are: The following Services are not available to return
Type: String shipment:

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 211
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

Max Allowed: 1 01 = Next Day Air 13 = Next Day Air Saver
Length: 2
02 = 2nd Day Air 59 = 2nd Day Air AM
03 = Ground 82 = UPS Today Standard
07 = Express 83 = UPS Today Dedicated Courier
08 = Expedited 84 = UPS Today Intercity
11 = UPS Standard 85 = UPS Today Express
12 = 3 Day Select 86 = UPS Today Express Saver.
13 = Next Day Air Saver
14 = UPS Next Day Air® Early
54 = Express Plus
59 = 2nd Day Air A.M.
65 = UPS Saver
M2 = First Class Mail
M3 = Priority Mail
M4 = Expedited MaiI Innovations
M5 = Priority Mail Innovations
M6 = Economy Mail Innovations
70 = UPS Access Point™ Economy
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.
Note: Only service code 03 is used for Ground Freight Pricing
shipments

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 212
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Service/Description
Description Required: No Description of the service code. Examples are Next Day Air,
Type: String Worldwide Express, and Ground.
Max Allowed: 1
Length: 1…35

InvoiceLineTotal

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/InvoiceLineTotal
InvoiceLineTotal Required: Cond Container to hold InvoiceLineTotal Information. Required for forward shipments whose origin is the U.S.
Type: Container and destination is Puerto Rico or Canada. Not available for
Max Allowed: 1 any other shipments. FOR OTHER DESTINATIONS the
Length: N/A InvoiceLineTotal in the International Forms Container must
be used.
/ShipConfirmRequest/Shipment/InvoiceLineTotal/CurrencyCode
CurrencyCode Required: Yes* Invoice Line Total currency type.
Type: String
Max Allowed: 1
Length: 3
/ShipConfirmRequest/Shipment/InvoiceLineTotal/MonetaryValue
MonetaryValue Required: Yes* Invoice Line Total amount for the entire shipment. Valid values are from 1 to 99999999
Type: String
Max Allowed: 1
Length: 1…19

NumOfPiecesInShipment

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/NumOfPiecesInShipment
NumOfPiecesInShipment Required: Cond Total number of pieces in all pallets in a UPS Worldwide Express It is required for UPS Worldwide Express Freight Shipment.
Type: String Freight Shipment. Valid values are 1 to 99999.
Max Allowed: 1
Length: 1…5

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 213
Shipping Package Web Service Developer Guide November 1, 2016

USPSEndorsement

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/USPSEndorsement
USPSEndorsement Required: Cond USPS Endorsement valid values: Required for Mail Innovations forward shipments.
Type: String
1 = Return Service Requested
Max Allowed: 1
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

Name Constraint Description Validation

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

SubClassification

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 214
Shipping Package Web Service Developer Guide November 1, 2016

CostCenter

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/CostCenter
CostCenter Required: Cond Customer assigned identifier for report and billing summarization Required only for Mail Innovations forward shipments.
Type: String displays to the right of the Cost Center title. Alpha numeric values only.
Max Allowed: 1
Length: 1…30

PackageID

Name Constraint Description Validation

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

IrregularIndicator

Name Constraint Description Validation

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

ShipmentIndicationType

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentIndicationType
ShipmentIndicationType Required: Cond Container for Shipment Indication Type. Required to indicate whether shipment is "Hold For Pickup
Type: Container At UPS Access Point" shipment or "UPS Access Point™
Max Allowed: 1 Delivery" shipment.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 215
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentIndicationType/Code
Code Required: Yes* Valid values are '01' - Hold for Pickup at UPS Access Point and
Type: String '02' - UPS Access Point™ Delivery.
Max Allowed: 1
Length: 2
/ShipConfirmRequest/Shipment/ShipmentIndicationType/Description
Description Required: No Description for the code.
Type: String
Max Allowed: 1
Length: 1…50

RatingMethodRequestedIndicator

Name Constraint Description Validation

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

TaxInformationIndicator

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/TaxInformationIndicator
TaxInformationIndicator Required: No Presence/Absence Indicator. Any value inside is ignored.
Type: String TaxInformationIndicator is an indicator.
Max Allowed: 1
If present, any taxes that may be applicable to a shipment would
Length: 0
be returned in response.
If this indicator is requested with NegotiatedRatesIndicator, Tax
related information, if applicable, would be returned only for
Negotiated Rates and not for Published Rates.
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 216
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentServiceOptions

Name Constraint Description Validation

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

SaturdayDeliveryIndicator

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/SaturdayDeliveryIndicator
SaturdayDeliveryIndicator Required: No Saturday delivery indicator. The presence indicates Saturday Empty Tag.
Type: String delivery is requested and the absence indicates Saturday
Max Allowed: 1 delivery is not requested.
Length: 0

COD

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/COD
COD Required: No COD container Indicates COD is requested. Shipment COD is only
Type: Container available for EU origin countries and for shipper's
Max Allowed: 1 account type Daily Pickup and Drop Shipping. Not
Length: N/A available to shipment with return service.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/COD/CODFundsCode
CODFundsCode Required: Yes* For valid values, refer to COD Supported Countries in the
Type: String Appendix.
Max Allowed: 1
Length: 1
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/COD/CODAmount
CODAmount Required: Yes* COD Amount Container.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 217
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/COD/CODAmount/CurrencyCode
CurrencyCode Required: Yes* COD amount currency code type.
Type: String
Max Allowed: 1
Length: 3
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/COD/CODAmount/MonetaryValue
MonetaryValue Required: Yes* COD Amount monetary value.
Type: String
Max Allowed: 1
Length: 1…8

AccessPointCOD

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 218
Shipping Package Web Service Developer Guide November 1, 2016

DeliverToAddresseeOnlyIndicator

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/DeliverToAddresseeOnlyIndicator
DeliverToAddresseeOnlyIndicator Required: No Presence/Absence Indicator. Any value inside is ignored. Only valid for Shipment Indication type "01 - Hold
Type: String DeliverToAddresseeOnlyIndicator is shipper specified For PickUp at UPS Access Point".
Max Allowed: 1 restriction that requires the addressee to be the one who
Length: 0 takes final delivery of the "Hold For PickUp at UPS Access
Point" package.
Presence of indicator means shipper restriction will apply to
the shipment.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/DirectDeliveryOnlyIndicator
DirectDeliveryOnlyIndicator Required: No Presence/Absence Indicator. Any value inside is ignored. This accessorial is not valid with Shipment Indication
Type: String Direct Delivery Only (DDO) accessorial in a request would Type "01 - Hold For Pickup At UPS Access Point"
Max Allowed: 1 ensure that delivery is made only to the ship to address on and "02 - UPS Access Point™ Delivery".
Length: 0 the shipping label.

Notification

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification
Notification Required: No Container for the Quantum View Notification (QVN) is valid
Type: Container for all shipments including Return service, Import Control
Max Allowed: 1 and Returns Flexible Access. Valid return service types are:
Length: N/A ERL, PRL, PNM, RS1, or RS3.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification/NotificationCode
NotificationCode Required: Yes* The type of notification requested. Valid values: Note: QVN Exception notification and return
Type: String notification are not applicable to GFP. QV In-transit and
5 - QV In-transit Notification
Max Allowed: 1 Return Notifications are only valid for ImportControl
Length: 1 6 - QV Ship Notification and Return shipment.
7 - QV Exception Notification QV In-transit Notification is allowed for return
8 - QV Delivery Notification shipments only.

2 - Return Notification or Label Creation Notification QV Ship Notification is allowed for forward moving
shipments only.
012 - Alternate Delivery Location Notification
013 - UAP Shipper Notification

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 219
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMail
EMail Required: Yes* Container for Email Information.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMail/EMailAddress
EMailAddress Required: Yes* Email address where the notification is sent. Up to five email addresses are allowed for each type of
Type: String Quantum View TM shipment notification. Up to two
Max Allowed:2...5 email address for return notification.
Length: 1…50
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMail/UndeliverableEMailAddress
UndeliverableEMailAddress Required: No The address where an undeliverable eMail message is sent There can be only one UndeliverableEMailAddress for
Type: String if the eMail with the notification is undeliverable. each type of Quantum View Shipment Notifications.
Max Allowed: 1
Length: 1…50
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMail/FromEMailAddress
FromEMailAddress Required: Cond The e-mail address specifies the Reply To E-mail address. Valid for Return Notification only.
Type: String The "From" field of the message header contains
Max Allowed: 1 pkginfo@ups.com.
Length: 1…50
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMail/FromName
FromName Required: No The name the email will appear to be from. Defaults to the The FromName must occur only once for each type of
Type: String Shipper Name. Quantum View Shipment Notifications.
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMail/Memo
Memo Required: No User defined text that will be included in the eMail. The Memo must occur only once for each type of
Type: String Quantum View Shipment Notifications.
Max Allowed: 1
Length: 1…150

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 220
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMail/Subject
Subject Required: No The eMail's subject. Defaults to text provided by UPS Return Notification only.
Type: String
Max Allowed: 1
Length: 1…75
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification/EMail/SubjectCode
SubjectCode Required: No Specifies a reference code and reference number to display For return notification:
Type: String in the subject of the Notification. The valid subject codes are:
If the subject code tag is not provided and the subject
Max Allowed: 1
01 - Shipment Reference Number 1 text is provided, the subject of the notification will be
Length: 2
the subject text.
02 - Shipment Reference Number 2
If the subject text is provided and the subject code tag
03 - package Reference Number 1
exists, then the subject code value must be 08. If
04 - package Reference Number 2 Subject code is 08, subject text must exist.
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.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification/VoiceMessage
VoiceMessage Required: No VoiceMessage container is used for specifying phone Valid only for Alternate Delivery Location notification
Type: Container number for receiving voice Alternate Delivery Location and UAP Shipper notification. VoiceMessage phone
Max Allowed: 1 notification and UAP Shipper notification. number or TextMessage phone number or email
Length: N/A address is required for ADL notification and UAP
Shipper notification.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification/VoiceMessage/PhoneNumber
PhoneNumber Required: Yes* Phone number for receiving Voice Alternate Delivery
Type: String Location notification and UAP Shipper notification.
Max Allowed: 1
Length: 1…15
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/Notification/TextMessage
TextMessage Required: No TextMessage container is used for specifying phone number Valid only for Alternate Delivery Location notification
Type: Container for receiving text Alternate Delivery Location notification and and UAP Shipper notification. VoiceMessage phone
Max Allowed: 1 UAP Shipper notification. number or TextMessage phone number or email
Length: N/A address is required for ADL notification and UAP
Shipper notification.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 221
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

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

LabelDelivery

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery
LabelDelivery Required: Cond Container for the Label Delivery accessorial. Valid for shipments with an Electronic Return Label
Type: Container Return Service.
Note: Currently Label delivery accessorial is not applicable
Max Allowed: 1
to GFP.
Length: N/A
Required for shipments with either Electronic Return Label
Return Service or ImportControl Electronic LabelMethod
type. If this container is present, either of the
LabelLinksIndicator or Email container should be provided.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 222
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail
EMail Required: No Container for the email message.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/EMailAddress
EMailAddress Required: Yes* The destination eMail address for the Label Delivery.
Type: String
Max Allowed: 1
Length: 1…50
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/UndeliverableEMailAddress
UndeliverableEMailAddress Required: No The address where an undeliverable email message is sent Defaults to FromEMailAddress.
Type: String if the Label Delivery email is undeliverable.
Max Allowed: 1
Length: 1…50
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/FromEMailAddress
FromEMailAddress Required: Yes* The e-mail address specifies the Reply To E-mail address.
Type: String The "From" field of the message header contains
Max Allowed: 1 pkginfo@ups.com.
Length: 1…50
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/FromName
FromName Required: No The "FrontName" is the name from which notification will
Type: String appear. Defaults to the "Shipper Name".
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/Memo
Memo Required: No User defined text that will be included in the email.
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 223
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/Subject
Subject Required: No The eMail's subject. Defaults to the Label Delivery
Type: String Notification plus the shipment ID. Defaults to text provided
Max Allowed: 1 by UPS.
Length: 1…75
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/EMail/SubjectCode
SubjectCode Required: No Specifies a reference code and reference number to display If the subject code tag is not provided and the subject
Type: String in the subject of the Label Delivery notification. text is provided, the subject of the notification will be
Max Allowed: 1 the subject text.
When the subject code is provided, the subject will contain
Length: 2
the following: UPS Label Delivery, the reference code (the If the subject text is provided, and the subject code tag
reference code will be mapped to the corresponding ANSI exists, then the subject code value must be 08.
value) and the reference number.
If Subject code is 08, subject text must exist. If a
subject code is provided that refers to a nonexistent
reference number, the subject will default to the
shipment identification number.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/LabelDelivery/LabelLinksIndicator
LabelLinksIndicator Required: No Indicates the Label and Receipt URL's are to be returned in
Type: String the XML response. Applicable for ImportControl Electronic
Max Allowed: 1 Labels or for ReturnService Electronic Labels.
Length: 0

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 224
Shipping Package Web Service Developer Guide November 1, 2016

InternationalForms

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms
InternationalForms Required: No International Forms information.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/FormType
FormType Required: Yes* Indicates the name of the International Form requested. Valid values:
Type: String
Max Allowed:6 • 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
• 10 - UPS Premium Care
Form
• 11 - EEI
For shipment with return
service 01, 05 or 10 are the
only valid values
Note: 01 and 05 are
mutually exclusive and 05 is
only valid for return
shipments only.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 225
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UserCreatedForm
UserCreatedForm Required: Cond Data container for DocumentID(s). Required if Form Type is 07.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UserCreatedForm/DocumentID
DocumentID Required: Yes* DocumentID represents a document uploaded to Forms History.
Type: String
Max Allowed: 13
Length: 26
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm
UPSPremiumCareForm Required: Cond UPS Premium Care Form is required if UPS Premium Care Indicator is present on a Valid only for Canda to
Type: Container package. Canada movements.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/ShipmentDate
ShipmentDate Required: Yes* Shipment Date associated with UPS Premium Care Shipment. Format: yyyyMMdd
Type: String
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/PageSize
PageSize Required: Yes* Size of UPS Premium Care Form. Valid values:
Type: String 01 = A4 Size
Max Allowed: 1 02 = Letter Size
Length: 2
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/PrintType
PrintType Required: Yes* Format of UPS Premium Care Form. Valid values:
Type: String 01 = PNG
Max Allowed: 1 02 = PDF
Length: 2

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 226
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/NumOfCopies
NumOfCopies Required: Yes* Number of Copies of UPS Premium Care Form. Valid value is 02.
Type: String
Max Allowed: 1
Length: 2
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/LanguageForUPSPremiumCare
LanguageForUPSPremium Required: Yes* Container to hold languages in which UPS Premium Care Form is required.
Care Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/UPSPremiumCareForm/LanguageForUPSPremiumCare/Language
Language Required: Yes* Languages for UPS Premium Care Form. Two langues are required for UPS Valid values:
Type: String Premium Care Form. eng = US English
Max Allowed:2 fra = Canadian French
Length: 3
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form
CN22Form Required: Cond Container for the CN22 form. Required if the customer
Type: Container wants to use the UPS
Max Allowed: 1 generated CN22.
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/LabelSize
LabelSize Required: Yes* Provide the valid values 6 = 4X6 or 1 = 8.5X11 Required if the CN22 form
Type: String container is present.
Max Allowed: 1
Length: 2
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/PrintsPerPage
PrintsPerPage Required: Yes* Number of label per page. Currently 1 per page is supported. Required if the CN22 form
Type: String container is present.
Max Allowed: 1
Length: 1

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 227
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/LabelPrintType
LabelPrintType Required: Yes* Valid values: pdf, png, gif, zpl, star, epl2 and spl. Required if the CN22 form
Type: String container is present.
Max Allowed: 1
Length: 1...4
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Type
CN22Type Required: Yes* Valid values: Required if the CN22 form
Type: String container is present.
Max Allowed: 1 • 1 = GIFT
Length: 1 • 2 = DOCUMENTS
• 3 = COMMERCIAL SAMPLE
• 4 = OTHER
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22OtherDescription
CN22OtherDescription Required: Cond Required if CN22Type is OTHER. Required if the CN22 form
Type: String container is present.
Max Allowed: 1
Length: 20
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/FoldHereText
FoldHereText Required: No String will replace default "Fold Here" text displayed on the label.
Type: String
Max Allowed: 1
Length: 35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content
CN22Content Required: Yes* Container for CN22 content. Required if the CN22 form
Type: Container container is present.
Max Allowed: 3
Note: The maximum number
Length: N/A
of goods printed on the
CN22 form when a
combined MI package and
CN22 form label is
requested is one.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 228
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentQuantity
CN22ContentQuantity Required: Yes* Total number of items associated with this content. Required if the CN22 form
Type: String container is present.
Max Allowed: 1
Length:
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentDescription
CN22ContentDescription Required: Yes* Detailed description of the content. Required if the CN22 form
Type: String container is present.
Max Allowed: 1
Length: 105
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentWeight
CN22ContentWeight Required: Yes* Container for CN22 content weight.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container for UOM.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentWeight/UnitOfMeasurement/Code
Code Required: Yes* Required if weight is provided, valid values are lbs and ozs. Required if weight is
Type: String provided.
Max Allowed: 1
Length: 3
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentWeight/UnitOfMeasurement/Description
Description Required: No Short description for UnitOfMeasurement.
Type: String
Max Allowed: 1
Length: 1…50

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 229
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentWeight/Weight
Weight Required: Yes* Total weight of the content. Pounds and Ounces are allowed up to 2 decimals. Required if the CN22 form
Type: String container is present.
Max Allowed: 1
Length: 7
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentTotalValue
CN22ContentTotalValue Required: Yes* Total value of the items associated with this content. Required if the CN22 form
Type: String container is present.
Max Allowed: 1
Length: 9
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentCurrencyCode
CN22ContentCurrencyCod Required: Yes* Currently only USD is supported. Required if the CN22 form
e Type: String container is present.
Max Allowed: 1
Length: 3
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentCountryOfOrigin
CN22ContentCountryOfOrig Required: No Country of Origin from where the CN22 contents originated.
in Type: String
Max Allowed: 1
Length: 2
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CN22Form/CN22Content/CN22ContentTariffNumber
CN22ContentTariffNumber Required: No The tariff number associated with the CN22 contents.
Type: String
Max Allowed: 1
Length: 40

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 230
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/AdditionalDocumentIndicator
AdditionalDocumentIndicato Required: No Presence of the indicator means user will supply additional document, such as EEI, This indicator should be set
r Type: String NAFTA_CO or CO. when the shipper intends to
Max Allowed: 1 utilize UPS paperless
Length: 0 invoice functionality AND
the shipper has SELF-
PREPARED other
International Forms (EEI,CO,
NAFTACO) to accompany
the shipment. It is evaluated
only when:
1. Account is paperless
enabled.
2. Movement requires an
invoice.
3. Destination country
accepts paperless invoice.
4. Invoice data is supplied
by the client and the data
passes validation.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/FormGroupIdName
FormGroupIdName Required: No Contains description text which identifies the group of International forms. This
Type: String element does not appear on the forms.
Max Allowed: 1
Length: 1…50
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption
EEIFilingOption Required: Cond EEI Filing option. Applicable for EEI form and
Type: Container is required.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/Code
Code Required: Yes* Required for EEI Form. Applicable for EEI form.
Type: String
Valid values:
Max Allowed: 1
1 - Shipper filed 3- UPS filed
Length: 1

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 231
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/EMailAddress
EMailAddress Required: Cond Email Address where the notification is sent. Valid for UPS filed (option 3), Shipper Applicable for EEI form.
Type: String filed (option 1- A , 1-C)
Max Allowed: 1
Length: 1…50
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/Description
Description Required: No Optional Description of Filing Code. Applicable for EEI form.
Type: String
Max Allowed: 1
Length: 1…20
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/UPSFiled
UPSFiled Required: No Indicates the EEI UPS Filed option. (option 3) Applicable for EEI form.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/UPSFiled/POA
POA Required: Yes* Container for POA. Applicable for EEI form.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/UPSFiled/POA/Code
Code Required: Yes* Indicates the EEI UPS Filed POA filing option. Applicable for EEI form.
Type: String Valid values are 1- One
Max Allowed: 1 Time POA; 2- Blanket POA.
Length: 1
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/UPSFiled/POA/Description
Description Required: No Description for POA Code. Applicable for EEI form.
Type: String
Max Allowed: 1
Length: 1…20

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 232
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/ShipperFiled
ShipperFiled Required: No Indicates the EEI Shipper Filed option. (Option 1). Applicable for EEI form.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/ShipperFiled/Code
Code Required: Yes* Indicates the EEI Shipper sub option. Applicable for EEI form and
Type: String is required. Valid values:
Max Allowed: 1
'A'- requires the ITN
Length: 1
'B'- requires the Exemption
Legend
'C'- requires the post
departure filing citation
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/ShipperFiled/Description
Description Required: No Description of ShipperFiled Code. Applicable for EEI form.
Type: String
Max Allowed: 1
Length: 1…20
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/ShipperFiled/PreDepartureITNNumber
PreDepartureITNNumber Required: Cond Input for Shipper Filed option 'A'. The format is available from AESDirect website. Valid and Required for
Type: String Shipper Filed option 'A'. EEI
Max Allowed: 1 form only.
Length: 17

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 233
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EEIFilingOption/ShipperFiled/ExemptionLegend
ExemptionLegend Required: Cond Input for Shipper Filed option 'B'. Valid and Required for
Type: String Shipper Filed option 'B'. EEI
Max Allowed: 1 30.2(d)(2) 30.26(a) 30.36 form only.
Length: 20 30.37(a) 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)

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 234
Shipping Package Web Service Developer Guide November 1, 2016

International Forms continued, Contacts

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts
Contacts Required: Cond Holds the contact information of various parties. Applicable for EEI and NAFTA CO only.
Type: Container Required for NAFTA CO and EEI. Ultimate
Max Allowed: 1 consignee contact information is required for
Length: N/A EEI.
Producer contact information is required for
NAFTA CO
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent
ForwardAgent Required: No The forwarding agent is the company or person Applicable for EEI form only.
Type: Container acting as agent in the trans-shipping of freight to
Max Allowed: 1 the destination country.
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/CompanyName
CompanyName Required: Yes* Company Name or the Individual name of the Applicable for EEI form only.
Type: String Forwarding agent.
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/TaxIdentificationNumber
TaxIdentificationNumber Required: Yes* Tax ID of the Forwarding agent. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…15
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address
Address Required: Yes* Address information of the Forwarding agent. Applicable for EEI form only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address/AddressLine
AddressLine Required: Yes* Address line of the Forwarding agent. Applicable for EEI form only. Max Occurrence
Type: String must be 3.
Max Allowed:3
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 235
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address/City
City Required: Yes* City of the Forwarding agent. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…30
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address/StateProvinceCode
StateProvinceCode Required: Cond State of the Forwarding agent. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…5
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address/Town
Town Required: No Town of the Forwarding Agent. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…30
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address/PostalCode
PostalCode Required: Cond Postal code of the Forwarding agent. Applicable for EEI form only. Required for
Type: String certain countries. The length of the postal code
Max Allowed: 1 depends on the country code
Length: 1…9
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/ForwardAgent/Address/CountryCode
CountryCode Required: Yes* Country code of the Forwarding agent. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 2
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee
UltimateConsignee Required: Cond The ultimate consignee is the person or company Applicable for EEI form only.
Type: Container who receives the goods for end-use or the person
Max Allowed: 1 or company listed on the export license. This is the
Length: N/A end-user of the goods.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 236
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/CompanyName
CompanyName Required: Yes* Company Name or the Individual name of the Applicable for EEI form only.
Type: String Ultimate consignee.
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address
Address Required: Yes* Address information of the Ultimate consignee. Applicable for EEI form only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address/AddressLine
AddressLine Required: Yes* Address line of the Ultimate consignee. Applicable for EEI form only. Max Occurrence
Type: String must be 3.
Max Allowed:3
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address/City
City Required: Yes* City of the Ultimate consignee. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…30
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address/StateProvinceCode
StateProvinceCode Required: Cond State of the Ultimate consignee. Applicable for EEI form only. Required for
Type: String certain countries. The length of the postal code
Max Allowed: 1 depends on the country code
Length: 1…5
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address/Town
Town Required: No Town of the Ultimate consignee. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…30

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 237
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address/PostalCode
PostalCode Required: Cond Postal code of the Ultimate consignee. Applicable for EEI form only. Required for
Type: String certain countries.The length of the postal code
Max Allowed: 1 depends on the country code.
Length: 1…9
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/Address/CountryCode
CountryCode Required: Yes* Country code of the Ultimate consignee. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 2
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/UltimateConsigneeType
UltimateConsigneeType Required: No Container for providing ultimateConsignee Type. Applicable for EEI form only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/UltimateConsigneeType/Code
Code Required: Yes* Ultimate Consignee Type Code. Values are: 'D' = Applicable for EEI form only.
Type: String Direct Consumer; 'G'=Government Entity ; 'R'=
Max Allowed: 1 Reseller ; 'O'=Other/Unknown.
Length: 1
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/UltimateConsignee/UltimateConsigneeType/Description
Description Required: No Ultimate Consignee Type Description. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…20
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee
IntermediateConsignee Required: No The intermediate consignee is the person or Applicable for EEI form only.
Type: Container company in the importing country that makes final
Max Allowed: 1 delivery to the ultimate consignee.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 238
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/CompanyName
CompanyName Required: Yes* Company Name or the Individual name of the Applicable for EEI form only.
Type: String Intermediate consignee.
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/Address
Address Required: Yes* Address information of the Intermediate Applicable for EEI form only.
Type: Container Consignee.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/Address/AddressLine
AddressLine Required: Yes* Address line of the Intermediate Consignee. Applicable for EEI form only. Max Occurrence
Type: String must be 3.
Max Allowed:3
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/Address/City
City Required: Yes* City of the Intermediate Consignee. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…30
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/Address/StateProvinceCode
StateProvinceCode Required: Cond State of the Intermediate Consignee. Applicable for EEI form only. Required for
Type: String certain countries.
Max Allowed: 1
Length: 1…5
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/IntermediateConsignee/Address/Town
Town Required: No Town of the Intermediate consignee. Applicable for EEI form only.
Type: String
Max Allowed: 1
Length: 1…5

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 239
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

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

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/CompanyName
CompanyName Required: Cond Company Name or the Individual name of the Applies to NAFTA CO. Only applicable when
Type: String Producer. producer option is empty or not present.
Max Allowed: 1 Conditionally required for: NAFTA CO, when
Length: 1…35 Producer option is not specified.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 240
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/TaxIdentificationNumber
TaxIdentificationNumber Required: No Tax ID of the Producer. Applies to NAFTA CO. Only applicable when
Type: String producer option is empty or not present
Max Allowed: 1
Length: 1…15
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address
Address Required: Cond Address information of the Producer. Applies to NAFTA CO. Only applicable if
Type: Container producer option is empty or not present.
Max Allowed: 1 Conditionally required for: NAFTA CO, when
Length: N/A Producer option is not specified.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/AddressLine
AddressLine Required: Yes* Address line of the Producer. Max Occurrence must be 3.
Type: String
Max Allowed:3
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/City
City Required: Yes* City of the Producer. Applies to NAFTA CO. Conditionally required
Type: String for: NAFTA CO, when Producer option is not
Max Allowed: 1 specified.
Length: 1…30
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/StateProvinceCode
StateProvinceCode Required: Cond State of the Producer. Applies to NAFTA CO. Required for certain
Type: String countries.
Max Allowed: 1
Length: 1…5
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/Town
Town Required: No Town of the Producer.
Type: String
Max Allowed: 1
Length: 1…30

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 241
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/PostalCode
PostalCode Required: Cond Postal code of the Producer. Applies to NAFTA CO. Required for certain
Type: String countries. The length of the postal code
Max Allowed: 1 depends on the country code.
Length: 1…9
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Address/CountryCode
CountryCode Required: Yes* Country code of the Producer. Applies to NAFTA CO.
Type: String
Max Allowed: 1
Length: 2
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/AttentionName
AttentionName Required: No Contact name at the Producer location. Applies to NAFTA CO.
Type: String
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Phone
Phone Required: No Phone number information of Producer. Applies to NAFTA CO.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Phone/Number
Number Required: Yes* The location's phone number of the Producer. Applies to NAFTA CO.
Type: String
Max Allowed: 1
Length: 1…15
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/Phone/Extension
Extension Required: No The location's phone extension of the Producer. Applies to NAFTA CO.
Type: String
Max Allowed: 1
Length: 1…4

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 242
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/Producer/EMailAddress
EMailAddress Required: No Producer email address. Applies to NAFTA CO.
Type: String
Max Allowed: 1
Length: 1…50
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo
SoldTo Required: No SoldTo Container. Applies to Invoice and NAFTA CO Forms.
Type: Container Required if Invoice or NAFTA CO (International
Max Allowed: 1 Form) is requested.
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Name
Name Required: Yes* Company Name.
Type: String
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/AttentionName
AttentionName Required: Yes* Sold to contact name.
Type: String
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/TaxIdentificationNumber
TaxIdentificationNumber Required: No SoldTo Tax Identification Number.
Type: String
Max Allowed: 1
Length: 1…15
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Phone
Phone Required: No Phone Container.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 243
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Phone/Number
Number Required: Yes* Sold To contact's phone number.
Type: String
Max Allowed: 1
Length: 1…15
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Phone/Extension
Extension Required: No Sold To contact's phone extension.
Type: String
Max Allowed: 1
Length: 1…4
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Option
Option Required: No The text associated with the code will be printed in Applies to NAFTA CO form. Possible Values
Type: String the sold to section of the NAFTA CO form. The are 01 and 02.
Max Allowed: 1 values indicate the following: 01 – Unknown.
Length: 2
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address
Address Required: Yes* Sold To Address Container. Applies to NAFTA CO.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address/AddressLine
AddressLine Required: Yes* SoldTo location’s street address. Applies to NAFTA CO.
Type: String
Max Allowed:3
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address/City
City Required: Yes* SoldTo location’s city.
Type: String
Max Allowed: 1
Length: 1…30

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 244
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address/StateProvinceCode
StateProvinceCode Required: Cond SoldTo location’s state or province code. Required for certain countries.
Type: String
Max Allowed: 1
Length: 1…5
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address/Town
Town Required: No SoldTo location’s town code.
Type: String
Max Allowed: 1
Length: 1…30
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address/PostalCode
PostalCode Required: Cond SoldTo location’s postal code.
Type: String
Max Allowed: 1
Length: 1…9
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/Address/CountryCode
CountryCode Required: Yes* SoldTo location’s country code.
Type: String
Max Allowed: 1
Length: 2
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Contacts/SoldTo/EMailAddress
EMailAddress Required: No SoldTo email address.
Type: String
Max Allowed: 1
Length: 1…50

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 245
Shipping Package Web Service Developer Guide November 1, 2016

InternationalForms continued, Product

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product
Product Required: Yes* Contains the commodity/product information. Applies to EEI, Invoice, Partial Invoice, CO
Type: Container and NAFTA CO. When any International form
Max Allowed: 1…50 is requested, at least one Product must be
Length: N/A 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.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Description
Description Required: Yes* Description of the product. Applies to all International Forms. Optional
Type: String for Partial Invoice.
Max Allowed:3
Must be present at least once and can occur
Length: 1…35
for a maximum of 3 times.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit
Unit Required: Cond Container tag for the unit's information of each Required for Invoice forms and optional for
Type: Container product. (also called as commodity) Partial Invoice.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/Number
Number Required: Yes* Total quantity of each commodity to be shipped Required for Invoice forms and optional for
Type: String Partial Invoice. Must be numeric. Valid
measured in the units specified in the Unit of
Max Allowed: 1 characters are 0-9.
Measure field.
Length: 1…7

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 246
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container tag for the Unit of measurement for Required for Invoice forms and optional for
Type: Container the commodity. Partial Invoice.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/UnitOfMeasurement/Code
Code Required: Yes* Code for the Unit of measurement of the Required for Invoice forms and optional for
Type: String commodity units. Partial Invoice.
Max Allowed: 1
Refer to Unit of Measure Codes in the
Length: 1…3
Appendix for valid values.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/UnitOfMeasurement/Description
Description Required: Cond The Unit of Measure if OTH (Other) is entered Applies to Invoice and Partial Invoice forms.
Type: String as the UnitOfMeasurement code. Conditionally Required for the Invoice and
Max Allowed: 1 Partial Invoice form if OTH is entered as the
Length: 1…3 units UnitOfMeasurement Code.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 247
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/Unit/Value
Value Required: Yes* Monetary amount used to specify the worth or Applies to Invoice and Partial Invoice form.
Type: String price of the commodity. Amount should be Required for Invoice forms and optional for
Max Allowed: 1 greater than zero. Partial Invoice.
Length: 1…19
• 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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 248
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/CommodityCode
CommodityCode Required: Cond 6-to-15-alphanumeric commodity code. Applies to Invoice, Partial Invoice and
Type: String Customs uses this code to determine what NAFTA CO. Required for NAFTA CO and
Max Allowed: 1 duties should be assessed on the commodity. optional for Partial Invoice. Should be at
Length: 6…15 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.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PartNumber
PartNumber Required: No The part number or reference number for the Applies to Invoice and Partial Invoice.
Type: String product contained in the invoice line, as Required for Invoice forms and optional for
Max Allowed: 1 indicated on the customs invoice. Partial Invoice.
Length: 1…10
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/OriginCountryCode
OriginCountryCode Required: Cond The country in which the good was
Type: String manufactured, produced or grown.
Max Allowed: 1
For detailed information on country of origin,
Length: 2
certificate of origin, rules of origin, and any
related matters, please refer to the U.S.
Customs and Border Protection Web site at
www.customs.gov or contact your country's
Customs authority.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/JointProductionIndicator
JointProductionIndicator Required: No If present, JNT will be used as the origin of Applies to NAFTA CO only.
Type: String country code on the NAFTA form and the
Max Allowed: 1 Product/OriginCountryCode tag will be
Length: 0 ignored.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 249
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NetCostCode
NetCostCode Required: Cond For each good described in the Description of Applies to NAFTA CO only. Required for
Type: String Goods field, where the good is subject to a NAFTA CO.
Max Allowed: 1 regional value content (RVC) requirement,
Possible Values: NC and NO.
Length: 2 indicate NC if the RVC is calculated according
to the net cost method; otherwise, indicate NO.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NetCostDateRange
NetCostDateRange Required: No Date Range for regional value content (RVC). Applies to NAFTA CO only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NetCostDateRange/BeginDate
BeginDate Required: Yes* If the RVC is calculated over a period of time, it Applies to NAFTA CO only. Format is
Type: String should be identified by the begin date yyyyMMdd.
Max Allowed: 1 (yyyyMMdd) of that period. (Reference: Articles
Length: 8 402.1, 402.5).
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NetCostDateRange/EndDate
EndDate Required: Yes* If the RVC is calculated over a period of time, it Applies to NAFTA CO only. Format is
Type: String should be identified by the End date yyyyMMdd.
Max Allowed: 1 (yyyyMMdd) of that period. (Reference: Articles
Length: 8 402.1, 402.5).
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PreferenceCriteria
PreferenceCriteria Required: Cond Indicates the criterion (A through F) for each Applies to NAFTA CO only.
Type: String good described in the Description of Goods
Max Allowed: 1 field if applicable.
Length: 1
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).

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 250
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProducerInfo
ProducerInfo Required: Cond Indicate the following: Applicable for NAFTA CO and is required.
Type: String
Yes - If shipper is the producer of the good. If
Max Allowed: 1
not, state 02, 03, and 04 depending on
Length: 3…5
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.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/MarksAndNumbers
MarksAndNumbers Required: No Any special marks, codes, and numbers that Applies to CO Only.
Type: String may appear on package.
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/NumberOfPackagesPerCommodity
NumberOfPackagesPerCommodity Required: Cond The total number of packages, cartons, or Applicable for CO and is required. Should be
Type: String containers for the commodity. numeric. Valid characters are 0 -9.
Max Allowed: 1
Length: 1…3
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProductWeight
ProductWeight Required: Cond The shipping weight, including containers, for Applies to CO and EEI forms only. Required
Type: Container each commodity with a separate Harmonized for CO and EEI forms.
Max Allowed: 1 Tariff Code / Schedule B Number. This weight
Length: N/A does not include carrier equipment.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ProductWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container tag for the Unit of Measurement of Applies to CO and EEI forms only.
Type: Container weight.
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 251
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 252
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/Number
Number Required: Yes* A unique 10-digit commodity classification Applies to EEI forms only. Has to be 10
Type: String code for the item being exported. (To classify a characters.
Max Allowed: 1 commodity access the following Web page:
Length: 10 http://www.census.gov/foreign-
trade/schedules/b/#search).
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/Quantity
Quantity Required: Cond The count of how many Schedule B units of the Applies to EEI forms only. Conditionally
Type: String current good are in the shipment (EEI only). required for EEI forms if ScheduleB
Max Allowed:2 UnitOfMeasurement is not X.
For example, if the Schedule B unit of measure
Length: 1…10
is dozens and eight dozen, is being shipped, Should be Numeric.
indicate 8 in this field.
Valid characters are 0 -9.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/UnitOfMeasurement
UnitOfMeasurement Required: Yes* The unit of measure indicated on the Export Applies to EEI forms only.
Type: Container License.
Max Allowed: 2
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 253
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/UnitOfMeasurement/Code
Code Required: Yes* The unit of measure indicated on the Export Refer to EEI Unit of Measure Codes in the
Type: String License. Enter an X if there is no unit of Appendix for valid values.
Max Allowed: 1 measure in the Schedule B Unit field.
Length: 1…3
Applies to EEI forms only.
Required for the EEI form.

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ScheduleB/UnitOfMeasurement/Description
Description Required: No Description of the Unit of Measure.
Type: String
Max Allowed: 1
Length: 1…20
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ExportType
ExportType Required: Cond Code indicating Domestic: Exports that have Applies to EEI forms only. Required for EEI
Type: String been produced, manufactured, or grown in the form.
Max Allowed: 1 United States or Puerto Rico.
Possible Values:
Length: 1
This includes imported merchandise which has
D: Domestic
been enhanced in value or changed from the
form in which imported by further manufacture F: Foreign
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 254
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/SEDTotalValue
SEDTotalValue Required: Cond This amount will always be USD. Applies to EEI forms only. Required for EEI
Type: String form. Valid characters are 0-9 and '.'
Max Allowed: 1 (Decimal point). Limit to 2 digit after the
Length: 1…15 decimal. The maximum length of the field is
15 including '.' and can hold up to 2 decimal
places.
Note: This value is calculated based on the
Product/Unit/Value and
/Product/Unit/Number (Number of Units *
Price per Unit). If the total value is incorrect it
will be replaced by the actual calculated total
value.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ExcludeFromForm
ExcludeFromForm Required: No Container tag for determining whether or not to If this container is not present we assume
Type: Container exclude product information from a particular that the DEFAULT is selected which is
Max Allowed: 1 form. "none" and all products will appear on all
Length: N/A forms.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/ExcludeFromForm/FormType
FormType Required: Yes* Indicates the name of the International form Possible Values are 04 – NAFTA CO.
Type: String requested to NOT have product information.
Please note that if this is used and you DO
Max Allowed:Unbounded
NOT have the corresponding form type
Length: 1…2
requested this will be IGNORED.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PackingListInfo
PackingListInfo Required: Cond Data Container holding package related Required for packaging list and Air Freight
Type: Container information. Packing list.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PackingListInfo/PackageAssociated
PackageAssociated Required: Yes* Data Container holding package/product Required for packaging list and Air Freight
Type: Container related information that will break up the Packing list.
Max Allowed: UNB product into each package on the packing list.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 255
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PackingListInfo/PackageAssociated/PackageNumber
PackageNumber Required: Yes* Package number the product should be Required for packaging list and Air Freight
Type: String allocated to ont he packing list. Packing list.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/PackingListInfo/PackageAssociated/ProductAmount
ProductAmount Required: Yes* Amount of Product associated with a package. Required for packaging list and Air Freight
Type: String Packing list.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/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
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/ExportInformation
ExportInformation Required: Cond Required for EEI form id it is a SDL Applies to EEI form only. Required if
Type: String product.Valid values: EEIFilingOption code 3 specified for EEI
Max Allowed: 1 form.
LC, LV, SS,MS, GS, DP, HR, UG, IC, SC, DD,
Length: 2
HH, SR, TE,TL, IS, CR, GP, RJ, TP, IP, IR, DB,
CH, RS, OS
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/License
License Required: Cond Licence information for SDL commodity. Applies to EEI form only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/License/Number
Number Required: Cond Represents any one of the following values: Applies to EEI form only.
Type: String export license number, exception code, CFR
Max Allowed: 1 citation, KPC Number, ACM Number.
Length: 7…13
Refer to EEI License Types and Exemptions in
the Appendix for valid values and formats.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 256
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/License/Code
Code Required: Cond The standard license code published by US Applies to EEI form only. It is required for
Type: String government. EEIFilingOption code 3. It is optionally
Max Allowed: 1 required for all other filing types; however, it
Refer to EEI License Codes in the Appedix for
Length: 3 is used to categorize each product as SDL or
valid values.
non-SDL. It is also used to identify which
piece of information is applicable.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/License/LicenseLineValue
LicenseLineValue Required: Cond The export monetary amount allowed per Applies to EEI form only. Required if
Type: String license. EEIFilingOption code 1A (only for SDL
Max Allowed: 1 shipments) or 3.
Required for a licensable product when the
Length: 1…10
EEI form is selected.
Format: Whole numbers only.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/License/ECCNNumber
ECCNNumber Required: Cond Product ECCN Number issued by BIS (Bureau Applies to EEI forms only. It is required for
Type: String of Industry and Security). If the license number EEIFilingOption code 3. ECCN is required
Max Allowed: 1 is a commerce license, ECCN must be one of the following License Exception
Length: 5 provided.The format is #A### or EAR99 Codes is entered: CIV, CTP, ENC, GBS, KMI,
LVS, TSR
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation
DDTCInformation Required: Cond Department of State/ Directorate of Defense Applies to EEI Form only.
Type: Container Trade Control Information. This element is a
Max Allowed: 1 container for additional information that is
Length: N/A applicable to SDL products. It will only be
evaluated if the provided license code is an
SDL code.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 257
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/ITARExemptionNumber
ITARExemptionNumber Required: Cond The specific citation (exemption number) under Applies to EEI Form only. This field is
Type: String the International Traffic in Arms Regulations applicable for EEIFiling option 1A and 3.
Max Allowed: 1 (ITAR) from the Code of Federal Register (see
Length: 3…10 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).
Refer to EEI License Codes in the Appedix for
valid values.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/USMLCategoryCode
USMLCategoryCode Required: Cond Digit numeric code (e.g. 01-18, 20 or 21). Applies to EEI form only. It is required for
Type: String Indicates the U.S. Munitions List (USML) EEIFilingOption code 3.
Max Allowed: 1 category article, service or related technical
Length: 2 data as it applies to the article reported.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/EligiblePartyIndicator
EligiblePartyIndicator Required: No Presence/Absent indicator. Certification by the
Type: String U.S. exporter that the exporter is an eligible
Max Allowed: 1 party to participate in the defense trade.
Length: 0
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/RegistrationNumber
RegistrationNumber Required: Cond It is a unique registration code assigned to the It is required for EEIFilingOption code 3.
Type: String registrant. The DDTC registration code consist
Max Allowed: 1 of a letter prefix, M (assigned to a manufacturer
Length: 6 and/or exporter) or K (assigned to a broker),
followed by four or five digits (e.g. K-1234 or
M12345).
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/Quantity
Quantity Required: Cond Export Quantity. Applies to EEI form only. It is required for
Type: String EEIFilingOption code 3. Only positive integer
Max Allowed: 1 value is valid.
Length: 1…7

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 258
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/UnitOfMeasurement
UnitOfMeasurement Required: Cond Container for unit of measurement. Applies to EEI form only. It is required for
Type: Container EEIFilingOption code 3.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/UnitOfMeasurement/Code
Code Required: Yes* Required for EEI form. Unit of measurement Applies to EEI form only. It is required for
Type: String code. The two or three (3) alpha unit of EEIFilingOption code 1A and 3.
Max Allowed: 1 measurement for the article being shipped. For
Length: 2…3 example: BAG/BG - bags
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/UnitOfMeasurement/Description
Description Required: No Description for Unit of Measurement. Applies to EEI form only.
Type: String
Max Allowed: 1
Length: 1…15
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/SignificantMilitaryEquipmentIndicator
SignificantMilitaryEquipmentIndicator Required: No Presence/ Absence Indicator. Applies to EEI form only.
Type: String
Max Allowed: 1
Length: 0
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Product/EEIInformation/DDTCInformation/ACMNumber
ACMNumber Required: Cond Approved Community Member Number (ACM). Applies to EEI form only. It is required for
Type: String It is required to be provided along with EEIFilingOption code 1A and 3.
Max Allowed: 1 ITARExemptionNumber for some License code
Length: 11 (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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 259
Shipping Package Web Service Developer Guide November 1, 2016

International Forms continued

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 260
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/TermsOfShipment
TermsOfShipment Required: No Indicates the rights to the seller from the buyer. Also, it Applies to Invoice and Partial Invoice forms only.
Type: String refers to Terms of Sale.
Values:
Max Allowed: 1
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
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/ReasonForExport
ReasonForExport Required: Cond A reason to export the current international shipment. Applies to Invoice and Partial Invoice forms only.
Type: String Possible values: SALE, GIFT, SAMPLE, RETURN,
Required for Invoice forms and Optional for Partial
Max Allowed: 1 REPAIR, INTERCOMPANYDATA, Any other reason.
Invoice.
Length: 1…20
No validation.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Comments
Comments Required: No Any extra information about the current shipment. Applies to Invoice and Partial Invoice forms only.
Type: String
Max Allowed: 1
Length: 1…150

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 261
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/DeclarationStatement
DeclarationStatement Required: No This is the legal explanation, used by Customs, for the Applies to Invoice and Partial Invoice forms only.
Type: String delivering of this shipment. It must be identical to the set On the invoice for return shipment, the verbiage is
Max Allowed: 1 of declarations actually used by Customs. as follows (user input is ignored): The exporter of
Length: 1…550 the products covered by this document declares
Examples of declarations that might be entered in this
that except where otherwise clearly indicated these
field are:
products are of EEA preferential origin
I hereby certify that the goods covered by this shipment
qualify as originating goods for purposes of preferential
tariff treatment under the NAFTA.
I hereby certify that the information on this invoice is true
and correct and the contents and value of this shipment
is as stated above.
EEA statement: The exporter of the products covered by
this document declares that except where otherwise
clearly indicated these products are of EEA preferential
origin.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Discount
Discount Required: No Container tag that holds the discount. Applies to Invoice and Partial Invoice forms only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/Discount/MonetaryValue
MonetaryValue Required: Yes* The discount to be subtracted from the sum of the total Applies to Invoice and Partial Invoice forms only.
Type: String value on the invoice. Required for Invoice forms and optional for Partial
Max Allowed: 1 Invoice. Valid characters are 0-9 and '.' (Decimal
Length: 1…15 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.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/FreightCharges
FreightCharges Required: No Container tag that holds the Freight Charges. Applies to Invoice and Partial Invoice forms only.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 262
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/FreightCharges/MonetaryValue
MonetaryValue Required: Yes* Cost to transport the shipment. Applies to Invoice and Partial Invoice forms only.
Type: String Required for Invoice forms and optional for Partial
Max Allowed: 1 Invoice. Valid characters are 0-9 and '.' (Decimal
Length: 1…15 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.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/InsuranceCharges
InsuranceCharges Required: No Container tag that holds the Insurance Charges. Applies to Invoice and Partial Invoice forms only.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/InsuranceCharges/MonetaryValue
MonetaryValue Required: Yes* The amount the shipper or receiver pays to cover the Applies to Invoice and Partial Invoice forms only.
Type: String cost of replacing the shipment if it is lost or damaged. Required for Invoice forms and optional for Partial
Max Allowed: 1 Invoice. Valid characters are 0-9 and '.' (Decimal
Length: 1…15 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.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/OtherCharges
OtherCharges Required: No Container tag that holds the information of amount that Applies to Invoice and Partial Invoice forms only.
Type: Container covers additional charges not already listed on the
Max Allowed: 1 invoice.
Length: N/A
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/OtherCharges/MonetaryValue
MonetaryValue Required: Yes* The Monetary value of Other Charges. Applies to Invoice and Partial Invoice forms only.
Type: String Required for Invoice forms and optional for Partial
Max Allowed: 1 Invoice. Valid characters are 0-9 and '.' (Decimal
Length: 1…15 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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 263
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/OtherCharges/Description
Description Required: Yes* Description of what the other charges are for. Applies to Invoice and Partial Invoice forms only.
Type: String Required for Complete Invoice and Optional for
Max Allowed: 1 Partial Invoice forms.
Length: 1…10
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CurrencyCode
CurrencyCode Required: Cond Currency code for all the monetary values of the Invoice Applies to Invoice and Partial Invoice forms only.
Type: String form.
Max Allowed: 1
Length: 3
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/BlanketPeriod
BlanketPeriod Required: Cond This field should be entered if the NAFTA Certificate Applies to NAFTA CO form only. Required for
Type: Container covers multiple shipments of identical goods as NAFTA CO. This is not valid for a paperless
Max Allowed: 1 described in the Description of Goods field that are shipment.
Length: N/A 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.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/BlanketPeriod/BeginDate
BeginDate Required: Yes* Begin date of the blanket period. It is the date upon Applies to NAFTA CO form only. Required for
Type: String which the Certificate becomes applicable to the good NAFTA CO. Format is yyyyMMdd. This is not valid
Max Allowed: 1 covered by the blanket Certificate (it may be prior to the for a paperless shipment.
Length: 8 date of signing this Certificate).
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/BlanketPeriod/EndDate
EndDate Required: Yes* End Date of the blanket period. It is the date upon which Applies to NAFTA CO form only. Required for
Type: String the blanket period expires. NAFTA CO. Format is yyyyMMdd. This is not valid
Max Allowed: 1 for a paperless shipment.
Length: 8
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/ExportDate
ExportDate Required: Cond The date the goods will be exiting the country. Applies to CO and EEI forms only. Required for CO
Type: String and EEI forms. Format is yyyyMMdd.
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 264
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/ExportingCarrier
ExportingCarrier Required: Cond The name of the carrier that is exporting the shipment. Applies to CO and EEI forms only. Required for CO
Type: String The vessels flag number should also be entered, if the and EEI forms.
Max Allowed: 1 carrier is a vessel.
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/CarrierID
CarrierID Required: No The four-character Standard Carrier Alpha Code Applies to EEI forms only. No Validations.
Type: String (SCAC) for vessel, rail, and truck shipments. For air
Max Allowed: 1 shipment, enter the two or three character International
Length: 1…17 Air Transport Association (IATA) code.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/InBondCode
InBondCode Required: Cond The two-character In Bond Code. Applies to EEI forms only. Required for EEI forms.
Type: String Valid values for EEI are: 70: Not in bond; 67: IE
Max Allowed: 1 from a FTZ; 68: T&E from a FTZ.
Length: 2
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/EntryNumber
EntryNumber Required: Cond The Import Entry Number when the export transaction is Applies to EEI forms only. Conditionally Required
Type: String used as proof of export for import transactions for EEI forms when In bond code value is other
Max Allowed: 1 (examples: In Bond, Temporary Import Bond or than 70 (Not In Bond)
Length: 1…25 Drawbacks).
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/PointOfOrigin
PointOfOrigin Required: Cond Contains one of the following: The two-digit U.S. Postal Applies to EEI forms only. Required for EEI.
Type: String Service abbreviation for the state from which the goods
Max Allowed: 1 were shipped to the port of export. The state that is the
Length: 1…5 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.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/PointOfOriginType
PointOfOriginType Required: Cond Valid values are : S (for state postal code abbrevation) , Applies EEI forms only. Required for EEI form.
Type: String F : FTZ Identifier
Max Allowed: 1
Length: 1

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 265
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/ModeOfTransport
ModeOfTransport Required: Cond Mode of transport by which the goods are exported. Applies to EEI forms only. Required for EEI. Only
Type: String Possible values: Air, AirContainerized, Auto, allowed values can be entered. Only 10
Max Allowed: 1 FixedTransportInstallations, Mail, Characters can appear on the form. Anything
Length: 1…35 PassengerHandcarried, Pedestrian, Rail, Rail, greater than 10 characters will be truncated on the
Containerized, RoadOther, SeaBarge, form.
SeaContainerized, SeaNoncontainerized, Truck,
TruckContainerized.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/PortOfExport
PortOfExport Required: No Should be one of the following: Applies to EEI forms only. No validation is
Type: String performed.
Overland: The U.S. Customs port where the carrier
Max Allowed: 1
crosses the U.S. border.
Length: 1…35
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.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/PortOfUnloading
PortOfUnloading Required: The country and the port where the goods will be Applies to EEI forms only. No validation is
Type: String unloaded from the exporting carrier. For vessel and air performed.
Max Allowed: 1 shipments only.
Length:
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/LoadingPier
LoadingPier Required: No Pier where goods are loaded. For vessel shipments Applies to EEI forms only. No validation is
Type: String only. performed.
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/PartiesToTransaction
PartiesToTransaction Required: Cond Information about parties to transaction. Use Related, if Applies to EEI forms only. Valid values: R -
Type: String the parties to the transaction are related. A related party Related, N - Non-related.
Max Allowed: 1 is an export from a U.S. businessperson or business to a
Length: 1 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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 266
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/RoutedExportTransactionIndicator
RoutedExportTransactionIndicator Required: No If Present, indicates that it is a routed export transaction. Applies to EEI forms only.
Type: String A routed export transaction is one, where the foreign
Max Allowed: 1 principal party in interest authorizes a U.S. forwarding
Length: 0 (or other) agent to export the merchandise outside the
U.S.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/ContainerizedIndicator
ContainerizedIndicator Required: No If present indicates that the goods are containerized. Applies to EEI forms only.
Type: String This applies to vessel shipments only.
Max Allowed: 1
Length: 0
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/OverridePaperlessIndicator
OverridePaperlessIndicator Required: No The application will automatically provide a copy of the
Type: String invoice or NAFTA/CO with each response regardless of
Max Allowed: 1 whether the user has enabled Paperless account. The
Length: 0 user now has the option to print or ignore the copy
provided.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/InternationalForms/ShipperMemo
ShipperMemo Required: No Text for the shipper to add additional information. Forward shipment only.
Type: String
Max Allowed: 1
Length: 1…300

DeliveryConfirmation

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/DeliveryConfirmation
DeliveryConfirmation Required: No Delivery Confirmation container. Valid for forward shipments only.
Type: Container
Refer to Delivery Confirmation Origin-Destination Pairs in the
Max Allowed: 1
Appendix for a list of valid values.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 267
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/DeliveryConfirmation/DCISType
DCISType Required: Yes* Type of delivery confirmation. Valid values:
Type: String
1 - Delivery Confirmation Signature Required
Max Allowed: 1
Length: 1 2 - Delivery Confirmation Adult Signature Required
Valid for forward shipments only
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/DeliveryConfirmation/DCISNumber
DCISNumber Required: No DCIS Number.
Type: String
Max Allowed: 1
Length: 1…20

ReturnOfDocumentIndicator

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/ReturnOfDocumentIndicator
ReturnOfDocumentIndicator Required: No The flag indicates the ReturnOfDocument accessorial has been Valid for Poland to Poland forward shipment only.
Type: String requested.
Max Allowed: 1
Length: 0

ImportControlIndicator

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 268
Shipping Package Web Service Developer Guide November 1, 2016

LabelMethod

Name Constraint Description Validation

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

CommercialInvoiceRemovalIndicator

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 269
Shipping Package Web Service Developer Guide November 1, 2016

UPScarbonneutralIndicator

Name Constraint Description Validation

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

PreAlertNotification

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 270
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 271
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/Locale/Language
Language Required: Yes* Refer to Language / Dialect Combinations in the
Type: String Appendix for valid pairs.
Max Allowed: 1
Length: 3
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/PreAlertNotification/Locale/Dialect
Dialect Required: Yes* Refer to Language / Dialect Combinations in the
Type: String Appendix for valid pairs.
Max Allowed: 1
Length: 2

ExchangeForwardIndicator

Name Constraint Description Validation

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

HoldForPickupIndicator

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 272
Shipping Package Web Service Developer Guide November 1, 2016

DropoffAtUPSFacilityIndicator

Name Constraint Description Validation

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

LiftGateForPickUpIndicator

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/LiftGateForPickUpIndicator
LiftGateForPickUpIndicator Required: No Lift Gate For Pick Up indicator. The empty tag means indicator Lift Gate for Pickup is not allowed with Drop Off At UPS
Type: String is present. Facility for a UPS Worldwide Express Freight shipment.
Max Allowed: 1 When both Hold for Pickup and Drop Off At Facility are
Length: 0 selected, neither of the Lift Gate accessorial (Pick Up or
Delivery) are allowed for a UPS Worldwide Express
Freight shipment. This accessorial is only valid for UPS
Worldwide Express Freight Shipment.
/ShipConfirmRequest/Shipment/ShipmentServiceOptions/LiftGateForDeliveryIndicator
LiftGateForDeliveryIndicator Required: No Lift Gate For Delivery indicator. The empty tag means indicator Lift Gate for Delivery is not allowed with Hold For Pickup
Type: String is present. for a UPS Worldwide Express Freight shipment. When
Max Allowed: 1 both Hold for Pickup and Drop Off At UPS Facility are
Length: 0 selected, neither of the Lift Gate accessorial (Pick Up or
Delivery) are allowed for a UPS Worldwide Express
Freight shipment. This accessorial is only valid for UPS
Worldwide Express Freight Shipment.

SDLShipmentIndicator

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 273
Shipping Package Web Service Developer Guide November 1, 2016

EPRAReleaseCode

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/ShipmentServiceOptions/EPRAReleaseCode
EPRAReleaseCode Required: No Package Release code allows the consignee or claimant to pick- The release code must be between length 4 and 6 and
Type: String up a package at a UPS Access Point™. only contain numbers.
Max Allowed: 1
The shipper must provide the Package Release Code to the
Length: 4...6
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™.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 274
Shipping Package Web Service Developer Guide November 1, 2016

Package

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 275
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/Packaging/Code
Code Required: Yes Package types. Values are: Package type 24, or 25 is only allowed for shipment
Type: String without return service.
Max Allowed: 1 • 01 = UPS Letter
Packaging type must be valid for all the following:
Length: 2 • 02 = Customer Supplied Package
• ShipTo country
• 03 = Tube
• ShipFrom country
• 04 = PAK
• Shipments going from ShipTo country to ShipFrom
• 21 = UPS Express Box country
• 24 = UPS 25KG Box • All Accessorials at both the shipment and package
• 25 = UPS 10KG Box level
• 30 = Pallet • Shipment service type
• 2a = Small Express Box UPS will not accept raw wood pallets and please
refer the UPS packaging guidelines for pallets on
• 2b = Medium Express Box UPS.com.
• 2c = Large Express Box
• 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.

Note: Only packaging type code 02 is applicable to

Ground Freight Pricing.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 276
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/Packaging/Description
Description Required: No Description of packaging type. Examples are letter,
Type: String customer supplied, express box.
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/Package/Dimensions
Dimensions Required: Cond Dimensions information container. Length + 2*(Width + Height) must be less than or
Type: Container equal to 130 IN or 330 CM.
Note: Currently dimensions are not applicable to Ground
Max Allowed: 1
Freight Pricing.
Length: N/A
/ShipConfirmRequest/Shipment/Package/Dimensions/UnitOfMeasurement
UnitOfMeasurement Required: Yes* UnitOfMeasurement container for dimensions.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/Dimensions/UnitOfMeasurement/Code
Code Required: Yes* Package dimensions measurement code. The unit of measurement must be valid for the
Type: String Shipper country.
Valid codes are:
Max Allowed: 1
Length: 2 • IN = Inches
• CM = Centimeters
• 00 = Metric Units Of Measurement
• 01 = English Units of Measurement
/ShipConfirmRequest/Shipment/Package/Dimensions/UnitOfMeasurement/Description
Description Required: No Description of the package dimensions measurement
Type: String units.
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/Package/Dimensions/Length
Length Required: Yes* Package length. Length must be the longest dimension of Valid values are 0 to 108 IN and 0 to 270 CM.
Type: String the container.
Max Allowed: 1
Length: 3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 277
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/Dimensions/Width
Width Required: Yes* Package width.
Type: String
Max Allowed: 1
Length: 3
/ShipConfirmRequest/Shipment/Package/Dimensions/Height
Height Required: Yes* Package height.
Type: String
Max Allowed: 1
Length: 3
/ShipConfirmRequest/Shipment/Package/PackageWeight
PackageWeight Required: Cond Container to hold package weight information. Package weight is a required for Ground Freight
Type: Container Pricing shipments.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/PackageWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container to hold UnitOfMeasurement information for
Type: Container package weight.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/PackageWeight/UnitOfMeasurement/Code
Code Required: Yes* Package weight unit of measurement code. Codes are:
Type: String
Max Allowed: 1 • LBS = Pounds
Length: 3 • KGS = Kilograms
• OZS = Ounces
Unit of Measurement "OZS" is the only valid UOM for
some of the Mail Innovations Forward Shipments.
Refer to Appendix for more details regarding the valid
combination of Mail Innovation Forward Shipment
services,
Package Type and Unit of Measurement.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 278
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/PackageWeight/UnitOfMeasurement/Description
Description Required: No Description of the unit of measurement for package
Type: String weight.
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/Package/PackageWeight/Weight
Weight Required: Yes* Packages weight. Weight accepted for letters/envelopes. Only average package weight is required for
Type: String Ground Freight Pricing Shipment.
Max Allowed: 1
Length: 1…5
/ShipConfirmRequest/Shipment/Package/LargePackageIndicator
LargePackageIndicator Required: No Presence of the indicator mentions that the package is Empty Tag.
Type: String Large Package.
Max Allowed: 1
Length: 0
/ShipConfirmRequest/Shipment/Package/ReferenceNumber
ReferenceNumber Required: No Package reference number information container. For Mail Innovation shipments reference number is
Type: Container not supported.
Max Allowed: 2
Length: N/A
/ShipConfirmRequest/Shipment/Package/ReferenceNumber/BarCodeIndicator
BarCodeIndicator Required: No If the indicator is present then the reference number's Empty Tag. Only one shipment-level or package-
Type: String value will be bar coded on the label. level reference number can be bar coded per
Max Allowed: 1 shipment. In order to barcode a reference number,
Length: 0 its value must be no longer than 14 alphanumeric
characters or 24 numeric characters and cannot
contain spaces.
/ShipConfirmRequest/Shipment/Package/ReferenceNumber/Code
Code Required: No Reference number type code, for the entire shipment. The Valid if the origin/destination pair is US/US or
Type: String code specifies the Reference name. PR/PR. It needs to be alpha-numeric.
Max Allowed: 1
Refer to the Reference Number Code table.
Length: 2

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 279
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/ReferenceNumber/Value
Value Required: Yes* Customer supplied reference number. Valid if the origin/destination pair is US/US or
Type: String PR/PR. Supports up to 2 customer supplied
Max Allowed: 1 combinations of Reference code- value
Length: 1…35 combinations.
/ShipConfirmRequest/Shipment/Package/AdditionalHandlingIndicator
AdditionalHandlingIndicator Required: No Additional Handling Required. The presence indicates Empty Tag.
Type: String additional handling is required, the absence indicates no
Max Allowed: 1 additional handling is required.
Length: 0
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions
PackageServiceOptions Required: No Package Service Options container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DeliveryConfirmation
DeliveryConfirmation Required: No Delivery Confirmation container. Valid only for forward shipment only.
Type: Container
Refer to in the Appendix for valid values.
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 280
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DeliveryConfirmation/DCISType
DCISType Required: Yes* Type of delivery confirmation. Valid values:
Type: String
Max Allowed: 1 • 1 - Delivery Confirmation
Length: 1 • 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
• Media Mail

USPS Delivery Confirmation is prohibited for:

• Standard Flats
• BPM
• BPM Flats
• Parcels
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DeliveryConfirmation/DCISNumber
DCISNumber Required: No Delivery Confirmation Control number associated with the Valid for forward shipments only.
Type: String delivery confirmation for the package.
Max Allowed: 1
Length: 1…11

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 281
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DeclaredValue
DeclaredValue Required: No Container for Declared Value.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DeclaredValue/Type
Type Required: No Container for Declared Value Type.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DeclaredValue/Type/Code
Code Required: Yes* Declared value type. Valid value are 01=EVS, 02=DVS. The user cannot specify different type of declared
Type: String Defaults to 01 i.e. EVS if declared value type is not value for the shipment. User can either have shipper
Max Allowed: 1 provided. declared value (DVS) or declared value (EVS) but
Length: 2 not both at package level.
Note: The Shipper Declared Value is applicable for
forward shipments when the billing option is freight
collect or third party.
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DeclaredValue/Type/Description
Description Required: No Declared value Description.
Type: String
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DeclaredValue/CurrencyCode
CurrencyCode Required: Yes* Declared value amount currency type. Defaults to the Code must represent a currency that is a valid for
Type: String non-Euro currency used in the shipper's country. Shipper country.
Max Allowed: 1
Length: 3
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DeclaredValue/MonetaryValue
MonetaryValue Required: Yes* Declared value amount.
Type: String
Max Allowed: 1
Length: 1…19

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 282
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/COD
COD Required: No Container for COD. Indicates COD is requested.
Type: Container
Package level COD is available for shipment
Max Allowed: 1
without return service from US/PR to US/PR, CA to
Length: N/A
CA, and CA to U.S.. CA to U.S. COD is not allowed
for package Letter/ Envelope.
COD is not valid for return service movements.
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/COD/CODFundsCode
CODFundsCode Required: Yes* For valid values, refer to COD Supported Countries in the
Type: String Appendix.
Max Allowed: 1
Length: 1
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/COD/CODAmount
CODAmount Required: Yes* COD Amount container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/COD/CODAmount/CurrencyCode
CurrencyCode Required: Yes* COD amount currency code type.
Type: String
Max Allowed: 1
Length: 3
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/COD/CODAmount/MonetaryValue
MonetaryValue Required: Yes* COD Amount. Valid values:
Type: String
0.01 to 50000.00 U.S.D
Max Allowed: 1
Length: 5

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 283
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/AccessPointCOD
AccessPointCOD Required: No Access Point COD indicates Package COD is requested Valid only for "01 - Hold For Pickup At UPS Access
Type: Container for a shipment. Point" Shipment Indication type.
Max Allowed: 1
Package Access Point COD is valid only for
Length: N/A
shipment without return service from US/PR to
US/PR and CA to CA.
Not valid with COD at package level.
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/AccessPointCOD/CurrencyCode
CurrencyCode Required: Yes* Access Point COD Currency Code.
Type: String
Max Allowed: 1
Length: 3
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/AccessPointCOD/MonetaryValue
MonetaryValue Required: Yes* Access Point COD Monetary Value.
Type: String
Max Allowed: 1
Length: 1…8
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation
VerbalConfirmation Required: No Verbal Confirmation Info. Allowed for shipment without return service.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo
ContactInfo Required: Cond Optional if the Shipper's AttentionName, PhoneNumber,
Type: Container and PhoneExtension (optional) are given and are the
Max Allowed: 1 desired name, phone number and extension,
Length: N/A respectively, to be used for verbal confirmation.
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo/Name
Name Required: Cond Name of the person to be contacted for confirmation. Optional if Shipper/AttentionName is given and that
Type: String Defaults to Shipper AttentionName if given. is the name of the person to be contacted else
Max Allowed: 1 required for verbal confirmation.
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 284
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo/Phone
Phone Required: No Phone container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo/Phone/Number
Number Required: Yes* Contact phone number.
Type: String
Max Allowed: 1
Length: 1…15
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/ContactInfo/Phone/Extension
Extension Required: No Contact phone extension.
Type: String
Max Allowed: 1
Length: 1…4
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/ShipperReleaseIndicator
ShipperReleaseIndicator Required: No The presence indicates that the package may be released Empty Tag. Only available for US50/PR to US50/PR
Type: String by driver without a signature from the consignee. packages without return service.
Max Allowed: 1
Length: 0
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/Notification
Notification Required: No Receiver Return Notification. Applicable for Shipment with returned service.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 285
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/NotificationCode
NotificationCode Required: Yes* Notification Code. Valid values:
Type: String
3 - Receiver Return Notification
Max Allowed: 1
Length: 1 6 - QV Email Notification
7 - QV Exception Notification
8 - QV Delivery Notification
For Mail Innovations forward shipments, QV Email
Notifications are allowed for First Class, Priority
Mail, and Expedited Mail Innovation services.
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMail
EMail Required: Yes* Container for the e-mail message.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/EMailAddress
EMailAddress Required: Yes* The destination email address of the receiver returns
Type: String notification email.
Max Allowed: 1
Length: 1…50
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/UndeliverableEMailAddress
UndeliverableEMailAddress Required: No The e-mail address where an undeliverable email Defaults to FromEMailAddress. Only allowed at the
Type: String message is sent if the Receiver Return Notification email first package.
Max Allowed: 1 is undeliverable.
Length: 1…50
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/FromEMailAddress
FromEMailAddress Required: No The email address listed in the Reply To field of the Only allowed at the first package.
Type: String message header, includes name and e-mail address of
Max Allowed: 1 sender. The "From" field of the message header contains
Length: 1…50 pkginfo@ups.com.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 286
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/FromName
FromName Required: No The name the receiver return notification will appear to be Defaults to the Shipper Name. Only allowed at the
Type: String from. first package.
Max Allowed: 1
Length: 1…35
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/Memo
Memo Required: No User defined text that will be included in the email. Only allowed at the first package.
Type: String
Max Allowed: 1
Length: 1…150
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/Subject
Subject Required: No The eMail's subject. Defaults to the UPS Receiver Return Only allowed at the first package.
Type: String Notification plus the shipment ID.
Max Allowed: 1
Length: 1…75
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/Notification/EMail/SubjectCode
SubjectCode Required: No Specifies a reference code and reference number to If the subject code tag is not provided and the
Type: String display in the subject of the Receiver Return Notification. subject text is provided, the subject of the
Max Allowed: 1 notification will be the subject text. If the subject text
When the subject code is provided, the subject will
Length: 2 is provided, and subject code tag exists, then the
contain the following: UPS Receiver Return Notification.
subject code value must be 08.
The reference code (the reference code will be mapped to
If the subject code is 08, the subject text must exist. If
the corresponding ANSI value) Plus the reference
a subject code is provided that refers to a
number.
nonexistent reference number, the subject will
default to the tracking number. Only allowed at the
first package.
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce
DryIce Required: No Container for Dry Ice. Maximum 1 Dry Ice is allowed.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 287
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/RegulationSet
RegulationSet Required: Yes* Regulation set for dryIce Shipment.
Type: String
Valid values:
Max Allowed: 1
Length: 3…4 CFR = HazMat regulated by U.S. Dept. of Transportation
within the U.S. or ground shipments to Canada
IATA= Worldwide Air movement
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight
DryIceWeight Required: Yes* Container for Dry Ice weight.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container for Unit of measurement for Dry Ice Weight.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/UnitOfMeasurement/Code
Code Required: Yes* DryIce weight unit of measurement code. Valid values:
Type: String
Max Allowed: 1 • 00 = KG (Metric Unit of Measurements)
Length: 2…3 • 01 = LB (English Unit of Measurements)
• KG
• LB
• KGS
• LBS
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/UnitOfMeasurement/Description
Description Required: No Description for unit of measurement for Dry Ice Weight.
Type: String
Max Allowed: 1
Length: 1…20

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 288
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/Weight
Weight Required: Yes* Dry Ice Weight. Cannot be more than package weight.
Type: String
Should be more than 0.0.
Max Allowed: 1
Length: 1…5 Valid characters are 0-9 and "." (Decimal point).
Limit to 1 digit after the decimal.
The maximum length of the field is 5 including "."
and can hold up to 1 decimal place.
/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/DryIce/MedicalUseIndicator
MedicalUseIndicator Required: No Presence/Absence Indicator. Any value inside is ignored.
Type: String Relevant only in CFR regulation set. If present it is used to
Max Allowed: 1 designate the dry Ice is for any medical use and rates are
Length: 0 adjusted for DryIce weight more than 2.5 Kgs or 5.7 Lbs.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 289
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/PackageServiceOptions/UPSPremiumCareIndicator
UPSPremiumCareIndicator Required: No An UPSPremiumCareIndicator indicates special handling Empty Tag means indicator is present.
Type: String is required for shipment having controlled substances.
The UPSPremiumCareIndicator cannot be
Max Allowed: 1
requested for package with Delivery Confirmation -
Length: 0
Adult Signature Required and Delivery
Confirmation- Signature Required.
UPSPremiumCareIndicator 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 UPSPremiumCareIndicator can be requested
with following UPS services:

• UPS Express Early

• UPS Express
• UPS Express Saver
• UPS Standard
Valid only for Canada to Canada movements.
/ShipConfirmRequest/Shipment/Package/Commodity
Commodity Required: Cond Container to hold the Commodity information. It is required if the Ground Freight Pricing Shipment
Type: Container indicator is present in the request.
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/Commodity/FreightClass
FreightClass Required: Yes* Freight Classification. Freight class partially determines Required for Ground Freight Pricing Shipments
Type: String the freight rate for the article. only.
Max Allowed: 1
Length: 10

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 290
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmRequest/Shipment/Package/Commodity/NMFC
NMFC Required: No Container to hold the NMFC codes.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/Shipment/Package/Commodity/NMFC/PrimeCode
PrimeCode Required: Yes* Specifies the Commodity's NMFC prime code. Required if NMFC Container is present.
Type: String
Max Allowed: 1
Length: 4…6
/ShipConfirmRequest/Shipment/Package/Commodity/NMFC/SubCode
SubCode Required: No Specifies the Commodity's NMFC sub code. Needs to be provided when the SubCode
Type: String associated with the PrimeCode is other than 00.
Max Allowed: 1
UPS defaults the sub value to 00 if not provided. If
Length: 2
provided the Sub Code should be associated with
the PrimeCode of the NMFC.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 291
Shipping Package Web Service Developer Guide November 1, 2016

Label Specification
Name Constraint Description Validation
/ShipConfirmRequest/LabelSpecification
LabelSpecification Required: Cond Container used to define the properties required by the user to Required for shipment without return service or shipments
Type: Container print and/or display the UPS shipping label. with PRL return service.
Max Allowed: 1
Length: N/A

LabelImageFormat

Name Constraint Description Validation

/ShipConfirmRequest/LabelSpecification/LabelImageFormat
LabelImageFormat Required: Yes* LabelImageFormat Container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/LabelSpecification/LabelImageFormat/Code
Code Required: Yes* Label print method code determines the format in which Labels For shipments without return service the valid value is GIF,
Type: String are to be generated. ZPL, EPL and SPL.
Max Allowed: 1
• For EPL2 formatted Labels use EPL For shipments with PRL return service, the valid values are
Length: 4
EPL, ZPL, SPL, STARPL and GIF.
• For SPL formatted Labels use SPL
For Mail Innovations forward shipments STARPL is not
• For ZPL formatted Labels use ZPL and for image formats use supported.
GIF
• For Star Printer format formatted Labels use STARPL
/ShipConfirmRequest/LabelSpecification/LabelImageFormat/Description
Description Required: No Description of the label image format code.
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 292
Shipping Package Web Service Developer Guide November 1, 2016

HTTPUserAgent

Name Constraint Description Validation

/ShipConfirmRequest/LabelSpecification/HTTPUserAgent
Required: Cond Browser HTTPUserAgent String. This is the preferred way of Required if
Type: String identifying GIF image type to be generated. /ShipConfirmRequest/LabelSpecificationLabelSpecification/
Max Allowed: 1 LabelImageFormat/Code = Gif.
Length: 1...64
Default to Mozilla/4.5 if this field is missing or has invalid
value.

LabelStockSize

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 293
Shipping Package Web Service Developer Guide November 1, 2016

Instruction

Name Constraint Description Validation

/ShipConfirmRequest/LabelSpecification/Instruction
Instruction Required: No Routing Instruction Container.
Type: Container
Max Allowed: UNB
Length: N/A
/ShipConfirmRequest/LabelSpecification/Instruction/Code
Code Required: Yes* For Exchange Forward Shipment, by default Label will have
Type: String Exchange Routing instruction Text as EXCHANGE-LIKE ITEM
Max Allowed: 1 ONLY.
Length: 2
If code value is:
01- EXCHANGE-LIKE ITEM ONLY
02- EXCHANGE-DRIVER INSTRUCTIONS INSIDE
/ShipConfirmRequest/LabelSpecification/Instruction/Description
Description Required: No Description of the label Instruction code.
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 294
Shipping Package Web Service Developer Guide November 1, 2016

ReceiptSpecification
Name Constraint Description Validation
/ShipConfirmRequest/ReceiptSpecification
ReceiptSpecification Required: No Container used to allow the user to choose to print a thermal
Type: Container receipt.
Max Allowed: 1
Length: N/A

ImageFormat

Name Constraint Description Validation

/ShipConfirmRequest/ReceiptSpecification/ImageFormat
ImageFormat Required: Yes* ImageFormat Container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmRequest/ReceiptSpecification/ImageFormat/Code
Code Required: Yes* Print code that determines the receipt format. Valid Codes are: EPL, SPL, ZPL, STARPL and HTML.
Type: String
Max Allowed: 1
Length: 3…4
/ShipConfirmRequest/ReceiptSpecification/ImageFormat/Description
Description Required: No Description of the receipt format code.
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 295
ShipConfirmResponse Top Level Containers

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 296
Shipping Package Web Service Developer Guide November 1, 2016

ShipConfirmResponse XPath Tables

Note: Not all containers/elements are reflected separately in the table of contents.

Name Constraint Description Validation

/ShipConfirmResponse
ShipConfirmResponse Required: Yes Ship Confirm Response.
Type: Container
Max Allowed: 1
Length: N/A

Response
Name Constraint Description Validation
/ShipConfirmResponse/Response
Response Required: Yes Response container.
Type: Container
Max Allowed: 1
Length: N/A

ResponseStatus

Name Constraint Description Validation

/ShipConfirmResponse/Response/ResponseStatus
ResponseStatus Required: Yes Response status container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmResponse/Response/ResponseStatus/Code
Code Required: Yes Identifies the success or failure of the transaction. 1 = Successful
Type: String
Max Allowed: 1
Length: 1

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 297
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmResponse/Response/ResponseStatus/Description
Description Required: Yes Describes Response Status Code. Returns text of Success.
Type: String
Max Allowed: 1
Length: 1…35

Alert

Name Constraint Description Validation

/ShipConfirmResponse/Response/Alert
Alert Required: No Alert Container. There can be zero to many alert containers with
Type: Container code and description.
Max Allowed: UNB
Length: N/A
/ShipConfirmResponse/Response/Alert/Code
Code Required: Yes* Warning code returned by the system.
Type: String
Max Allowed: 1
Length: 1…10
/ShipConfirmResponse/Response/Alert/Description
Description Required: Yes* Warning messages returned by the system.
Type: String
Max Allowed: 1
Length: 1…150

TransactionReference

Name Constraint Description Validation

/ShipConfirmResponse/Response/TransactionReference
TransactionReference Required: No Transaction Reference Container.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 298
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmResponse/Response/TransactionReference/CustomerContext
CustomerContext Required: No The CustomerContext Information which will be echoed during
Type: String response.
Max Allowed: 1
Length: 1…512

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 299
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentResults
Name Constraint Description Validation
/ShipConfirmResponse/ShipmentResults
ShipmentResults Required: Yes Shipment Results container.
Type: Container
Max Allowed: 1
Length: N/A

Disclaimer

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/Disclaimer
Disclaimer Required: Cond Disclaimer would be used to provide more information to shipper
regarding the processed shipment. This would be used to notify
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
valid values.
This field would be returned only if TaxInformationIndicator is
present in a request.
/ShipConfirmResponse/ShipmentResults/Disclaimer/Code
Code Required: Yes* Code representing type of Disclaimer.
Type: String
Refer to Disclaimer Codes and Messages in the Appendix for
Max Allowed: 1
valid values.
Length: 2
/ShipConfirmResponse/ShipmentResults/Disclaimer/Description
Description Required: Yes* Disclaimer description.
Type: String
Refer to Disclaimer Codes and Messages in the Appendix for
Max Allowed: 1
valid values.
Length:
Unbounded

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 300
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentCharges

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/ShipmentCharges
ShipmentCharges Required: Cond Shipment charges Container. Shipment charges info.
Type: Container Shipment charges are only guaranteed to be returned for
Max Allowed: 1 shipments whose origin country is US or Puerto Rico.
Length: N/A
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/RateChart
RateChart Required: No Rate Type with which Shipment is rated.
Type: String
Possible RateChart values for different regions will be:
Max Allowed: 1
Length: 1 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
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/TransportationCharges
TransportationCharges Required: Yes* Transportation Charges container.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 301
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/ShipmentCharges/TransportationCharges/CurrencyCode
CurrencyCode Required: Yes* Transportation charges currency code type. The currency code
Type: String used in the Ship confirm request is returned.
Max Allowed: 1
Length: 3
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/TransportationCharges/MonetaryValue
MonetaryValue Required: Yes* Transportation and surcharges value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned only when the subversion
Type: Container element is present and greater than or equal to '1601'.
Max Allowed: UNB
Length: N/A
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized charge.
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/Description
Description Required: No Description of Itemized Charge that had been charged.
Type: String
Max Allowed: 1
Length: 1…50
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* Itemized Charges currency code type. The currency code used
Type: String in the Ship confirm request is returned.
Max Allowed: 1
Length: 3
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 302
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/SubType
SubType Required: No The sub-type of ItemizedCharge type.
Type: String
Max Allowed: 1
Length: 1…50
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/ServiceOptionsCharges
ServiceOptionsCharges Required: Yes* Service Option Charges container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/ServiceOptionsCharges/CurrencyCode
CurrencyCode Required: Yes* Accessorial charges currency code type. The currency code
Type: String used in the Ship confirm request is returned.
Max Allowed: 1
Length: 3
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/ServiceOptionsCharges/MonetaryValue
MonetaryValue Required: Yes* Accessorial charges value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/TaxCharges
TaxCharges Required: Cond TaxCharges container are returned only when
Type: Container TaxInformationIndicator is present in Ship Confirm request and
Max Allowed: UNB when Negotiated Rates are not applicable. TaxCharges
Length: N/A container contains Tax information for a given shipment.
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/TaxCharges/Type
Type Required: Yes* Tax Type code. The code represents the type of Tax applied to
Type: String a shipment.
Max Allowed: 1
Refer to Tax Type Values / Abbreviations in the Appendix for
Length: 1…9
valid values.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 303
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/ShipmentCharges/TaxCharges/MonetaryValue
MonetaryValue Required: Yes* Tax Monetary Value represent the Tax amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/TotalCharges
TotalCharges Required: Yes* Total charges container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/TotalCharges/CurrencyCode
CurrencyCode Required: Yes* Total charges currency code type. The currency code used in
Type: String the Ship confirm request is returned.
Max Allowed: 1
Length: 3
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/TotalCharges/MonetaryValue
MonetaryValue Required: Yes* Total charges value amount. Valid values are from 0 to 99999999999999.99.
Type: String
Max Allowed: 1
Length: 1…19
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/TotalChargesWithTaxes
TotalChargesWithTaxes Required: Cond TotalChargesWithTaxes container would be returned only if
Type: Container TaxInformationIndicator is present in Ship Confirm request and
Max Allowed: 1 when Negotiated Rates are not applicable.
Length: N/A TotalChargesWithTaxes contains total charges including total
taxes applied to a shipment.
/ShipConfirmResponse/ShipmentResults/ShipmentCharges/TotalChargesWithTaxes/CurrencyCode
CurrencyCode Required: Yes* TotalChargesWithTaxes currency code type. The currency
Type: String code used in the Ship Confirm request is returned.
Max Allowed: 1
Length: 3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 304
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/ShipmentCharges/TotalChargesWithTaxes/MonetaryValue
MonetaryValue Required: Yes* TotalChargesWithTaxes monetary value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

NegotiatedRateCharges

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges
NegotiatedRateCharges Required: No Negotiated Rates Charge Container. For tiered rates and promotional discounts, if a
Type: Container particular shipment based on zone, origin, destination
Max Allowed: 1 or even shipment size doesn't qualify for the existing
Length: N/A discount then no negotiated rates container will be
returned. Published rates will be the applicable rate.
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned only when the subversion
Type: Container element is present and greater than or equal to '1601'.
Max Allowed: UNB
Length: N/A
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized charge.
Type: String
Max Allowed: 1
Length: 3
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/Description
Description Required: No Description of Itemized Charge that had been charged.
Type: String
Max Allowed: 1
Length: 1…50
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* Itemized Charges currency code type. The currency code
Type: String used in the Ship confirm request is returned.
Max Allowed: 1
Length: 3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 305
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1...19
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/SubType
SubType Required: No The sub-type of ItemizedCharge type.
Type: String
Max Allowed: 1
Length: 1…50
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/TaxCharges
TaxCharges Required: Cond TaxCharges container are returned only when
Type: Container TaxInformationIndicator is present in Ship Confirm request.
Max Allowed: UNB TaxCharges container contains Tax information for a given
Length: N/A shipment.
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/TaxCharges/Type
Type Required: Yes* Tax Type code. The code represents the type of Tax applied
Type: String to a shipment.
Max Allowed: 1
Refer to Tax Type Values / Abbreviations in the Appendix for
Length: 1…9
valid values.
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/TaxCharges/MonetaryValue
MonetaryValue Required: Yes* Tax Monetary Value represent the Tax amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/TotalCharge
TotalCharge Required: No Total charges container. Account Based Rates info. Total
Type: Container charges are only returned for ABR eligible shipper
Max Allowed: 1 account/UserId combinations when the user includes the
Length: N/A NegotiatedRatesIndicator in the request.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 306
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/TotalCharge/CurrencyCode
CurrencyCode Required: Yes* Total charges currency code.
Type: String
Max Allowed: 1
Length: 3
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/TotalCharge/MonetaryValue
MonetaryValue Required: Yes* Total charges monetary value. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/TotalChargesWithTaxes
TotalChargesWithTaxes Required: Cond TotalChargesWithTaxes container would be returned only if
Type: Container TaxInformationIndicator is present in Ship Confirm request.
Max Allowed: 1 TotalChargesWithTaxes contains total charges including total
Length: N/A taxes applied to a shipment.
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/TotalChargesWithTaxes/CurrencyCode
CurrencyCode Required: Yes* TotalChargesWithTaxes currency code type. The currency
Type: String code used in the Ship Confirm request is returned.
Max Allowed: 1
Length: 3
/ShipConfirmResponse/ShipmentResults/NegotiatedRateCharges/TotalChargesWithTaxes/MonetaryValue
MonetaryValue Required: Yes* TotalChargesWithTaxes monetary value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

FRSShipmentData

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/FRSShipmentData
FRSShipmentData Required: Cond Ground Freight Pricing Shipment data container. Ground Freight
Pricing shipment data is only guaranteed to be returned for
Ground Freight Pricing shipments only.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 307
Shipping Package Web Service Developer Guide November 1, 2016
TransportationCharges

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/FRSShipmentData/TransportationCharges
TransportationCharges Required: Yes* Transportation charges container. Ground Freight Pricing
Type: Container transportation charges.
Max Allowed: 1
These are only returned for Ground Freight Pricing
Length: N/A
enabled shipper account number when the user includes
the FRSShipmentIndicator in the request.
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/TransportationCharges/GrossCharge
GrossCharge Required: Yes* Gross Charges container. It indicates the shipment level
Type: Container gross Ground Freight Pricing transportation charges.
Max Allowed: 1
Length: N/A
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/TransportationCharges/GrossCharge/CurrencyCode
CurrencyCode Required: Yes* Gross charges currency code.
Type: String
Max Allowed: 1
Length: 3
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/TransportationCharges/GrossCharge/MonetaryValue
MonetaryValue Required: Yes* Gross charges monetary value. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/TransportationCharges/DiscountAmount
DiscountAmount Required: Yes* Discount Amount container. It indicates the shipment level
Type: Container Ground Freight Pricing discount amount for transportation
Max Allowed: 1 charges
Length: N/A
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/TransportationCharges/DiscountAmount/CurrencyCode
CurrencyCode Required: Yes* Discount Amount currency code.
Type: String
Max Allowed: 1
Length: 3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 308
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/FRSShipmentData/TransportationCharges/DiscountAmount/MonetaryValue
MonetaryValue Required: Yes* Discount amount monetary value. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/TransportationCharges/DiscountPercentage
DiscountPercentage Required: Yes* It indicates the shipment level discount percentage for
Type: String transportation charges.
Max Allowed: 1
Length: 1…5
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/TransportationCharges/NetCharge
NetCharge Required: Yes* Net Charges container. It indicates the shipment level net
Type: Container Ground Freight Pricing transportation charges.
Max Allowed: 1
Length: N/A
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/TransportationCharges/NetCharge/CurrencyCode
CurrencyCode Required: Yes* Net Charge currency code.
Type: String
Max Allowed: 1
Length: 3
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/TransportationCharges/NetCharge/MonetaryValue
MonetaryValue Required: Yes* Net charges monetary value. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

FreightDensityRate

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/FRSShipmentData/FreightDensityRate
FreightDensityRate Required: No FreightDensityRate container for Density based rating.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 309
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/FRSShipmentData/FreightDensityRate/Density
Density Required: Yes* Density is returned if the Shipper is eligible for Density based rate. Valid values are 0 to 999.9
Type: String
Max Allowed: 1
Length: 1…5
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/FreightDensityRate/TotalCubicFeet
TotalCubicFeet Required: Yes* TotalCubic feet is returned if the Shipper is eligible for Density based rate. Valid values are 0 to
Type: String 99999.999
Max Allowed: 1
Length: 1…9

HandlingUnits

Name Constraints Description Validation

/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits
HandlingUnits Required: Cond Handling Unit for Density based rating container.
Type: Container
Max Allowed: 50
Length: N/A
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Quantity
Quantity Required: Yes* Handling Unit Quantity for Density based rating.
Type: String
Max Allowed: 1
Length: 8
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Type
Type Required: Yes* Handling Unit Type for Density based rating.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 310
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraints Description Validation

/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Type/Code
Code Required: Yes* The code associated with Handling Unit Type. Valid values:
Type: String SKD = Skid
Max Allowed: 1 CBY = Carboy
Length: 3 PLT = Pallet
TOT = Totes
LOO = Loose
OTH = Other
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Type/Description
Description Required: No A description of the code for the Handling Unit type.
Type: String
Max Allowed: 1
Length: 1…35
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions
Dimensions Required: Yes* Dimension of the HandlingUnit container for density
Type: Container based pricing.
Max Allowed: 1
Length: N/A
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/UnitOfMeasurement
UnitOfMeasurement Required: Yes* UnitOfMeasurement container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/UnitOfMeasurement/Code
Code Required: Yes* Code for UnitOfMeasurement for the line item
Type: String dimension.
Max Allowed: 1
Valid value: IN = Inches
Length: 3
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/UnitOfMeasurement/Description
Description Required: No Description for UnitOfMeasurement for the line item
Type: String dimension.
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 311
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraints Description Validation

/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/Length
Length Required: Yes* The length of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/Width
Width Required: Yes* The width of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/Height
Height Required: Yes* The height of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight
AdjustedHeight Required: Cond Container to hold Adjusted Height information.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight/Value
Value Required: Yes* Adjusted Height value for the handling unit. Height Adjustment is done only when Handling unit
Type: String type is SKD = Skid or PLT = Pallet.
Max Allowed: 1
Length: 1…19
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Unit of Measurement container for the Adjusted
Type: Container height.
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 312
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraints Description Validation

/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight/UnitOfMeasurement/Code
Code Required: Yes* Code associated with Unit of Measurement for the
Type: String Adjusted height.
Max Allowed: 1
Length: 3
/ShipConfirmResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight/UnitOfMeasurement/Description
Description Required: No Description for Code associated with Unit of
Type: String Measurement for the Adjusted height.
Max Allowed: 1
Length: 1…35

RatingMethod

Name Constraint Description Validation

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

BillableWeightCalculationMethod

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/BillableWeightCalculationMethod
BillableWeightCalculationMethod Required: Cond BillableWeightCalculationMethod is to indicate whether the Valid values are 01 = Shipment Billable Weight, 02 =
Type: String billable weight calculation method utilized was - the package Package Billable Weight.
Max Allowed: 1 level or shipment level. This information will be returned only if
Length: 2 RatingMethodRequestedIndicator is present in the request.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 313
Shipping Package Web Service Developer Guide November 1, 2016

BillingWeight

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/BillingWeight
BillingWeight Required: Yes Billing Weight container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipConfirmResponse/ShipmentResults/BillingWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes Billing weight unit of measurement code. The unit of
Type: Container measurement used in Shipment request is returned.
Max Allowed: 1
Length: N/A
/ShipConfirmResponse/ShipmentResults/BillingWeight/UnitOfMeasurement/Code
Code Required: Yes Code of the billing weight measurement units. Values are: KGS
Type: String or LBS.
Max Allowed: 1
Length: 3
/ShipConfirmResponse/ShipmentResults/BillingWeight/UnitOfMeasurement/Description
Description Required: No Description of the billing weight measurement units.
Type: String
Max Allowed: 1
Length: 1…35
/ShipConfirmResponse/ShipmentResults/BillingWeight/Weight
Weight Required: Yes Billing weight. Higher of the actual shipment weight versus the
Type: String shipment dimensional weight.
Max Allowed: 1
Length: 8

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 314
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentIdentificationNumber

Name Constraint Description Validation

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

ShipmentDigest

Name Constraint Description Validation

/ShipConfirmResponse/ShipmentResults/ShipmentDigest
ShipmentDigest Required: Cond Encoded shipment parameters required to be passed in the
Type: String accept phase. Applicable only for ShipConfirmResponse.
Max Allowed: 1
Length:
Unbounded

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 315
Chapter 6: Ship Accept API Elements and Details
ShipAccept Request Top Level Containers

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 316
Shipping Package Web Service Developer Guide November 1, 2016

ShipAcceptRequest XPath Tables

Note: Not all containers/elements are reflected separately in the table of contents.

Name Constraint Description Validation

/ShipAcceptRequest
ShipAcceptRequest Required: Yes Ship Accept Request.
Type: Container
Max Allowed: 1
Length: N/A

Request
Name Constraint Description Validation
/ShipAcceptRequest/Request
Request Required: Yes Request Container.
Type: Container
Max Allowed: 1
Length: N/A

RequestOption

Name Constraint Description Validation

/ShipAcceptRequest/Request/RequestOption
RequestOption Required: Yes Optional Processing.
Type: String
nonvalidate = No street level address validation would be
Max Allowed: 1
performed, but Postal Code/State combination validation would
Length: 1…15
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 Tool User to
ensure the address entered is correct to avoid an address
correction fee.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 317
Shipping Package Web Service Developer Guide November 1, 2016

SubVersion

Name Constraint Description Validation

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

TransactionReference

Name Constraint Description Validation

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

ShipmentDigest
Name Constraint Description Validation
/ShipAcceptRequest/ShipmentDigest
ShipmentDigest Required: Yes Encoded shipment parameters required to be passed in the Base 64 Encoded.
Type: String accept phase.
Max Allowed: 1
Length:
Unbounded

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 318
ShipAccept ResponseTop Level Containers

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 319
Shipping Package Web Service Developer Guide November 1, 2016

ShipAcceptResponse XPath Tables

Note: Not all containers/elements are reflected separately in the table of contents.

Name Constraint Description Validation

/ShipAcceptResponse
ShipAcceptResponse Required: Yes Ship Accept Response.
Type: Container
Max Allowed: 1
Length:

Response
Name Constraint Description Validation
/ShipAcceptResponse/Response
Response Required: Yes Response container for Ship Accept Response.
Type: Container
Max Allowed: 1
Length:

ResponseStatus

Name Constraint Description Validation

/ShipAcceptResponse/Response/ResponseStatus
ResponseStatus Required: Yes Response status container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/Response/ResponseStatus/Code
Code Required: Yes Identifies the success or failure of the transaction. 1 = Successful
Type: String
Max Allowed: 1
Length: 1

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 320
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/Response/ResponseStatus/Description
Description Required: Yes Describes Response Status Code. Returns text of Success.
Type: String
Max Allowed: 1
Length: 1…35

Alert

Name Constraint Description Validation

/ShipAcceptResponse/Response/Alert
Alert Required: No Alert Container. There can be zero to many alert containers with
Type: Container code and description.
Max Allowed: UNB
Length: N/A
/ShipAcceptResponse/Response/Alert/Code
Code Required: Yes* Warning code returned by the system.
Type: String
Max Allowed: 1
Length: 1…10
/ShipAcceptResponse/Response/Alert/Description
Description Required: Yes* Warning messages returned by the system.
Type: String
Max Allowed: 1
Length: 1…150

Transaction Reference

Name Constraint Description Validation

/ShipAcceptResponse/Response/TransactionReference
TransactionReference Required: No Transaction Reference Container.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 321
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/Response/TransactionReference/CustomerContext
CustomerContext Required: No The CustomerContext Information which will be echoed during
Type: String response.
Max Allowed: 1
Length: 1…512

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 322
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentResults
Name Constraint Description Validation
/ShipAcceptResponse/ShipmentResults
ShipmentResults Required: Yes Shipment Results container.
Type: Container
Max Allowed: 1
Length: N/A

Disclaimer

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/Disclaimer
Disclaimer Required: Cond Disclaimer would be used to provide more information to shipper
regarding the processed shipment. This would be used to notify
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 Ship Confirm request.
/ShipAcceptResponse/ShipmentResults/Disclaimer/Code
Code Required: Yes* Code representing type of Disclaimer.
Type: String
Refer to Disclaimer Codes and Messages in the Appendix for
Max Allowed: 1
possible code values.
Length: 2
/ShipAcceptResponse/ShipmentResults/Disclaimer/Description
Description Required: Yes* Disclaimer description.
Type: String
Refer to Disclaimer Codes and Messages in the Appendix for
Max Allowed: 1
possible descriptions.
Length:
Unbounded

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 323
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentCharges

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/ShipmentCharges
ShipmentCharges Required: Cond Shipment charges Container. Shipment charges info.
Type: Container Shipment charges are only guaranteed to be returned for
Max Allowed: 1 shipments whose origin country is US or Puerto Rico.
Length: N/A
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/RateChart
RateChart Required: No Rate Type with which Shipment is rated. Values:
Type: String
1 – Daily Rates
Max Allowed: 1
Length: 1 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
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/TransportationCharges
TransportationCharges Required: Yes* Transportation Charges container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/TransportationCharges/CurrencyCode
CurrencyCode Required: Yes* Transportation charges currency code type. The currency code
Type: String used in the Ship confirm request is returned.
Max Allowed: 1
Length: 3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 324
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/ShipmentCharges/TransportationCharges/MonetaryValue
MonetaryValue Required: Yes* Transportation and surcharges value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned only when the subversion
Type: Container element is present and greater than or equal to '1601'.
Max Allowed: UNB
Length: N/A
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized charge.
Type: String
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/Description
Description Required: No Description of Itemized Charges that had been charged.
Type: String
Max Allowed: 1
Length: 1…50
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* Itemized Charges currency code type. The currency code
used in the Ship confirm request is returned.
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/ItemizedCharges/SubType
SubType Required: No The sub-type of the ItemizedCharge type.
Type: String
Max Allowed: 1
Length: 1…50

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 325
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/ShipmentCharges/ServiceOptionsCharges
ServiceOptionsCharges Required: Yes* Service Option Charges container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/ServiceOptionsCharges/CurrencyCode
CurrencyCode Required: Yes* Accessorial charges currency code type. The currency code
Type: String used in the Ship confirm request is returned.
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/ServiceOptionsCharges/MonetaryValue
MonetaryValue Required: Yes* Accessorial charges value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/TaxCharges
TaxCharges Required: Cond TaxCharges container are returned only when
Type: Container TaxInformationIndicator is present in Ship Confirm request and
Max Allowed: UNB when Negotiated Rates are not applicable. TaxCharges
Length: N/A container contains Tax information for a given shipment.
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/TaxCharges/Type
Type Required: Yes* Tax Type code. The code represents the type of Tax applied to
Type: String a shipment.
Max Allowed: 1
Refer to Tax Type Values / Abbreviations in the Appendix for
Length: 1…9
valid values.
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/TaxCharges/MonetaryValue
MonetaryValue Required: Yes* Tax Monetary Value represent the Tax amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 326
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/ShipmentCharges/TotalCharges
TotalCharges Required: Yes* Total charges container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/TotalCharges/CurrencyCode
CurrencyCode Required: Yes* Total charges currency code type. The currency code used in
Type: String the Ship confirm request is returned.
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/TotalCharges/MonetaryValue
MonetaryValue Required: Yes* Total charges value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/TotalChargesWithTaxes
TotalChargesWithTaxes Required: Cond TotalChargesWithTaxes container would be returned only if
Type: Container TaxInformationIndicator is present in Ship Confirm request and
Max Allowed: UNB when Negotiated Rates are not applicable.
Length: N/A TotalChargesWithTaxes contains total charges including total
taxes applied to a shipment.
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/TotalChargesWithTaxes/CurrencyCode
CurrencyCode Required: Yes* TotalChargesWithTaxes currency code type. The currency
Type: String code used in the Ship Confirm request is returned.
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/ShipmentCharges/TotalChargesWithTaxes/MonetaryValue
MonetaryValue Required: Yes* TotalChargesWithTaxes monetary value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 327
Shipping Package Web Service Developer Guide November 1, 2016

NegotiatedRateCharges

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges
NegotiatedRateCharges Required: No Negotiated Rates Charge Container. For tiered rates and promotional discounts, if a
Type: Container particular shipment based on zone, origin, destination
Max Allowed: 1 or even shipment size doesn't qualify for the existing
Length: N/A discount then no negotiated rates container will be
returned. Published rates will be the applicable rate.
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned only when the subversion
Type: Container element is present and greater than or equal to '1601'.
Max Allowed: UNB
Length: N/A
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized charge.
Type: String
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/Description
Description Required: No Description of Itemized Charges that had been charged.
Type: String
Max Allowed: 1
Length: 1…50
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* Itemized Charges currency code type. The currency code
Type: String used in the Ship confirm request is returned.
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 328
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/ItemizedCharges/SubType
SubType Required: No The sub-type of the ItemizedCharge type.
Type: String
Max Allowed: 1
Length: 1…50
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/TaxCharges
TaxCharges Required: Cond TaxCharges container are returned only when
Type: Container TaxInformationIndicator is present in Ship Confirm request.
Max Allowed: UNB TaxCharges container contains Tax information for a given
Length: N/A shipment.
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/TaxCharges/Type
Type Required: Yes* Tax Type code. The code represents the type of Tax applied
to a shipment.
Refer to Tax Type Values / Abbreviations in the Appendix for
valid values.
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/TaxCharges/MonetaryValue
MonetaryValue Required: Yes* Tax Monetary Value represent the Tax amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…9
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/TotalCharge
TotalCharge Required: No Total charges container. Account Based Rates info. Total
Type: Container charges are only returned for ABR eligible shipper
Max Allowed: 1 account/UserId combinations when the user includes the
Length: N/A NegotiatedRatesIndicator in the request.
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/TotalCharge/CurrencyCode
CurrencyCode Required: Yes* Total charges currency code.
Type: String
Max Allowed: 1
Length: 3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 329
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/TotalCharge/MonetaryValue
MonetaryValue Required: Yes* Total charges monetary value. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/TotalChargesWithTaxes
TotalChargesWithTaxes Required: Cond TotalChargesWithTaxes container would be returned only if
Type: Container TaxInformationIndicator is present in Ship Confirm request.
Max Allowed: 1 TotalChargesWithTaxes contains total charges including total
Length: N/A taxes applied to a shipment.
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/TotalChargesWithTaxes/CurrencyCode
CurrencyCode Required: Yes* TotalChargesWithTaxes currency code type. The currency
Type: String code used in the Ship Confirm request is returned.
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/NegotiatedRateCharges/TotalChargesWithTaxes/MonetaryValue
MonetaryValue Required: Yes* TotalChargesWithTaxes monetary value amount. Valid values are from 0 to 99999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

FRSShipmentData

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/FRSShipmentData
FRSShipmentData Required: Cond Ground Freight Pricing Shipment data container. Ground Freight
Type: Container Pricing shipment data is only guaranteed to be returned for
Max Allowed: 1 Ground Freight Pricing shipments only.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 330
Shipping Package Web Service Developer Guide November 1, 2016
TransportationCharges

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/FRSShipmentData/TransportationCharges
TransportationCharges Required: Yes* Transportation charges container. Ground Freight Pricing
Type: Container transportation charges. These are only returned for Ground
Max Allowed: 1 Freight Pricing enabled shipper account number when the
Length: N/A user includes the FRSShipmentIndicator in the request.
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/TransportationCharges/GrossCharge
GrossCharge Required: Yes* Gross Charges container. It indicates the shipment level
Type: Container gross Ground Freight Pricing transportation charges.
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/TransportationCharges/GrossCharge/CurrencyCode
CurrencyCode Required: Yes* Gross charges currency code.
Type: String
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/TransportationCharges/GrossCharge/MonetaryValue
MonetaryValue Required: Yes* Gross charges monetary value. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/TransportationCharges/DiscountAmount
DiscountAmount Required: Yes* Discount Amount container. It indicates the shipment level
Type: Container Ground Freight Pricing discount amount for transportation
Max Allowed: 1 charges
Length: N/A
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/TransportationCharges/DiscountAmount/CurrencyCode
CurrencyCode Required: Yes* Discount Amount currency code.
Type: String
Max Allowed: 1
Length: 3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 331
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/FRSShipmentData/TransportationCharges/DiscountAmount/MonetaryValue
MonetaryValue Required: Yes* Discount amount monetary value. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/TransportationCharges/DiscountPercentage
DiscountPercentage Required: Yes* It indicates the shipment level discount percentage for
Type: String transportation charges.
Max Allowed: 1
Length: 1…5
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/TransportationCharges/NetCharge
NetCharge Required: Yes* Net Charges container. It indicates the shipment level net
Type: Container Ground Freight Pricing transportation charges.
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/TransportationCharges/NetCharge/CurrencyCode
CurrencyCode Required: Yes* Net Charge currency code.
Type: String
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/TransportationCharges/NetCharge/MonetaryValue
MonetaryValue Required: Yes* Net charges monetary value. Valid values are from 0 to 9999999999999999.99
Type: String
Max Allowed: 1
Length: 1…19

FreightDensityRate

/ShipAcceptResponse/ShipmentResults/FRSShipmentData/FreightDensityRate
FreightDensityRate Required: No FreightDensityRate container for Density based rating.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 332
Shipping Package Web Service Developer Guide November 1, 2016

/ShipAcceptResponse/ShipmentResults/FRSShipmentData/FreightDensityRate/Density
Density Required: Yes* Density is returned if the Shipper is eligible for Density based rate. Valid values are 0 to 999.9
Type: String
Max Allowed: 1
Length: 1…5
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/FreightDensityRate/TotalCubicFeet
TotalCubicFeet Required: Yes* TotalCubic feet is returned if the Shipper is eligible for Density based rate. Valid values are 0 to
Type: String 99999.999
Max Allowed: 1
Length: 1…9

HandlingUnits

Name Constraints Description Validation

/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits
HandlingUnits Required: Cond Handling Unit for Density based rating container.
Type: Container
Max Allowed: 50
Length: N/A
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Quantity
Quantity Required: Yes* Handling Unit Quantity for Density based rating.
Type: String
Max Allowed: 1
Length: 8
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Type
Type Required: Yes* Handling Unit Type for Density based rating.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 333
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraints Description Validation

/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Type/Code
Code Required: Yes* The code associated with Handling Unit Type. Valid values:
Type: String SKD = Skid
Max Allowed: 1 CBY = Carboy
Length: 3 PLT = Pallet
TOT = Totes
LOO = Loose
OTH = Other
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Type/Description
Description Required: No A description of the code for the Handling Unit type.
Type: String
Max Allowed: 1
Length: 1…35
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions
Dimensions Required: Yes* Dimension of the HandlingUnit container for density
Type: Container based pricing.
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/UnitOfMeasurement
UnitOfMeasurement Required: Yes* UnitOfMeasurement container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/UnitOfMeasurement/Code
Code Required: Yes* Code for UnitOfMeasurement for the line item
Type: String dimension.
Max Allowed: 1
Valid value: IN = Inches
Length: 3
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/UnitOfMeasurement/Description
Description Required: No Description for UnitOfMeasurement for the line item
Type: String dimension.
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 334
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraints Description Validation

/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/Length
Length Required: Yes* The length of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/Width
Width Required: Yes* The width of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/Dimensions/Height
Height Required: Yes* The height of the line item used to determine
Type: String dimensional weight.
Max Allowed: 1
Length: 1…19
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight
AdjustedHeight Required: Cond Container to hold Adjusted Height information.
Type: Container
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight/Value
Value Required: Yes* Adjusted Height value for the handling unit. Height Adjustment is done only when Handling unit
Type: String type is SKD = Skid or PLT = Pallet.
Max Allowed: 1
Length: 1…19
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Unit of Measurement container for the Adjusted
Type: Container height.
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 335
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraints Description Validation

/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight/UnitOfMeasurement/Code
Code Required: Yes* Code associated with Unit of Measurement for the
Type: String Adjusted height.
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/FRSShipmentData/HandlingUnits/AdjustedHeight/UnitOfMeasurement/Description
Description Required: No Description for Code associated with Unit of
Type: String Measurement for the Adjusted height.
Max Allowed: 1
Length: 1…35

RatingMethod

Name Constraint Description Validation

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

BillableWeightCalculationMethod

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/BillableWeightCalculationMethod
BillableWeightCalculationMethod Required: Cond BillableWeightCalculationMethod is to indicate whether the Valid values are 01 = Shipment Billable Weight, 02 =
Type: String billable weight calculation method utilized was - the package Package Billable Weight.
Max Allowed: 1 or shipment level. This information will be returned only if
Length: 2 RatingMethodRequestedIndicator is present in the request.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 336
Shipping Package Web Service Developer Guide November 1, 2016

BillingWeight

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/BillingWeight
BillingWeight Required: Yes Billing Weight container.
Type: Container
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/ShipmentResults/BillingWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes Billing weight unit of measurement code. The unit of
Type: Container measurement used in Ship Confirm request is returned.
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/ShipmentResults/BillingWeight/UnitOfMeasurement/Code
Code Required: Yes Code of the billing weight measurement units. Values are: KGS
Type: String or LBS.
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/BillingWeight/UnitOfMeasurement/Description
Description Required: No Description of the billing weight measurement units.
Type: String
Max Allowed: 1
Length: 1…35
/ShipAcceptResponse/ShipmentResults/BillingWeight/Weight
Weight Required: Yes Billing weight. Higher of the actual shipment weight versus the
Type: String shipment dimensional weight.
Max Allowed: 1
Length: 8

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 337
Shipping Package Web Service Developer Guide November 1, 2016

ShipmentIdentificationNumber

Name Constraint Description Validation

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

ShipmentDigest

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/ShipmentDigest
ShipmentDigest Required: Cond Encoded shipment parameters required to be passed in the
Type: String accept phase. Applicable only for ShipConfirmResponse.
Max Allowed: 1
Length:
Unbounded

PackageResults

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/PackageResults
PackageResults Required: No Returned Package Information.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: UNB
ShipAcceptResponse.
Length: N/A
/ShipAcceptResponse/ShipmentResults/PackageResults/TrackingNumber
TrackingNumber Required: Yes* Package 1Z number.
Type: String
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse. For Mail Innovations shipments,
Length: 18
please use the USPSPICNumber when tracking
packages (a non-1Z number Mail Manifest Id is
returned).

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 338
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/PackageResults/ServiceOptionsCharges
ServiceOptionsCharges Required: Cond Shipment charges info. Shipment charges are only
Type: Container guaranteed to be returned for shipments whose origin
Max Allowed: 1 country is US or Puerto Rico.
Length: N/A
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/PackageResults/ServiceOptionsCharges/CurrencyCode
CurrencyCode Required: Yes* Package accessorial charges currency code type. The
Type: String currency code used in the Ship confirm request is
Max Allowed: 1 returned.
Length: 3
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/PackageResults/ServiceOptionsCharges/MonetaryValue
MonetaryValue Required: Yes* Package accessorial charges value amount. Valid
Type: String values are from 0 to 99999999999999.99.
Max Allowed: 1
Applicable only for ShipmentResponse and
Length: 1…19
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingLabel
ShippingLabel Required: Cond The container for UPS shipping label. Shipment without
Type: Container return service or with PRL returns service.
Max Allowed: 1
Applicable only for ShipmentResponse and
Length: N/A
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingLabel/ImageFormat
ImageFormat Required: Yes* The container image format.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 339
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingLabel/ImageFormat/Code
Code Required: Yes* Label image code that the labels are generated. Values For multi piece COD shipments, the label image
Type: String are EPL = EPL2, SPL = SPL, ZPL = ZPL, GIF = gif format for the first package will always be a GIF for
Max Allowed: 1 images, or PNG for PNG images. Only EPL, SPL, ZPL any form of label requested.
Length: 3 and GIF are currently supported.
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingLabel/ImageFormat/Description
Description Required: No Description of the label image format code.
Type: String
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: 1…35
/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingLabel/GraphicImage
GraphicImage Required: Yes* Base 64 encoded graphic image.
Type: Base 64 Encoded
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: Unbounded
/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingLabel/InternationalSignatureGraphicImage
InternationalSignatureGraphicImage Required: Cond Base 64 encoded graphic image of the Warsaw text
Type: Base 64 Encoded and signature box for EPL2, ZPL and SPL labels. The
Max Allowed: 1 image will be returned for non-US based shipments.
Length: Unbounded One image will be given per shipment and it will be in
the first PackageResults container.
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingLabel/HTMLImage
HTMLImage Required: Cond Base 64 encoded html browser image rendering
Type: Base 64 Encoded software. This is only returned for gif and png image
Max Allowed: 1 formats.
Length: Unbounded
Applicable only for ShipmentResponse and
ShipAcceptResponse.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 340
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingLabel/PDF417
PDF417 Required: Cond PDF-417 is a two-dimensional barcode, which can
Type: Base 64 Encoded store up to about 1,800 printable ASCII characters or
Max Allowed: 1 1,100 binary characters per symbol. The symbol is
Length: Unbounded rectangular. The image is Base 64 encoded and
returned if the LabelImageFormat code is GIF.
Shipment with PRL return service only.
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingReceipt
ShippingReceipt Required: Cond Container for the receipt of a return shipment. Not
Type: Container supported for ERL or PRL shipments.
Max Allowed: 1
Applicable only for ShipmentResponse and
Length: N/A
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingReceipt/ImageFormat
ImageFormat Required: Yes* Container for a Image Format.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A
/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingReceipt/ImageFormat/Code
Code Required: Yes* Code representing the format in which a receipt is
Type: String delivered. Valid values: HTML = HTML format.
Max Allowed: 1
Applicable only for ShipmentResponse and
Length: 4
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingReceipt/ImageFormat/Description
Description Required: No Description of the image format code.
Type: String
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: 1…35
/ShipAcceptResponse/ShipmentResults/PackageResults/ShippingReceipt/GraphicImage
GraphicImage Required: Yes* Base 64 encoded PRL receipt in HTML format.
Type: Base 64 Encoded
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: Unbounded

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 341
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/PackageResults/USPSPICNumber
USPSPICNumber Required: Cond USPSPICNumber is USPS Package Identification; it
Type: String should be used for tracking Mail Innovations shipments.
Max Allowed: 1
Length: Unbounded
/ShipAcceptResponse/ShipmentResults/PackageResults/CN22Number
CN22Number Required: Cond USPS defined CN22 ID number format varies based on
Type: String destination country. Not applicable as of Jan 2015. Mail
Max Allowed: 1 Innovations shipments US to VI, PR, and GU are not
Length: N/A considered international.
/ShipAcceptResponse/ShipmentResults/PackageResults/Accessorial
Accessorial Required: Cond The container for Accessorial indicators. This This is valid only for UPS Worldwide Express
Type: Container information would be returned only if Freight Service.
Max Allowed: UNB ItemizedChargesRequested was present during
Length: N/A request. This is valid only for UPS Worldwide Express
Freight Service.
/ShipAcceptResponse/ShipmentResults/PackageResults/Accessorial/Code
Code Required: Yes* Code for Accessorial Indicator.
Type: String
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/PackageResults/Accessorial/Description
Description Required: No Description for Accessorial Indicator.
Type: String
Max Allowed: 1
Length: 1…50
/ShipAcceptResponse/ShipmentResults/PackageResults/Form
Form Required: Cond Container tag for the International forms image. Currenlty this container would be returned for
Type: Container UPS Premium Care shipments.
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 342
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 343
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

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

ItemizedCharges

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/PackageResults/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned only when the subversion element is present and greater than or equal
Type: Container to '1607'.
Max Allowed: UNB
Length: N/A
/ShipAcceptResponse/ShipmentResults/PackageResults/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized charge.
Type: String
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/PackageResults/ItemizedCharges/Description
Description Required: No Description of Itemized Charge that had been charged.
Type: String
Max Allowed: 1
Length: 1…50

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 344
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/PackageResults/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code associated with the Itemized Charge costs for the shipment.
Type: String
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/PackageResults/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount.
Type: String
Max Allowed: 1
Length: 16.2
/ShipAcceptResponse/ShipmentResults/PackageResults/ItemizedCharges/SubType
SubType Required: No The sub-type of ItemizedCharge type.
Type: String
Max Allowed: 1
Length: 1…50

NegotiatedCharges

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges
NegotiatedRateCharges Required: Cond Negotiated Rates Charge Container. These charges would be returned only when -
Type: Container 1) subversion is greater than or equal to 1607
Max Allowed: 1 2) if negotiated rates were requested for GFP shipments and
Length: N/A account number is eligible to receive negotiated rates.
/ShipAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges
ItemizedCharges Required: Cond Negotiated Itemized Accessorial and Sur Charges.
Type: Container
These charges would be returned only when
Max Allowed: UNB
Subversion is greater than or equal to 1607.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 345
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized charge.
Type: String
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/Description
Description Required: No Description of Itemized Charge that had been
Type: String charged.
Max Allowed: 1
Length: 1…50
/ShipAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code associated with the
Type: String Itemized Charge costs for the shipment.
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* Itemized Charges value amount.
Type: String
Max Allowed: 1
Length: 16.2
/ShipAcceptResponse/ShipmentResults/PackageResults/NegotiatedCharges/ItemizedCharges/SubType
SubType Required: No The sub-type of ItemizedCharge type.
Type: String
Max Allowed: 1
Length: 1…50

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 346
Shipping Package Web Service Developer Guide November 1, 2016

ControlLogReceipt

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/ControlLogReceipt
ControlLogReceipt Required: Cond Container for the High Value reports when forward shipments
Type: Container have declared value between $999 and $50,000 USD. Two
Max Allowed: 1 copies of high value report needs to be pointed out.
Length: N/A
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/ControlLogReceipt/ImageFormat
ImageFormat Required: Yes* Container for the High Value report format required if parent
Type: Container exist.
Max Allowed: 1
Applicable only for ShipmentResponse and
Length: N/A
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/ControlLogReceipt/ImageFormat/Code
Code Required: Yes* Code for the type of Graphic Image for the High Value Report.
Type: String
Values are:
Max Allowed: 1
Length: 4 EPL = EPL2 (when user requests label in EPL2 format),
SPL = SPL (when user requests label in SPL format),
ZPL = ZPL (when user requests label in ZPL format),
HTML= HTML (when user requests label in HTML format).

Applicable only for ShipmentResponse and

ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/ControlLogReceipt/ImageFormat/Description
Description Required: No Description of the format code.
Type: String
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 347
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/ControlLogReceipt/GraphicImage
GraphicImage Required: Yes* Base 64 encoded html, EPL2, ZPL or SPL image.
Type: Base 64
Applicable only for ShipmentResponse and
Encoded
ShipAcceptResponse.
Max Allowed: 1
Length: Unbounded

Form

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/Form
Form Required: Cond Container tag for the International forms image.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A
/ShipAcceptResponse/ShipmentResults/Form/Code
Code Required: Yes* Code that indicates the type of form. Possible Values 01 - All
Type: String Requested International Forms.
Max Allowed: 1
Applicable only for ShipmentResponse and
Length: 2
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/Form/Description
Description Required: Yes* Description that indicates the type of form. Possible Values. - All
Type: String Requested International Forms.
Max Allowed: 1
Applicable only for ShipmentResponse and
Length: 1…35
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/Form/Image
Image Required: Cond Container tag for the International forms image.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 348
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/Form/Image/ImageFormat
ImageFormat Required: Cond Container tag for the International forms image format information.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A
/ShipAcceptResponse/ShipmentResults/Form/Image/ImageFormat/Code
Code Required: Yes* Code representing the format in which the forms are generated.
Type: String Possible Values: PDF = pdf Only. PDF is supported currently.
Max Allowed: 1
Applicable only for ShipmentResponse and
Length: 3
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/Form/Image/ImageFormat/Description
Description Required: No Description of the form image format code.
Type: String
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: 1…35
/ShipAcceptResponse/ShipmentResults/Form/Image/GraphicImage
GraphicImage Required: Cond Base 64 encoded International forms image.
Type: Base 64
Applicable only for ShipmentResponse and
Encoded
ShipAcceptResponse.
Max Allowed: 1
Length:
Unbounded
/ShipAcceptResponse/ShipmentResults/Form/FormGroupId
FormGroupId Required: Cond Unique Id for later retrieval of saved version of the completed
Type: String international forms. Always returned when code = 01. 01
Max Allowed: 1 represents international forms.
Length: 1…26
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/Form/FormGroupIdName
FormGroupIdName Required: No Contains description text which identifies the group of
Type: String International forms. This element is part of both request and
Max Allowed: 1 response. This element does not appear on the forms.
Length: 1…50
Applicable only for ShipmentResponse and
ShipAcceptResponse.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 349
Shipping Package Web Service Developer Guide November 1, 2016

CODTurnInPage

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/CODTurnInPage
CODTurnInPage Required: No The container of the COD Turn In Page.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A
/ShipAcceptResponse/ShipmentResults/CODTurnInPage/Image
Image Required: Yes* The container of the image for COD Turn In Page.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A
/ShipAcceptResponse/ShipmentResults/CODTurnInPage/Image/ImageFormat
ImageFormat Required: Yes* The container for format of COD Turn In Page.
Type: Container
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: N/A
/ShipAcceptResponse/ShipmentResults/CODTurnInPage/Image/ImageFormat/Code
Code Required: Yes* Format code of the generated COD Turn In Page. Valid values:
Type: String HTML = HTML format. Only HTML format is supported for COD
Max Allowed: 1 Turn In Page.
Length: 4
Applicable only for ShipmentResponse and
ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/CODTurnInPage/Image/ImageFormat/Description
Description Required: No Description of the format code of generated COD Turn In page.
Type: String
Applicable only for ShipmentResponse and
Max Allowed: 1
ShipAcceptResponse.
Length: 1…35
/ShipAcceptResponse/ShipmentResults/CODTurnInPage/Image/GraphicImage
GraphicImage Required: Yes* Base 64 encoded html browser image rendering software.
Type: Base 64
Applicable only for ShipmentResponse and
Encoded
ShipAcceptResponse.
Max Allowed: 1
Length: Unbounded

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 350
Shipping Package Web Service Developer Guide November 1, 2016

HighValueReport

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/HighValueReport
HighValueReport Required: Cond Container for the HighValue Report generated for ImportControl
Type: Container or Return shipments with high package declared value.
Max Allowed: 1 Applicable for one pass ShipmentResponse and two-pass
Length: N/A ShipAcceptResponse.
/ShipAcceptResponse/ShipmentResults/HighValueReport/Image
Image Required: Yes* Container for the HighValue Report image for Import Control
Type: Container Shipments.
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/ShipmentResults/HighValueReport/Image/ImageFormat
ImageFormat Required: Yes* Container for the HighValue Report image format information for
Type: Container Import Control Shipments.
Max Allowed: 1
Length: N/A
/ShipAcceptResponse/ShipmentResults/HighValueReport/Image/ImageFormat/Code
Code Required: Yes* Code representing the format in which the HighValueReport is
Type: String generated. Possible Values: PDF = 'pdf'
Max Allowed: 1
Length: 3
/ShipAcceptResponse/ShipmentResults/HighValueReport/Image/ImageFormat/Description
Description Required: No Description of the image format.
Type: String
Max Allowed: 1
Length: 1…35
/ShipAcceptResponse/ShipmentResults/HighValueReport/Image/GraphicImage
GraphicImage Required: Yes* Base 64 Encoded PDF Image.
Type: Base 64
Encoded
Max Allowed: 1
Length: Unbounded

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 351
Shipping Package Web Service Developer Guide November 1, 2016

LabelURL

Name Constraint Description Validation

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

LocalLanguageLabelURL

Name Constraint Description Validation

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

ReceiptURL

Name Constraint Description Validation

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 352
Shipping Package Web Service Developer Guide November 1, 2016

LocalLanguageReceiptURL

Name Constraint Description Validation

/ShipAcceptResponse/ShipmentResults/LocalLanguageReceiptURL
LocalLanguageReceiptURL Required: Cond LocalLanguageReceiptURL is returned if the
Type: String LabelLinksIndicator is requested for an ImportControl shipment
Max Allowed: 1 or a Return shipment. The URL will contain the receipt in the
Length: Country's local language if supported by UPS.
Unbounded

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 353
Shipping Package Web Service Developer Guide November 1, 2016

Chapter 7: Label Recovery API 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.

Accessing Label Recovery Web Service

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

LabelRecoveryRequest Top Level Containers

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 354
Shipping Package Web Service Developer Guide November 1, 2016

LabelRecoveryRequest XPath Tables

Note: Not all containers/elements are reflected separately in the table of contents.

Name Constraint Description Validation

/LabelRecoveryRequest
LabelRecoveryRequest Required: Yes Request for obtaining the Label for the return shipment
Type: Container
Max Allowed: 1
Length: N/A

Request
Name Constraint Description Validation
/LabelRecoveryRequest/Request
Request Required: Yes Request Container
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryRequest/Request/RequestOption
RequestOption Required: No Request option is no longer used
Type: String
Max
Allowed:Unbounded
Length: 1..15
/LabelRecoveryRequest/Request/TransactionReference
TransactionReference Required: No Container that identifies transactions between client and server
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryRequest/Request/TransactionReference/CustomerContext
CustomerContext Required: No The Client uses this to synchronize request and response pair. It is replayed back to client by server
Type: String
Max Allowed: 1
Length: 1..512

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 355
Shipping Package Web Service Developer Guide November 1, 2016

LabelSpecification
Name Constraint Description Validation
/LabelRecoveryRequest/LabelSpecification
LabelSpecification Required: No Container that is used to define the properties required by the Required for the shipment with out return service, or
Type: Container user to print and/ or display the UPS shipping label. shipment with PRL return service.
Max Allowed: 1
Length: N/A
/LabelRecoveryRequest/LabelSpecification/HTTPUserAgent
HTTPUserAgent Required: No Browser HTTPUserAgent String. This is the preferred way of Required if <Root node>/
Type: String identifying GIF image type to be generated. LabelSpecification/LabelImageFormat/Code = Gif.
Max Allowed: 1
Default to Mozilla/4.5 if this field is missing or has invalid
Length: 1..64
value.
/LabelRecoveryRequest/LabelSpecification/LabelImageFormat
LabelImageFormat Required: No The file format of the label and receipt. Defaults to HTML format if
Type: Container this node does not exist.
Max Allowed: 1
Length: N/A
/LabelRecoveryRequest/LabelSpecification/LabelImageFormat/Code
Code Required: Yes* File type that the label and receipt is to be generated in.
Type: String
Valid values:
Max Allowed: 1
Length: 3 GIF - The generated label and 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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 356
Shipping Package Web Service Developer Guide November 1, 2016

Translate
Name Constraint Description Validation
/LabelRecoveryRequest/Translate
Translate Required: No Translate container allows the user to specify the language Combinations:
Type: Container he/she would like a specific portion of response to return.
eng GB = Queen's English
Max Allowed: 1
The language is specified by the combination of language code
Length: N/A spa 97 = Castilian Spanish
and dialect code.
ita 97 = Italian
Valid combinations are: LanguageCode + DialectCode.
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 357
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/LabelRecoveryRequest/Translate/LanguageCode
LanguageCode Required: Yes* The Language code. The language codes are three letter
Type: String language codes.
Max Allowed: 1
Supported languages are:
Length: 2..3
eng - English
spa - Spanish
ita - Italian
fra - French
deu - German
por -Portuguese
nld - Dutchdan - 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
US - United States
97 – Not Applicable
/LabelRecoveryRequest/Translate/Code
Code Required: Yes* Used to specify what will be translated. Valid codes are: “01”.
Type: String Code definitions: “01” = label direction instructions and receipt.
Max Allowed: 1
Length: 2

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 358
Shipping Package Web Service Developer Guide November 1, 2016

LabelDelivery
Name Constraint Description Validation
/LabelRecoveryRequest/LabelDelivery
LabelDelivery Required: No Container for the Label Delivery accessorial. One Label Delivery
Type: Container per shipment
Max Allowed: 1
Length: N/A
/LabelRecoveryRequest/LabelDelivery/LabelLinkIndicator
LabelLinkIndicator Required: No Indicates that the Label Recovery and Receipt Recovery URL
Type: String links are to be returned in the XML Response. Valid for shipments
Max Allowed: 1 with a Web Return Label Return Service.
Length: 0

TrackingNumber
Name Constraint Description Validation
/LabelRecoveryRequest/TrackingNumber
TrackingNumber Required: Cond Package Tracking Number. If the TrackingNumber is not Check on availability, check on length of Package Tracking
Type: String provided, then the ReferenceNumber/Value and ShipperNumber Number. If the TrackingNumber is not provided, then the
Max Allowed: 1 have to be provided. ReferenceNumber/Value and ShipperNumber have to be
Length: 1..18 provided.

ReferenceValues
Name Constraint Description Validation
/LabelRecoveryRequest/ReferenceValues
ReferenceValues Required: Cond Container that holds reference number and shipper number If tracking number is not present use reference Number
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 359
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/LabelRecoveryRequest/ReferenceValues/ReferenceNumber
ReferenceNumber Required: Yes* Container for reference number
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryRequest/ReferenceValues/ReferenceNumber/Value
Value Required: Yes* Required if TrackingNumber is not populated. Customer supplied
Type: String reference number. Supports up to 2 customer supplied
Max Allowed: 1 combinations of Reference code- value combinations.
Length: 1..35
/LabelRecoveryRequest/ReferenceValues/ShipperNumber
ShipperNumber Required: Yes* Required if ReferenceNumber/Value is populated. Shipper’s six
Type: String digit account number. Must be six alphanumeric characters. Must
Max Allowed: 1 be associated with the Internet account used to login.
Length: 6

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 360
LabelRecoveryResponse Top Level Containers

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 361
Shipping Package Web Service Developer Guide November 1, 2016

LabelRecoveryResponse XPath Tables

Note: Not all containers/elements are reflected separately in the table of contents.

Name Constraint Description Validation

/LabelRecoveryResponse
LabelRecoveryResponse Required: Yes Response for the Label recovery request Validates the date range and label being present. Also if
Type: Container the shipment is return or not
Max Allowed: 1
Length: N/A

Response
Name Constraint Description Validation
/LabelRecoveryResponse/Response
Response Required: Yes Response Container
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryResponse/Response/ResponseStatus
ResponseStatus Required: Yes Response Status container
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryResponse/Response/ResponseStatus/Code
Code Required: Yes Identifies the success status of the transaction. 1=Success
Type: String
Max Allowed: 1
Length: 1
/LabelRecoveryResponse/Response/ResponseStatus/Description
Description Required: Yes Describes Response Status Code. Returns the text "Success"
Type: String
Max Allowed: 1
Length: 1..35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 362
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/LabelRecoveryResponse/Response/Alert
Alert Required: No Alert Container. There can be zero to many alert containers with
Type: Container code and description
Max Allowed: UNB
Length: N/A
/LabelRecoveryResponse/Response/Alert/Code
Code Required: Yes* Warning code returned by the system
Type: String
Max Allowed: 1
Length: 1..10
/LabelRecoveryResponse/Response/Alert/Description
Description Required: Yes* Warning messages returned by the system
Type: String
Max Allowed: 1
Length: 1..512
/LabelRecoveryResponse/Response/TransactionReference
TransactionReference Required: No Transaction Reference Container
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryResponse/Response/TransactionReference/CustomerContext
CustomerContext Required: No The CustomerContext Information which will be echoed during
Type: String response
Max Allowed: 1
Length: 1..512

ShipmentIdentificationNumber
Name Constraint Description Validation
/LabelRecoveryResponse/ShipmentIdentificationNumber
ShipmentIdentificationNumber Required: No Tracking number of the leading package in the shipment
Type: String
Max Allowed: 1
Length: 18

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 363
Shipping Package Web Service Developer Guide November 1, 2016

LabelResults
Name Constraint Description Validation
/LabelRecoveryResponse/LabelResults
LabelResults Required: Yes Container that stores the label results. Information
Type: Container containing the results of the user's Label Recovery
Max Allowed: 1 Request.
Length: N/A
/LabelRecoveryResponse/LabelResults/TrackingNumber
TrackingNumber Required: Yes Package Tracking number. Package 1Z number.
Type: String
Max Allowed: 1
Length: 18
/LabelRecoveryResponse/LabelResults/LabelImage
LabelImage Required: Yes The elements needed to render a label on a printer or in a
Type: Container browser. Specifies the format in which GraphicImage is
Max Allowed: 1 represented.
Length: N/A
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 image byte stream.
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryResponse/LabelResults/LabelImage/LabelImageFormat/Code
Code Required: Yes The format of a label image byte stream. Code type that the label image is to be generated
Type: String in. Valid value returned is GIF or PDF
Max Allowed: 1
Length: 3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 364
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/LabelRecoveryResponse/LabelResults/LabelImage/GraphicImage
GraphicImage Required: Yes Base 64 encoded graphic image.
Type: String
Max Allowed: 1
Length: Unbounded
/LabelRecoveryResponse/LabelResults/LabelImage/HTMLImage
HTMLImage Required: No Base 64 encoded html browser image rendering software.
Type: String This is only returned for GIF image formats.
Max Allowed: 1
Length: Unbounded
/LabelRecoveryResponse/LabelResults/LabelImage/PDF417
PDF417 Required: No PDF-417 is a two-dimensional barcode, which can store up
Type: String to about 1,800 printable ASCII characters or 1,100 binary
Max Allowed: 1 characters per symbol. The symbol is rectangular.
Length: Unbounded
The PDF417 image will be returned when the shipment is
transborder and the service option is one of the following:
StandardExpressSaverExpress Plus. The image is Base 64
encoded and only returned for GIF image format
/LabelRecoveryResponse/LabelResults/LabelImage/InternationalSignatureGraphicImage
InternationalSignatureGraphicImage Required: No Base 64 encoded graphic image of the Warsaw text and
Type: String signature box.
Max Allowed: 1
Length: Unbounded
/LabelRecoveryResponse/LabelResults/LabelImage/URL
URL Required: No This is only returned if the label link is requested to be
Type: String returned and only at the first package result
Max Allowed: 1
Length: Unbounded
/LabelRecoveryResponse/LabelResults/Receipt
Receipt Required: No Container for the HTML receipt and the receipt link.
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 365
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/LabelRecoveryResponse/LabelResults/Receipt/HTMLImage
HTMLImage Required: No Base 64 encoded html browser image.
Type: String
Max Allowed: 1
Length: Unbounded
/LabelRecoveryResponse/LabelResults/Receipt/Image
Image Required: No Container for the receipt in the format other than HTML.
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryResponse/LabelResults/Receipt/Image/ImageFormat
ImageFormat Required: No Container for the format of the receipt
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryResponse/LabelResults/Receipt/Image/ImageFormat/Code
Code Required: Yes* Code representing the format in which a receipt is returned.
Type: String Valid values: HTML = HTML format, PDF = pdf
Max Allowed: 1
Length: 3..4
/LabelRecoveryResponse/LabelResults/Receipt/Image/GraphicImage
GraphicImage Required: No Base 64 encoded graphic image
Type: String
Max Allowed: 1
Length: Unbounded
/LabelRecoveryResponse/LabelResults/Receipt/URL
URL Required: No Receipt's url
Type: String
Max Allowed: 1
Length: Unbounded

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 366
Shipping Package Web Service Developer Guide November 1, 2016

TrackingCandidate
Name Constraint Description Validation
/LabelRecoveryResponse/TrackingCandidate
TrackingCandidate Required: Cond Information containing the results of the users Label Recovery
Type: Container Request. Returned in the event the Shipper Number and
Max Allowed: 1 Reference Number are supplied in the request.
Length: N/A
/LabelRecoveryResponse/TrackingCandidate/TrackingNumber
TrackingNumber Required: Yes* Packaging Tracking Number Only supported for the web package shipment so only
Type: String supported 18 digit
Max Allowed: 1
Length: 18
/LabelRecoveryResponse/TrackingCandidate/DestinationPostalCode
DestinationPostalCode Required: No Destination postal code candidate
Type: String
Max Allowed: 1
Length: 1..9
/LabelRecoveryResponse/TrackingCandidate/DestinationCountryCode
DestinationCountryCode Required: No Destination country code candidate, like US = USA, CA = Canada Must be valid ups country code
Type: String
Max Allowed: 1
Length: 2
/LabelRecoveryResponse/TrackingCandidate/PickupDateRange
PickupDateRange Required: No A range of time the package was picked up.
Type: Container
Max Allowed: 1
Length: N/A
/LabelRecoveryResponse/TrackingCandidate/PickupDateRange/BeginDate
BeginDate Required: Yes* The beginning of the date range for the candidate. Format: Service is only supported for 30 days
Type: String YYYYMMDD
Max Allowed: 1
Length: 8

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 367
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/LabelRecoveryResponse/TrackingCandidate/PickupDateRange/EndDate
EndDate Required: Yes* The end of the date range for the candidate. Format: YYYYMMDD
Type: String
Max Allowed: 1
Length: 8

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 368
Chapter 8: Void Shipment Elements and Details
The Void Operation is a single transaction that sends a VoidShipmentWebServicesRequest and receives the
VoidShipmentWebServicesResponse to confirm the void,

Accessing Void Web Service

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

VoidShipmentRequest Top Level Containers

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 369
Shipping Package Web Service Developer Guide November 1, 2016

VoidShipmentRequest XPath Tables

Note: Not all containers/elements are reflected separately in the table of contents.

Name Constraint Description Validation

/VoidShipmentRequest
VoidShipmentRequest Required: Yes Void Request Container
Type: Container
Max Allowed: 1
Length: N/A

Request
Name Constraint Description Validation
/VoidShipmentRequest/Request
Request Required: Yes Request Container
Type: Container
Max Allowed: 1
Length: N/A
/VoidShipmentRequest/Request/RequestOption
RequestOption Required: No Optional processing. No options Not used. Left for future uses
Type: String
Max Allowed: 1
Length: 1
/VoidShipmentRequest/Request/TransactionReference
TransactionReference Required: No TransactionReference identifies transactions between client and
Type: Container server.
Max Allowed: 1
Length: N/A
/VoidShipmentRequest/Request/TransactionReference/CustomerContext
CustomerContext Required: No The client uses CustomerContext to synchronize
Type: String request/response pairs. The client establishes CustomerContext,
Max Allowed: 1 which can contain any information you want, as long as it is valid
Length: 1...512 XML; it is echoed back by the server.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 370
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/VoidShipmentRequest/Request/TransactionReference/TransactionIdentifier
TransactionIdentifier Required: No The Unique TransactionIdentifier for a given transaction. Empty Tag. Not used. Left for future uses.
Type: String
Max Allowed: 1
Length: 4

VoidShipment
Name Constraint Description Validation
/VoidShipmentRequest/VoidShipment
VoidShipment Required: Yes The container for the Ship Void Request.
Type: Container
Max Allowed: 1
Length: 1
/VoidShipmentRequest/VoidShipment/ShipmentIdentificationNumber
ShipmentIdentificationNumber Required: Yes The shipment's identification number Alpha-numeric. Must pass 1Z rules. Must be upper case.
Type: String
Max Allowed: 1
Length: 18
/VoidShipmentRequest/VoidShipment/TrackingNumber
TrackingNumber Required: No The package's identification number Alpha-numeric. Must pass 1Z rules. Must be upper case
Type: String
Max Allowed:20
Length: 18

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 371
Void Shipment Response Top Level Containers

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 372
Shipping Package Web Service Developer Guide November 1, 2016

VoidShipmentResponse XPath Tables

Note: Not all containers/elements are reflected separately in the table of contents.

Name Constraint Description Validation

/VoidShipmentResponse
VoidShipmentResponse Required: Yes Void Response Container.
Type: Container
Max Allowed: 1
Length: N/A

Response
Name Constraint Description Validation
/VoidShipmentResponse/Response
Response Required: Yes Response Container.
Type: Container
Max Allowed: 1
Length: N/A
/VoidShipmentResponse/Response/ResponseStatus
ResponseStatus Required: Yes Response Status Container.
Type: Container
Max Allowed: 1
Length: N/A
/VoidShipmentResponse/Response/ResponseStatus/Code
Code Required: Yes Identifies the success or failure of the transaction. 1 = Successful
Type: String
Max Allowed: 1
Length: 1
/VoidShipmentResponse/Response/ResponseStatus/Description
Description Required: Yes Describes Response Status Code. Returns text of Success
Type: String
Max Allowed: 1
Length: 1…35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 373
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/VoidShipmentResponse/Response/Alert
Alert Required: No Alert Container. There can be zero to many alert containers with
Type: Container code and description.
Max Allowed: 1
Length: N/A
/VoidShipmentResponse/Response/Alert/Code
Code Required: Yes* Warning code returned by the system.
Type: String
Max Allowed: 1
Length: 1…10
/VoidShipmentResponse/Response/Alert/Description
Description Required: Yes* Warning messages returned by the system.
Type: String
Max Allowed: 1
Length: 1-150
/VoidShipmentResponse/Response/TransactionReference
TransactionReference Required: No Transaction Reference Container.
Type: Container
Max Allowed: 1
Length: N/A
/VoidShipmentResponse/Response/TransactionReference/CustomerContext
CustomerContext Required: No The CustomerContext Information which will be echoed during
Type: String response.
Max Allowed: 1
Length: 1...512
/VoidShipmentResponse/Response/TransactionReference/TransactionIdentifier
TransactionIdentifier Required: No The Unique TransactionIdentifier Information for that transaction.
Type: String This will be present only if requested in the request.
Max Allowed: 1
Length: 35

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 374
Shipping Package Web Service Developer Guide November 1, 2016

SummaryResult
Name Constraint Description Validation
/VoidShipmentResponse/SummaryResult
SummaryResult Required: Yes Container for the Summary Result
Type: Container
Max Allowed: 1
Length: N/A
/VoidShipmentResponse/SummaryResult/Status
Status Required: Yes Container for the status of the Summary Result
Type: Container
Max Allowed: 1
Length: N/A
/VoidShipmentResponse/SummaryResult/Status/Code
Code Required: Yes Code for the status of the Summary Result
Type: String
Max Allowed: 1
Length: 1
/VoidShipmentResponse/SummaryResult/Status/Description
Description Required: Yes Description of the status of the Summary Result
Type: String
Max Allowed: 1
Length: 1…35

PackageLevelResult
Name Constraint Description Validation
/VoidShipmentResponse/PackageLevelResult
PackageLevelResult Required: No Contains the Package Level Results
Type: Container
Max Allowed: 1
Length: N/A

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 375
Shipping Package Web Service Developer Guide November 1, 2016

Name Constraint Description Validation

/VoidShipmentResponse/PackageLevelResult/TrackingNumber
TrackingNumber Required: Yes* The package's identification number
Type: String
Max Allowed: 1
Length: 18
/VoidShipmentResponse/PackageLevelResult/Status
Status Required: Yes* Contains the status code tags.
Type: Container
Max Allowed: 1
Length: 1
/VoidShipmentResponse/PackageLevelResult/Status/Code
Code Required: Yes* The Package Level void status code. A numeric value that
Type: String describes the status code. 1 = Voided or Already Voided; 0 = Not
Max Allowed: 1 Voided
Length: 1
/VoidShipmentResponse/PackageLevelResult/Status/Description
Description Required: Yes* A text description of the status code.
Type: String
Max Allowed: 1
Length: 1...15

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 376
Chapter 9: Shipping Web Service API Examples
ShipmentRequest Published Rates
<envr:Envelope xmlns:auth="http://www.ups.com/schema/xpci/1.0/auth"
xmlns:envr="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:upss="http://www.ups.com/XMLSchema/XOLTWS/UPSS/v1.0"
xmlns:common="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<envr:Header>
<upss:UPSSecurity>
<upss:UsernameToken>
<upss:Username>Your Username</upss:Username>
<upss:Password>Your Password</upss:Password>
</upss:UsernameToken>
<upss:ServiceAccessToken>
<upss:AccessLicenseNumber>Your Access License Number</upss:AccessLicenseNumber>
</upss:ServiceAccessToken>
</upss:UPSSecurity>
</envr:Header>
<envr:Body>
<ship:ShipmentRequest xsi:schemaLocation="http://www.ups.com/XMLSchema/XOLTWS/Ship/v1.0"
xmlns:ship="http://www.ups.com/XMLSchema/XOLTWS/Ship/v1.0"
xmlns:ifs="http://www.ups.com/XMLSchema/XOLTWS/IF/v1.0">
<common:Request>
<common:RequestOption>validate</common:RequestOption>
<common:TransactionReference>
<common:CustomerContext>Your Customer Context</common:CustomerContext>
</common:TransactionReference>
</common:Request>
<ship:Shipment>
<ship:Description>Description</ship:Description>
<ship:Shipper>
<ship:Name>Shipper Name</ship:Name>
<ship:AttentionName>Shipper Attn Name</ship:AttentionName>
<ship:TaxIdentificationNumber>123456</ship:TaxIdentificationNumber>
<ship:Phone>
<ship:Number>1234567890</ship:Number>
<ship:Extension>1</ship:Extension>
</ship:Phone>
<ship:ShipperNumber>Your Shipper Number</ship:ShipperNumber>
<ship:FaxNumber>1234567890</ship:FaxNumber>
<ship:Address>
<ship:AddressLine>Address Line</ship:AddressLine>
<ship:City>City</ship:City>
<ship:StateProvinceCode>StateProvinceCode</ship:StateProvinceCode>
<ship:PostalCode>PostalCode</ship:PostalCode>
<ship:CountryCode>CountryCode</ship:CountryCode>
</ship:Address>
</ship:Shipper>
<ship:ShipTo>
<ship:Name>Ship To Name</ship:Name>
<ship:AttentionName>Ship To Attn Name</ship:AttentionName>
<ship:Phone>
<ship:Number>1234567890</ship:Number>
</ship:Phone>

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 377
Shipping Package Web Service Developer Guide November 1, 2016

<ship:Address>
<ship:AddressLine>Address Line</ship:AddressLine>
<ship:City>City</ship:City>
<ship:StateProvinceCode>StateProvinceCode</ship:StateProvinceCode>
<ship:PostalCode>PostalCode</ship:PostalCode>
<ship:CountryCode>CountryCode</ship:CountryCode>
</ship:Address>
</ship:ShipTo>
<ship:ShipFrom>
<ship:Name>Ship From Name</ship:Name>
<ship:AttentionName>Ship From Attn Name</ship:AttentionName>
<ship:Phone>
<ship:Number>1234567890</ship:Number>
</ship:Phone>
<ship:FaxNumber>1234567890</ship:FaxNumber>
<ship:Address>
<ship:AddressLine>Address Line</ship:AddressLine>
<ship:City>City</ship:City>
<ship:StateProvinceCode>StateProvinceCode</ship:StateProvinceCode>
<ship:PostalCode>PostalCode</ship:PostalCode>
<ship:CountryCode>CountryCode</ship:CountryCode>
</ship:Address>
</ship:ShipFrom>
<ship:PaymentInformation>
<ship:ShipmentCharge>
<ship:Type>01</ship:Type>
<ship:BillShipper>
<ship:AccountNumber>Your Account Number</ship:AccountNumber>
</ship:BillShipper>
</ship:ShipmentCharge>
</ship:PaymentInformation>
<ship:Service>
<ship:Code>01</ship:Code>
<ship:Description>Express</ship:Description>
</ship:Service>
<ship:Package>
<ship:Description>Description</ship:Description>
<ship:Packaging>
<ship:Code>02</ship:Code>
<ship:Description>Description</ship:Description>
</ship:Packaging>
<ship:Dimensions>
<ship:UnitOfMeasurement>
<ship:Code>IN</ship:Code>
<ship:Description>Inches</ship:Description>
</ship:UnitOfMeasurement>
<ship:Length>7</ship:Length>
<ship:Width>5</ship:Width>
<ship:Height>2</ship:Height>
</ship:Dimensions>
<ship:PackageWeight>
<ship:UnitOfMeasurement>
<ship:Code>LBS</ship:Code>
<ship:Description>Pounds</ship:Description>
</ship:UnitOfMeasurement>
<ship:Weight>10</ship:Weight>
</ship:PackageWeight>

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 378
Shipping Package Web Service Developer Guide November 1, 2016

</ship:Package>
</ship:Shipment>
<ship:LabelSpecification>
<ship:LabelImageFormat>
<ship:Code>GIF</ship:Code>
<ship:Description>GIF</ship:Description>
</ship:LabelImageFormat>
<ship:HTTPUserAgent>Mozilla/4.5</ship:HTTPUserAgent>
</ship:LabelSpecification>
</ship:ShipmentRequest>
</envr:Body>
</envr:Envelope>

ShipmentResponse Published Rates

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body>
<ship:ShipmentResponse xmlns:ship="http://www.ups.com/XMLSchema/XOLTWS/Ship/v1.0">
<common:Response xmlns:common="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0">
<common:ResponseStatus>
<common:Code>1</common:Code>
<common:Description>Success</common:Description>
</common:ResponseStatus>
<common:TransactionReference>
<common:CustomerContext>Your Customer Context</common:CustomerContext>
</common:TransactionReference>
</common:Response>
<ship:ShipmentResults>
<ship:ShipmentCharges>
<ship:TransportationCharges>
<ship:CurrencyCode>USD</ship:CurrencyCode>
<ship:MonetaryValue>88.12</ship:MonetaryValue>
</ship:TransportationCharges>
<ship:ServiceOptionsCharges>
<ship:CurrencyCode>USD</ship:CurrencyCode>
<ship:MonetaryValue>0.00</ship:MonetaryValue>
</ship:ServiceOptionsCharges>
<ship:TotalCharges>
<ship:CurrencyCode>USD</ship:CurrencyCode>
<ship:MonetaryValue>88.12</ship:MonetaryValue>
</ship:TotalCharges>
</ship:ShipmentCharges>
<ship:BillingWeight>
<ship:UnitOfMeasurement>
<ship:Code>LBS</ship:Code>
<ship:Description>Pounds</ship:Description>
</ship:UnitOfMeasurement>
<ship:Weight>10.0</ship:Weight>
</ship:BillingWeight>
<ship:ShipmentIdentificationNumber>1ZWA82900191640782</ship:ShipmentIdentificationN
umber>
<ship:PackageResults>
<ship:TrackingNumber>1ZWA82900191640782</ship:TrackingNumber>
<ship:ServiceOptionsCharges>
<ship:CurrencyCode>USD</ship:CurrencyCode>

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 379
Shipping Package Web Service Developer Guide November 1, 2016

<ship:MonetaryValue>0.00</ship:MonetaryValue>
</ship:ServiceOptionsCharges>
<ship:ShippingLabel>
<ship:ImageFormat>
<ship:Code>GIF</ship:Code>
<ship:Description>GIF</ship:Description>
</ship:ImageFormat> <ship:GraphicImage>R0lGODdheAUgA+c
(Truncated)</ship:GraphicImage>
<ship:HTMLImage>PCFET0NUWVBFIEhUTUwgUFVCTElDICI
(Truncated)</ship:HTMLImage>
</ship:ShippingLabel>
</ship:PackageResults>
</ship:ShipmentResults>
</ship:ShipmentResponse>
</soapenv:Body>
</soapenv:Envelope>

ShipmentRequest Negotiated Rates

<envr:Envelope xmlns:auth="http://www.ups.com/schema/xpci/1.0/auth"
xmlns:envr="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:upss="http://www.ups.com/XMLSchema/XOLTWS/UPSS/v1.0"
xmlns:common="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<envr:Header>
<upss:UPSSecurity>
<upss:UsernameToken>
<upss:Username>Your Username</upss:Username>
<upss:Password>Your Password</upss:Password>
</upss:UsernameToken>
<upss:ServiceAccessToken>
<upss:AccessLicenseNumber>Your Access License Number</upss:AccessLicenseNumber>
</upss:ServiceAccessToken>
</upss:UPSSecurity>
</envr:Header>
<envr:Body>
<ship:ShipmentRequest xsi:schemaLocation="http://www.ups.com/XMLSchema/XOLTWS/Ship/v1.0"
xmlns:ship="http://www.ups.com/XMLSchema/XOLTWS/Ship/v1.0"
xmlns:ifs="http://www.ups.com/XMLSchema/XOLTWS/IF/v1.0">
<common:Request>
<common:RequestOption>validate</common:RequestOption>
<common:TransactionReference>
<common:CustomerContext>Your Customer Context</common:CustomerContext>
</common:TransactionReference>
</common:Request>
<ship:Shipment>
<ship:Description>Description</ship:Description>
<ship:Shipper>
<ship:Name>Shipper Name</ship:Name>
<ship:AttentionName>Shipper Attn Name</ship:AttentionName>
<ship:TaxIdentificationNumber>123456</ship:TaxIdentificationNumber>
<ship:Phone>
<ship:Number>1234567890</ship:Number>
<ship:Extension>1</ship:Extension>
</ship:Phone>
<ship:ShipperNumber>Your Shipper Number</ship:ShipperNumber>
<ship:FaxNumber>1234567890</ship:FaxNumber>

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 380
Shipping Package Web Service Developer Guide November 1, 2016

<ship:Address>
<ship:AddressLine>Address Line</ship:AddressLine>
<ship:City>City</ship:City>
<ship:StateProvinceCode>StateProvinceCode</ship:StateProvinceCode>
<ship:PostalCode>PostalCode</ship:PostalCode>
<ship:CountryCode>CountryCode</ship:CountryCode>
</ship:Address>
</ship:Shipper>
<ship:ShipTo>
<ship:Name>Ship To Name</ship:Name>
<ship:AttentionName>Ship To Attn Name</ship:AttentionName>
<ship:Phone>
<ship:Number>1234567890</ship:Number>
</ship:Phone>
<ship:Address>
<ship:AddressLine>Address Line</ship:AddressLine>
<ship:City>City</ship:City>
<ship:StateProvinceCode>StateProvinceCode</ship:StateProvinceCode>
<ship:PostalCode>PostalCode</ship:PostalCode>
<ship:CountryCode>CountryCode</ship:CountryCode>
</ship:Address>
</ship:ShipTo>
<ship:ShipFrom>
<ship:Name>Ship From Name</ship:Name>
<ship:AttentionName>Ship From Attn Name</ship:AttentionName>
<ship:Phone>
<ship:Number>1234567890</ship:Number>
</ship:Phone>
<ship:FaxNumber>1234567890</ship:FaxNumber>
<ship:Address>
<ship:AddressLine>Address Line</ship:AddressLine>
<ship:City>City</ship:City>
<ship:StateProvinceCode>StateProvinceCode</ship:StateProvinceCode>
<ship:PostalCode>PostalCode</ship:PostalCode>
<ship:CountryCode>CountryCode</ship:CountryCode>
</ship:Address>
</ship:ShipFrom>
<ship:PaymentInformation>
<ship:ShipmentCharge>
<ship:Type>01</ship:Type>
<ship:BillShipper>
<ship:AccountNumber>Your Account Number</ship:AccountNumber>
</ship:BillShipper>
</ship:ShipmentCharge>
</ship:PaymentInformation>
<ship:Service>
<ship:Code>01</ship:Code>
<ship:Description>Express</ship:Description>
</ship:Service>
<ship:ShipmentRatingOptions>
<ship:NegotiatedRatesIndicator>0</ship:NegotiatedRatesIndicator>
</ship:ShipmentRatingOptions>
<ship:Package>
<ship:Description>Description</ship:Description>
<ship:Packaging>
<ship:Code>02</ship:Code>
<ship:Description>Description</ship:Description>

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 381
Shipping Package Web Service Developer Guide November 1, 2016

</ship:Packaging>
<ship:Dimensions>
<ship:UnitOfMeasurement>
<ship:Code>IN</ship:Code>
<ship:Description>Inches</ship:Description>
</ship:UnitOfMeasurement>
<ship:Length>7</ship:Length>
<ship:Width>5</ship:Width>
<ship:Height>2</ship:Height>
</ship:Dimensions>
<ship:PackageWeight>
<ship:UnitOfMeasurement>
<ship:Code>LBS</ship:Code>
<ship:Description>Pounds</ship:Description>
</ship:UnitOfMeasurement>
<ship:Weight>10</ship:Weight>
</ship:PackageWeight>
</ship:Package>
</ship:Shipment>
<ship:LabelSpecification>
<ship:LabelImageFormat>
<ship:Code>GIF</ship:Code>
<ship:Description>GIF</ship:Description>
</ship:LabelImageFormat>
<ship:HTTPUserAgent>Mozilla/4.5</ship:HTTPUserAgent>
</ship:LabelSpecification>
</ship:ShipmentRequest>
</envr:Body>
</envr:Envelope>

ShipmentResponse Negotiated Rates

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body>
<ship:ShipmentResponse xmlns:ship="http://www.ups.com/XMLSchema/XOLTWS/Ship/v1.0">
<common:Response xmlns:common="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0">
<common:ResponseStatus>
<common:Code>1</common:Code>
<common:Description>Success</common:Description>
</common:ResponseStatus>
<common:TransactionReference>
<common:CustomerContext>Your Customer Context</common:CustomerContext>
</common:TransactionReference>
</common:Response>
<ship:ShipmentResults>
<ship:ShipmentCharges>
<ship:TransportationCharges>
<ship:CurrencyCode>USD</ship:CurrencyCode>
<ship:MonetaryValue>88.12</ship:MonetaryValue>
</ship:TransportationCharges>
<ship:ServiceOptionsCharges>
<ship:CurrencyCode>USD</ship:CurrencyCode>
<ship:MonetaryValue>0.00</ship:MonetaryValue>
</ship:ServiceOptionsCharges>
<ship:TotalCharges>

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 382
Shipping Package Web Service Developer Guide November 1, 2016

<ship:CurrencyCode>USD</ship:CurrencyCode>
<ship:MonetaryValue>88.12</ship:MonetaryValue>
</ship:TotalCharges>
</ship:ShipmentCharges>
<ship:NegotiatedRateCharges>
<ship:TotalCharge>
<ship:CurrencyCode>USD</ship:CurrencyCode>
<ship:MonetaryValue>70.00</ship:MonetaryValue>
</ship:TotalCharge>
</ship:NegotiatedRateCharges>
<ship:BillingWeight>
<ship:UnitOfMeasurement>
<ship:Code>LBS</ship:Code>
<ship:Description>Pounds</ship:Description>
</ship:UnitOfMeasurement>
<ship:Weight>10.0</ship:Weight>
</ship:BillingWeight>
<ship:ShipmentIdentificationNumber>1ZWA82900191640782</ship:ShipmentIdentificationN
umber>
<ship:PackageResults>
<ship:TrackingNumber>1ZWA82900191640782</ship:TrackingNumber>
<ship:ServiceOptionsCharges>
<ship:CurrencyCode>USD</ship:CurrencyCode>
<ship:MonetaryValue>0.00</ship:MonetaryValue>
</ship:ServiceOptionsCharges>
<ship:ShippingLabel>
<ship:ImageFormat>
<ship:Code>GIF</ship:Code>
<ship:Description>GIF</ship:Description>
</ship:ImageFormat>
<ship:GraphicImage>R0lGODdheAUgA+cAAAAAAAEBAQIC
(Truncated)</ship:GraphicImage>
<ship:HTMLImage>PCFET0NUWVBFIEhUTUwgUFVCTElD
(Truncated)</ship:HTMLImage>
</ship:ShippingLabel>
</ship:PackageResults>
</ship:ShipmentResults>
</ship:ShipmentResponse>
</soapenv:Body>
</soapenv:Envelope>

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 383
Shipping Package Web Service Developer Guide November 1, 2016

LabelRecoveryRequest Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.ups.com/XMLSchema/XOLTWS/UPSS/v1.0"
xmlns:v11="http://www.ups.com/XMLSchema/XOLTWS/LBRecovery/v1.0"
xmlns:v12="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0">
<soapenv:Header>
<v1:UPSSecurity>
<v1:UsernameToken>
<v1:Username>Your User Id</v1:Username>
<v1:Password>Your Password</v1:Password>
</v1:UsernameToken>
<v1:ServiceAccessToken>
<v1:AccessLicenseNumber>Your Access License Number</v1:AccessLicenseNumber>
</v1:ServiceAccessToken>
</v1:UPSSecurity>
</soapenv:Header>
<soapenv:Body>
<v11:LabelRecoveryRequest>
<v11:LabelSpecification>
<v11:LabelImageFormatCode>GIF</v11:LabelImageFormatCode>
<v11:HTTPUserAgent>Mozilla/4.5</v11:HTTPUserAgent>
</v11:LabelSpecification>
<v11:Translate>
<v11:LanguageCode>eng</v11:LanguageCode>
<v11:DialectCode>GB</v11:DialectCode>
<v11:Code>01</v11:Code>
</v11:Translate>
<v11:TrackingNumber>Your Tracking Number</v11:TrackingNumber>
</v11:LabelRecoveryRequest>
</soapenv:Body>
</soapenv:Envelope>

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 384
Shipping Package Web Service Developer Guide November 1, 2016

LabelRecoveryResponse Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body>
<lbrec:LabelRecoveryResponse
xmlns:lbrec="http://www.ups.com/XMLSchema/XOLTWS/LBRecovery/v1.0">
<common:Response xmlns:common="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0">
<common:ResponseStatus>
<common:Code>1</common:Code>
<common:Description>Success</common:Description>
</common:ResponseStatus>
</common:Response>
<lbrec:LabelResults>
<lbrec:TrackingNumber>1Z1107YY8567985294</lbrec:TrackingNumber>
<lbrec:LabelImage>
<lbrec:LabelImageFormat>
<lbrec:Code>gif</lbrec:Code>
</lbrec:LabelImageFormat>
<lbrec:GraphicImage>R0lGODdheAUgA+cAAAAAAAEBAQICAgMD
(Truncated)</lbrec:GraphicImage>
<lbrec:HTMLImage>PCFET0NUWVBFIEhUTUwgUFVCTElDICItLy
(Truncated)</lbrec:HTMLImage>
<lbrec:PDF417>R0lGODdhLAG8AucAAAAAAAEBAQICAgMD
(Truncated)</lbrec:PDF417>
</lbrec:LabelImage>
<lbrec:Receipt>
<lbrec:HTMLImage>PGh0bWw+PGhlYWQ+PHRpdGxlPlJlY2V
(Truncated)</lbrec:HTMLImage>
</lbrec:Receipt>
</lbrec:LabelResults>
<lbrec:LabelResults>
<lbrec:TrackingNumber>1Z1107YY8586551109</lbrec:TrackingNumber>
<lbrec:LabelImage>
<lbrec:LabelImageFormat>
<lbrec:Code>gif</lbrec:Code>
</lbrec:LabelImageFormat>
<lbrec:GraphicImage>R0lGODdheAUgA+cAAAAAAAEBAQICAgMD
(Truncated)</lbrec:GraphicImage>
<lbrec:HTMLImage>PCFET0NUWVBFIEhUTUwgUFVCTElDICItLy
(Truncated)</lbrec:HTMLImage>
<lbrec:PDF417>R0lGODdhLAG8AucAAAAAAAEBAQICAgMD
(Truncated)</lbrec:PDF417>
</lbrec:LabelImage>
<lbrec:Receipt>
<lbrec:HTMLImage>PGh0bWw+PGhlYWQ+PHRpdGxlPlJlY2V
(Truncated)</lbrec:HTMLImage>
</lbrec:Receipt>
</lbrec:LabelResults>
</lbrec:LabelRecoveryResponse>
</soapenv:Body>
</soapenv:Envelope>

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 385
Shipping Package Web Service Developer Guide November 1, 2016

VoidShipmentRequest Example
<envr:Envelope xmlns:auth="http://www.ups.com/schema/xpci/1.0/auth"
xmlns:envr="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:upss="http://www.ups.com/XMLSchema/XOLTWS/UPSS/v1.0"
xmlns:common="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<envr:Header>
<upss:UPSSecurity>
<upss:UsernameToken>
<upss:Username>Your Username</upss:Username>
<upss:Password>Your Password</upss:Password>
</upss:UsernameToken>
<upss:ServiceAccessToken>
<upss:AccessLicenseNumber>Your Access License Number</upss:AccessLicenseNumber>
</upss:ServiceAccessToken>
</upss:UPSSecurity>
</envr:Header>
<envr:Body>
<void:VoidShipmentRequest xmlns:void="http://www.ups.com/XMLSchema/XOLTWS/Void/v1.1">
<common:Request>
<common:TransactionReference>
<common:CustomerContext>Your Customer Context</common:CustomerContext>
</common:TransactionReference>
</common:Request>
<void:VoidShipment>
<void:ShipmentIdentificationNumber>Your Shipment Identification
Number</void:ShipmentIdentificationNumber>
</void:VoidShipment>
</void:VoidShipmentRequest>
</envr:Body>
</envr:Envelope>

VoidShipmentResponse Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body>
<void:VoidShipmentResponse xmlns:void="http://www.ups.com/XMLSchema/XOLTWS/Void/v1.1">
<common:Response xmlns:common="http://www.ups.com/XMLSchema/XOLTWS/Common/v1.0">
<common:ResponseStatus>
<common:Code>1</common:Code>
<common:Description>Success</common:Description>
</common:ResponseStatus>
<common:TransactionReference>
<common:CustomerContext>Your Customer Context</common:CustomerContext>
</common:TransactionReference>
</common:Response>
<void:SummaryResult>
<void:Status>
<void:Code>1</void:Code>
<void:Description>Voided</void:Description>
</void:Status>
</void:SummaryResult>
</void:VoidShipmentResponse>
</soapenv:Body>
</soapenv:Envelope>

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 386
Shipping Package Web Service Developer Guide November 1, 2016

Chapter 10: 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 URL’s 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?

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 387
Shipping Package Web Service Developer Guide November 1, 2016

Category Question Answer

Consignee Billing Is Consignee Billing Yes, Consignee Billing is supported in the U.S. and PR.
supported in the Shipping
This payment method allows you to bill the charges for a
API?
specified shipment to a consignee who has agreed to pay
the charges. All shipping charges are billed to the
consignee's UPS account number including the following
accessorials: Additional Handling, Delivery Area
Surcharges, Delivery Change Requests, Early AM Premium,
Early AM Out of Territory, Fuel Surcharge, Hazardous
Material Surcharges, Large Package Surcharge, Over Max
Limits, and Saturday Delivery.
Declared Value, Delivery Confirmation, On Call Pickup,
Remote Area Surcharge, Saturday Pickup and Verbal
Confirmation of Delivery fees are not passed to the
consignee and these charges are billed to the shippers UPS
account number.
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; the logic 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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 388
Shipping Package Web Service Developer Guide November 1, 2016

Category Question Answer

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 API work 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?

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 389
Shipping Package Web Service Developer Guide November 1, 2016

Category Question Answer

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.
API support 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 API behave 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?

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 390
Shipping Package Web Service Developer Guide November 1, 2016

Category Question Answer

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 element in 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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 391
Shipping Package Web Service Developer Guide November 1, 2016

Category Question Answer

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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 392
Shipping Package Web Service Developer Guide November 1, 2016

Category Question Answer

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 Developer’s 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? API Elements and Details chapter.
Returns Is there a URL ONLY No.
capability for returns within
the Shipping API?

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 393
Shipping Package Web Service Developer Guide November 1, 2016

Category Question Answer

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 394
Shipping Package Web Service Developer Guide November 1, 2016

Category Question Answer

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
customer’s information.
The Control ID is currently included in the following U.S. and
Canada Invoice Media types:

• Online PDF Images

• EDI Domestic and Import
• Hard Copy Invoices
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?

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 395
 Appendices

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 396
Shipping Package Web Service Developer Guide November 1, 2016

Error Codes

If you get a < ShipmentResponse > in a SOAP Envelope’s Body part, it means the request is processed
successfully. Otherwise, a SOAP Fault will be returned in a SOAP Envelope’s Body part. In a good response, check
the ResponseStatusCode element. A “1” normally indicates a successful response.
When you get a SOAP FAULT, check the Errors and the sub-element ErrorDetail. The value of <Severity> can be
either Transient or Hard. When an error occurs there will also be an error code, and an error description in
PrimaryErrorCode element.

• Success – Successful responses may or may not include Warnings.

■ (without warnings) Request is processed as anticipated by the client.
■ (with warnings) Warning messages indicate that UPS was able to process the request; however (potentially)
unanticipated results have also occurred. The warning contains information in the response that should be
passed to the end user.
• Errors – will return two different levels of severity.
■ Transient errors are temporary errors, due to temporary high server loads or scheduled maintenance, for
example. The application may re-issue the request at a later time.
■ Hard errors indicate that an error existed in the request that UPS could not resolve, it is a user error. These
errors are critical and prevent requests from processing.
Applications should not re-issue requests with Hard errors without first correcting the error.
The following tables lists the errors that UPS may return in response to a request.

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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 397
Shipping Package Web Service Developer Guide November 1, 2016

Code Severity Description

250006 Hard The maximum number of user access attempts was exceeded.
250007 Hard The UserId is currently locked out; please try again in 24 hours.
250009 Hard License Number not found in the UPS database.
250019 Hard Invalid Field value.
250050 Transient License system not available.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 398
Shipping Package Web Service Developer Guide November 1, 2016

Shipping Error Codes

Error Codes 20004 - 20011

Error Code Severity Description

20004 Hard Cannot access the high level business components, {0}
20005 Hard Cannot access the low level business components, {0}
20007 Hard Missing required field, {0}
20008 Hard The field, {0}, contains invalid data, {1}
20010 Hard The phone number contains invalid characters
20011 Hard The Integration Indicator is no longer supported

Error Codes 12700 - 127007

Error Code Severity Description

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.
127006 Hard EEI forms cannot be used together.
127007 Hard Shipper has no SDL contract and is not eligible to ship SDL shipments.

Error Codes 110001 - 125000

Error Code Severity Description

110001 Hard XML Rating and Service Selection Service Unavailable
120001 Hard XML Shipping System is unavailable, please try again later.
120020 Hard Max packages per shipment exceeded
120021 Hard The same shipment cannot be requested to be created more than once.
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 399
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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.
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 or invalid shipper name
120102 Hard Missing or invalid shipper address line 1
120103 Hard Invalid shipper address line 2

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 400
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

120104 Hard Invalid shipper address line 3
120105 Hard Missing or invalid Shipper City
120106 Hard Missing or invalid Shipper StateProvinceCode
120107 Hard Missing or invalid Shipper PostalCode. (Description)
120108 Hard Missing or invalid Shipper CountryCode
120109 Hard Missing or invalid Shipper PhoneNumber
120110 Hard Missing or invalid Shipper AttentionName
120111 Hard Shipper EmailAddress cannot exceed a length of 50 characters
120112 Hard Shipper EmailAddress is an invalid format
120113 Hard Shipper number must contain alphanumeric characters only
120114 Hard Shipper phone extension cannot exceed the length of 4.
120115 Hard Shipper PhoneNumber must be at least 10 alphanumeric characters
120116 Hard Shipper phone extension must contain only numbers
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.
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 or invalid ShipTo CompanyName
120201 Hard Missing or invalid ShipTo AttentionName
120202 Hard Missing or invalid ShipTo AddressLine1
120203 Hard Invalid ShipTo AddressLine2
120204 Hard Invalid ShipTo AddressLine3
120205 Hard Missing or invalid ShipTo City
120206 Hard Missing or invalid ShipTo StateProvinceCode
120207 Hard Missing or invalid ShipTo PostalCode. (Description)
120208 Hard Missing or invalid ShipTo CountryCode
120209 Hard Missing or invalid ShipTo PhoneNumber
120210 Hard ShipTo EmailAddress cannot exceed a length of 50 characters
120211 Hard ShipTo EmailAddress is an invalid format
120212 Hard ShipTo PhoneExtension cannot exceed the length of 4.
120213 Hard ShipTo PhoneNumber must be at least 10 alphanumeric characters
120214 Hard ShipTo PhoneExtension must contain only numbers
120216 Hard ShipTo PhoneExtension is only valid if a phone number is given

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 401
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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 or invalid ShipFrom CompanyName
120301 Hard Missing or invalid ShipFrom AttentionName
120302 Hard Missing or invalid ShipFrom AddressLine1
120303 Hard Invalid ShipFrom AddressLine2
120304 Hard Invalid ShipFrom AddressLine3
120305 Hard Missing or invalid ShipFrom City
120306 Hard Missing or invalid ShipFrom StateProvinceCode
120307 Hard Missing or invalid ShipFrom PostalCode. (Description)
120308 Hard Missing or invalid ShipFrom CountryCode
120309 Hard Missing or invalid ShipFrom PhoneNumber
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
120318 Hard ShipFrom phone number and phone extension together cannot be more than 15 digits
long
120400 Hard Missing or invalid shipment payment method
120402 Hard Missing or invalid credit card type
120403 Hard Missing or invalid credit card number
120404 Hard Missing or invalid credit card expiration date
120406 Hard creditcard number is not valid for the credit card type
120407 Hard The credit card provided as the payment method has expired.
120408 Hard Missing credit card type
120412 Hard UPS account number that was provided as the payment method is missing or invalid.
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
120417 Hard The account number for FRS payment information is not FRS enabled
120437 Hard Third party or freight collect shippers postal code is missing or invalid.
120444 Hard Invalid Bill-To type
120500 Hard Missing or invalid Service Code
120501 Hard Invalid Shipment ReferenceNumber Value
120502 Hard InvoiceLineTotal/MonetaryValue must be greater than 0

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 402
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

120503 Hard Shipment Description cannot exceed the length of 35 characters
120504 Hard InvoiceLineTotal is not allowed for this shipment
120505 Hard Saturday Delivery Option cannot be used for this shipment
120506 Hard Invalid Shipment ReferenceNumber Code
120512 Hard Shipment Description is required for this shipment.
120515 Hard { notification type} Memo cannot exceed the length of 150 characters
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
120522 Hard Alternate Delivery Time is not valid for any available services
120523 Hard Shipment DocumentsOnly is invalid with the shipments origin/destination pair
120524 Hard Package Pickup Request is not available with this shipments service
120526 Hard InvoiceLineTotal MonetaryValue may not exceed the length of 8
120530 Hard SuiteRoomID length of shipment pickup cannot exceed 8 characters
120531 Hard FloorID length of shipment pickup cannot exceed 3 characters
120532 Hard Location length of shipment pickup cannot exceed 11 characters
120533 Hard The earliest shipment pickup time is required
120534 Hard The latest shipment pickup time is required
120535 Hard Contact name of shipment pickup is required
120536 Hard Contact phone number of shipment pickup is required
120538 Hard Shipment Pickup Error: (further description is provided in XML)
120549 Hard Invalid ReferenceNumber BarCodeIndicator.
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 403
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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.
120600 Hard Missing Package Packaging Type Code
120601 Hard Missing or invalid Package weight
120602 Hard Missing or 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
120606 Hard Mismatch package dimensions, package type and package weight
120607 Hard Invalid Package Reference Code
120608 Hard Package weight is required
120609 Hard All Package Dimensions are required and each must be greater than 0
120610 Hard Invalid COD monetary value
120611 Hard The contact name of verbal confirmation cannot exceed a length of 35
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 404
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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 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
120644 Hard LabelDelivery is not valid with the shipment
120654 Hard No more than two email addresses for Receiver Return Notification are allowed in a
shipment.
120655 Hard {0} of Receiver Return Notification is only allowed to be specified at the first package
that has Receiver Return Notification.
120661 Hard For a shipment, the maximum number of {0} 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 or invalid subject text of {Notification type}
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.
120704 Hard Missing/Invalid LabelSpecification LabelStockSize Height
120705 Hard Missing/Invalid LabelSpecification LabelStockSize Width.
120759 Hard MovementReferenceNumber must contain alphanumeric characters only.
120760 Hard MovementReferenceNumber must be a length of 18 characters.
120761 Hard Invalid MovementReferenceNumber . The 3rd and 4th Character Must be the Shipper
country ISO Code.
120801 Hard Address Validation Error on Shipper address
120802 Hard Address Validation Error on ShipTo address

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 405
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

120803 Hard Address Validation Error on ShipFrom address
120900 Warning User Id and Shipper Number combination is not qualified to receive negotiated 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.
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 Direct to Retail Shipment.
120999 Hard Missing or invalid UPS Access Point ID.
121000 Hard Request contains invalid data e.g. special characters etc. Please correct.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 406
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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}
121040 Hard The Return Services are unavailable with the requested service.
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.
121087 Hard The Authorized Return Service option is not allowed for shipments.
121090 Hard {Rating error description}
121091 Hard {Rating error description}
121100 Hard The selected service is invalid for the shipment origin.
121105 Hard The given accessory key is invalid for the shipment origin.
121106 Hard The specified country, origin or destination, is not supported.
121107 Hard A blank origin postal was specified.
121115 Hard The COD amount must be greater than zero
121116 Hard The declared value amount must be greater than zero.
121120 Hard The COD amount cannot exceed $1,000 when a cashiers check or money order is
requested.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 407
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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
country’s 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.
121165 Hard The Verbal Confirmation of Deliveryoption cannot be combined with the Return
Services 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.
121182 Hard The payer's transportation country is not valid for carbon neutral shipments.
121195 Hard The selected billing option is unavailable with the selected service.
121196 Hard The selected billing option is unavailable with UPS Letters.
121200 Hard Saturday Delivery is unavailable to desired destination.
121205 Hard Additional Handling is unavailable with the selected service.
121206 Hard Additional Handling is unavailable with UPS Letters.
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 A package-level accessorial is not available with the shipments origin/dest pair.
(Description) will be a detailed description based on the shipment.
121212 Hard The requested package type is not allowed in a shipment from the origin to the
destination
121213 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.
121225 Hard Return Services are unavailable to the given destination.
121230 Hard Next Day Air Early Surcharge is unavailable with the selected service.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 408
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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}
121255 Hard Shipper Duty Fee is unavailable with the selected service.
121260 Hard Shipper Duty Fee is unavailable with the selected billing option.
121261 Hard Accessory may not be combined with the product.
121262 Hard Accessory may not be combined with the accessory.
121265 Hard The selected billing option is unavailable to the desired country.
121266 Hard The currency code is invalid for the shipment.
121267 Hard The Ship From Country is invalid for the credit card.
121268 Hard The Billing address Country is invalid for the credit card.
121285 Hard {Rating error description}
121286 Hard {Rating error description}
121290 Hard The given billing option is invalid
121295 Hard {Rating error description}
121315 Hard The Authorized Return Service is unavailable with the selected accessorial.
121317 Hard The UPS Import Control option is unavailable with the selected accessory.
121320 Hard The Authorized Return Service is unavailable with the selected service.
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.
121460 Hard Shipments cannot exceed a COD amount of $5,000 when requesting a cashiers check
or money order.
121500 Hard {Rating error description}
121501 Hard {Rating error Description}
121502 Hard The selected country does not allow forward movements.
121510 Hard Unsupported package type.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 409
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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
121523 Hard Invalid GoodsNotInFreeCirculationIndicator
121524 Hard 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.
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.
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.
121565 Hard The UPS Returns Flexible Access option is unavailable with the requested accessory.
121570 Hard The UPS Returns Flexible Access option is available only with Return Services Print
Mail, Electronic Return Label, and Print Return Label.
121575 Hard The UPS Returns Flexible Access option is unavailable with Additional Handling.
121580 Hard The UPS Returns Flexible Access option is unavailable with Large Package.
121585 Hard The UPS Returns Flexible Access option is available for US and Puerto Rico shippers
only.
121590 Hard The maximum per package weight for the UPS Returns Flexible Access option is ...
121595 Hard The maximum length (the longest side) of a UPS Returns Flexible Access package is
...
121600 Hard The maximum length of the second-longest side of a UPS Returns Flexible Access
package is ...
121605 Hard The maximum total size constraint (length + girth, where girth is 2 x width plus 2 x
height) of a UPS Returns Flexible Access package is …
121610 Hard The maximum declared value amount for the UPS Returns Flexible Access option is ...
121615 Hard All packages in the shipment must have the UPS Returns Flexible Access option if 1
package has it.
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 {0}

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 410
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

121802 Hard {0}
123005 Warning (Description)
123010 Warning Package(s) in this shipment contains a warning: (Description)
123020 Warning Invalid Ship From postal code
123021 Warning Invalid Ship To postal code
123060 Warning {Rating Error Description} 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.

Error Codes 126000 - 126099

Error Code Severity Description

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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 411
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 412
Shipping Package Web Service Developer Guide November 1, 2016

Error Codes 128001 - 150000

Error Code Severity Description

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
128030 Hard Invalid producer email address. Valid length is 0 to 50 alphanumeric
128030 Hard Invalid producer tax id. Valid length is 0 to 15 alphanumeric
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 413
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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.
128039 Hard Invalid number of products.
128041 Hard The form specified for the product must be one of the requested forms.
128042 Hard If invoice is a requested international form, all specified products must belong to
invoice
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 414
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 415
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 416
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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.
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 a request.
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 a 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 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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 417
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 418
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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.
129203 Hard Account is not authorized for UPS Exchange service
129204 Hard Account is not authorized for UPS Pack and Collect service

Error Code Severity Description

150000 Hard Tracking service unavailable

Error Codes 250010 - 250064

Error Code Severity Description

250010 Hard Illegal Request Action
250011 Hard Illegal Request Option
250012 Hard No tool is requested
250019 Hard Invalid field value
250020 Hard Invalid developer license number
250021 Hard The data length is in error for CompanyName
250022 Hard The data length is in error for AddressLine1
250023 Hard The data length is in error for AddressLine2
250024 Hard The data length is in error for AddressLine3
250025 Hard The data length is in error for City
250026 Hard Invalid country code

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 419
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

250027 Hard The data is in error for StateProvinceCode
250028 Hard The data length is in error for PostalCode
250029 Hard The data is in error for phone number
250030 Hard Invalid e-mail address
250031 Hard Invalid URL
250032 Hard Invalid Country Code in AccessLicenseProfile
250033 Hard Invalid Language Code in AccessLicenseProfile
250034 Hard Invalid ToolVersion
250035 Hard The data length is in error for the name of contact person
250036 Hard The data length is in error for the title of contact person
250037 Hard The data is in error for fax number
250038 Hard Error in Shipper Number
250040 Hard Client software profile is missed for the 3rd party developer license
250041 Hard Invalid ToolID
250042 Hard Tool Version not available for the Access License
250043 Hard Tool ID not available for the Access License
250044 Hard Tool Version not licensed for developer
250045 Hard Tool already licensed
250046 Hard User already has a license
250047 Hard License number revoked
250048 Hard Missing License Agreement Text
250049 Hard Invalid License Agreement Text
250051 Hard Not allowed to create new license
250052 Hard Authorization system is currently unavailable
250060 Hard The data length is in error for the Software Installer
250061 Hard The data length is in error for the Software Product Name
250062 Hard The data length is in error for the Software Provider
250063 Hard The data length is in error for the Software Version Number
250064 Hard Invalid ToolID/ToolVersion

Error Codes 1270092 – 1270125

Error Code Severity Description

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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 420
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

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).

Error Codes 9120000 +

Error Code Severity Description

9120068 Hard Either credit card or account number information is needed but not both.
9120201 Hard Missing package description.
9120203 Hard Missing or invalid Combination of package length, width, and height values for
package {0}.
9120211 Hard Missing or invalid declared value currency code for package {0}.
9120212 Hard Missing or invalid declared value monetary value for package {0}.
9120213 Hard Shipper release is not allowed with return service.
9120214 Hard The verbal confirmation of delivery option cannot be combined with the Return
Services option.
9120215 Hard Missing verbal confirmation phone number for package {0}.
9120216 Hard Missing or invalid package notification code for package {0}.
9120217 Hard Missing package notification email information for package {0}.
9120218 Hard Missing or invalid notification email address for package {0}.
9120219 Hard Receiver Return Notification is not allowed for the shipment without return service.
9120225 Hard Missing commodity information for package{0}
9120226 Hard Missing package NMFC prime code of commodity for package{0}
9120227 Hard Missing package weight container information for package{0}
9120228 Hard Missing packaging type for Package {0}.
9120241 Hard Missing label specification information.
9120242 Hard Missing label specification label image format.
9120243 Hard Missing label specification label image format Code.
9120244 Hard Missing label specification label stock size.
9120245 Hard Invalid label specification label stock dimensions.
9120246 Hard Missing/Invalid Label Instruction Code
9120247 Hard Invalid set of Label Instruction Codes
9120248 Hard LabelSpecification/Instruction is not allowed with the shipment

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 421
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

9120300 Hard Cannot use multiple types of currency in a shipment.
9120301 Hard A shipment can have only one type of unit of measurement for dimensions.
9120302 Hard A shipment can have only one type of unit of measurement for a weight.
9120400 Hard Missing or invalid shipment digest.
9120401 Hard Invalid shipment object.
9120800 Hard Missing contact information.
9120801 Hard Missing sold to address information.
9120802 Hard No more than 3 address line information can be given for sold to address.
9120803 Hard Missing forward agent address information.
9120804 Hard No more than 3 address line information can be given for forward agent address.
9120805 Hard Missing intermediate consignee address information.
9120806 Hard No more than 3 address line information can be given for intermediate consignee
address.
9120807 Hard Missing ultimate consignee address information.
9120808 Hard No more than 3 address line information can be given for ultimate consignee address.
9120809 Hard Missing producer information.
9120810 Hard Missing producer address information.
9120811 Hard No more than 3 address line information can be given for producer address.
9120812 Hard Missing product weight information for product number {0}.
9120813 Hard Missing product weight unit of measurement information for product number {0}.
9120814 Hard Missing product unit information for product number {0}.
9120815 Hard Missing product unit of measurement information for product number {0}.
9120816 Hard Missing schedule B information for product number {0}.
9120817 Hard Missing schedule B unit of measurement information for product number {0}.
9120818 Hard Missing blanket period information.
9120819 Hard Missing license information.
9121000 Hard Invalid Ship Request Document
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.
9129087 Hard Invalid Shipment Delivery Confirmation Type

9120500 Hard FreightDensityInfo container is required for Density Based Rating request.
9120501 Hard AdjustedHeight container is required if AdjustedHeightIndicator is requested.
9120502 Hard Missing or Invalid Value for AdjustedHeight
9120503 Hard Missing or Invalid UnitOfMeasurement for AdjustedHeight.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 422
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Severity Description

9120504 Hard Missing HandlingUnits container for Density Based Rating request.
9120505 Hard Missing or Invalid Quantity for HandlingUnits {0}.
9120506 Hard Missing or Invalid Type for HandlingUnits {0}.
9120507 Hard Missing Dimensions container for HandlingUnits {0}.
9120508 Hard Missing or Invalid Height for HandlingUnits {0}.
9120509 Hard Missing or Invalid Length for HandlingUnits {0}.
9120510 Hard Missing or Invalid Width for HandlingUnits {0}.
9120511 Hard Missing or Invalid UnitOfMeasurement for HandlingUnits {0}.
9120512 Hard Invalid Unit Of Measurement.
9120513 Hard Invalid number of handling units.

9370906+

9370906 Hard EEI forms cannot be used together

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 423
Shipping Package Web Service Developer Guide November 1, 2016

Label Recovery Error Codes

Error Code Type Description
9800000 Transient Label Recovery System Error
9800001 Transient Label Recovery Service is Temporarily Unavailable
9800002 Hard Invalid Label Recovery Transient Request
9800004 Hard Not present Label Specification
9800005 Hard Not present Tracking Number
9800007 Hard Too short Tracking Number
9800008 Hard Too long Tracking Number
9800009 Hard Not present Label Image Format Code
9800010 Hard Too short Label Image Format Code
9800011 Hard Too long Label Image Format Code
9800012 Hard Not allowed Label Image Format Code
9800013 Hard Too long HTTP User Agent
9800014 Hard Not present Width in Label Stock Size
9800015 Hard Too short Width in Label Stock Size
9800016 Hard Too long Width in Label Stock Size
9800017 Hard Not present Height in Label Stock Size
9800018 Hard Too short Height in Label Stock Size
9800019 Hard Too long Height in Label Stock Size
9800020 Hard Label is unavailable -- the label is expired.
9800500 Hard Invalid Tracking Number
9800501 Hard Invalid Label Specification
9800502 Hard Invalid Translate
9801000 Hard Missing or Invalid shipper number
9801001 Hard Shipper number must contain alphanumeric characters only
9801002 Hard Invalid Shipment/ReferenceNumber/Value
9801003 Hard Invalid/Missing the earliest shipment pickup time
9801004 Hard Invalid ShipmentServiceOptionsNotification/EMailMessage /SubjectCode
9801005 Hard Invalid PackageServiceOptionsNotification/ EMailMessage /SubjectCode
9801006 Hard No more than two email addresses for Receiver.Return Notification are allowed in a
shipment
9801007 Hard {0}
9801008 Hard Missing/Invalid LabelSpecification/ LabelPrintMethod/Code
9801009 Hard Missing/Invalid LabelSpecification/ HTTPUserAgent
9801010 Hard Missing/Invalid LabelSpecification/ LabelImageFormat/Code
9801011 Hard Missing/Invalid Combination of LabelSpecification/ LabelStockSize
9801012 Hard Invalid LabelSpecification/ LabelStockSize/Height
9801013 Hard Invalid LabelSpecification/LabelStockSize/Width

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 424
Shipping Package Web Service Developer Guide November 1, 2016

Error Code Type Description

9801014 Hard Invalid MovementReferenceNumber
9801015 Hard Invalid MovementReferenceNumber
9801016 Hard Invalid MovementReferenceNumber
9801017 Hard PreAlertNotification Dialect length must be less than or equal to 2
9801018 Hard PreAlertNotification Language-Dialect Pair not valid
9801019 Hard Notification Language is missing
9801020 Hard Notification Dialect is missing
9801021 Hard Notification Language must be less than or equal to 3
9801022 Hard Missing/Invalid Label Instruction Code
9801023 Hard Invalid set of Label Instruction Codes
9801024 Hard Invalid or missing export date. Valid format is yyyyMMdd
9801025 Hard Invalid Return Service Void Date
9801026 Hard A Label cannot be generated for a voided Return Service Shipment
9801027 Hard Label Recovery system is currently unavailable
9801028 Hard Label is unavailable -- the package has been sent to the destination address
9801029 Hard Invalid shipments return service for label recovery
9801030 Hard Either tracking number or combination of reference plus shipper number required
9801031 Hard The shipment for the requested tracking number or the combination of reference
number plus shipper. 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
9801032 Hard Invalid Translate/code
9801033 Hard Invalid Tracking Number
9801034 Hard Email subsystem is currently unavailable
9801035 Hard Invalid LabelSpecification/HTTPUserAgent
9801036 Hard 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
9801037 Hard Invalid Reference Number
9801038 Hard Invalid Shipper Number
9801039 Hard Label is unavailable -- the shipment has no {0}
9801040 Hard The shipment for which you are trying to recover a label or Receipt has been voided.
Please contact the vendor for further information
9801041 Hard Label is unavailable -- the shipment has not been processed
9801042 Hard Label is unavailable -- the shipment has not been processed

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 425
Shipping Package Web Service Developer Guide November 1, 2016

Void Error Codes

Code Severity Description
190001 Transient Void not available at this time
190002 Transient Invalid/Missing registration ID
190100 Hard Invalid ShipmentIdentificationNumber.
190101 Hard Time for voiding has expired.
190102 Hard No shipment found within the allowed void period
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 426
Shipping Package Web Service Developer Guide November 1, 2016

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 427
Shipping Package Web Service Developer Guide November 1, 2016

Code Accessorial / Surcharge

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 428
Shipping Package Web Service Developer Guide November 1, 2016

Code Accessorial / Surcharge

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 429
Shipping Package Web Service Developer Guide November 1, 2016

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 430
Shipping Package Web Service Developer Guide November 1, 2016

COD Supported Countries

Rating and Shipping Package COD supported countries

Shipment Level
1 9
Cash Check
Country Cashier's Check
Money Order

All European Union (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 EU coutries currently support Package level COD.

9
0 8
Personal Check
Check, Cash Cashier’s Check
Country 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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 431
Shipping Package Web Service Developer Guide November 1, 2016

Country Codes
Rating and Shipping Package API Supported 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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 432
Shipping Package Web Service Developer Guide November 1, 2016

Supported Supported
Destination Country Name Country Code
Forward Origin Return Origin
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 433
Shipping Package Web Service Developer Guide November 1, 2016

Supported Supported
Destination Country Name Country Code
Forward Origin Return Origin
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 434
Shipping Package Web Service Developer Guide November 1, 2016

Supported Supported
Destination Country Name Country Code
Forward Origin Return Origin
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 435
Shipping Package Web Service Developer Guide November 1, 2016

Supported Supported
Destination Country Name Country Code
Forward Origin Return Origin
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 436
Shipping Package Web Service Developer Guide November 1, 2016

Supported Supported
Destination Country Name Country Code
Forward Origin Return Origin
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 437
Shipping Package Web Service Developer Guide November 1, 2016

Supported Supported
Destination Country Name Country Code
Forward Origin Return Origin
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 438
Shipping Package Web Service Developer Guide November 1, 2016

Supported Supported
Destination Country Name Country Code
Forward Origin Return Origin
Zimbabwe ZW X

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 439
Shipping Package Web Service Developer Guide November 1, 2016

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 440
Shipping Package Web Service Developer Guide November 1, 2016

Country/Region Currency Name Currency Code

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 441
Shipping Package Web Service Developer Guide November 1, 2016

Country/Region Currency Name Currency Code

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 442
Shipping Package Web Service Developer Guide November 1, 2016

Country/Region Currency Name Currency Code

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 443
Shipping Package Web Service Developer Guide November 1, 2016

Country/Region Currency Name Currency Code

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 444
Shipping Package Web Service Developer Guide November 1, 2016

Country/Region Currency Name Currency Code

Portugal Euro EUR
Puerto Rico US Dollar USD
Qatar Qatari Rial QAR
Réunion Euro EUR
Romania New Leu RON
Russian Federation Russian Ruble RUB
Rwanda Rwanda Franc RWF
Saint Helena Saint Helena Pound SHP
Saint Kitts and Nevis East Caribbean Dollar XCD
Saint Lucia East Caribbean Dollar XCD
Saint Pierre and Miquelon Euro EUR
Saint Vincent and The Grenadines East Caribbean Dollar XCD
Samoa Tala WST
San Marino Euro EUR
São Tome and Principe Dobra STD
Saudi Arabia Saudi Riyal SAR
Senegal CFA Franc BCEAO XOF
Serbia Serbian Dinar RSD
Seychelles Seychelles Rupee SCR
Sierra Leone Leone SLL
Singapore Singapore Dollar SGD
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 445
Shipping Package Web Service Developer Guide November 1, 2016

Country/Region Currency Name Currency Code

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 446
Shipping Package Web Service Developer Guide November 1, 2016

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
US 50 US50, PR P P P
CA, VI S S
Intl other than CA, PR, VI S S
Canada (CA) US50, PR, VI S S
CA P P P
Intl other than US50, PR, VI S S
Puerto Rico (PR) US50, PR P P P
CA, VI S S
Intl other than US50, CA, 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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 447
Shipping Package Web Service Developer Guide November 1, 2016

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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 448
Shipping Package Web Service Developer Guide November 1, 2016

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).
EAR99 may be reported as an ECCN.
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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 449
Shipping Package Web Service Developer Guide November 1, 2016

Code Description Report ECCN Export MOT

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 450
Shipping Package Web Service Developer Guide November 1, 2016

Code Description Report ECCN Export MOT

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 451
Shipping Package Web Service Developer Guide November 1, 2016

Code Description Report ECCN Export MOT

C36 Shipments to B Countries (GBS) Part 740.4 Report Mandatory CR, GP, All except
‘GBS’. IS, TE, ‘70’ (Fixed
EAR99 may NOT be reported as an ECCN. Must be one of
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 452
Shipping Package Web Service Developer Guide November 1, 2016

Code Description Report ECCN Export MOT

C37 Civil End Users (CIV) Part 740.5 Report Mandatory CR, IS, All except
‘CIV’. TE, TL, ‘70’ (Fixed
EAR99 may NOT be reported as an ECCN. Must be one of
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 453
Shipping Package Web Service Developer Guide November 1, 2016

Code Description Report ECCN Export MOT

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 454
Shipping Package Web Service Developer Guide November 1, 2016

Code Description Report ECCN Export MOT

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.
EAR99 may be reported as an ECCN.
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
EAR99 may be reported as an ECCN.
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)
Items under 600 series ECCNs are not eligible
under this license type.
Consolidates the following categories: Gift parcels;
Humanitarian donations.
EAR99 may be reported as an ECCN.
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 455
Shipping Package Web Service Developer Guide November 1, 2016

Code Description Report ECCN Export MOT

C45 Baggage (BAG) Part 740.14 Report Mandatory OI, OS, All except
‘BAG’. IW ‘70’ (Fixed
Items under 600 series ECCNs are not eligible
Transport)
under this license type.
EAR99 may be reported as an ECCN.
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.
Items under 600 series ECCNs are not eligible
under this license type.
EAR99 may be reported as an ECCN.
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)
EAR99 may be reported as an ECCN.
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 456
Shipping Package Web Service Developer Guide November 1, 2016

Code Description Report ECCN Export MOT

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 People’s Republic of Transport)
China and India.
Items under 600 series ECCNs are not eligible
under this license type.
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 457
Shipping Package Web Service Developer Guide November 1, 2016

Department of Energy/National Nuclear Security Administration (DOE/NNSA)

Code Description Report ECCN Export MOT
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)

Code Description Report ECCN Export MOT
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)

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 458
Shipping Package Web Service Developer Guide November 1, 2016

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.
S61 DSP-61 Report spaces. Report the Allowed MS, All except ‘70’ (Fixed
License Number. GS, OI, Transport)
Temporary import of
OS
unclassified articles.
S73 DSP-73 Report spaces. Report the Allowed MS, All except ‘70’ (Fixed
License Number. GS, Transport)
Temporary export of
TP, OI,
unclassified articles.
OS
S85 DSP-85 Report spaces. Report the Allowed MS, All except ‘70’ (Fixed
License Number. GS, OI, Transport)
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)

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 459
Shipping Package Web Service Developer Guide November 1, 2016

Department of Treasury/Office of Foreign Assets Control (OFAC)

Code Description Report ECCN Export MOT
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

Code Description Report ECCN Export MOT
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).

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 460
Shipping Package Web Service Developer Guide November 1, 2016

EEI License Types and Exemptions

Note: * AES Filing Required Regardless of Value

License Types

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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 461
Shipping Package Web Service Developer Guide November 1, 2016

EEI Unit of Measure Codes

• BBL: Barrels
• CAR: Carat
• CKG: Content Kilogram
• CM2: Square Centimeters
• CTN: Content Ton
• CUR: Curie
• CYK: Clean Yield Kilogram
• DOZ: Dozen
• DPC: Dozen Pieces
• DPR: Dozen Pairs
• FBM: Fiber Meter
• GCN: Gross Containers
• GM: Gram
• GRS: Gross
• HUN: Hundred
• KG: Kilogram
• KM3: 1,000 Cubic Meters
• KTS: Kilogram Total Sugars
• L: Liter
• M: Meter
• M2: Square Meters
• M3: Cubic Meters
• MC: Millicurie
• NO: Number
• PCS: Pieces
• PFL: Proof Liter
• PK: Pack
• PRS: Pairs
• RBA: Running Bales
• SQ: Square
• T: Ton
• THS: 1,000
• X: No Quantity required

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 462
Shipping Package Web Service Developer Guide November 1, 2016

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.

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 463
Shipping Package Web Service Developer Guide November 1, 2016

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
LOK FU LF1

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 464
Shipping Package Web Service Developer Guide November 1, 2016

District Code
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
TAI LAM CHUNG NT5

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 465
Shipping Package Web Service Developer Guide November 1, 2016

District Code
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 466
Shipping Package Web Service Developer Guide November 1, 2016

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 467
Shipping Package Web Service Developer Guide November 1, 2016

Label Examples
The following figures are examples of UPS shipping and return labels.

Shipping Label Sample

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 468
Shipping Package Web Service Developer Guide November 1, 2016

Return Label Sample

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 469
Shipping Package Web Service Developer Guide November 1, 2016

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 470
Shipping Package Web Service Developer Guide November 1, 2016

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 471
Shipping Package Web Service Developer Guide November 1, 2016

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
UOM Weight Type of Endorsement Confirmation Notification
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
UOM Weight Type of Endorsement Confirmation Notification
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 472
Shipping Package Web Service Developer Guide November 1, 2016

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 473
Shipping Package Web Service Developer Guide November 1, 2016

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 Employer’s 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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 474
Shipping Package Web Service Developer Guide November 1, 2016

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

Description Shipping Rating

UPS 2nd Day Air 02 02
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 01 01
UPS Next Day Air Early 14 14
UPS Next Day Air Saver 13 13
UPS Priority Mail M3 M3

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 475
Shipping Package Web Service Developer Guide November 1, 2016

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
UPS Express 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
Description Category Shipping Rating
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
Description Category Shipping Rating
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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 476
Shipping Package Web Service Developer Guide November 1, 2016

Poland
Description Category Shipping Rating
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

Description Shipping Rating

UPS 2nd Day Air 02 02
UPS Ground 03 03
UPS Next Day Air 01 01
UPS Next Day Air Early 14 14
UPS Worldwide Expedited 08 08
UPS Worldwide Express 07 07
UPS Worldwide Express Plus 54 54
UPS Worldwide Saver 65 65

Undefined countries
Use for all countries other than United States, Canada, European Union, Mexico, Poland, and Puerto Rico

Description Shipping Rating

UPS Express 07 07
UPS Standard 11 11
UPS Worldwide Expedited 08 08
UPS Worldwide Express Plus 54 54
UPS Worldwide Saver 65 65

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 477
Shipping Package Web Service Developer Guide November 1, 2016

All Countries
Shipments originating in any country

Description Shipping Rating

UPS Worldwide Express Freight 96 96
UPS Priority Mail Innovations M5 M5
UPS Economy Mail Innovations M6 M6

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 478
Shipping Package Web Service Developer Guide November 1, 2016

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

© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 479
 Shipping Package Web Service Developer Guide
© 2016 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary