Rating - Package

XML Developer Guide

January 8, 2018
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.

© 2018 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
© 2018 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.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary iii
 Table of Contents
Chapter 1: Introduction ......................................................................................................... 7
Release Features ..................................................................................................................................... 8

Chapter 2: Understanding the Rating API ............................................................................. 13

Business Process and Rules ............................................................................................................... 13
Negotiated Rates ................................................................................................................................... 13
Rate Types Table ................................................................................................................................... 14
User Level Promotion Business Processes and rules ...................................................................... 14
Saturday Delivery .................................................................................................................................. 14

Chapter 3: Customer Integration Environment (CIE) ............................................................. 15

System Availability ................................................................................................................................ 15
Using Negotiated Rates in CIE ............................................................................................................. 15
User Level and Transactional Promotions in CIE .............................................................................. 15
Integration Testing ................................................................................................................................ 16
Production .............................................................................................................................................. 16
Server Availability Check...................................................................................................................... 16

Chapter 4: Rating API Elements and Details ......................................................................... 17

Element Constraints .............................................................................................................................. 17
RatingServiceSelectionRequest Top Level Containers .................................................................... 18
RatingServiceSelectionRequest .......................................................................................................... 19
Request .............................................................................................................................................. 19
RequestAction .................................................................................................................................... 19
RequestOption ................................................................................................................................... 19
TransactionReference ........................................................................................................................ 20
PickupType ........................................................................................................................................ 21
CustomerClassification ...................................................................................................................... 21
Shipment ............................................................................................................................................ 22
OriginRecordTransactionTimestamp ................................................................................................. 22
Shipper ............................................................................................................................................... 22
ShipTo ................................................................................................................................................ 24
ShipmentServiceOptions ................................................................................................................... 49
RatingServiceSelectionResponse Top Level Containers ................................................................. 59
RatingServiceSelectionResponse XPath Tables ............................................................................... 60
RatingServiceSelectionResponse...................................................................................................... 60
Response ........................................................................................................................................... 60
TransactionReference ........................................................................................................................ 60
ResponseStatusCode ........................................................................................................................ 60
ResponseStatusDescription ............................................................................................................... 60
Error ................................................................................................................................................... 61

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary iv
 RatedShipment .................................................................................................................................. 62
Disclaimer .......................................................................................................................................... 62
Service ............................................................................................................................................... 63
RateChart ........................................................................................................................................... 63
RatedShipmentWarning ..................................................................................................................... 64
BillableWeightCalculationMethod ...................................................................................................... 64
RatingMethod ..................................................................................................................................... 64
BillingWeight ...................................................................................................................................... 65
TransportationCharges ...................................................................................................................... 65
BaseServiceCharge ........................................................................................................................... 66
ItemizedCharges ................................................................................................................................ 66
ServiceOptionsCharges ..................................................................................................................... 67
TaxCharges........................................................................................................................................ 67
TotalCharges...................................................................................................................................... 68
TotalChargesWithTaxes .................................................................................................................... 68
RatedPackage.................................................................................................................................... 68

Chapter 5: Rating XML API Examples.................................................................................... 79

Published Rates XML Request Example ............................................................................................. 79
Published Rates XML Response Example .......................................................................................... 80
Negotiated Rates XML Request Example ........................................................................................... 82
Negotiated Rates XML Response Example ........................................................................................ 83

Chapter 6: Rating Package API FAQs .................................................................................... 85

Appendices ......................................................................................................................... 89
Common Error Codes ........................................................................................................................ 89
Rating Package XML Error Codes ..................................................................................................... 91
Accessorial / Surcharge Codes ......................................................................................................... 116
Accessorial & Surcharge Subtypes.................................................................................................. 119
COD Supported Countries .................................................................................................................. 121
Country Codes ..................................................................................................................................... 122
Currency Codes ................................................................................................................................... 131
Delivery Confirmation Origin-Destination Pairs ............................................................................... 139
Disclaimer Codes and Messages ....................................................................................................... 140
HazMat Accessorial Code and SubType ........................................................................................... 141
Service Codes ...................................................................................................................................... 142
United States.................................................................................................................................... 142
Canada ............................................................................................................................................. 143
European Union ............................................................................................................................... 143
Mexico .............................................................................................................................................. 143
Poland .............................................................................................................................................. 144
Puerto Rico ...................................................................................................................................... 144

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary v
 Germany .......................................................................................................................................... 144
Undefined Countries ........................................................................................................................ 144
All Countries ..................................................................................................................................... 145
Tax Type Values / Abbreviations ....................................................................................................... 146
SubVersion Details .............................................................................................................................. 147
Rate Request Elements ................................................................................................................... 147
Rate Response Elements ................................................................................................................ 148

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary vi
Rating Package XML Developer Guide January 8, 2018

Chapter 1: Introduction
In this document, you will find guidance and instructions for integrating the Rating Package XML API into your
application, service, or system.

In this guide, you will find:

 New release features
 Rating Package XML API functionality and business rules
 XML API request and response schema
 FAQs for the Rating API
 Rating error response code descriptions
 Service code references

This guide applies to the following API:

 Rating Package XML API

This guide does not apply to the following APIs:

 Rating Package Web Service API
 Rating Ground Freight or Air Freight API

Intended Audience
This guide is intended for developers who will be integrating the Rating Package XML API into their application,
service, or system.

Required Knowledge & Skills

This guide assumes you have a basic understanding of the following:
 Concepts and instructions in the Introduction to the UPS Developer Kit guide.
 XML syntax and structure
 Software development

How to Use this Guide

 If this is your first time working with the UPS Developer Kit, begin with the Introduction to the 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 Rating API, continue with
Chapter 2: Understanding the Rating API. There you will find an overview of the Rating functionality and business
rules.
 Chapter 3: Customer Integration Environment (CIE) contains information on UPS integration environments.
 Chapter 4: Rating API Elements and Details contains an overview of the top-level containers and elements that
comprise the Rating request and response.
 Request and response examples are located in Chapter 5: Rating XML API Examples.
 Reference tables, services codes, and error codes are located in the Appendices.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 7
Rating Package XML Developer Guide January 8, 2018

Release Features
January 2018

Description
Seasonal Surcharge enhancements
 Rate API will support three new general service offering (GSO) surcharges
o Transportation –based peak surcharge for US/PR and International shipments
o Additional handling
o Large Package for US Domestic and PR packages

Extended Area Surcharge

 Rate API will support Domestic Canada extended area surcharge for the following subtypes:
o Delivery area surcharge
o Delivery area surcharge – extended
o Delivery area surcharge - remote

Domestic Saver End of Day (EOD)

 Rate API to support new UPS Express 12:00 service for German domestic service
 The existing UPS Express Saver will now have an end of day commit time
 Rate API will support “Rate Shop” functionality for this service

Hazmat Emergency Phone number update

 Rate API will restrict certain special characters in the phone number field
o (each shown within quotation marks here for clarity):
o “period “.”, dash “-“, plus sign “+” and conventional parentheses “(“ and “)”
o “EXT or OPT”

New Error Codes – Please see appendix for new codes.

Added Support for Refrigeration at package level

 New request Containers/Elements
/RateRequest/Shipment/Package/PackageServiceOptions/RefrigerationIndicator

Proactive Monitoring will now require a contract check

New Error Codes – Please see appendix for new codes.

Length Validation Update

Maximum allowed metric package length has been updated to 274 cm from 270 cm

Large Package Surcharge enhancement

 New maximum length of 96"

New Subversion – 1801

Including this SubVersion in a request made with the UPSSecurity schema will return additional error information pertaining
to package validation errors if applicable. Please refer to the appendix for a list of containers that will be returned.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 8
Rating Package XML Developer Guide January 8, 2018

July 2017

Description
Worldwide Express Freight (WWEF) NA 1 & Time of Day
 Rate API to support the new Worldwide Freight Midday service
 Enhancements to Rate API to include Rate Shop for WWEF and WWEF-Midday service
 New SubVersion value to support indicator at Package Level in response if the package has a Dry Ice accessory or is
over-sized for UPS Worldwide Express Freight service and UPS Worldwide Express Freight Mid-day service – 1707.
New Response Containers/Elements
 /RatedShipment/RatedPackage/Accessorial
 Code
Commercial Inside Release Enhancements
 Rating API to support new account level indication - Commercial US Domestic Signature Required.

New Business Rules regarding Saturday Delivery.

Peak Delivery Times

 UPS alters delivery time tables during seasons of peak business as well as some holidays. To see the most up-to-date
information regarding delivery times, please use the new RateTimeInTransit or ShopTimeInTransit request options.
Information returned in the /RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival container will have the most
accurate delivery data.

March 2017

Description
 New Error Codes
 New Service names in Service Codes Appendix
 New /Shipment/DeliveryTimeInformation/PackageBillType value
o 07 = Domestic Pallet

January 2017

Description
User Level Promotions
Rate API will support UserId level promotion/discount. If new indicator is requested, no shipper number is passed in the
shipper container, and MY UPS ID is eligible for promotional discount, discounted rates will be returned in response under
NegotiatedRates container.
New Request Containers/Elements
 /ShipmentRatingOptions/UserLevelDiscountIndicator

Time in Transit
Rate API will support the return of time in transit information when new RequestOptions “shoptimeintransit” and
“ratetimeintransit” are passed, along with the new DeliveryTimeInformation container.
New RatingOption value to support Time In Transit Feature: shoptimeintransit, ratetimeintransit
New Request Containers/Elements
 /Shipment/ShipmentTotalWeight
 UnitOfMeasurement

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 9
Rating Package XML Developer Guide January 8, 2018

Description
o Code
o Description
 Weight
 /Shipment/DeliveryTimeInformation
 PackageBillType
 Pickup
o Date
o Time
New Response Containers/Elements
 /RatedShipment/TimeInTransit
 PickupDate
 DocumentsOnlyIndicator
 PackageBillType
 ServiceSummary
 Service
o Description
 GuaranteedIndicator
 Disclaimer
 EstimatedArrival
o Arrival
 Date
 Time
o BusinessDaysInTransit
o Pickup
 Date
 Time
o DayOfWeek
o CustomerCenterCutoff
o DelayCount
o HolidayCount
o RestDays
o TotalTransitDays
o SaturdayDelivery
o SaturdayDeliveryDisclaimer
o AutoDutyCode
o Disclaimer

Base Service Charge

Rate API will support the return of base service charge for all services. This value is the transportation cost of the service
minus all fuel surcharges.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 10
Rating Package XML Developer Guide January 8, 2018

Description
New SubVersion value to support BaseServiceCharge feature: 1701
New Response Containers/Elements
 /RatedShipment/BaseServiceCharge
 CurrencyCode
 MonetaryValue
 /RatedShipment/RatedPackage/BaseServiceCharge
 CurrencyCode
 MonetaryValue

Transactional Promotions
Rate API will support Transactional promotion/discount. If a shipment is requested with a valid PromoCode and PromoAlias
Code and if the shipment is eligible for transactional promotional discount, discounted rates will be returned in the response
under the NegotiatedRates container.
New Request Containers/Elements
 /Shipment/PromotionalDiscountInformation
 PromoCode
 PromoAliasCode

Dimensional Weight
Rate API will support the passing of customer calculated dimensional weight. This value will apply to non US/CA/PR
shipments where dimensions are not provided.
New Request Containers/Elements
 /Shipment/DimWeight
 UnitOfMeasurement
o Code
o Description
 Weight

Global Dangerous Goods Expansion

Rate API enhanced will support shipping Dangerous/Hazardous material. Rate API is updated to support expansion and
improvement of Cargo Quantities for US and International air services and remove DG class restrictions for existing
International DG countries. Rate API will support current levels of service for critical shipments in the healthcare industry, as
well as to enhance customer experience and overall satisfaction.
New SubVersion value to support HazMat feature - 1701
New Request Containers/Elements
 /Shipment/OriginRecordTransactionTimestamp
 /Shipment/Package/PackageServiceOptions/HazMat
o /Shipment/Package/PackageServiceOptions/HazMat/PackageIdentifier
o /Shipment/Package/PackageServiceOptions/HazMat/QValue
o /Shipment/Package/PackageServiceOptions/HazMat/OverPackedIndicator
o /Shipment/Package/PackageServiceOptions/HazMat/AllPackedInOneIndicator
o /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/ChemicalRecordIdentifier

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 11
Rating Package XML Developer Guide January 8, 2018

Description
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/ClassDivisionNumber
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/IDNumber
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/TransportationMode
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/RegulationSet
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/EmergencyPhone
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/EmergencyContact
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/ReportableQuantity
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/SubRiskClass
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/PackagingGroupType
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/Quantity
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/UOM
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/PackagingInstructionCode
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/ProperShippingName
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/TechnicalName
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/AdditionalDescription
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/PackagingType
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/HazardLabelRequired
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/PackagingTypeQuantity
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/CommodityRegulatedLevelCode
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/TransportCategory
 /Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/TunnelRestrictionCode

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 12
Rating Package XML Developer Guide January 8, 2018

Chapter 2: Understanding the Rating API

The Rating API is used when rating or shopping a shipment. The Rating API for packages allows you to submit two
types of rate requests to UPS:
 A rate request to return the rate for a specific UPS service, for example, UPS Next Day Air
 A shop request to return all available services and their rates for a shipment
In this way, you and your customers are able to estimate their shipping costs prior to requesting a specific shipping
service or service option.

WARNING: UPS restricts the usage of the Rating API to users who plan to ship packages
manifested, tendered, and delivered by UPS. Any customers or developers abusing the API or
data mining the API will have their access revoked.

Business Process and Rules

General
 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.
 Only users that plan to ship packages manifested, tendered, and delivered by UPS can use the Rating API.
 Any customers/developers abusing or data mining the Rating API will have their access revoked.
 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.
 The Rating Package API provides published and negotiated rates.
 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 Rating API provides access to Published Rates as well as 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.

o 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.
o Since 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 Rating API.
 Make sure that all requests are identical when comparing shipping charges between applications and
APIs that provide UPS Negotiated Rates.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 13
Rating Package XML Developer Guide January 8, 2018

 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

Rate Types Table

The following table displays the Rate Chart that is returned by the Rating API based on the combination of
CustomerClassification code, Pickup Type code, and Account Number.

Customer Classification Pickup Type Account Number Rate Returned

00 Valid/Missing/Invalid Valid Rate associated with account number

00 Valid/Missing/Invalid Missing/Invalid Rate Type based on the shipper's

country

01 Valid/Missing/Invalid Valid/Missing/Invalid Daily Rates

04 Valid/Missing/Invalid Valid/Missing/Invalid Retail Rates

53 Valid/Missing/Invalid Valid/Missing/Invalid Standard List Rates

Missing/Invalid 01 Valid/Missing/Invalid Daily Rates

Missing/Invalid 03/06/07/19/20 Valid/Missing/Invalid Rate Type based on the shipper's

country

Missing/Invalid Missing/Invalid Valid Rate associated with account number

Missing/Invalid Missing/Invalid Container provided Rate Type based on the shipper's

but account number country
Invalid/Missing

Missing/Invalid Missing/Invalid Not Provided Rate Type based on the shipper's

country

User Level Promotion Business Processes and rules

User level promotion is for the customers who do not have a UPS shipper account. The following conditions need to
be met to use user level promotions: UserLevelDiscountIndicator in request, do not pass shipper number, Username
should be present and user should be eligible for a user level promotion.

 If User level promotion is requested with a UPS shipper account (Shipper/ShipperNumber), User level promotion
will not be requested for a given shipment.

Saturday Delivery
UPS offers Saturday Delivery options, for an additional charge, for many service levels. When requesting Time In
Transit information with the Rating API, services that are eligible for Saturday Delivery may be returned. Services that
are available for Saturday Delivery will have an Estimated Delivery day of week
(/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/DayOfWeek) of “SAT” (Saturday). In addition, if
there is a charge for the service, there will be a Saturday Delivery indicator with a value of “1”
(/RatedShipment/TimeInTransit/ServiceSummary/SaturdayDelivery) along with a disclaimer that the service is
available for an additional charge (/RatedShipment/TimeInTransit/ServiceSummary/SaturdayDeliveryDisclaimer).

 Three Day Select and Ground services are now available for Saturday Delivery in some cities at no additional
charge. To determine if either of these services are available for your transit lane you must include the
ResidentialAddressIndicator in your Request. In this case, the Saturday Delivery indicator will have a value of “0”
and no disclaimer will show. However, the Estimated Delivery day of week will still be “SAT”.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 14
Rating Package XML Developer Guide January 8, 2018

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 Service 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.

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.

 All URLs are case sensitive.

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 rate 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.

User Level and Transactional Promotions in CIE

Discounted rates are available in the UPS Customer Integration Environment (CIE) and are returned when either the
transactional promotion is valid or the User Level Discount Indicator is provided in the rate request.
 The negotiated rates returned do not reflect the contractual rate and may vary. Typically, they are 1% off the
published rate.
 For Transactional Promotions, the promotion code is not validated. There is also no check as to whether or not the
applied promotion is valid for the service or shipping lane in the request.
 For User Level Promotions, the UserID is still validated to see if a valid promotion is tied to it. However, there is no
check as to whether or not the applied promotion is valid for the service or shipping lane in the request.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 15
Rating Package XML Developer Guide January 8, 2018

Integration Testing
 All URLs are case sensitive.
For integration testing, direct your test Rating Package XML to:
https://wwwcie.ups.com/ups.app/xml/Rate

Production
 All URLs are case sensitive.
Once testing is complete, direct your Rating Package XML to the production URL:
https://onlinetools.ups.com/ups.app/xml/Rate

Server Availability Check

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

Service Name: Rate

Remote User: null

Server Port: 443

Server Name: wwwcie.ups.com

Servlet Path: /Rate

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 16
Rating Package XML Developer Guide January 8, 2018

Chapter 4: Rating API Elements and Details

Element Constraints
The Request and Response XPath tables contain the full hierarchy of the API elements.

UPS expects schema elements/tags as defined in the XPath and presented in the schema
structure i.e., no spelling or structural deviations. Elements/tags that are not defined in the schema
or do not conform to the schema structure will be ignored by UPS.

Element constraints are defined as follows:

Required
 Yes - indicates the element must be present in the request or response.
 Yes* - indicates the element must be present in the request if the parent container is present in the request.
 No - indicates the element is optional and may be used if it applies to the request.
 Cond – indicates the element is required under certain conditions.

Type
 Container - holds a group of related elements.
 String - consists of alphanumeric characters, spaces, and decimals.

Length
 The maximum number of characters that can be present in a String. Length is not applicable (N/A) to Containers.

Max Allowed
 The maximum number of elements or containers that can be present in the parent container.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 17
Rating Package XML Developer Guide January 8, 2018

RatingServiceSelectionRequest Top Level Containers

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 18
Rating Package XML Developer Guide January 8, 2018

RatingServiceSelectionRequest
Name Constraint Description Validation

/RatingServiceSelectionRequest
RatingServiceSelectionRequest Required: Yes Rating Service Selection Request N/A
Type: Container container.
Max Allowed: 1
Length: N/A

Request
Name Constraint Description Validation

/RatingServiceSelectionRequest/Request
Request Required: Yes Request Container N/A
Type: Container
Max Allowed: 1
Length: N/A

RequestAction
Name Constraint Description Validation

/RatingServiceSelectionRequest/Request/RequestAction
RequestAction Required: Yes The action to be taken by the Rating It must contain Rate to
Type: String and Service Selection tool. execute rating and service
Max Allowed: 1 selection.
Length: 15

RequestOption
Name Constraint Description Validation

/RatingServiceSelectionRequest/Request/RequestOption

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 19
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

RequestOption Required: No Used to define the request type. Valid Values:

Type: String Rate = The server rates
Max Allowed: 1 (The default Request option
Length: 15 is Rate if a Request Option
is not provided).

Shop = The server

validates the shipment, and
returns rates for all UPS
products from the
ShipFrom to the ShipTo
addresses.

Ratetimeintransit = The
server rates with transit
time information

Shoptimeintransit = The
server validates the
shipment, and returns rates
and transit times for all
UPS products from the
ShipFrom to the ShipTo
addresses.

Rate is the only valid

request option for UPS
Ground Freight Pricing
requests.

SubVersion
Name Constraint Description Validation

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

TransactionReference
Name Constraint Description Validation

/RatingServiceSelectionRequest/Request/TransactionReference
TransactionReference Required: No TransactionReference identifies
Type: Container transactions between client and
Max Allowed: 1 server.
Length: N/A

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 20
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionRequest/Request/TransactionReference/CustomerContext
CustomerContext Required: No The client uses CustomerContext to
Type: String synchronize request/response pairs.
Max Allowed: 1
Length: 1..512 CustomerContext can contain any
information the client requires. As
long as it is valid XML it is echoed
back by the server.

PickupType
Name Constraint Description Validation

/RatingServiceSelectionRequest/PickupType
PickupType Required: No Pickup Type container tag
Type: Container
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/PickupType/Code
Code Required: Yes* Pickup Type Code. Valid values:
Type: String 01 - Daily Pickup (Default)
Max Allowed: 1 03 - Customer Counter
Length: 2 06 - One Time Pickup
19 - Letter Center
20 - Air Service Center

Refer to the Rate Types

Table in the Appendix for
rate type based on Pickup
Type and Customer
Classification Code.

If invalid value is provided,

default will be used.

Length is not validated.

CustomerClassification

Name Constraint Description Validation

/RatingServiceSelectionRequest/CustomerClassification
CustomerClassification Required: No Customer classification container.
Type: Container Valid if ShipFrom country is US.
Max Allowed: 1
Length: N/A

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 21
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionRequest/CustomerClassification/Code
Code Required: Yes* Customer classification code. Valid values:
Type: String 00 - Rates Associated with
Max Allowed: 1 Shipper Number
Length: 2 01 - Daily Rates
04 - Retail Rates
05 - Regional Rates
06 - General List Rates
53 - Standard List Rates.
Length is not validated. If
customer classification
code is not provided or it is
provided with an invalid
value, UPS would use rate
chart (customer
classification code)
associated with a shipper
country to rate the
shipments.

Shipment
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment
Shipment Required: Yes Shipment container.
Type: Container
Max Allowed: 1
Length: N/A

OriginRecordTransactionTimestamp
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/OriginRecordTransactionTimestamp
OriginRecordTransactionTimesta Required: No The time that the request was made Applicable only for HazMat
mp Type: String from the originating system. UTC request and with
Max Allowed: 1 time down to milliseconds. Example subversion greater than or
Length: N/A - 2016-07-14T12:01:33.999 equal to 1701.

Shipper
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/Shipper
Shipper Required: Yes Shipper details are included in this N/A
Type: Container container.
Max Allowed: 1
Length: N/A

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 22
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/Shipper/Name
Name Required: No The shipper's name or shipper's Length is not validated.
Type: String company name.
Max Allowed: 1
Length: 35

/RatingServiceSelectionRequest/Shipment/Shipper/ShipperNumber
ShipperNumber Required: Cond The shipper's UPS account number. Value must match a
Type: String Note: A shipper number is required commissioned shipper
Max Allowed: 1 when requesting to receive the number. Cannot be present
Length: 6 negotiated rates. The shipper when requesting
number is optional when requesting UserLevelDiscount.
to receive the published rates.

/RatingServiceSelectionRequest/Shipment/Shipper/Address
Address Required: Yes Contains the address details of If the ShipFrom container is
Type: Container shipper not present then this
Max Allowed: 1 address will be used as the
Length: N/A ShipFrom. If this address
is used as the ShipFrom
the shipment will be rated
from this origin address.

/RatingServiceSelectionRequest/Shipment/Shipper/Address/AddressLine1
AddressLine1 Required: No The shipper's street address, Length is not validated.
Type: String including name and number (when
Max Allowed: 1 applicable).
Length: 35

/RatingServiceSelectionRequest/Shipment/Shipper/Address/AddressLine2
AddressLine2 Required: No Additional shipper address Length is not validated.
Type: String information, preferably room or floor.
Max Allowed: 1
Length: 35

/RatingServiceSelectionRequest/Shipment/Shipper/Address/AddressLine3
AddressLine3 Required: No Additional shipper address Length is not validated.
Type: String information, preferably department
Max Allowed: 1 name.
Length: 35

/RatingServiceSelectionRequest/Shipment/Shipper/Address/City
City Required: Cond Shipper's City Required if country does
Type: String not utilize postal codes.
Max Allowed: 1 Length is not validated.
Length: 30

/RatingServiceSelectionRequest/Shipment/Shipper/Address/StateProvinceCode
StateProvinceCode Required: No Shipper's state code. Length is not validated.
Type: String
Max Allowed: 1
Length: 2

/RatingServiceSelectionRequest/Shipment/Shipper/Address/PostalCode

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 23
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

PostalCode Required: Cond Shipper's postal code. Length is not validated.

Type: String
Max Allowed: 1
Length: 9

/RatingServiceSelectionRequest/Shipment/Shipper/Address/CountryCode
CountryCode Required: Yes Shipper CountryCode. Required, but default to US.
Type: String For additional information,
Max Allowed: 1 refer to Country Codes in
Length: 2 the Appendix.

/RatingServiceSelectionRequest/Shipment/Shipper/Address/ResidentialAddressIndicator
ResidentialAddressIndicator Required: No A flag indicating if the shipper's Empty Tag
Type: String address is a residential location.
Max Allowed: 1 True if tag exists; false otherwise.
Length: 0 Note: When requesting
TimeInTransit information, this
indicator must be passed to
determine if Three Day Select or
Ground shipment is eligible for
Saturday Delivery at no charge.

ShipTo
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/ShipTo
ShipTo Required: Yes Container stores the details of N/A
Type: Container ShipTo
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/ShipTo/CompanyName
CompanyName Required: No Receiver's name or Company Length is not validated.
Type: String Name. When using the Rating API in
Max Allowed: 1 conjunction with the Shipping API,
Length: 35 this field should be the same as the
Ship To name of the Shipping API
request.

/RatingServiceSelectionRequest/Shipment/ShipTo/Address
Address Required: Yes ShipTo Address container contains N/A
Type: Container the details of ShipTo address
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/ShipTo/Address/AddressLine1
AddressLine1 Required: No The receiver's street address Length is not validated.
Type: String including name and number (when
Max Allowed: 1 applicable).
Length: 35

/RatingServiceSelectionRequest/Shipment/ShipTo/Address/AddressLine2
AddressLine2 Required: No Additional receiver address Length is not validated.
Type: String information, preferably room or floor.
Max Allowed: 1
Length: 35

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 24
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/ShipTo/Address/AddressLine3
AddressLine3 Required: No Additional receiver address Length is not validated.
Type: String information, preferably department
Max Allowed: 1 name.
Length: 35

/RatingServiceSelectionRequest/Shipment/ShipTo/Address/City
City Required: Cond Receiver's city. Required if country does
Type: String not utilize postal codes.
Max Allowed: 1 Length is not validated.
Length: 30

/RatingServiceSelectionRequest/Shipment/ShipTo/Address/StateProvinceCode
StateProvinceCode Required: Cond Receiver's state code. Note: A
Type: String State/Province Code is required
Max Allowed: 1 when requesting to receive the
Length: 2 negotiated rates. The State/Province
code is optional when requesting to
receive the published rates.

/RatingServiceSelectionRequest/Shipment/ShipTo/Address/PostalCode
PostalCode Required: Cond Receiver's postal code. Required if country utilizes
Type: String postal codes (i.e. US and
Max Allowed: 1 PR).
Length: 9

/RatingServiceSelectionRequest/Shipment/ShipTo/Address/CountryCode

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 25
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

CountryCode Required: Yes The IATA OR UPS BILLING code For additional information,
Type: String representing the receiver's country. refer to the Country Codes
Max Allowed: 1 in the Appendix.
Length: 2

/RatingServiceSelectionRequest/Shipment/ShipTo/Address/ResidentialAddressIndicator
ResidentialAddressIndicator Required: No A flag indicating if the shipper's Empty Tag
Type: String address is a residential location.
Max Allowed: 1 True if tag exists; false otherwise.
Length: 0

ShipFrom
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/ShipFrom
ShipFrom Required: No ShipFrom Container. N/A
Type: Container
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/ShipFrom/CompanyName
CompanyName Required: No ShipFrom locations name or Length is not validated.
Type: String company name.
Max Allowed: 1
Length: 35

/RatingServiceSelectionRequest/Shipment/ShipFrom/Address
Address Required: Cond Contains ShipFrom address The shipment will be rated
Type: Container elements from this origin address to
Max Allowed: 1 the destination ShipTo
Length: N/A address.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 26
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/ShipFrom/Address/AddressLine1
AddressLine1 Required: No ShipFrom locations street address Length is not validated.
Type: String including name and number (when
Max Allowed: 1 applicable).
Length: 35

/RatingServiceSelectionRequest/Shipment/ShipFrom/Address/AddressLine2
AddressLine2 Required: No Additional ShipFrom location Length is not validated.
Type: String address information, preferably room
Max Allowed: 1 or floor.
Length: 35

/RatingServiceSelectionRequest/Shipment/ShipFrom/Address/AddressLine3
AddressLine3 Required: No Additional ShipFrom location Length is not validated.
Type: String address information, preferably
Max Allowed: 1 department name.
Length: 35

/RatingServiceSelectionRequest/Shipment/ShipFrom/Address/City
City Required: Yes ShipFrom locations city. Required if country does
Type: String not utilize postal codes.
Max Allowed: 1 Length is not validated.
Length: 30

/RatingServiceSelectionRequest/Shipment/ShipFrom/Address/StateProvinceCode
StateProvinceCode Required: Cond ShipFrom locations state code.
Type: String Note: A State/Province Code is
Max Allowed: 1 required when requesting to receive
Length: 2 the negotiated rates. The
State/Province code is optional
when requesting to receive the
published rates.

/RatingServiceSelectionRequest/Shipment/ShipFrom/Address/PostalCode
PostalCode Required: Yes* ShipFrom locations postal code. Required if country utilizes
Type: String postal codes (i.e. US and
Max Allowed: 1 PR)
Length: 9

/RatingServiceSelectionRequest/Shipment/ShipFrom/Address/CountryCode
CountryCode Required: No ShipFrom CountryCode. Required, but default to US.
Type: String For additional information,
Max Allowed: 1 refer to Country Codes in
Length: 2 the Appendix.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 27
Rating Package XML Developer Guide January 8, 2018

AlternateDeliveryAddress
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/AlternateDeliveryAddress
AlternateDeliveryAddress Required: Cond AlternateDeliveryAddress container AlternateDeliveryAddress is
Type: Container address information for UPS Access required if:
Max Allowed: 1 Point. 01 Hold for Pickup at UPS
Length: N/A Access Point
02 UPS Access Point™
Delivery

/RatingServiceSelectionRequest/Shipment/AlternateDeliveryAddress/Name
Name Required: No The name of UPS Access Point.
Type: String
Max Allowed: 1
Length: 1…35

/RatingServiceSelectionRequest/Shipment/AlternateDeliveryAddress/Address
Address Required: Yes* Address Container for Alternate
Type: Container Delivery Address.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/AlternateDeliveryAddress/Address/AddressLine1
AddressLine1 Required: No The UPS Access Point's street Length is not validated.
Type: String address, including name and
Max Allowed: 1 number (when applicable).
Length: 1…35

/RatingServiceSelectionRequest/Shipment/AlternateDeliveryAddress/Address/AddressLine2
AddressLine2 Required: No The UPS Access Point's street Length is not validated.
Type: String address, including name and
Max Allowed: 1 number (when applicable).
Length: 1…35

/RatingServiceSelectionRequest/Shipment/AlternateDeliveryAddress/Address/AddressLine3
AddressLine3 Required: No The UPS Access Point's street Length is not validated.
Type: String address, including name and
Max Allowed: 1 number (when applicable).
Length: 1…35

/RatingServiceSelectionRequest/Shipment/AlternateDeliveryAddress/Address/City
City Required: Cond UPS Access Point city.
Type: String
Max Allowed: 1
Length: 1…30

/RatingServiceSelectionRequest/Shipment/AlternateDeliveryAddress/Address/StateProvinceCode
StateProvinceCode Required: Cond UPS Access Point State or Province
Type: String code.
Max Allowed: 1
Length: 2

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 28
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/AlternateDeliveryAddress/Address/PostalCode
PostalCode Required: Cond UPS Access Point Postal code.
Type: String
Max Allowed: 1
Length: 1…9

/RatingServiceSelectionRequest/Shipment/AlternateDeliveryAddress/Address/CountryCode
CountryCode Required: Yes* UPS Access Point Country code.
Type: String
Max Allowed: 1
Length: 2

/RatingServiceSelectionRequest/Shipment/AlternateDeliveryAddress/Address/ResidentialAddressIndicator
ResidentialAddressIndicator Required: No Presence/Absence Indicator. Any Empty Tag
Type: String value inside is ignored. A flag
Max Allowed: 1 indicating if the shipper's address is
Length: 0 a residential location. True if tag
exists; false otherwise

/RatingServiceSelectionRequest/Shipment/AlternateDeliveryAddress/Address/POBoxIndicator
POBoxIndicator Required: No Presence/Absence Indicator. Any Not valid with Shipment
Type: String value inside is ignored. Indication Types:
Max Allowed: 1 This field is a flag to indicate if the 01 Hold for Pickup at UPS
Length: 0 receiver address has PO box Access Point
indicator. 02 UPS Access Point™
True if POBoxIndicator tag exists. Delivery

ShipmentIndicationType
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/ShipmentIndicationType
ShipmentIndicationType Required: Cond Container to hold shipment Currently only one
Type: Container indication type. Shipment Indication Type is
Max Allowed: 1 allowed.
Length: N/A

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

/RatingServiceSelectionRequest/Shipment/ShipmentIndicationType/Description
Description Required: No Description for Shipment Indication Length is not Validated.
Type: String Type.
Max Allowed: 1
Length: 1…50

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 29
Rating Package XML Developer Guide January 8, 2018

PaymentDetails
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/PaymentDetails
PaymentDetails Required: No Payment details container for This container is used for
Type: Container detailed shipment charges. The two Who Pays What
Max Allowed: 1 shipment charges that are available functionality.
Length: N/A for specification are Transportation
charges and Duties and Taxes.

/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge
ShipmentCharge Required: Yes* Shipment charge container.
Type: Container
Max Allowed: 2
Length: N/A

/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/Type
Type Required: Yes* Valid values:
Type: String 01 = Transportation
Max Allowed: 1 02 = Duties and Taxes
Length: 2

/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/BillShipper
BillShipper Required: Cond Container for the BillShipper billing This element or its sibling
Type: Container option. element, BillReceiver,
Max Allowed: 1 BillThirdParty or
Length: N/A ConsigneeBilledIndicator,
must be present but no
more than one can be
present.

/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/BillShipper/AccountNumber
AccountNumber Required: Yes* UPS account number Must be the same UPS
Type: String account number as the one
Max Allowed: 1 provided in
Length: 6 Shipper/ShipperNumber.

/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/BillReceiver
BillReceiver Required: Cond Container for the BillReceiver billing This element or its sibling
Type: Container option. element, BillShipper,
Max Allowed: 1 BillThirdParty or Consignee
Length: N/A Billed, must be present but
no more than one can be
present. For a return
shipment, Bill Receiver is
invalid for Transportation
charges.

/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/BillReceiver/AccountNumber

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 30
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

AccountNumber Required: Yes* The UPS account number. The account must be a
Type: String valid UPS account number
Max Allowed: 1 that is active.
Length: 6
For US, PR and CA
accounts, the account must
be a daily pickup account,
an occasional account, a
customer B.I.N account, or
a dropper shipper account.

All other accounts must be

either a daily pickup
account, an occasional
account, a drop shipper
account, or a non-shipping
account.
/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/BillReceiver/Address
Address Required: Cond Container for additional information
Type: Container for the bill receiver’s UPS accounts
Max Allowed: 1 address.
Length: N/A

/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/BillReceiver/Address/PostalCode
PostalCode Required: Yes* The postal code for the UPS
Type: String account's pickup address. The
Max Allowed: 1 pickup postal code was entered in
Length: 1…9 the UPS system when the account
was set-up.

/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/BillThirdParty
BillThirdParty Required: Cond Container for the third party billing This element or its sibling
Type: Container option. element, BillShipper,
Max Allowed: 1 BillReceiver or Consignee
Length: N/A Billed, must be present but
no more than one can be
present.

/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/BillThirdParty/AccountNumber
AccountNumber Required: Yes* The UPS account number of the The account must be a
Type: String third party shipper. valid UPS account number
Max Allowed: 1 that is active.
Length: 6
For US, PR and CA
accounts, the account must
be either a daily pickup
account, an occasional
account, or a customer
B.I.N account, or a drop
shipper account.

All other accounts must be

either a daily pickup
account, an occasional
account, a drop shipper
account, or a non-shipping
account.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 31
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/BillThirdParty/Address
Address Required: Yes* Container for additional information
Type: Container for the third party UPS accounts
Max Allowed: 1 address.
Length: N/A

/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/BillThirdParty/Address/PostalCode
PostalCode Required: Yes* Origin postal code. The postal code must be
Type: String the same as the UPS
Max Allowed: 1 account pickup address
Length: 1…9 postal code. Required for
United States and
Canadian UPS accounts
and/or if the UPS account
pickup address has a
postal code. If the UPS
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.

/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/BillThirdParty/Address/CountryCode
CountryCode Required: Yes* Origin Country code. Refer to the
Type: String Supported Country Tables located in
Max Allowed: 1 the Appendix.
Length: 2
/RatingServiceSelectionRequest/Shipment/PaymentDetails/ShipmentCharge/ConsigneeBilledIndicator
ConsigneeBilledIndicator Required: Cond Consignee Billing payment option Empty Tag. This element or
Type: String indicator. The presence indicates its sibling element,
Max Allowed: 1 consignee billing option is selected. BillShipper, BillReceiver or
Length: 0 The absence indicates one of the BillThirdParty, must be
other payment options is selected. present but no more than
one can be present. This
billing option is valid for a
shipment charge type of
Transportation only. Only
applies to US/PR and
PR/US shipment origins
and destination.

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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 32
Rating Package XML Developer Guide January 8, 2018

GoodsNotInFreeCirculationIndicator
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/GoodsNotInFreeCirculationIndicator
GoodsNotInFreeCirculationIndica Required: No Goods Not In Free Circulation This is an empty tag, any
tor Type: String indicator. value inside is ignored. This
Max Allowed: 1 indicator is invalid for a
Length: 0 package type of UPS Letter
and DocumentsOnly.

Service
Name Constraint Description Validation

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

/RatingServiceSelectionRequest/Shipment/Service/Code
Code Required: Cond The code for the UPS Service
Type: String associated with the shipment.
Max Allowed: 1
Length: 2 NOTE: For a complete listing of
values, refer to Service Codes in the
Appendix.

Valid domestic values:

01 = Next Day Air
02 = 2nd Day Air
03 = Ground
12 = 3 Day Select
13 = Next Day Air Saver
14 = UPS Next Day Air Early
59 = 2nd Day Air A.M.
Valid international values:
07 = Worldwide Express
08 = Worldwide Expedited
11= Standard
54 = Worldwide Express Plus
65 = Saver
96 = UPS Worldwide Express
Freight
71 = UPS Worldwide Express
Freight Midday
Required for Rating and ignored for
Shopping.

/RatingServiceSelectionRequest/Shipment/Service/Description
Description Required: No A text description of the UPS Length is not validated.
Type: String Service associated with the
Max Allowed: 1 shipment.
Length: 35

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 33
Rating Package XML Developer Guide January 8, 2018

DocumentsOnly
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/DocumentsOnly
DocumentsOnly Required: No Indicates that the shipment contains
Type: String only documents.
Max Allowed: 1
Length: 0

NumOfPieces
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/NumOfPieces
NumOfPieces Required: No Total number of pieces in all pallets.
Type: String Required for UPS Worldwide
Max Allowed: 1 Express Freight and UPS Worldwide
Length: 1…5 Express Freight Midday shipments.

ShipmentTotalWeight
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/ShipmentTotalWeight
ShipmentTotalWeight Required: Cond Shipment Total Weight Container. Required for all
Type: Container This container is only applicable for international shipments
Max Allowed: 1 "ratetimeintransit" and when retreiving time in
Length: N/A "shoptimeintransit" request options. transit information,
including letters and
documents shipments.
/RatingServiceSelectionRequest/Shipment/ShipmentTotalWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* UnitOfMeasurement Container.
Type: Container
Max Allowed:
Length: N/A

/RatingServiceSelectionRequest/Shipment/ShipmentTotalWeight/UnitOfMeasurement/Code
Code Required: Yes* Code representing the unit of
Type: String measure associated with the
Max Allowed: shipment weight.
Length: 3 Codes are: LBS = Pounds, KGS =
Kilograms.

/RatingServiceSelectionRequest/Shipment/ShipmentTotalWeight/UnitOfMeasurement/Description
Description Required: No Text description of the code
Type: String representing the unit of measure
Max Allowed: 1 associated with the shipment weight.
Length: 1..35

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 34
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/ShipmentTotalWeight/Weight
Weight Required: Yes* Non-zero total weight of all
Type: String packages in the shipment.
Max Allowed:
Length: 1..3

Package
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/Package
Package Required: No Container for Package. N/A
Type: Container
Max Allowed: 200
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackagingType
PackagingType Required: Cond Container to hold Packaging Type If no container is specified,
Type: Container information. RAVE assumes UPS
Max Allowed: 1 Package, i.e., type 02
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackagingType/Code
Code Required: Yes* The code for the UPS packaging Valid values:
Type: String type associated with the package. 00 = UNKNOWN
Max Allowed: 1 01 = UPS Letter
Length: 2 02 = Package
03 = Tube
04 = Pak
21 = Express Box
24 = 25KG Box
25 = 10KG Box
30 = Pallet
2a = Small Express Box
2b = Medium Express Box
2c = Large Express Box

/RatingServiceSelectionRequest/Shipment/Package/PackagingType/Description
Description Required: No A text description of the code for the Length is not validated.
Type: String UPS packaging type associated with
Max Allowed: 1 the shipment.
Length: 35

/RatingServiceSelectionRequest/Shipment/Package/Dimensions
Dimensions Required: Cond Container to hold Dimensions of N/A
Type: Container Package.
Max Allowed: 1
Length: N/A

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 35
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/Package/Dimensions/UnitOfMeasurement
UnitOfMeasurement Required: Cond Container to hold Unit of Required if Packaging Type
Type: Container Measurement of Package. in not Letter, Express Tube,
Max Allowed: 1 or Express Box. Required
Length: N/A for GB to GB and Poland to
Poland shipments
/RatingServiceSelectionRequest/Shipment/Package/Dimensions/UnitOfMeasurement/Code
Code Required: No Package dimensions unit of Valid codes:
Type: String measurement code. IN = Inches
Max Allowed: 1 CM = Centimeters
Length: 2
/RatingServiceSelectionRequest/Shipment/Package/Dimensions/UnitOfMeasurement/Description
Description Required: No A text description of the code for the Length is not validated.
Type: String unit of measure associated with the
Max Allowed: 1 package dimensions.
Length: 35
/RatingServiceSelectionRequest/Shipment/Package/Dimensions/Length
Length Required: Cond The length of the package used to Required if Packaging Type
Type: String determine dimensional weight. in not Letter, Express Tube,
Max Allowed: 1 or Express Box. Required
Length: 6 for GB to GB and Poland to
Poland shipments.
/RatingServiceSelectionRequest/Shipment/Package/Dimensions/Width
Width Required: Cond The width of the package used to Required if Packaging Type
Type: String determine dimensional weight. in not Letter, Express Tube,
Max Allowed: 1 or Express Box. Required
Length: 6 for GB to GB and Poland to
Poland shipments.

/RatingServiceSelectionRequest/Shipment/Package/Dimensions/Height
Height Required: Cond The height of the package used to Required if Packaging Type
Type: String determine dimensional weight. in not Letter, Express Tube,
Max Allowed: 1 or Express Box. Required
Length: 6 for GB to GB and Poland to
Poland shipments.
/RatingServiceSelectionRequest/Shipment/Package/DimWeight
DimWeight Required: No Package Dimensional Weight Only used for non-
Type: Container container. Values in this container US/CA/PR shipments.
Max Allowed: 1 are ignored when package
Length: N/A dimensions are provided. Please
visit ups.com for instructions on
calculating this value.

/RatingServiceSelectionRequest/Shipment/Package/DimWeight/UnitOfMeasurement
UnitOfMeasurement Required: No UnitOfMeasurement Container. N/A
Type: Container
Max Allowed: 1
Length: N/A

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 36
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/Package/DimWeight/UnitOfMeasurement/Code
Code Required: No Code representing the unit of Valid values: “LBS” =
Type: String measure associated with the Pounds (default) and “KGS”
Max Allowed: 1 package weight. Codes are: LBS = = Kilograms.
Length: 3 Pounds, KGS = Kilograms.
/RatingServiceSelectionRequest/Shipment/Package/DimWeight/UnitOfMeasurement/Description
Description Required: No Text description of the code Length and value are not
Type: String representing the unit of measure validated.
Max Allowed: 1 associated with the package weight.
Length: 1…35

/RatingServiceSelectionRequest/Shipment/Package/DimWeight/Weight
Weight Required: No Dimensional weight of the package.
Type: String Decimal values are not accepted,
Max Allowed: 1 however there is one implied
Length: 6 decimal place for values in this field
(i.e. 115 = 11.5).

/RatingServiceSelectionRequest/Shipment/Package/PackageWeight
PackageWeight Required: Cond Container to hold Package Weight Weight allowed for
Type: Container information. letters/envelopes.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageWeight/UnitOfMeasurement
UnitOfMeasurement Required: Cond Container to hold Unit of N/A
Type: Container Measurement of Package Weight.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageWeight/UnitOfMeasurement/Code
Code Required: No Code representing the unit of Valid values:
Type: String measure associated with the LBS = Pounds (default)
Max Allowed: 1 package weight. KGS = Kilograms
Length: 3

/RatingServiceSelectionRequest/Shipment/Package/PackageWeight/UnitOfMeasurement/Description
Description Required: No Text description of the code Length is not validated.
Type: String representing the unit of measure
Max Allowed: 1 associated with the package weight.
Length: 35

/RatingServiceSelectionRequest/Shipment/Package/PackageWeight/Weight
Weight Required: Yes* Value of the package weight. Valid values: 0.1 - 150.0
Type: String
Max Allowed: 1
Length: 6

/RatingServiceSelectionRequest/Shipment/Package/LargePackageIndicator
LargePackageIndicator Required: No Presence of LargePackageIndicator
Type: String specifies that the package is a Large
Max Allowed: 1 package.
Length: 0

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 37
Rating Package XML Developer Guide January 8, 2018

PackageServiceOptions
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions
PackageServiceOptions Required: No Container for Package Service N/A
Type: Container Options.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/InsuredValue
InsuredValue Required: No Container for Insured Value Type. N/A
Type: Container
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/InsuredValue/CurrencyCode
CurrencyCode Required: No Declared value amount currency Code must represent a
Type: String type. The IATA currency code currency that is a valid for
Max Allowed: 1 associated with the declared value Shipper country.
Length: 3 amount for the package.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/InsuredValue/MonetaryValue
MonetaryValue Required: Yes* Declared value amount. Declared value amount.
Type: String
Max Allowed: 1
Length: 1..19

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/AccessPointCOD
AccessPointCOD Required: No Access Point COD indicates Valid only for "01 - Hold For
Type: Container Package COD is requested for a Pickup At UPS Access
Max Allowed: 1 shipment. Point" Shipment Indication
Length: N/A type.
Package Access Point
COD is valid only for
shipment without return
service from US/PR to
US/PR and CA to CA. Not
valid with (Package) COD.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/AccessPointCOD/CurrencyCode
CurrencyCode Required: Yes* Access Point COD Currency Code. Required if
Type: String AccessPointCOD container
Max Allowed: 1 is present.
Length: 3

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/AccessPointCOD/MonetaryValue
MonetaryValue Required: Yes* Access Point COD Monetary Value. Required if
Type: String AccessPointCOD container
Max Allowed: 1 is present.
Length: 8

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/COD

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 38
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

COD Required: No COD container Indicates COD is

Type: Container requested. Package level
Max Allowed: 1 COD is available for US/PR
Length: N/A to US/PR, CA to CA, and
CA to US. CA to US COD
is not allowed for package
Letter/ Envelope.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/COD/CODFundsCode
CODFundsCode Required: Cond Indicates the type of funds that can For valid values, refer
Type: String be used for the C.O.D. payment. to COD Supported
Max Allowed: 1 Countries in the Appendix.
Length: 1

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/COD/CODAmount
CODAmount Required: Cond Container to hold COD Amount. N/A
Type: Container
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/COD/CODAmount/CurrencyCode
CurrencyCode Required: Cond The IATA currency code associated Required if a value for the
Type: String with the COD amount for the COD amount exists in the
Max Allowed: 1 package. MonetaryValue tag. Must
Length: 3 match one of the IATA
currency codes.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/COD/CODAmount/MonetaryValue
MonetaryValue Required: Cond The COD value for the package. Required if COD option is
Type: String present. The maximum
Max Allowed: 1 amount allowed is
Length: 8 50,000USD.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/DeliveryConfirmation
DeliveryConfirmation Required: No Container to hold Delivery For list of allowed
Type: Container Confirmation information. origin/destinations, please
Max Allowed: 1 refer to Appendix D.
Length: N/A DeliveryConfirmation and
COD cannot coexist on a
single Package.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/DeliveryConfirmation/DCISType
DCISType Required: Yes* Type of delivery confirmation Valid values:
Type: String 1 - Delivery Confirmation
Max Allowed: 1 2 - Delivery Confirmation
Length: 1 Signature Required
3 - Delivery Confirmation
Adult Signature Required

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/ShipperDeclaredValue

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 39
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

ShipperDeclaredValue Required: No Shipper Paid Declared Value N/A

Type: Container Charge at Package level. Required
Max Allowed: 1 for UPS Worldwide Express Freight
Length: N/A and UPS Worldwide Express Freight
Midday Shipments.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/ShipperDeclaredValue/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code associated Length is not validated.
Type: String with the amount for the package.
Max Allowed: 1
Length: 3

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/ShipperDeclaredValue/MonetaryValue
MonetaryValue Required: Yes* The monetary value for the amount N/A
Type: String associated with the package.
Max Allowed: 1
Length: 1..19
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/ProactiveIndicator
ProactiveIndicator Required: No Valid for UPS Worldwide Express Shippers account need to
Type: String Freight and UPS Worldwide Express have a valid contract for
Max Allowed: 1 Freight Midday Shipments. Contract Proactive.
Length: 0 based accessorial which can be
used by health care companies to
monitor the package progress
through the UPS system

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/RefrigerationIndicator
RefrigerationIndicator Required: No Presence/Absence Indicator. Any Shippers account need to
Type: String value is ignored. If present, indicates have a valid contract for
Max Allowed: 1 that the package contains an item Refrigeration.
Length: 0 that needs refrigeration.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/Insurance
Insurance Required: No Insurance Accesorial. Valid for UPS
Type: Container Worldwide Express Freight and UPS
Max Allowed: 1 Worldwide Express Freight Midday
Length: N/A Shipments.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/Insurance/BasicFlexibleParcelIndicator
BasicFlexibleParcelIndicator Required: No Container to hold Basic Flexible
Type: Container Parcel Indicator information.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/Insurance/BasicFlexibleParcelIndicator/Curre
ncyCode
CurrencyCode Required: Yes* The IATA currency code associated
Type: String with the amount for the package.
Max Allowed: 1
Length: 3

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/Insurance/BasicFlexibleParcelIndicator/Mone
taryValue

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 40
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

MonetaryValue Required: Yes* The monetary value for the amount

Type: String associated with the package.
Max Allowed: 1
Length: 1..9
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/Insurance/ExtendedFlexibleParcelIndicator
ExtendedFlexibleParcelIndicator Required: No Container to hold Extended Flexible
Type: Container Parcel Indicator information.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/Insurance/ExtendedFlexibleParcelIndicator/C
urrencyCode
CurrencyCode Required: Yes* The IATA currency code associated
Type: String with the amount for the package.
Max Allowed: 1
Length: 3
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/Insurance/ExtendedFlexibleParcelIndicator/
MonetaryValue
MonetaryValue Required: Yes* The monetary value for the amount
Type: String associated with the package.
Max Allowed: 1
Length: 1..9
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/Insurance/TimeInTransitFlexibleParcelIndicat
or
TimeInTransitFlexibleParcelIndic Required: No Container to hold Time In Transit
ator Type: Container Flexible Parcel Indicator information.
Max Allowed: 1
Length: N/A
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/Insurance/TimeInTransitFlexibleParcelIndicat
or/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code associated
Type: String with the amount for the package.
Max Allowed: 1
Length: 3
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/Insurance/TimeInTransitFlexibleParcelIndicat
or/MonetaryValue
MonetaryValue Required: Yes* The monetary value for the amount
Type: String associated with the package.
Max Allowed: 1
Length: 1..9

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation
VerbalConfirmation Required: No Container to hold Verbal N/A
Type: Container Confirmation information.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/Name
Name Required: No The name of the person that will
Type: String provide verbal confirmation for the
Max Allowed: 1 package.
Length: 35

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/PhoneNumber

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 41
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

PhoneNumber Required: No Container to hold Shipper's Phone

Type: Container Number.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/PhoneNumber/Structure
dPhoneNumber
StructuredPhoneNumber Required: No Container to hold Structured Phone Required if parent element,
Type: Container number. PhoneNumber, is required.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/PhoneNumber/Structure
dPhoneNumber/PhoneCountryCode
PhoneCountryCode Required: No The Country Code portion of the Not valid for US phone
Type: String phone number. numbers.
Max Allowed: 1
Length: 3
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/PhoneNumber/Structure
dPhoneNumber/PhoneDialPlanNumber
PhoneDialPlanNumber Required: No Dial plan number portion of the
Type: String phone number.
Max Allowed: 1
Length: 15
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/PhoneNumber/Structure
dPhoneNumber/PhoneLineNumber
PhoneLineNumber Required: No Line number portion of the phone
Type: String number.
Max Allowed: 1
Length: 15

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/VerbalConfirmation/PhoneNumber/Structure
dPhoneNumber/PhoneExtension
PhoneExtension Required: No Shipper's phone extension.
Type: String
Max Allowed: 1
Length: 4

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/UPSPremiumCareIndicator

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 42
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

UPSPremiumCareIndicator Required: No UPSPremiumCareIndicator indicates Empty Tag means indicator

Type: String that special handling is required for is present.
Max Allowed: 1 shipments of controlled substances.
Length: 0 The
UPSPremiumCareIndicator
cannot be requested for
package with:
- Delivery Confirmation -
Adult Signature Required
- Delivery Confirmation-
Signature Required

UPS Premium Care 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 UPS Premium Care

can be requested with
following UPS services:
- UPS Express® Early
- UPS Express
- UPS Express Saver
- UPS Standard.
Valid only for Canada to
Canada movements.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat
HazMat Required: No Container to hold HazMat Applies only if SubVersion
Type: Container information. is greater than or equal to
Max Allowed: 1 1701.
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/PackageIdentifier
PackageIdentifier Required: Cond Identifies the package containing Required if SubVersion is
Type: String Dangerous Goods. greater than or equal to
Max Allowed: 1 1701.
Length: 1…5

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/QValue
QValue Required: Cond QValue is required when a HazMat Applies only if SubVersion
Type: String shipment specifies is greater than or equal to
Max Allowed: 1 AllPackedInOneIndicator and the 1701. Valid values are :
Length: 3 regulation set for that shipment is 0.1; 0.2; 0.3; 0.4; 0.5; 0.6;
IATA. 0.7; 0.8; 0.9; 1.0

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/OverPackedIndicator
OverPackedIndicator Required: No Presence/Absence Indicator. Any Applies only if SubVersion
Type: String value is ignored. Presence indicates is greater than or equal to
Max Allowed: 1 that shipment is overpack. 1701.
Length: 0

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 43
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/AllPackedInOneIndicator
AllPackedInOneIndicator Required: No Presence/Absence Indicator. Any Applies only if SubVersion
Type: String value is ignored. Indicates the is greater than or equal to
Max Allowed: 1 hazmat shipment/package is all 1701.
Length: 0 packed in one.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord
HazMatChemicalRecord Required: Yes* Container to hold HazMat Chemical
Type: Container Records.
Max Allowed: 3
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/ChemicalR
ecordIdentifier
ChemicalRecordIdentifier Required: Cond Identifies the Chemcial Record. Required if SubVersion is
Type: String greater than or equal to
Max Allowed: 1 1701.
Length: 1…3

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/ClassDivisi
onNumber
ClassDivisionNumber Required: Cond This is the hazard class associated Applies only if SubVersion
Type: String to the specified commodity. is greater than or equal to
Max Allowed: 1 Required if 1701.
Length: 1…7 CommodityRegulatedLevelCode is
‘LQ’ or ‘FR’

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/IDNumber
IDNumber Required: Cond This is the ID number (UN/NA/ID) for Applies only if SubVersion
Type: String the specified commodity. Required if is greater than or equal to
Max Allowed: 1 CommodityRegulatedLevelCode = 1701.
Length: 1…6 LR, LQ or FR and if the field applies
to the material by regulation.
UN/NA/ID Identification Number
assigned to the specified regulated
good. (Include the UN/NA/ID as part
of the entry).

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/Transportat
ionMode
TransportationMode Required: Yes* The method of transport by which a Applies only if SubVersion
Type: String shipment is approved to move and is greater than or equal to
Max Allowed: 1 the regulations associated with that 1701. For multiple
Length: 2 method. Only required when the ChemicalRecords per
CommodityRegulatedLevelCode is package having different
FR or LQ. TransportationMode,
Valid values: TransportationMode of first
01 - Highway ChemicalRecord would be
02 - Ground considered for validating
03 - Passenger Aircraft and rating the package. All
04 - Cargo Aircraft Only TransportationMode except
for '04' are general service
offering. If any chemical
record contains '04' as
TransportationMode,
ShipperNumber needs to
be authorized to use '04' as
TransportationMode.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 44
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/Regulation
Set
RegulationSet Required: Yes* The Regulatory set associated with Applies only if SubVersion
Type: String every regulated shipment. It must be is greater than or equal to
Max Allowed: 1 the same across the shipment. 1701. For multiple
Length: 3…4 Valid values: ChemicalRecords per
ADR - For Europe to Europe package or multiple
Ground Movement packages containing
CFR - For HazMat regulated by US different RegulationSet,
Dept. of Transportation within the RegulationSet of first
U.S. or ground shipments to ChemicalRecord would be
Canada, considered for validating
IATA - For Worldwide Air and rating the entire
movement shipment.
TDG - For Canada to Canada
ground movement or Canada to U.S.
standard movement

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/Emergency
Phone
EmergencyPhone Required: No 24 Hour Emergency Phone Number Applies only if SubVersion
Type: String of the shipper. is greater than or equal to
Max Allowed: 1 Valid values for this field are (0) 1701.
Length: 1…25 through (9) with trailing blanks. For The following are restricted
numbers within the U.S., the layout in the phone number
is '1', area code, 7-digit number. For
all other countries the layout is “period “.”, dash “-“, plus
country code, area code, number. sign “+” and conventional
parentheses “(“ and “)”,
“EXT or OPT”
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/Emergency
Contact
EmergencyContact Required: Cond The emergency information, contact Applies only if SubVersion
Type: String name and/or contact number, is greater than or equal to
Max Allowed: 1 required to be communicated when 1701.
Length: 1…35 a call is placed to the
EmergencyPhoneNumber. The
information is required if there is a
value in the
EmergencyPhoneNumber field
above and the shipment is with a
US50 or PR origin and/or destination
and the RegulationSet is IATA.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/Reportable
Quantity
ReportableQuantity Required: Cond Required if Applies only if SubVersion
Type: String CommodityRegulatedLevelCode = is greater than or equal to
Max Allowed: 1 LQ or FR and if the field applies to 1701.
Length: 1…2 the material by regulation. If
reportable quantity is met, 'RQ'
should be entered.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/SubRiskCla
ss

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 45
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

SubRiskClass Required: Cond Required if Applies only if SubVersion

Type: String CommodityRegulatedLevelCode = is greater than or equal to
Max Allowed: 1 LQ or FR and if the field applies to 1701.
Length: 1…100 the material by regulation.
Secondary hazardous
characteristics of a package. (There
can be more than one – separate
each with a comma).

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/Packaging
GroupType
PackagingGroupType Required: Cond This is the packing group category Applies only if SubVersion
Type: String associated to the specified is greater than or equal to
Max Allowed: 1 commodity. Required if 1701.
Length: 1…10 CommodityRegulatedLevelCode =
LQ or FR and if the field applies to
the material by regulation. Must be
shown in Roman Numerals.
Valid values are:
I,
II,
III,
blank.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/Quantity
Quantity Required: Cond Required if Applies only if SubVersion
Type: String CommodityRegulatedLevelCode = is greater than or equal to
Max Allowed: 1 LQ or FR. The numerical value of 1701.
Length: 15 the mass capacity of the regulated
good.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/UOM
UOM Required: Cond Required if Applies only if SubVersion
Type: String CommodityRegulatedLevelCode = is greater than or equal to
Max Allowed: 1 LQ or FR. The unit of measure used 1701.
Length: 1…10 for the mass capacity of the
regulated good. For Example: ml, L,
g, mg, kg, cylinder, pound, pint,
quart, gallon, ounce etc.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/PackagingI
nstructionCode
PackagingInstructionCode Required: Cond The packing instructions related to Applies only if SubVersion
Type: String the chemical record. Required if is greater than or equal to
Max Allowed: 1 CommodityRegulatedLevelCode = 1701.
Length: 1…353 LQ or FR and if the field applies to
the material by regulation.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/ProperShip
pingName
ProperShippingName Required: Cond The Proper Shipping Name Applies only if SubVersion
Type: String assigned by ADR, CFR or IATA. is greater than or equal to
Max Allowed: 1 Required if 1701.
Length: 1…250 CommodityRegulatedLevelCode =
LR, LQ or FR.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/TechnicalN
ame

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 46
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

TechnicalName Required: Cond The technical name (when required) Applies only if SubVersion
Type: String for the specified commodity. is greater than or equal to
Max Allowed: 1 Required if 1701.
Length: 1…300 CommodityRegulatedLevelCode =
LQ or FR and if the field applies to
the material by regulation.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/AdditionalD
escription
AdditionalDescription Required: Cond Additional remarks or special Applies only if SubVersion
Type: String provision information. Required if is greater than or equal to
Max Allowed: 1 CommodityRegulatedLevelCode = 1701.
Length: 1…75 LQ or FR and if the field applies to
the material by regulation.
Additional information that may be
required by regulation about a
hazardous material, such as,
“Limited Quantity”, DOT-SP
numbers, EX numbers.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/Packaging
Type
PackagingType Required: Cond The package type code identifying Applies only if SubVersion
Type: String the type of packaging used for the is greater than or equal to
Max Allowed: 1 commodity. (Ex: Fiberboard Box). 1701.
Length: 1…255 Required if
CommodityRegulatedLevelCode =
LQ or FR.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/HazardLab
elRequired
HazardLabelRequired Required: Cond Defines the type of label that is Applies only if SubVersion
Type: String required on the package for the is greater than or equal to
Max Allowed: 1 commodity. Not applicable if 1701.
Length: 1…50 CommodityRegulatedLevelCode =
LR or EQ.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/Packaging
TypeQuantity
PackagingTypeQuantity Required: Cond The number of pieces of the specific Applies only if SubVersion
Type: String commodity. Required if is greater than or equal to
Max Allowed: 1 CommodityRegulatedLevelCode = 1701.
Length: 1…3 LQ or FR.
Valid values are 1 to 999.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/Commodity
RegulatedLevelCode
CommodityRegulatedLevelCode Required: Cond Indicates the type of commodity - Applies only if SubVersion
Type: String Fully Regulated (FR), Limited is greater than or equal to
Max Allowed: 1 Quantity (LQ), Excepted Quantity 1701.
Length: 2 (EQ), Lightly Regulated (LR). Default
value is FR.
Valid values are
LR,
FR,
LQ,
EQ.
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/TransportC
ategory

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 47
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

TransportCategory Required: No Transport Category. Applies only if SubVersion

Type: String Valid values are 0 to 4. is greater than or equal to
Max Allowed: 1 1701.
Length: 1

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/HazMat/HazMatChemicalRecord/TunnelRest
rictionCode
TunnelRestrictionCode Required: No Defines what is restricted to pass Applies only if SubVersion
Type: String through a tunnel. is greater than or equal to
Max Allowed: 1 1701.
Length: 1…10
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/DryIce
DryIce Required: No Container for Dry Ice. One Dry Ice
Type: Container container is allowed.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/DryIce/RegulationSet
RegulationSet Required: Yes* Regulation set for DryIce Shipment. The following values are
Type: String Valid values: valid: CFR and IATA.
Max Allowed: 1 CFR = For HazMat regulated by US
Length: 3…4 Dept. of Transportation within the
U.S. or ground shipments to Canada
IATA = For Worldwide Air movement

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight
DryIceWeight Required: Yes* Container for Weight information for
Type: Container Dry Ice.
Max Allowed: 1
Length: N/A
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container for Unit Of Measurement
Type: Container for Dry Ice.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/UnitOfMeasurement/Co
de
Code Required: Yes* DryIce weight unit of measurement Valid values: 00, 01
Type: String code.
Max Allowed: 1 Valid values are:
Length: 2 00 = KG (Metric Unit of
Measurements) or KGS
01 = LB (English Unit of
Measurements) or LBS
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/UnitOfMeasurement/De
scription
Description Required: No Short description for
Type: String UnitOfMeasurement.
Max Allowed: 1
Length: 1…20

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/DryIce/DryIceWeight/Weight

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 48
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

Weight Required: Yes* Weight for Dry Ice. Cannot be more than
Type: String package weight. Should be
Max Allowed: 1 more than 0.0. Valid
Length: 1…5 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.
/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/DryIce/MedicalUseIndicator
MedicalUseIndicator Required: No Presence/Absence Indicator. Any
Type: String value inside is ignored. Relevant
Max Allowed: 1 only in CFR regulation set. If
Length: 0 present, it is used to designate that
Dry Ice is for any medical use and
rates are adjusted for Dry Ice weight
more than 2.5 Kgs or 5.7 LBs.

/RatingServiceSelectionRequest/Shipment/Package/PackageServiceOptions/DryIce/AuditRequired
AuditRequired Required: No Presence/Absence Indicator. Any
Type: String value inside is ignored. Indicator for
Max Allowed: 1 auditing Dry Ice. Empty tag means
Length: 0 indicator is present.

/RatingServiceSelectionRequest/Shipment/Package/AdditionalHandling
AdditionalHandling Required: No A flag indicating if the packages N/A
Type: String requires additional handling. True if
Max Allowed: 1 tag exists; false otherwise
Length: 0

ShipmentServiceOptions
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions
ShipmentServiceOptions Required: No Container to hold Shipment Service N/A
Type: Container Options.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/SaturdayPickup
SaturdayPickup Required: No A flag indicating if the shipment N/A
Type: String requires a Saturday pickup. True if
Max Allowed: 1 tag exists; false otherwise
Length: 0

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/SaturdayDelivery
SaturdayDelivery Required: No A flag indicating if a shipment must N/A
Type: String be delivered on a Saturday. True if
Max Allowed: 1 tag exists; false otherwise
Length: 0

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/AccessPointCOD

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 49
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

AccessPointCOD Required: No Access Point COD indicates Valid only for "01 - Hold For
Type: Container Shipment level Access Point COD is Pickup At UPS Access
Max Allowed: 1 requested for a shipment. Point" Shipment Indication
Length: N/A type.
Shipment COD is valid only
for countries within E.U.
Not valid with (Shipment)
COD.
Not available to shipment
with return service.

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/AccessPointCOD/CurrencyCode
CurrencyCode Required: Yes* Access Point COD Currency Code. Required if
Type: String AccessPointCOD container
Max Allowed: 1 is present.
Length: 3

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/AccessPointCOD/MonetaryValue
MonetaryValue Required: Yes* Access Point COD Currency Code. Required if
Type: String AccessPointCOD container
Max Allowed: 1 is present.
Length: 8

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

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

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/COD
COD Required: No COD container. Indicates COD is
Type: Container requested. Shipment COD
Max Allowed: 1 is only available for EU
Length: N/A origin countries and for
shipper's account type
Daily Pickup and Drop
Shipping.
/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/COD/CODFundsCode

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 50
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

CODFundsCode Required: No For valid values, refer to Rating and

Type: String Shipping COD Supported Countries
Max Allowed: 1 in the Appendix.
Length: 1

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/COD/CODAmount
CODAmount Required: Yes* Container to hold COD Amount. N/A
Type: Container
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/COD/CODAmount/CurrencyCode
CurrencyCode Required: No COD amount currency code type.
Type: String Defaults to the currency used in the
Max Allowed: 1 destination country.
Length: 3

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

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

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/DeliveryConfirmation
DeliveryConfirmation Required: No Container for Delivery Confirmation. For list of allowed
Type: Container origin/destinations please
Max Allowed: 1 refer to Appendix.
Length: N/A

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

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/UPScarbonneutralIndicator
UPScarbonneutralIndicator Required: No UPS carbon neutral indicator -
Type: String Required to rate carbon neutral
Max Allowed: 1 shipments at the shipment level.
Length: 0

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/CertificateOfOriginIndicator

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 51
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

CertificateOfOriginIndicator Required: No Valid for UPS Worldwide Express

Type: String Freight and UPS Worldwide Express
Max Allowed: 1 Freight Midday shipments. The
Length: 0 empty tag in request indicates that
the customer would be using UPS
prepared SED form.

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/PickupOptions
PickupOptions Required: No Shipment Service Pickup Options
Type: Container Container. Valid for UPS Worldwide
Max Allowed: 1 Express Freight and UPS Worldwide
Length: N/A Express Freight Midday shipments.

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/PickupOptions/LiftGateAtPickupIndicator
LiftGateAtPickupIndicator Required: No The presence of the tag
Type: String LiftGatePickupRequiredIndicator
Max Allowed: 1 indicates that the shipment requires
Length: 0 a lift gate for pickup.

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/PickupOptions/HoldForPickupIndicator
HoldForPickupIndicator Required: No The presence of the this fields
Type: String indicates that the user opted to hold
Max Allowed: 1 the shipment for pickup.
Length: 0

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/DeliveryOptions
DeliveryOptions Required: No Shipment Service Delivery Options
Type: Container Container. Valid for UPS Worldwide
Max Allowed: 1 Express Freight and UPS Worldwide
Length: N/A Express Freight Midday shipments.

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/DeliveryOptions/LiftGateAtDeliveryIndicator
LiftGateAtDeliveryIndicator Required: No The presence of the tag
Type: String LiftGateDeliveryRequiredIndicator
Max Allowed: 1 indicates that the shipment requires
Length: 0 a lift gate for delivery.

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/DeliveryOptions/DropOffAtUPSFacilityIndicator
DropOffAtUPSFacilityIndicator Required: No The presence of the this field
Type: String indicates that the user selected drop
Max Allowed: 1 off at facility.
Length: 0

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/RestrictedArticles
RestrictedArticles Required: No Valid for UPS Worldwide Express
Type: Container Freight and UPS Worldwide Express
Max Allowed: 1 Freight Midday shipments.
Length: N/A

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/RestrictedArticles/AlcoholicBeveragesIndicator
AlcoholicBeveragesIndicator Required: No This field is a flag to indicate if the
Type: String package has Alcohol. True if
Max Allowed: 1 present; false otherwise
Length: 0
/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/RestrictedArticles/DiagnosticSpecimensIndicator

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 52
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

DiagnosticSpecimensIndicator Required: No This field is a flag to indicate if the

Type: String package has Biological substances.
Max Allowed: 1 True if present; false otherwise
Length: 0

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/RestrictedArticles/PerishablesIndicator
PerishablesIndicator Required: No This field is a flag to indicate if the
Type: String package has Perishables. True if
Max Allowed: 1 present; false otherwise
Length: 0
/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/RestrictedArticles/PlantsIndicator
PlantsIndicator Required: No This field is a flag to indicate if the
Type: String package has Plants. True if present;
Max Allowed: 1 false otherwise
Length: 0
/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/RestrictedArticles/SeedsIndicator
SeedsIndicator Required: No This field is a flag to indicate if the
Type: String package has Seeds. True if present;
Max Allowed: 1 false otherwise
Length: 0

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/RestrictedArticles/SpecialExceptionsIndicator
SpecialExceptionsIndicator Required: No This field is a flag to indicate if the
Type: String package has Special Exceptions
Max Allowed: 1 Restricted Materials. True if present;
Length: 0 false otherwise

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/RestrictedArticles/TobaccoIndicator
TobaccoIndicator Required: No This field is a flag to indicate if the
Type: String package has Tobbacco. True if
Max Allowed: 1 present; false otherwise
Length: 0
/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/ShipperExportDeclarationIndicator
ShipperExportDeclarationIndicat Required: No Valid for UPS Worldwide Express
or Type: String Freight and UPS Worldwide Express
Max Allowed: 1 Freight Midday shipments. The
Length: 0 empty tag in request indicates that
customer would be using UPS
prepared SED form.

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/CommercialInvoiceRemovalIndicator
CommercialInvoiceRemovalIndic Required: No Presence/Absence Indicator. Any
ator Type: String value inside is ignored.
Max Allowed: 1 CommercialInvoiceRemovalIndicator
Length: 0 - empty tag means indicator is
present.
CommercialInvoiceRemovalIndicator
allows a shipper to dictate UPS to
remove the Commercial Invoice from
the user's shipment before the
shipment is delivered to the ultimate
consignee.
/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/ImportControl

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 53
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

ImportControl Required: No Container for type of Import Control

Type: Container shipments.
Max Allowed: 1
Length: N/A
/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/ImportControl/Code
Code Required: Yes* Code for type of Import Control
Type: String shipment.
Max Allowed: 1 Valid values:
Length: 2 01 = ImportControl Print and Mail
02 = ImportControl One-Attempt
04 = ImportControl Electronic Label
05 = ImportControl Print Label

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/ImportControl/Description
Description Required: No Description for type of Import
Type: String Control.
Max Allowed: 1
Length: 1…50

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/ReturnService
ReturnService Required: No Container for type of Return
Type: Container Services.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/ReturnService/Code
Code Required: Yes Code for type of Return shipment. 10 = UPS Exchange Print
Type: String Valid values: Return Label and 5 = UPS
Max Allowed: 1 2 = UPS Print and Mail Return Label Three Attempt Return Label
Length: 1…2 3 =UPS One-Attempt Return Label are not valid for UPS
5 = UPS Three Attempt Return WorldWide Express Freight
Label and UPS Worldwide
8 = UPS Electronic Return Label Express Freight Midday
9 = UPS Print Return Label Services.
10 = UPS Exchange Print Return
Label 3 = UPS One-Attempt
Return Label is not valid
return service with UPS
Premium Care accessorial.

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/ReturnService/Description
Description Required: No Description for type of Return
Type: String Service.
Max Allowed: 1
Length: 1…50

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/SDLShipmentIndicator
SDLShipmentIndicator Required: No Empty Tag means the indicator is
Type: String present. This field is a flag to
Max Allowed: 1 indicate if the receiver needs SDL
Length: 0 rates in response.

True if SDLShipmentIndicator tag

exists; false otherwise.

/RatingServiceSelectionRequest/Shipment/ShipmentServiceOptions/EPRAIndicator

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 54
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

EPRAIndicator Required: No Presence/Absence Indicator. Any

Type: String value inside is ignored. This field is a
Max Allowed: 1 flag to indicate Package Release
Length: 0 Code is requested for shipment.

This accessorial is only valid with

ShipmentIndicationType ‘01’ - Hold
for Pickup at UPS Access Point™.

RateInformation
Name Constraint Description Validation

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

/RatingServiceSelectionRequest/Shipment/RateInformation/NegotiatedRatesIndicator
NegotiatedRatesIndicator Required: No NegotiatedRatesIndicator is required
Type: String to display two types of discounts:
Max Allowed: 1 1) Bids or Account Based Rates
Length: 0 2) Web/Promotional Discounts Bids

Account Based Rates - If the

indicator is present in the XML
Request the response will contain
negotiated rates for an authorized
account.

Web/Promotional Discounts - If the

indicator is present, the
Web/Promotional Discounts will be
reflected in the negotiated rates
returned in the XML response for an
authorized account.

/RatingServiceSelectionRequest/Shipment/RateInformation/RateChartIndicator
RateChartIndicator Required: No RateChartIndicator, if present in
Type: String request, response will contain
Max Allowed: 1 RateChart element.
Length: 0

/RatingServiceSelectionRequest/Shipment/RateInformation/UserLevelDiscountIndicator
UserLevelDiscountIndicator Required: No UserLevelDiscountIndicator - This is required to obtain
Type: String required to obtain rates for User User Level Discounts.
Max Allowed: 1 Level Promotions. There must also be no
Length: 0 ShipperNumber in the
Shipper container.

InvoiceLineTotal
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/InvoiceLineTotal

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 55
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

InvoiceLineTotal Required: Cond Container to hold Invoice Line Total Required if the shipment is
Type: Container Information. from US/PR Outbound to
Max Allowed: 1 non US/PR destination with
Length: N/A the PackagingType of UPS
PAK(04).

Required for international

shipments
when using request option
"ratetimeintransit" or
"shoptimeintransit".

/RatingServiceSelectionRequest/Shipment/InvoiceLineTotal/CurrencyCode
CurrencyCode Required: No Invoice Line Total currency type. Note: UPS doesn't support
Type: String Defaults to the rating currency used all international currency
Max Allowed: 1 in the shipper's country. If entered, codes. Please check the
Length: 3 the Currency code should match the developer guides for
origin country's currency code, Supported Currency codes.
otherwise the currency code entered
will be ignored.
/RatingServiceSelectionRequest/Shipment/InvoiceLineTotal/MonetaryValue
MonetaryValue Required: Yes* Invoice Line Total amount for the Valid values are from 1 to
Type: String shipment. 99999999
Max Allowed: 1
Length: 1..19

RatingMethodRequestedIndicator
Name Constraint Description Validation

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

TaxInformationIndicator
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/TaxInformationIndicator

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 56
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

TaxInformationIndicator Required: No Presence/Absence Indicator. Any If present, any taxes that

Type: String value inside is ignored. may be applicable to a
Max Allowed: 1 TaxInformationIndicator is an shipment would be returned
Length: 0 indicator. in response.

The Tax related information includes If this indicator is requested

any type of Taxes, corresponding with
Monetary Values, Total Charges NegotiatedRatesIndicator,
with Taxes and disclaimers (if Tax related information, if
applicable) would be returned in applicable, would be
response. returned only for
Negotiated Rates and not
for Published Rates.

PromotionalDiscountInformation
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/PromotionalDiscountInformation
PromotionalDiscountInformation Required: No PromotionalDiscountInformation
Type: Container container. This container contains
Max Allowed: 1 discount information that the
Length: N/A customer wants to request each time
while placing a shipment.

/RatingServiceSelectionRequest/Shipment/PromotionalDiscountInformation/PromoCode
PromoCode Required: Yes* Promotion Code. A discount that is Required if
Type: String applied to the user. PromotionalDiscountInform
Max Allowed: 1 ation container is present.
Length: 9
/RatingServiceSelectionRequest/Shipment/PromotionalDiscountInformation/PromoAliasCode
PromoAliasCode Required: Yes* Promotion Alias code Required if
Type: String PromotionalDiscountInform
Max Allowed: 1 ation container is present.
Length: 20

DeliveryTimeInformation
Name Constraint Description Validation

/RatingServiceSelectionRequest/Shipment/DeliveryTimeInformation
DeliveryTimeInformation Required: Cond Container for requesting Time In Required to view any time
Type: Container Transit Information. in transit information.
Max Allowed: 1
Length: N/A
/RatingServiceSelectionRequest/Shipment/DeliveryTimeInformation/PackageBillType

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 57
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

PackageBillType Required: Yes* Valid values: If DocumentsOnlyIndicator

Type: String 02 - Document only is selected, then
Max Allowed: 1 03 - Non-Document PackageBillType must be
Length: 2 04 - WWEF Pallet "02".
07 - Domestic Pallet
If 04 is included, Worldwide Express
Freight and UPS Worldwide Express
Freight Midday services (if
applicable) will be included in the
response.

/RatingServiceSelectionRequest/Shipment/DeliveryTimeInformation/Pickup
Pickup Required: No Pickup container.
Type: Container
Max Allowed: 1
Length: N/A

/RatingServiceSelectionRequest/Shipment/DeliveryTimeInformation/Pickup/Date
Date Required: No Shipment Date; The Pickup date is a If a date is not provided, it
Type: String Shipment Date and it is a required will be defaulted to the
Max Allowed: 1 input field. The user is allowed to current system date.
Length: 8 query up to 35 days into the past
and 60 days into the future. Format:
YYYYMMDD

/RatingServiceSelectionRequest/Shipment/DeliveryTimeInformation/Pickup/Time
Time Required: No Reflects the time the package is Invalid pickup time will not
Type: String tendered to UPS for shipping (can be validated.
Max Allowed: 1 be dropped off at UPS or picked up
Length: 4…6 by UPS).
Military Time Format HHMMSS or
HHMM.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 58
Rating Package XML Developer Guide January 8, 2018

RatingServiceSelectionResponse Top Level Containers

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 59
Rating Package XML Developer Guide January 8, 2018

RatingServiceSelectionResponse XPath Tables

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

RatingServiceSelectionResponse
Name Constraint Description Validation

/RatingServiceSelectionResponse
RatingServiceSelectionResponse Required: Yes Rating Service Selection
Type: Container Response container.
Max Allowed: 1
Length: N/A

Response
Name Constraint Description Validation

/RatingServiceSelectionResponse/Response
Response Required: Yes Response container.
Type: Container
Max Allowed: 1
Length: N/A

TransactionReference
Name Constraint Description Validation

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

/RatingServiceSelectionResponse/Response/TransactionReference/CustomerContext
CustomerContext Required: No Customer provided data. If this
Type: String data is present in the request, it is
Max Allowed: 1 echoed back to the customer.
Length: 0...512

ResponseStatusCode
Name Constraint Description Validation

/RatingServiceSelectionResponse/Response/ResponseStatusCode
ResponseStatusCode Required: Yes Identifies the success or failure of
Type: String the interchange.
Max Allowed: 1 1 = Success; 0 = Failure
Length: 1

ResponseStatusDescription
Name Constraint Description Validation

/RatingServiceSelectionResponse/Response/ResponseStatusDescription

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 60
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

ResponseStatusDescription Required: No Describes the Response Status

Type: String Code.
Max Allowed: 1
Length: 1...15

Error
Name Constraint Description Validation

/RatingServiceSelectionResponse/Response/Error
Error Required: No If an error is encountered during
Type: Container the interchange, the Response
Max Allowed: contains an error. If the error is
UNB present, then the ErrorSeverity
Length: N/A and ErrorCode are required.

/RatingServiceSelectionResponse/Response/Error/ErrorSeverity
ErrorSeverity Required: Yes* Describes the severity of the error.
Type: String (Hard or Transient)
Max Allowed: 1
Length: 1...15

/RatingServiceSelectionResponse/Response/Error/ErrorCode
ErrorCode Required: Yes* A numeric value that describes the
Type: String error. Each tool defines a range
Max Allowed: 1 of error codes. Based on the
Length: 1...15 current functionality only the first
error is returned and processing
terminates.

/RatingServiceSelectionResponse/Response/Error/ErrorDescription
ErrorDescription Required: No Describes the error code.
Type: String
Max Allowed: 1
Length: 1...50

/RatingServiceSelectionResponse/Response/Error/ElementLevelInformation
ElementLevelInformation Required: Cond Provides more information about Currently applies to and
Type: Container the element that represents the returned only for request
Max Allowed: 1 alert. containing HazMat and
Length: N/A SubVersion greater than
or equal to 1701.

/RatingServiceSelectionResponse/Response/Error/ElementLevelInformation/Level
Level Required: Yes* Define type of element in request. Possible values:
Type: String 'H’ = header details level
Max Allowed: 1 ‘S’ = shipment level
Length: 1 ‘P’ = package level
‘C’ = commodity level

/RatingServiceSelectionResponse/Response/Error/ElementLevelInformation/ElementIdentifier
ElementIdentifier Required: Cond Contains more information about Returned if Level is 'P' or
Type: Container the type of element. 'C'.
Max Allowed:
Unbounded
Length: N/A

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 61
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionResponse/Response/Error/ElementLevelInformation/ElementIdentifier/Code
Code Required: Yes* Represents the type of element. Possible values are 'P'
Type: String and 'C'.
Max Allowed: 1
Length: 1

/RatingServiceSelectionResponse/Response/Error/ElementLevelInformation/ElementIdentifier/Value
Value Required: Yes* Represents the value of element.
Type: String
Max Allowed: 1
Length: 1…5

/RatingServiceSelectionResponse/Response/Error/ErrorLocation
ErrorLocation Required: No Identifies the element in error.
Type: Container
Max Allowed:
UNB
Length: N/A

/RatingServiceSelectionResponse/Response/Error/ErrorLocation/ErrorLocationElementName
ErrorLocationElementName Required: No The Xpath name of the element in
Type: String error. This is a valid Xpath
Max Allowed: 1 pointing to an element in the
Length: 1...512 request document.

RatedShipment
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment
RatedShipment Required: Yes Container to hold Rated Shipment
Type: Container information.
Max Allowed: 1
Length: N/A

Disclaimer
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/Disclaimer

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 62
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

Disclaimer Required: Cond Disclaimer would be used to

Type: Container provide more information to
Max Allowed: shipper regarding the processed
UNB shipment.
Length: UNB 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.

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

/RatingServiceSelectionResponse/RatedShipment/Disclaimer/Description
Description Required: Yes* Disclaimer description.
Type: String Refer to Disclaimer Codes and
Max Allowed: 1 Messages in the
Length: UNB Appendix for valid values.

Service
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/Service
Service Required: Yes Container to hold UPS Service
Type: Container information that was rated.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/Service/Code
Code Required: Yes Rated shipment's UPS service.
Type: String
Max Allowed: 1
Length: 2

/RatingServiceSelectionResponse/RatedShipment/Service/Description
Description Required: No Rated shipment's UPS service
Type: String Description.
Max Allowed: 1
Length: 35

RateChart
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/RateChart

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 63
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

RateChart Required: Cond Rate Type With which Shipment is

Type: String rated. Possible RateChart values
Max Allowed: 1 for different regions will be:
Length: 1 US 48 origin:
1 – Daily Rates
3 – Standard List Rates
4 – Retail Rates
Alaska/Hawaii origin:
1 – Daily Rates
3 – Daily Rates
4 – Retail Rates
All Other origins:
1 – Rates
5 - Regional Rates
6 - General List Rates
3 and 4 do not apply.

RatedShipmentWarning
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/RatedShipmentWarning
RatedShipmentWarning Required: No Location of warning messages.
Type: String
Max Allowed: 1
Length: 150

BillableWeightCalculationMethod
Name Constraint Description Validation

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

RatingMethod
Name Constraint Description Validation

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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 64
Rating Package XML Developer Guide January 8, 2018

BillingWeight
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/BillingWeight
BillingWeight Required: Yes Container for Billable Weight
Type: Container information.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/BillingWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes Container to hold Unit of
Type: Container measurement for Billing Weight.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/BillingWeight/UnitOfMeasurement/Code
Code Required: Yes Code associated with the unit of
Type: String measure for the billable weight of
Max Allowed: 1 a shipment.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/BillingWeight/UnitOfMeasurement/Description
Description Required: No Description for the billable weight
Type: String associated with the shipment.
Max Allowed: 1
Length: 35

/RatingServiceSelectionResponse/RatedShipment/BillingWeight/Weight
Weight Required: Yes Value for the billable weight
Type: String associated with the shipment.
Max Allowed: 1
Length: 5

TransportationCharges
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/TransportationCharges
TransportationCharges Required: Yes Container to hold Transportaion
Type: Container Charges.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/TransportationCharges/CurrencyCode
CurrencyCode Required: No The IATA currency code
Type: String associated with the transportation
Max Allowed: 1 costs for the shipment.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/TransportationCharges/MonetaryValue
MonetaryValue Required: Yes The value for the transportation
Type: String costs associated with the
Max Allowed: 1 shipment.
Length: 16

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 65
Rating Package XML Developer Guide January 8, 2018

BaseServiceCharge
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/BaseServiceCharge
BaseServiceCharge Required: Cond Base Service Charge Container. These charges would be
Type: Container returned only when
Max Allowed: 1 subversion is greater
Length: N/A than or equal to 1701

/RatingServiceSelectionResponse/RatedShipment/BaseServiceCharge/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code
Type: String associated with the base service
Max Allowed: 1 charge costs for the shipment.
Length: 3
/RatingServiceSelectionResponse/RatedShipment/BaseServiceCharge/MonetaryValue
MonetaryValue Required: Yes* The base value of the specific
Type: String service for the shipment. This is
Max Allowed: 1 equal to transportation charges -
Length: 16 fuel surcharges.

ItemizedCharges
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned These charges would be
Type: Container only when the subversion element returned only when
Max Allowed: is present and greater than or subversion is greater
UNB equal to '1601'. than or equal to 1601
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized
Type: String charge.
Max Allowed: 1
Length: 3
/RatingServiceSelectionResponse/RatedShipment/ItemizedCharges/Description
Description Required: No Description of Itemized Charge
Type: String that had been charged.
Max Allowed: 1
Length: 1…50

/RatingServiceSelectionResponse/RatedShipment/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code
Type: String associated with the Itemized
Max Allowed: 1 Charge costs for the shipment.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* The value for Itemized Charge
Type: String costs associated with the
Max Allowed: 1 shipment.
Length: 16

/RatingServiceSelectionResponse/RatedShipment/ItemizedCharges/SubType

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 66
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

SubType Required: No The sub-type of Itemized Charge

Type: String type.
Max Allowed: 1
Length: 1…50

ServiceOptionsCharges
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/ServiceOptionsCharges
ServiceOptionsCharges Required: Yes Container to hold Service Options
Type: Container charges.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/ServiceOptionsCharges/CurrencyCode
CurrencyCode Required: No The IATA currency code
Type: String associated with the accessorial
Max Allowed: 1 charges for the shipment.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/ServiceOptionsCharges/MonetaryValue
MonetaryValue Required: Yes The value for the accessorial
Type: String charges associated with the
Max Allowed: 1 shipment.
Length: 16

TaxCharges
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/TaxCharges
TaxCharges Required: Cond TaxCharges container are
Type: Container returned only when
Max Allowed: TaxInformationIndicator is present
UNB in request and when Negotiated
Length: N/A Rates are not applicable.
TaxCharges container contains
Tax information for a given
shipment.

/RatingServiceSelectionResponse/RatedShipment/TaxCharges/Type
Type Required: Yes* Tax Type code. The code
Type: String represents the type of Tax applied
Max Allowed: 1 to a shipment.
Length: 1…9 Refer to Tax Type Values /
Abbreviations in the
Appendix for valid values.

/RatingServiceSelectionResponse/RatedShipment/TaxCharges/MonetaryValue
MonetaryValue Required: Yes* Tax Monetary Value represent the Valid values are from 0 to
Type: String Tax amount. 99999999999999.99
Max Allowed: 1
Length: 16

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 67
Rating Package XML Developer Guide January 8, 2018

TotalCharges
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/TotalCharges
TotalCharges Required: Yes Container to hold Total Charges.
Type: Container
Max Allowed: 1
Length: N/A
/RatingServiceSelectionResponse/RatedShipment/TotalCharges/CurrencyCode
CurrencyCode Required: No The IATA currency code
Type: String associated with the total charges
Max Allowed: 1 for the shipment.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/TotalCharges/MonetaryValue
MonetaryValue Required: Yes The value for the total charges
Type: String associated with the shipment.
Max Allowed: 1
Length: 16

TotalChargesWithTaxes
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/TotalChargesWithTaxes
TotalChargesWithTaxes Required: Cond TotalChargesWithTaxes container
Type: Container would be returned only if
Max Allowed: 1 TaxInformationIndicator is present
Length: N/A in request and when Negotiated
Rates are not applicable.
TotalChargesWithTaxes contains
total charges including total taxes
applied to a shipment.
/RatingServiceSelectionResponse/RatedShipment/TotalChargesWithTaxes/CurrencyCode
CurrencyCode Required: Yes* TotalChargesWithTaxes currency
Type: String code type. The currency code
Max Allowed: 1 used in the Shipment request is
Length: 3 returned.

/RatingServiceSelectionResponse/RatedShipment/TotalChargesWithTaxes/MonetaryValue
MonetaryValue Required: Yes* TotalChargesWithTaxes monetary Valid values are from 0 to
Type: String value amount. 99999999999999.99
Max Allowed: 1
Length: 16

RatedPackage
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/RatedPackage
RatedPackage Required: Yes Container to hold Package
Type: Container information.
Max Allowed: 200
Length: N/A

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 68
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/TransportationCharges
TransportationCharges Required: No Container to hold Transportaion
Type: Container Charges.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/TransportationCharges/CurrencyCode
CurrencyCode Required: No The IATA currency code
Type: String associated with the transportation
Max Allowed: 1 costs for the package.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/TransportationCharges/MonetaryValue
MonetaryValue Required: Yes* The value for the transportation
Type: String costs associated with the
Max Allowed: 1 package.
Length: 16

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/BaseServiceCharge
BaseServiceCharge Required: Cond Base Service Charge Container. These charges would be
Type: Container returned only when
Max Allowed: 1 subversion is greater
Length: N/A than or equal to 1701

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/BaseServiceCharge/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code
Type: String associated with the base service
Max Allowed: 1 charge costs for the shipment.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/BaseServiceCharge/MonetaryValue
MonetaryValue Required: Yes* The base value of the specific
Type: String service for the shipment. This is
Max Allowed: 1 equal to transportation charges -
Length: 16 fuel surcharges.

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/ServiceOptionsCharges
ServiceOptionsCharges Required: No Container to hold Service Options
Type: Container charges.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/ServiceOptionsCharges/CurrencyCode
CurrencyCode Required: No The IATA currency code
Type: String associated with the accessorial
Max Allowed: 1 charges for the package.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/ServiceOptionsCharges/MonetaryValue
MonetaryValue Required: Yes* The value for the accessorial
Type: String charges associated with the
Max Allowed: 1 package.
Length: 16

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/ItemizedCharges

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 69
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

ItemizedCharges Required: Cond Itemized Charges are returned These charges would be
Type: Container only when the subversion element returned only when
Max Allowed: is present and greater than or subversion is greater
UNB equal to '1607'. than or equal to 1601
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized
Type: String charge.
Max Allowed: 1
Length: 3

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/ItemizedCharges/Description
Description Required: No Description of Itemized Charge
Type: String that had been charged.
Max Allowed: 1
Length: 1…50

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code
Type: String associated with the Itemized
Max Allowed: 1 Charge costs for the shipment.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* The value for Itemized Charge
Type: String costs associated with the
Max Allowed: 1 shipment.
Length: 16

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/ItemizedCharges/SubType
SubType Required: No The sub-type of Itemized Charge
Type: String type.
Max Allowed: 1
Length: 1…50

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/TotalCharges
TotalCharges Required: No Container to hold Total Charges.
Type: Container
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/TotalCharges/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code
Type: String associated with the total charges
Max Allowed: 1 for the package.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/TotalCharges/MonetaryValue
MonetaryValue Required: Yes* The value for the total charges
Type: String associated with the package.
Max Allowed: 1
Length: 16

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/NegotiatedCharges

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 70
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

NegotiatedCharges Required: Cond Negotiated Rates container. These charges would be

Type: Container returned only when -
Max Allowed: 1 1) subversion is greater
Length: N/A than or equal to 1607
2) if negotiated rates
were requested for GFP
shipments and account
number is eligible to
receive negotiated rates.

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/NegotiatedCharges/ItemizedCharges
ItemizedCharges Required: Cond Negotiated Itemized Accessorial These charges would be
Type: Container and Sur Charges. returned only when
Max Allowed: subversion is greater
UNB than or equal to 1601
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/NegotiatedCharges/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized
Type: String charge.
Max Allowed: 1
Length: 3

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/NegotiatedCharges/ItemizedCharges/Description
Description Required: No Description of Itemized Charge
Type: String that had been charged.
Max Allowed: 1
Length: 1…50

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/NegotiatedCharges/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code
Type: String associated with the Itemized
Max Allowed: 1 Charge costs for the shipment.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/NegotiatedCharges/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* The value for Itemized Charge
Type: String costs associated with the
Max Allowed: 1 shipment.
Length: 16

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/NegotiatedCharges/ItemizedCharges/SubType
SubType Required: No The sub-type of Itemized Charge
Type: String type.
Max Allowed: 1
Length: 1…50

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/Weight
Weight Required: No Weight of the package in the rated
Type: String shipment.
Max Allowed: 1
Length: 5

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/BillingWeight

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 71
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

BillingWeight Required: No Container to hold Billing Weight

Type: Container information.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/BillingWeight/UnitOfMeasurement
UnitOfMeasurement Required: Yes* Container to hold Unit of
Type: Container measurement for Billing Weight.
Max Allowed: 1
Length: N/A
/RatingServiceSelectionResponse/RatedShipment/RatedPackage/BillingWeight/UnitOfMeasurement/Code
Code Required: Yes* Code associated with the unit of
Type: String measure for the billable weight of
Max Allowed: 1 a package.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/BillingWeight/UnitOfMeasurement/Description
Description Required: Yes* Description associated with the
Type: String unit of measure for the billable
Max Allowed: 1 weight of a package.
Length: 1..35

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/BillingWeight/Weight
Weight Required: Yes* Value for the billable weight
Type: String associated with the package.
Max Allowed: 1
Length: 5

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/Accessorial
Accessorial Required: Cond The container for Accessorial This is valid only for UPS
Type: Container indicators. This information would Worldwide Express
Max Allowed: be returned only if Freight and UPS
UNB ItemizedChargesRequested was Worldwide Express
Length: N/A present during Rate request. This Freight Middday Service.
is valid only for UPS Worldwide
Express Freight and UPS
Worldwide Express Freight Mid-
day service request with Dry Ice or
Oversize Pallet and SubVersion
greater than or equal to 1707.

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/Accessorial/Code
Code Required: Yes* Code for Accessorial Indicator.
Type: String
Max Allowed: 1
Length: 3

/RatingServiceSelectionResponse/RatedShipment/RatedPackage/Accessorial/Description
Description Required: No Description for Accessorial
Type: String Indicator.
Max Allowed: 1
Length: 1...50

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 72
Rating Package XML Developer Guide January 8, 2018

NegotiatedRates
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates
NegotiatedRates Required: Cond Container to hold Negotiated For tiered rates and
Type: Container Rates. promotional discounts, if
Max Allowed: 1 a particular shipment
Length: N/A based on zone, origin,
destination or even
shipment size doesn't
qualify for the existing
discount then no
negotiated rates
container will be
returned. Published rates
will be the applicable
rate.
/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/ItemizedCharges
ItemizedCharges Required: Cond Itemized Charges are returned These charges would be
Type: Container only when the subversion element returned only when
Max Allowed: is present and greater than or subversion is greater
UNB equal to '1601'. than or equal to 1601
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/ItemizedCharges/Code
Code Required: Yes* Identification code for itemized
Type: String charge.
Max Allowed: 1
Length: 3

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/ItemizedCharges/Description
Description Required: No Description of Itemized Charge
Type: String that had been charged.
Max Allowed: 1
Length: 1…50
/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/ItemizedCharges/CurrencyCode
CurrencyCode Required: Yes* The IATA currency code
Type: String associated with the Itemized
Max Allowed: 1 Charge costs for the shipment.
Length: 3

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/ItemizedCharges/MonetaryValue
MonetaryValue Required: Yes* The value for Itemized Charge
Type: String costs associated with the
Max Allowed: 1 shipment.
Length: 16

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/ItemizedCharges/SubType
SubType Required: No The sub-type of Itemized Charge
Type: String type.
Max Allowed: 1
Length: 1…50

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/TaxCharges

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 73
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

TaxCharges Required: Cond TaxCharges container are

Type: Container returned only when
Max Allowed: TaxInformationIndicator is present
UNB in request. TaxCharges container
Length: N/A contains Tax information for a
given shipment.

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/TaxCharges/Type
Type Required: Yes* Tax Type code. The code
Type: String represents the type of Tax applied
Max Allowed: 1 to a shipment.
Length: 1…9 Refer to Tax Type Values /
Abbreviations in the
Appendix for valid values.

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/TaxCharges/MonetaryValue
MonetaryValue Required: Yes* Tax Monetary Value represent the Valid values are from 0 to
Type: String Tax amount. 99999999999999.99
Max Allowed: 1
Length: 16

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/NetSummaryCharges
NetSummaryCharges Required: Cond Container to hold Net Summary
Type: Container charges.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/NetSummaryCharges/GrandTotal
GrandTotal Required: Cond Container to hold Grand Total
Type: Container charges.
Max Allowed: 1
Length: N/A
/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/NetSummaryCharges/GrandTotal/CurrencyCode
CurrencyCode Required: Yes* Net Summary charges currency
Type: String code type.
Max Allowed: 1
Length: 3

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/NetSummaryCharges/GrandTotal/MonetaryValue
MonetaryValue Required: Yes* Net Summary Grand Total
Type: String Charges for Account Based
Max Allowed: 1 Rating.
Length: 1..19

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/NetSummaryCharges/TotalChargesWithTaxes
TotalChargesWithTaxes Required: Cond TotalChargesWithTaxes container
Type: Container would be returned only if
Max Allowed: 1 TaxInformationIndicator is present
Length: N/A in request.
TotalChargesWithTaxes contains
total charges including total taxes
applied to a shipment.

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/NetSummaryCharges/TotalChargesWithTaxes/Currenc
yCode

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 74
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

CurrencyCode Required: Yes* TotalChargesWithTaxes currency

Type: String code type. The currency code
Max Allowed: 1 used in the Shipment request is
Length: 3 returned.

/RatingServiceSelectionResponse/RatedShipment/NegotiatedRates/NetSummaryCharges/TotalChargesWithTaxes/Monetar
yValue
MonetaryValue Required: Yes* TotalChargesWithTaxes value Valid values are from 0 to
Type: String amount. 99999999999999.99
Max Allowed: 1
Length: 16

TimeInTransit
Name Constraint Description Validation

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit
TimeInTransit Required: Cond Container for returned Time in Will only be returned if
Type: Container Transit information. request option was either
Max Allowed: 1 "ratetimeintransit" or
Length: N/A "shoptimeintransit" and
DeliveryTimeInformation
container was present in
request.

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/PickupDate
PickupDate Required: Yes* The date the user requests UPS In the event this Pickup
Type: String to pickup the package from the date differs from the
Max Allowed: 1 origin. Pickup date in the
Length: 8 Format: YYYYMMDD. Estimated Arrival
Container, a warning will
be returned.

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/DocumentsOnlyIndicator
DocumentsOnlyIndicator Required: Cond This is an Non-document. If the
Type: String indicator is present then the
Max Allowed: 1 shipment was processed as
Length: 0 Document Only.

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/PackageBillType
PackageBillType Required: Cond Package bill type for the shipment.
Type: String Valid values:
Max Allowed: 1 02 - Document only
Length: 2 03 - Non-Document
04 - Pallet

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary
ServiceSummary Required: Yes* Container for all available service
Type: Container information.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/Service

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 75
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

Service Required: Yes* Container for the the UPS service

Type: Container selected for a shipment.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/Service/Description
Description Required: No Optional. Description of service.
Type: String Example, UPS Next Day Air, UPS
Max Allowed: 1 Ground etc, as referenced by the
Length: 1..35 Service Code.

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/GuaranteedIndicator
GuaranteedIndicator Required: Cond Empty Tag. Indicates whether the
Type: String service will be guaranteed or not.
Max Allowed: 1 Required for International
Length: 0 Requests.

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/Disclaimer
Disclaimer Required: Cond The Disclaimer is provided based
Type: String upon the Origin and Destination
Max Allowed: 1 Country Codes provided in the
Length: UNB request document. The disclaimer
is returned as a conditional
statement to the validity of the
service being guaranteed. The
possible disclaimers that can be
returned are available in the
Service Guaranteed Disclaimers
table.
/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival
EstimatedArrival Required: Yes* Container for the Time-In-Transit
Type: Container arrival information by service. This
Max Allowed: 1 is the most accurate delivery
Length: N/A information available via the
Rating API and will reflect
changes in delivery schedules due
to peak business seasons or
holidays.

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/Arrival
Arrival Required: Yes* Container for date and time of
Type: Container arrival.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/Arrival/Date
Date Required: Yes* Scheduled Local Delivery Date.
Type: String Format: YYYYMMDD
Max Allowed: 1
Length: 8

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/Arrival/Time
Time Required: Cond The time UPS will pick up the
Type: String shipment. This is commit Time.
Max Allowed: 1 Military Time Format HHMMSS or
Length: 4...6 HHMM
/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/BusinessDaysInTransit

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 76
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

BusinessDaysInTransit Required: Yes* Number of business days from

Type: String Origin to Destination Locations.
Max Allowed: 1
Length: 1...5

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/Pickup
Pickup Required: Yes* The date and pick up time
Type: Container container.
Max Allowed: 1
Length: N/A

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/Pickup/Date
Date Required: Yes* The date UPS picks up the In the event the Pickup
Type: String package from the origin. date differs from the Ship
Max Allowed: 1 Format: YYYYMMDD. On Date, provided in the
Length: 8 request, a warning
message will be
returned.

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/Pickup/Time
Time Required: Cond The time UPS will pick up the
Type: String shipment. Military Time Format
Max Allowed: 1 HHMMSS or HHMM
Length: 4...6

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/DayOfWeek
DayOfWeek Required: Yes* Day of week for arrival.
Type: String Valid values are:
Max Allowed: 1 MON
Length: 1...9 TUE
WED
THUR
FRI
SAT
/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/CustomerCenterCutoff
CustomerCenterCutoff Required: Cond Customer Service call time.
Type: String Returned for domestic as well as
Max Allowed: 1 international requests.
Length: 1...6

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/DelayCount
DelayCount Required: Cond Number of days delayed at
Type: String customs. Returned for
Max Allowed: 1 International requests.
Length: 1...3
/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/HolidayCount
HolidayCount Required: Cond Number of National holidays
Type: String during transit. Returned for
Max Allowed: 1 International requests.
Length: 1...2
/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/RestDays
RestDays Required: Cond Number of rest days, i.e. non
Type: String movement. Returned for
Max Allowed: 1 International requests.
Length: 1...2
/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/EstimatedArrival/TotalTransitDays

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 77
Rating Package XML Developer Guide January 8, 2018

Name Constraint Description Validation

TotalTransitDays Required: Cond The total number of days in transit

Type: String from one location to the next.
Max Allowed: 1 Returned for International
Length: 1...5 requests.

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/SaturdayDelivery
SaturdayDelivery Required: No Saturday delivery information for a
Type: String service. Values are
Max Allowed: 1 1 - Saturday Delivery Available
Length: 1 with additional charges
0 - Saturday Delivery not available
or no additional charge, please
check Delivery Date to confirm if
the Delivery will be Saturday

Please see Saturday Delivery

business rules section for more
information.

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/ServiceSummary/SaturdayDeliveryDisclaimer
SaturdayDeliveryDisclaimer Required: No Saturday delivery disclaimer
Type: String message.
Max Allowed: 1
Length: UNB
/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/AutoDutyCode
AutoDutyCode Required: Cond Required output for International The possible values to be
Type: String requests. If Documents indicator is returned are:
Max Allowed: 1 set for Non-document a duty is 01 - Dutiable
Length: 2 automatically calculated. 02 - Non-Dutiable
03 - Low-value
04 - Courier Remission
05 - Gift
06 - Military
07 - Exception
08 - Line Release
09 - Section 321 low
value.

/RatingServiceSelectionResponse/RatedShipment/TimeInTransit/Disclaimer
Disclaimer Required: Cond The Disclaimer is provided based
Type: String upon the Origin and Destination
Max Allowed: 1 Country Codes provided in the
Length: N/A request document. The possible
disclaimers that can be returned
are available in the Service
Guaranteed Disclaimers table.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 78
Rating Package XML Developer Guide January 8, 2018

Chapter 5: Rating XML API Examples

Published Rates XML Request Example
<?xml version="1.0"?>
<AccessRequest xml:lang="en-US">
<AccessLicenseNumber>Your Access License</AccessLicenseNumber>
<UserId>Your User Id</UserId>
<Password>Your Password</Password>
</AccessRequest>
<?xml version="1.0"?>
<RatingServiceSelectionRequest xml:lang="en-US">
<Request>
<TransactionReference>
<CustomerContext>Your Customer Context</CustomerContext>
</TransactionReference>
<RequestAction>Rate</RequestAction>
<RequestOption>Rate</RequestOption>
</Request>
<Shipment>
<Shipper>
<Name>Shipper Name</Name>
<AttentionName>Shipper Attention Name</AttentionName>
<PhoneNumber>1234567890</PhoneNumber>
<FaxNumber>1234567890</FaxNumber>
<ShipperNumber>Your Shipper Number</ShipperNumber>
<Address>
<AddressLine1>Address Line 1</AddressLine1>
<City>City</City>
<StateProvinceCode>StateProvinceCode</StateProvinceCode>
<PostalCode>PostalCode</PostalCode>
<CountryCode>CountryCode</CountryCode>
</Address>
</Shipper>
<ShipTo>
<CompanyName>Ship To Company Name</CompanyName>
<AttentionName>Ship To Attention Name</AttentionName>
<PhoneNumber>1234567890</PhoneNumber>
<FaxNumber>1234567890</FaxNumber>
<Address>
<AddressLine1>Address Line 1</AddressLine1>
<City>City</City>
<StateProvinceCode>StateProvinceCode</StateProvinceCode>
<PostalCode>PostalCode</PostalCode>
<CountryCode>CountryCode</CountryCode>
</Address>
</ShipTo>
<ShipFrom>
<CompanyName>Ship From Company Name</CompanyName>
<AttentionName>Ship From Attention Name</AttentionName>
<PhoneNumber>1234567890</PhoneNumber>
<FaxNumber>1234567890</FaxNumber>
<Address>

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 79
Rating Package XML Developer Guide January 8, 2018

<AddressLine1>Address Line 1</AddressLine1>

<City>City</City>
<StateProvinceCode>StateProvinceCode</StateProvinceCode>
<PostalCode>PostalCode</PostalCode>
<CountryCode>CountryCode</CountryCode>
</Address>
</ShipFrom>
<Service>
<Code>59</Code>
<Description>2nd Day Air AM</Description>
</Service>
<Package>
<PackagingType>
<Code>02</Code>
<Description>UPS Package</Description>
</PackagingType>
<PackageWeight>
<UnitOfMeasurement>
<Code>LBS</Code>
</UnitOfMeasurement>
<Weight>5</Weight>
</PackageWeight>
<Dimensions>
<Length>10</Length>
<Width>5</Width>
<Height>7</Height>
</Dimensions>
</Package>
</Shipment>
</RatingServiceSelectionRequest>

Published Rates XML Response Example

<?xml version="1.0"?>
<RatingServiceSelectionResponse>
<Response>
<TransactionReference>
<CustomerContext>Your Customer Context</CustomerContext>
</TransactionReference>
<ResponseStatusCode>1</ResponseStatusCode>
<ResponseStatusDescription>Success</ResponseStatusDescription>
</Response>
<RatedShipment>
<Service>
<Code>59</Code>
</Service>
<RatedShipmentWarning>Your invoice may vary from the displayed reference
rates</RatedShipmentWarning>
<BillingWeight>
<UnitOfMeasurement>
<Code>LBS</Code>
</UnitOfMeasurement>
<Weight>5.0</Weight>
</BillingWeight>

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 80
Rating Package XML Developer Guide January 8, 2018

<TransportationCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>48.10</MonetaryValue>
</TransportationCharges>
<ServiceOptionsCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>0.00</MonetaryValue>
</ServiceOptionsCharges>
<TotalCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>48.10</MonetaryValue>
</TotalCharges>
<GuaranteedDaysToDelivery>2</GuaranteedDaysToDelivery>
<ScheduledDeliveryTime>10:30 A.M.</ScheduledDeliveryTime>
<RatedPackage>
<TransportationCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>48.10</MonetaryValue>
</TransportationCharges>
<ServiceOptionsCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>0.00</MonetaryValue>
</ServiceOptionsCharges>
<TotalCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>48.10</MonetaryValue>
</TotalCharges>
<Weight>5.0</Weight>
<BillingWeight>
<UnitOfMeasurement>
<Code>LBS</Code>
</UnitOfMeasurement>
<Weight>5.0</Weight>
</BillingWeight>
</RatedPackage>
</RatedShipment>
</RatingServiceSelectionResponse>

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 81
Rating Package XML Developer Guide January 8, 2018

Negotiated Rates XML Request Example

<?xml version="1.0"?>
<AccessRequest xml:lang="en-US">
<AccessLicenseNumber>Your Access License</AccessLicenseNumber>
<UserId>Your User Id</UserId>
<Password>Your Password</Password>
</AccessRequest>
<?xml version="1.0"?>
<RatingServiceSelectionRequest xml:lang="en-US">
<Request>
<TransactionReference>
<CustomerContext>Your Customer Context</CustomerContext>
</TransactionReference>
<RequestAction>Rate</RequestAction>
<RequestOption>Rate</RequestOption>
</Request>
<Shipment>
<RateInformation>
<NegotiatedRatesIndicator/>
</RateInformation>
<Shipper>
<Name>Shipper Name</Name>
<AttentionName>Shipper Attention Name</AttentionName>
<PhoneNumber>1234567890</PhoneNumber>
<FaxNumber>1234567890</FaxNumber>
<ShipperNumber>Your Shipper Number</ShipperNumber>
<Address>
<AddressLine1>Address Line 1</AddressLine1>
<City>City</City>
<StateProvinceCode>StateProvinceCode</StateProvinceCode>
<PostalCode>PostalCode</PostalCode>
<CountryCode>CountryCode</CountryCode>
</Address>
</Shipper>
<ShipTo>
<CompanyName>Ship To Company Name</CompanyName>
<AttentionName>Ship To Attention Name</AttentionName>
<PhoneNumber>1234567890</PhoneNumber>
<FaxNumber>1234567890</FaxNumber>
<Address>
<AddressLine1>Address Line 1</AddressLine1>
<City>City</City>
<StateProvinceCode>StateProvinceCode</StateProvinceCode>
<PostalCode>PostalCode</PostalCode>
<CountryCode>CountryCode</CountryCode>
</Address>
</ShipTo>
<ShipFrom>
<CompanyName>Ship From Company Name</CompanyName>
<AttentionName>Ship From Attention Name</AttentionName>
<PhoneNumber>1234567890</PhoneNumber>
<FaxNumber>1234567890</FaxNumber>
<Address>

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 82
Rating Package XML Developer Guide January 8, 2018

<AddressLine1>Address Line 1</AddressLine1>

<City>City</City>
<StateProvinceCode>StateProvinceCode</StateProvinceCode>
<PostalCode>PostalCode</PostalCode>
<CountryCode>CountryCode</CountryCode>
</Address>
</ShipFrom>
<Service>
<Code>59</Code>
<Description>2nd Day Air AM</Description>
</Service>
<Package>
<PackagingType>
<Code>02</Code>
<Description>UPS Package</Description>
</PackagingType>
<PackageWeight>
<UnitOfMeasurement>
<Code>LBS</Code>
</UnitOfMeasurement>
<Weight>5</Weight>
</PackageWeight>
<Dimensions>
<Length>10</Length>
<Width>5</Width>
<Height>7</Height>
</Dimensions>
</Package>
</Shipment>
</RatingServiceSelectionRequest>

Negotiated Rates XML Response Example

<?xml version="1.0"?>
<RatingServiceSelectionResponse>
<Response>
<TransactionReference>
<CustomerContext>Your Customer Context</CustomerContext>
</TransactionReference>
<ResponseStatusCode>1</ResponseStatusCode>
<ResponseStatusDescription>Success</ResponseStatusDescription>
</Response>
<RatedShipment>
<Service>
<Code>59</Code>
</Service>
<RatedShipmentWarning>Your invoice may vary from the displayed reference
rates</RatedShipmentWarning>
<BillingWeight>
<UnitOfMeasurement>
<Code>LBS</Code>
</UnitOfMeasurement>
<Weight>5.0</Weight>
</BillingWeight>

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 83
Rating Package XML Developer Guide January 8, 2018

<TransportationCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>48.10</MonetaryValue>
</TransportationCharges>
<ServiceOptionsCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>0.00</MonetaryValue>
</ServiceOptionsCharges>
<TotalCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>48.10</MonetaryValue>
</TotalCharges>
<GuaranteedDaysToDelivery>2</GuaranteedDaysToDelivery>
<ScheduledDeliveryTime>10:30 A.M.</ScheduledDeliveryTime>
<RatedPackage>
<TransportationCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>48.10</MonetaryValue>
</TransportationCharges>
<ServiceOptionsCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>0.00</MonetaryValue>
</ServiceOptionsCharges>
<TotalCharges>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>48.10</MonetaryValue>
</TotalCharges>
<Weight>5.0</Weight>
<BillingWeight>
<UnitOfMeasurement>
<Code>LBS</Code>
</UnitOfMeasurement>
<Weight>5.0</Weight>
</BillingWeight>
</RatedPackage>
<NegotiatedRates>
<NetSummaryCharges>
<GrandTotal>
<CurrencyCode>USD</CurrencyCode>
<MonetaryValue>106.50</MonetaryValue>
</GrandTotal>
</NetSummaryCharges>
</NegotiatedRates>
</RatedShipment>
</RatingServiceSelectionResponse>

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 84
Rating Package XML Developer Guide January 8, 2018

Chapter 6: Rating Package API FAQs

NOTE: Common FAQS are available in the Introduction to the UPS Developer Kit guide located in the Dev Kit.

Category Question Answer

3rd Party Billing Does the Rating Package API No, it does not support 3rd Party Billing.
support 3rd Party billing
requests?

Account How do I associate more than Contact your UPS Account Representative for assistance.
Number 99 account numbers with the
Limitation Shipping/Rating APIs?

Accessorials What accessorials does the Refer to the XPath section for a listing of supported
Rating API support? accessorials.

Choosing a Can a customer compare Yes. Use the “Shop” value, instead of the “Rate” value, in the
service services for a shipment using RequestOption element of the /Request container to retrieve
the Rating API? the rates for all services for the stated lane pair. The API
response will return a rate for each of the available services.
This is known as the Shop option.
The Rate option is used to request the rate for a specific UPS
service. The service must be defined in the request. The API
response will return the rate for the defined lane pairs for that
UPS service.
If a service is not valid for the defined lane pair, an error
response will be returned.

Currencies Does the Rating API return any Yes. A list of currencies and currency codes are available in the
currency other than USD? If so, appendix of this guide. The currency returned in the response
what currencies are supported? is based on the shipper’s country of origin.

Customer Are the rates that a customer The rate returned is determined by the Customer Classification
Classification gets via the Rating Package API Code selected in API.
Code the same as the rates they
receive at The UPS Store® Refer to the Rate Types Table and XPath for additional
locations or UPS Customer information.
Centers?

Delivery Area Does the Rating Package API Yes. However, it is included within the total transportation
Surcharge support Delivery Area charge in the rate response.
Surcharge?

Extended Area Is Extended Area Surcharge Yes. The Extended Area Surcharge (EAS) is returned with the
Surcharge included within the rating transportation charges.
response?
If EAS is applied to a shipment, a warning will be returned in
the XML response stating that an EAS has been added.

Freight LTL/Air Does Rating Package API No.

Freight support UPS Freight LTL or
UPS Air Freight services?

Fuel Surcharge Does the Rating Package API Yes, however it is not broken out separately, it is returned with
include fuel surcharge? other charges.

Ground Freight Does Rating API support ONLY the Rating Package Web Service version supports
Pricing Ground Freight Pricing (GFP)? Ground Freight Pricing.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 85
Rating Package XML Developer Guide January 8, 2018

Category Question Answer

Hundredweight Does Rating API support UPS Yes
(CWT) Hundredweight® Service
contracts?  ABR contract rates are based on the tier associated
with the UPS account number.
 The UPS Account number must be included in the rate
request.
 The ‘NegotiatedRatesIndicator’ must be sent in the
rate request.”
 UPS Hundredweight® published rates are no longer
available via the Rate API, only contract rates

International Does the Rating Package API Yes.

Extended Area support international extended
Surcharge area surcharges?

International Does the Rating Package API Yes. Requests are validated if the shipper number is from the
Rates support international rates? origin country.

Maximum What is the maximum number of When using the Rate option, there is a 200-package maximum
Packages packages that can be rated allowed for each API request. Each package container in the
Rated through the Rating Package request can contain 1 package.
API?
When using the Shop option, there is a 50-package maximum
limit allowed for each API request.

Negotiated Can a customer with a US Yes. However, the response will not return any negotiated or
Rates account number rate a package account-based rates. Negotiated and account-based rates
being shipped from another require the shipper’s country and the shipment country of origin
country? to be the same.
If you require negotiated or account-based rates from a country
outside the US, consider setting up an account in the non-US
country.

Negotiated How do I get negotiated rates? Contact your Account Representative.

Rates

Negotiated Does Rating API support Yes.

Rates/ABR Account Based Rating (ABR)?

Negotiated Is there a delay in activating a The availability of negotiated rates is dependent on the setup of
Rates or new or modified account in ABR your account.
Account Based for Rating or Shipping APIs?
Rates (ABR) If you have a pricing contract with UPS, please contact your
sales representative for proper setup. For additional
information, refer to Using Negotiated Rates in CIE.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 86
Rating Package XML Developer Guide January 8, 2018

Category Question Answer

Negotiated What do negotiated rates Negotiated rates include:
Rates or include?
Account Based  Basic incentives
Rates (ABR)  Performance tiered incentives
 Adjustments to performance tiered incentives are
automatically updated each week in each solution that
supports ABR.
 Ramp-ups on new contracts
 Multiple contracts (example: a shipper is attached to two or
more contracts).
 Custom rate charts (cell by cell)
 by weight
 by lane or zone
 Letter / Document rates
 Minimum billable weight for multi-piece shipments
 Per piece or per shipment
 Shipment pricing minimums
 Rate caps
 Import rates for international returns.
Note: Import rates are not available for Inbound shipments that
were shipped using Freight Collect billing.

Published & Can the Rating API provide both Yes.

Negotiated published and negotiated rates,
Rates (ABR) assuming ABR has been
Response activated, within the same
response?

Rate versus What is the difference between A “Rate” request returns the rate for a single service for each
Shop a "Rate" request and a "Shop" package, while a “Shop” request returns the rates for all
request? services available between a given origin/destination pair for
each package.

Rating for Web Are rates across all UPS Web Yes. The rates for other Web applications should not differ from
applications applications always the same? the Rating API. The only time rates would be different is if there
is a defect within the applications.
If a user questions rates returned by the Rating API, he could
generate the exact rate request on Calculate Time and Cost on
UPS.com, to confirm if rates are accurate.
Rates will differ if the user has negotiated rates set up with their
account number and is not sending a negotiated rates indicator
via the Rating API or does not have negotiated rates approved
to be used with the Rating API

Rating Does the Rating API return the Yes.

Scheduled time of day in its response?
Time

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 87
Rating Package XML Developer Guide January 8, 2018

Category Question Answer

Residential Does Rating API automatically UPS only classifies residential and commercial address
versus validate Residential verses classification for U.S. and Canada.
Commercial Commercial addresses?
If the residential indicator is included in the rate request, then
the shipment will be classified as residential. Upon processing,
if the address is classified by UPS differently that what is
provided in the request then a warning will be provided in the
response indicating that the classification was changed.

Return Does the Rating API support Yes.

Services Return Services?

Saturday Will the Rating allow a customer Since Saturday delivery is an accessorial, the customer must
Delivery to know if Saturday delivery is input this information in the Rating API rate request. If it is
available if they are shipping on available then the response will specify that the delivery will be
a Thursday? on Saturday.
The Rating API does not specify guaranteed delivery times.
Time in Transit API guarantees delivery times.

Shipping/ Can you ship and/or print labels No.

Labeling via the Rating Package API?

Suppression of Why does Rating API, Time in The Time in Transit API uses logic in its calculations and will
Service Types Transit API and Calculate Time suppress services that are more expensive if they will not
and Cost on UPS.com provide deliver the shipment any quicker than those shown in the
different results? Rating API.
There is a rule that states if ground service is as fast as or
faster than an air service, i.e., UPS 2nd Day Air®, then that air
service will be suppressed in the Time in Transit API response.
While the unlisted service is still a valid shipping option, the
customer could save money choosing from the listed services.

Testing and Are separate test IDs necessary No.

Production to access the test verses
environments production environment?

Time in Transit Does the Rating API support No. Time in Transit information can be obtained from the Time
Time in Transit results? in Transit API.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 88
Rating Package XML Developer Guide January 8, 2018

Appendices

Error Codes (XML)

When the UPS system is unable to respond to a request, be it from a malformed request, an illegal or invalid value, or
other issues, the API generates an error response. For examples and additional information on error responses, refer
to Chapter 3: Error Responses, in the Introduction to the UPS Developer Kit guide.
To discover errors, check the ResponseStatusCode element. A “1” normally indicates a successful response,
whereas a “0” indicates a Transient or Hard error. The PrimaryErrorCode element contains the error code and
description.
 Successful responses may or may not include warnings.
o Without warnings - Indicates the request has been processed as anticipated.
o With warnings - Indicates the request has been processed with potentially unanticipated results. The warning
contains information in the response that should be passed to the end user.
 The severity of an error may be transient or hard.
o Transient error - Indicates an error that is temporary in nature. Such errors may be caused by response
timeouts due to high server loads or scheduled maintenance in progress. The request may be issued
successfully at a later time.
o Hard error - Indicates the request has a problem that the system is not able to resolve. These errors are
critical and prevent requests from processing.

Do not resubmit requests with Hard Errors until the problems causing the error have been
resolved.

Common Error Codes

The following error codes can apply to all Webservice and other 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.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 89
Rating Package XML Developer Guide January 8, 2018

Code Severity Description

250002 Hard Invalid UserId/Password.

250003 Hard Invalid Access License number.

250004 Hard Incorrect UserId or Password.

250005 Hard No Access and Authentication Credentials provided.

250006 Hard The maximum number of user access attempts was exceeded.

250007 Hard The UserId is currently locked out; please try again in 30 minutes.

250009 Hard License Number not found in the UPS database.

250019 Hard Invalid Field value.

250050 Transient License system not available.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 90
Rating Package XML Developer Guide January 8, 2018

Rating Package XML Error Codes

HazMat Error Codes

For Dangerous Goods Acceptance Audit Pre-Check request, Streamline and Audit Pre-Check process is carried out
depending upon type of CommodityRegulatedLevelCode requested. Streamline process only applies to
CommodityRegulatedLevelCode FR and LQ. It doesn’t apply to EQ and LR.
 For CommodityRegulatedLevelCode FR and LQ, if Streamline process passes but Audit Pre-Check fails for
Dangerous Goods Acceptance Audit Pre-Check request, some of the following codes could be returned as
Warning.
 For CommodityRegulatedLevelCode FR and LQ, if Streamline process fails for Dangerous Goods Acceptance
Audit Pre-Check, the same warning codes could be returned as hard error.
 For CommodityRegulatedLevelCode LR and EQ, only Audit Pre-Check applies. Streamline process doesn’t apply.
Hence, for LR and EQ, it will be always hard error.

Error Code Severity Description

110070 Hard Missing or Invalid Quantity.

110071 Hard Missing or Invalid CommodityRegulatedLevelCode.

110072 Hard/Warning Missing or Invalid PackagingTypeQuantity.

110073 Hard Missing or Invalid TransportCategory.

110074 Hard Your UPS Account number is not authorized for Dangerous Goods shipments with
ADR RegulationSet.

110075 Hard Your UPS Account number is not authorized for Dangerous Goods shipments with
ADR RegulationSet and Fully Regulated RegulatoryQuantityCode.

110076 Hard Your UPS Account number is not authorized for Dangerous Goods shipments with
CFR RegulationSet.

110077 Hard Your UPS Account number is not authorized for Dangerous Goods shipments with
IATA RegulationSet.

110078 Hard Your UPS Account number is not authorized for Dangerous Goods shipments with
TDG RegulationSet.

110079 Hard Your UPS Account number is not authorized for Dangerous Goods shipments with
CAO TransportationMode.

110080 Hard Missing or Invalid QValue.

110081 Hard Missing or Invalid PackageIdentifier.

110082 Hard Missing or Invalid ChemicalRecordIdentifier.

110084 Warning Promotion Code was not applied since account had better discounts compared to
Promotion Code.

110086 Hard Missing or Invalid OriginRecordTransactionTimestamp.

111401 Hard Invalid regulation set. The regulation set for all chemical records in a package must
be the same.

111606 Hard SurePost is not compatible with Excepted Quantities of Dangerous Goods.

111607 Hard Fully Regulated or Limited Quantities of Dangerous Goods, Excepted Quantities of
Dangerous Goods, Lightly Regulated Lithium Batteries, or Dry Ice cannot be
combined in the same package.

111608 Hard Exceeded maximum number of chemicals in package : %package.index%

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 91
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

111609 Hard Mail Innovations is not compatible with Excepted Quantities of Dangerous Goods or
Lightly Regulated Lithium Batteries.

111010 Hard Dangerous Goods cannot be shipped using Return Services.

111611 Hard UPS Letters or UPS Envelopes are not compatible with Excepted Quantities of
Dangerous Goods or Lightly Regulated Lithium Batteries.

112089 Hard Missing or Invalid Chemical Record.

112091 Hard Missing or Invalid Regulation Set.

112092 Hard Missing or Invalid Class Division Number.

112093 Hard Missing or Invalid Transportation Mode.

112094 Hard Missing or Invalid ID number.

112102 Hard The shipment contains both Dry Ice and IDG packages. The Dry Ice package(s)
must use the regulation set associated with the IDG package(s).

112103 Hard The shipment contains both Dry Ice and IDG packages. The transportation mode
must be the same for Dry Ice and IDG packages.

112104 Hard Invalid regulation set. The regulation set for all IDG records in a package must be the
same.

112108 Hard Shipper is not eligible to ship HazMat.

112112 Hard Dangerous Goods cannot be shipped using UPS Import Control.

117059 Hard/Warning EmergencyContact is required when EmergencyPhone is provided.

117060 Hard/Warning Invalid EmergencyPhone. Emergency Phone Number must be a minimum of 10

characters with at least one numeric.

117061 Hard RegulationSet must be 49CFR or ADR when TransportationMode is Ground.

117064 Hard Black Powder (NA0027) cannot exceed 100 lbs per shipment.

117065 Hard Smokeless Powder (NA3178) cannot exceed 100 lbs per shipment.

117066 Hard/Warning TechnicalName is required for specified ProperShippingName.

117067 Hard TechnicalName is not allowed for this shipment.

117068 Hard/Warning Missing or Invalid ProperShippingName.

117069 Hard/Warning AdditionalDescription is required for this shipment.

117071 Hard Net Quantity indicated exceeds the allowed

maximum, based on chemical table validation.[][]

117072 Hard/Warning Packing Instruction specified does not match the packing instruction
expected, based on chemical table validation.[][]

117073 Hard/Warning Packing Instruction specified does not match the packing instruction expected, based
on chemical table validation. The packing instruction should be blank.

117074 Hard/Warning Package Type must be specified when the package is not Part of All Packed in One.

117075 Hard/Warning Net Quantity/TI must be specified.

117077 Hard Missing or Invalid UOM for a given Quantity.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 92
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

117078 Hard Net Quantity UOM:
XXX is Not Valid For IATA. Valid values are MT, G, KG, KG G, L, µG, ML, TI.[][]

117079 Hard Missing or Invalid PackagingGroupType for this shipment.

117080 Hard The Packing Group specified: XXX is invalid based on chemical table validation for
this UNID

117082 Hard Missing or Invalid SubRiskClass.

117083 Hard Lighter authentication (LAA) number required - Remarks must be entered or package
rejected.

117084 Hard TI Unit of Measure must be selected for Class Division Number 7.

117085 Hard/Warning Q Value must be N/A when there are no All Packed in One Basic Descriptions.

117086 Hard UPS does not offer Biological Substances, Category B service from the selected
origin country/postal code.

117087 Hard UPS does not offer service for the provided chemical record from the specified origin
country/postal code.

117088 Hard/Warning A single ChemicalRecord cannot be All Packed in One.

117089 Hard/Warning Overpack is required for a shipment with three ChemicalRecord where only two
ChemicalRecord are All Packed in One.

117090 Hard/Warning The APIO total net quantity exceeds the lowest permitted maximum net quantity.

117091 Hard The Net Quantity Weight exceeds the limit for the specified Risk Class, Sub Risk and
Packing Group combination. Risk Class 2.2 cannot exceed 75 KG.

117092 Hard The Net Quantity Weight exceeds the 25KG limit for the given specified
ClassDivisionNumber, SubRiskClass and PackingGroupType combination.

117093 Hard CAO Quantities of Class 1 Explosives are not allowed to the specified destination
country.

117094 Hard Unable to determine a single chemical record. Acceptance Audit Pre-Check cannot
be performed.

117095 Hard CAO Quantities of Class 1 Explosives are not allowed from the specified origin
country.

117096 Hard/Warning Invalid TunnelRestrictionCode for a given Hazardous material package using ADR
RegulationSet.

117097 Hard/Warning Invalid TransportCategory for a given Hazardous material package using ADR
RegulationSet.

117099 Hard Fully regulated commodities are prohibited to/from Great Britain for the specified
service level. Great Britain chunnel passage not allowed for fully regulated
commodities.

117101 Hard UPS does not offer dangerous goods for requested service from selected origin
country to selected destination country.

117104 Hard Unable to retrive the chemical record for selected (Regulation Set: XXX, UNNumber:
XXX and Hazard Class: XXX), validations cannot be performed for this commodity.

117105 Hard A ShipTo postal code is required to verify if dangerous goods service is available to
the selected destination country otherwise the shipment will be rejected.

117110 Hard Regulation Set is not valid for the destination country.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 93
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

117111 Hard UPS does not offer dangerous goods service from the selected Origin country/postal
code.

117113 Hard UPS does not offer dangerous goods service to the selected Destination
country/postal code.

117114 Hard/Warning Missing or Invalid PackagingType.

117115 Hard A ShipFrom PostalCode is required to verify if dangerous goods service is available
from the selected origin country, otherwise the shipment will be rejected.

117118 Hard UPS does not offer Dry Ice service from the selected origin country/postal code.

117119 Hard UPS does not offer Dry Ice service to the selected destination country/postal code.

117120 Hard UPS does not offer Biological Substance, Category B service to the selected
destination country/postal code.

117121 Hard UPS does not offer service for the specified chemical record to the selected
destination country/postal code.

117128 Hard UPS does not offer service for the specified Commodity Regulated Level Code
to selected Destination country.[XXX][]

117129 Hard UPS does not offer service for the specified Commodity Regulated Level
Code from the selected Origin country.[XXX][]

117130 Hard Requested TransportationMode indicates this item is forbidden, based on chemical
table validation.

117131 Hard Regulation Set is not valid for the origin country.

117132 Hard Excepted Quantities are not allowed from the selected origin country.

117133 Hard Excepted Quantities are not allowed to the selected destination country.

117135 Hard The specified origin country does not allow shipments CAO quantities of Dangerous
Goods.

117136 Hard The Transportation Mode for ADR regulation set must be Ground.

117137 Hard Mail Innovations is not a valid service for shipping all categories of dangerous goods.

117138 Hard SurePost is not a valid service for shipping all categories of dangerous goods other
than lightly regulated lithium batteries.

117139 Hard The specified destination country does not allow shipments containing CAO
quantities of Dangerous Goods.

117141 Hard As of January 1, 2017, UPS Policy requires that all air shipments containing lithium
ion and metal batteries packed alone to be transported as section I.A or I.B fully
regulated shipments. In addition, these changes also apply to UPS Ground service to
Alaska, Hawaii and Puerto Rico, and UPS Standard service to select locations
worldwide. Please refer to UPS.com for guidance to set up a UPS Dangerous Goods
service agreement.

117142 Hard Lightly regulated lithium batteries sent via SurePost cannot be shipped outside of the
US48.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 94
Rating Package XML Developer Guide January 8, 2018

10001 - 110600
Error 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 Hard 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

20004 Hard Cannot access the high level business components, {0}

20005 Hard Cannot access the low level business components, {0}

20006 Hard Invalid request action

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

20012 Hard The Client Information exceeds its Maximum Limit of {0}

110000 Hard Rating and Service Selection currently unavailable.

110001 Transient Rating and Service Selection temporarily unavailable.

110002 Hard No packages in shipment

110003 Hard Maximum number of packages exceeded

110004 Hard Package {0} is Void, which is not valid for the Rating and Service Selection service

110005 Hard This multi piece shipment contains one or more letters.

110006 Hard Two different shipment notification memos were provided at either the shipment- or
package-level. Only one memo is allowed per level.

110007 Hard {0}

110030 Transient Shipper, {0}, unrecognized or has not commissioned

110031 Hard Shipper data access error, {0}

110050 Hard Illegal RequestAction

110051 Hard Illegal RequestOption

110083 Hard Both the PromoAliasCode and the PromoCode are required.

Promotion Code was not applied since account had better discounts compared to
110084 Warning
Promotion Code.

110085 Warning Shipment is not eligible for Promotion Code.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 95
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

110103 Hard Invalid shipper address line 2

110104 Hard Invalid shipper address line 3

110105 Hard Missing Illegal Shipper/Address/City

110106 Hard Missing/Illegal Shipper/Address/StateProvCode

110107 Hard Missing/Illegal Shipper/PostalCode. {0}

110108 Hard Missing/Illegal Shipper/CountryCode

110109 Hard Missing Illegal Shipper/PhoneNumber

110110 Hard Missing/Illegal Shipper/AttentionName

110111 Hard Shipment/Shipper/EmailAddress cannot exceed a length of 50 characters

110112 Hard Shipment/Shipper/EmailAddress is an invalid format

110113 Hard Shipper number must contain alphanumeric characters only

110114 Hard Shipper/PhoneNumber/StructuredPhoneNumber/PhoneExtension cannot exceed the

length of 4.

110115 Hard Shipper/PhoneNumber must be at least 10 alphanumeric characters

110116 Hard Shipper/PhoneNumber/StructuredPhoneNumber/PhoneExtension must contain only

numbers

110117 Hard Shipper/PhoneNumber/StructuredPhoneNumber/PhoneExtension is only available if

the shipper is located in US, Puerto Rico or Canada

110118 Hard Shipper/PhoneNumber/StructuredPhoneNumber/PhoneExtension is only valid if a

phone number is given

110119 Hard Shipper phone number and phone extension together cannot be more than 15 digits
long

110120 Hard The country associated with Shipper/ShipperNumber must be the same as the
shipments origin country

110121 Hard Shipper/ShipperNumber is not an active account

110122 Hard Invalid Shipper/ShipperNumber

110200 Hard Missing/Illegal ShipTo/CompanyName

110201 Hard Missing/Illegal ShipTo/AttentionName

110202 Hard Missing/Illegal ShipTo/Address/AddressLine1

110203 Hard Illegal ShipTo/Address/AddressLine2

110204 Hard Illegal ShipTo/Address/AddressLine3

110205 Hard Missing/Illegal ShipTo/Address/City

110206 Hard Missing/Illegal ShipTo/Address/StateProvCode

110207 Hard Missing/Illegal ShipTo/Address/PostalCode. {0}

110208 Hard Missing/Illegal ShipTo/Address/CountryCode

110209 Hard Missing/Illegal ShipTo/PhoneNumber

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 96
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

110210 Hard Shipment/ShipTo/EmailAddress cannot exceed a length of 50 characters

110211 Hard Shipment/ShipTo/EmailAddress is an invalid format

110212 Hard ShipTo/PhoneNumber/StructuredPhoneNumber/PhoneExtension cannot exceed the

length of 4.

110213 Hard ShipTo/PhoneNumber must be at least 10 alphanumeric characters

110214 Hard ShipTo/PhoneNumber/StructuredPhoneNumber/PhoneExtension must contain only

numbers

110215 Hard ShipTo/PhoneNumber/StructuredPhoneNumber/PhoneExtension is only available if

the shipper is located in US, Puerto Rico or Canada

110216 Hard ShipTo/PhoneNumber/StructuredPhoneNumber/PhoneExtension is only valid if a

phone number is given

110217 Hard ShipTo phone number and phone extension together cannot be more than 15 digits
long

110300 Hard Missing/Illegal ShipFrom/CompanyName

110301 Hard Missing/Illegal ShipFrom/AttentionName

110302 Hard Missing/Illegal ShipFrom/Address/AddressLine1

110303 Hard Illegal ShipFrom/Address/AddressLine2

110304 Hard Illegal ShipFrom/Address/AddressLine3

110305 Hard Missing/Illegal ShipFrom/Address/City

110306 Hard Missing/Illegal ShipFrom/Address/StateProvCode

110307 Hard Missing/Illegal ShipFrom/Address/PostalCode. {0}

110308 Hard Missing/Illegal ShipFrom/Address/CountryCode

110309 Hard Missing/Illegal ShipFrom/PhoneNumber

110310 Hard Shipment/ShipFrom/EmailAddress cannot exceed a length of 50 characters

110311 Hard Shipment/ShipFrom/EmailAddress is an invalid format

110312 Hard ShipFrom/PhoneNumber/StructuredPhoneNumber/PhoneExtension cannot exceed

the length of 4.

110313 Hard ShipFrom/PhoneNumber must be at least 10 alphanumeric characters

110314 Hard ShipFrom/PhoneNumber/StructuredPhoneNumber/PhoneExtension must contain

only numbers

110315 Hard ShipFrom/PhoneNumber/StructuredPhoneNumber/PhoneExtension is only available

if the shipper is located in US, Puerto Rico or Canada

110316 Hard ShipFrom/PhoneNumber/StructuredPhoneNumber/PhoneExtension is only valid if a

phone number is given

110317 Hard The ShipFrom country must be the same as the Shipper country

110318 Hard ShipFrom phone number and phone extension together cannot be more than 15
digits long

110400 Hard The shipment is missing payment information.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 97
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

110500 Hard Missing/Illegal Service/Code

110501 Hard Invalid Shipment/ReferenceNumber/Value

110502 Hard InvoiceLineTotal/MonetaryValue must be greater than 0

110503 Hard Shipment/Description must not exceed the length of 35 characters

110504 Hard InvoiceLineTotal is not allowed for this shipment

110505 Hard Saturday Delivery Option cannot be used for this shipment

110506 Hard Invalid Shipment/ReferenceNumber/Code

110508 Hard Missing/Invalid ShipmentServiceOptions/Pickup/PickupDate

110509 Hard Invalid shipment declared value

110510 Hard Invalid/Missing ShipmentServiceOptions/ PickupDetails/ LatestPickupTime

110511 Hard Invalid ShipmentServiceOptions/PickupDetails/PickupDate or Invalid

ShipmentServiceOptions/PickupDetails/EarliestPickupTime or Invalid
ShipmentServiceOptions/PickupDetails/LatestPickupTime

110512 Hard Shipment/Description is required for this shipment.

110513 Hard The first Email Address used for Email Shipment Notification exceeds the maximum
length of 50 characters.

110514 Hard Invalid format for first Email Address used for Email Shipment Notification

110515 Hard ShipmentServiceOptions/ShipmentNotification/EMailMessage/Memo cannot exceed

the length of 150 characters

110516 Hard The first Email Address used for Email Shipment Notification is missing or contains
invalid characters

110517 Hard The second Email Address used for Email Shipment Notification exceeds the
maximum length of 50 characters

110518 Hard The format of the second Email Address entered in for Email Shipment Notification
is invalid

110519 Hard The second Email Address entered in for Email Shipment Notification is missing or
contains invalid characters

110520 Hard For a shipment, the maximum number of Email Addresses allowed for Email
Shipment Notifications is 2

110521 Hard For a shipment, the maximum number of Memos allowed for Email Shipment
Notifications is 1

110522 Hard Invalid Shipment/AlternateDeliveryTime

110523 Hard Shipment/DocumentsOnly is invalid with the shipments origin/destination pair

110524 Hard Package Pickup Request is not available with this shipments service

110525 Hard AlternateDeliveryTime must be between {0} and {1}

110526 Hard InvoiceLineTotal/MonetaryValue may not exceed the length of 8

110527 Hard Cannot use multiple types of currency in a shipment

110528 Hard A shipment can have only one type of UnitOfMeasurement for Dimensions

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 98
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

110529 Hard A shipment can have only one type of UnitOfMeasurement for a Weight

110530 Hard ShipmentServiceOptions/PickupDetails/SuiteRoomID length cannot exceed 8

characters

110531 Hard ShipmentServiceOptions/PickupDetails/FloorID length cannot exceed 3 characters

110532 Hard ShipmentServiceOptions/PickupDetails/Location length cannot exceed 11

characters

110533 Hard ShipmentServiceOptions/PickupDetails/EarliestTimeReady is required

110534 Hard ShipmentServiceOptions/PickupDetails/LatestTimeReady is required

110535 Hard ShipmentServiceOptions/PickupDetails/ContactInfo/Name is required

110536 Hard ShipmentServiceOptions/PickupDetails/ContactInfo/PhoneNumber is required

110537 Hard Invalid/Missing ShipmentServiceOptions/PickupDetails/ EarliestPickupTime

110539 Hard InvoiceLineTotal/MonetaryValue is required and must be a whole number

110541 Hard Shipment/ReferenceNumber is not allowed for this shipment

110542 Hard Package/ReferenceNumber is not allowed for this shipment

110543 Hard No more than 2 Shipment/ReferenceNumber can be given per shipment

110544 Hard No more than 2 Package/ReferenceNumber can be given per package

110545 Hard Shipment/Description is not valid with this shipment

110546 Hard {0} is not a valid unit of measurement for weight for this shipment

110547 Hard {0} is not a valid unit of measurement for dimensions for this shipment

110548 Hard A shipment cannot have a KGS/IN or LBS/CM as its unit of measurements

110549 Hard Invalid Shipment Weight

110600 Hard Missing/Invalid Package/PackagingType/Code

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 99
Rating Package XML Developer Guide January 8, 2018

110601 - 111200
Code Severity Description
110601 Hard Missing/Illegal Package/PackageWeight/Weight

110602 Hard Missing/Illegal Combination of Package/Dimensions

110603 Hard Illegal Package/Reference/Value

110604 Hard Invalid package declared value

110605 Hard Mismatch PackageDimensions/PackageType

110606 Hard Mismatch PackageDimensions/PackageType/PackageWeight

110607 Hard Illegal Package Reference/Code

110608 Hard Package/PackageWeight/Weight is required

110609 Hard All Package Dimensions are required and each must be greater than 0

110610 Hard The COD Amount is invalid. Please check the value entered

110611 Hard PackageServiceOptions/VerbalConfirmationContactInfo/Name cannot exceed a

length of 35

110612 Hard PackageServiceOptions/VerbalConfirmation/ContactInfo/PhoneNumber cannot

exceed the length of 15

110613 Hard PackageServiceOptions/VerbalConfirmation/ContactInfo/PhoneNumber must be at

least 10 alphanumeric characters

110614 Hard PackageServiceOptions/VerbalConfirmation/PhoneNumber/

StructuredPhoneNumber/PhoneExtension cannot exceed the length of 4

110615 Hard PackageServiceOptions/VerbalConfirmation/PhoneNumber/

StructuredPhoneNumber/PhoneExtension cannot exceed the length of 4

110616 Hard Package/PackageWeight/Weight cannot exceed a length of 5

110617 Hard Package declared value cannot exceed a value of 999

110618 Hard PackageServiceOptions/VerbalConfirmation/ContactInfo/ Name/ is required for

verbal confirmation of delivery

110619 Hard PackageServiceOptions/VerbalConfirmation/ContactInfo/ PhoneNumber is required

for verbal confirmation of delivery

110620 Hard Package/PackageWeight, Package/DimensionalWeight, Package/OversizePackage

and Package/Dimensions do not apply to UPS Envelopes

110621 Hard Package declared value cannot be greater than {0} {1}

110622 Hard Package/Description is required

110623 Hard Invalid Package/Description

110624 Hard A Return Shipment can only have one package

110625 Hard Invalid/Missing Package/ReturnService/Code

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 100
Rating Package XML Developer Guide January 8, 2018

Code Severity Description

110626 Hard Invalid COD Funds Code

110627 Hard Invalid COD Code

110628 Hard Invalid PackageServiceOptions/LabelDelivery/ EMailMessage/ReplyToEMailAddress

110629 Hard Invalid PackageServiceOptions/LabelDelivery/ EMailMessage/EMailAddress

110630 Hard Invalid PackageServiceOptions/LabelDelivery/

EMailMessage/UndeliverableEMailAddress

110631 Hard Invalid PackageServiceOptions/LabelDelivery/ EMailMessage/Memo

110632 Hard Invalid PackageServiceOptions/LabelDelivery /EMailMessage/Subject

110633 Hard Invalid PackageServiceOptions/PickupNotification/

EMailMessage/ReplyToEMailAddress

110634 Hard Invalid PackageServiceOptions/PickupNotification /EMailMessage/EMailAddress

110635 Hard Invalid PackageServiceOptions/PickupNotification/

EMailMessage/UndeliverableEMailAddress

110636 Hard Invalid PackageServiceOptions/PickupNotification/ EMailMessage/Memo

110637 Hard Invalid PackageServiceOptions/PickupNotification EMailMessage/Subject

110638 Hard Invalid PackageServiceOptions/ReturnNotification/

EMailMessage/ReplyToEMailAddress

110639 Hard Invalid PackageServiceOptions/ReturnNotification/ EMailMessage/EMailAddress[1]

110640 Hard Invalid PackageServiceOptions/ReturnNotification/ EMailMessage/EMailAddress[2]

110641 Hard Invalid PackageServiceOptions/ReturnNotification/

EMailMessage/UndeliverableEMailAddress

110642 Hard Invalid PackageServiceOptions/ReturnNotification/ EMailMessage/Memo

110643 Hard Invalid PackageServiceOptions/ReturnNotification/ EMailMessage/Subject

110644 Hard PackageServiceOptions/LabelDelivery is not valid with the shipments return service
type

110645 Hard PackageServiceOptions/PickupNotification is not valid with the shipments return

service

110646 Hard Package Level COD is not valid for the shipment origin and/or destination

110647 Hard Invalid COD currency code. Please use the destination country currency code.

110700 Hard Missing/Illegal LabelSpecification/LabelPrintMethod/Code

110701 Hard Missing/Illegal LabelSpecification/HTTPUserAgent

110702 Hard Missing/Illegal Label Specification/LabelImageFormat/Code

110703 Hard Missing/Illegal Combination of LabelSpecification/LabelStockSize

110704 Hard Missing/Invalid LabelSpecification/ LabelStockSize/Height

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 101
Rating Package XML Developer Guide January 8, 2018

Code Severity Description

110705 Hard Missing/Invalid LabelSpecification/ LabelStockSize/Wdth

110710 Hard Invalid package Delivery Confirmation type

110720 Warning The Account Number of FRS payment information is not FRS enabled.

110721 Hard Invalid Shipment Delivery Confirmation Type

110801 Hard Address Validation Error on Shipment/Shipper/Address

110802 Hard Address Validation Error on Shipment/ShipTo/Address

110803 Hard Address Validation Error on Shipment/ShipFrom/Address

110950 Hard Customer Classification Code is required with the requested Pickup Type

110971 Warning Your invoice may vary from the displayed reference rates

110984 Warning Exceeds maximum weight for rating the requested packaging. Standard package
rates apply

111000 Hard Verify that the supplied country code for the ship from and/or ship to is correct and is
in uppercase (Cannot locate site).

111005 Hard The COD option cannot be combined with the Return Services option.

111010 Hard Hazardous materials cannot be shipped using Return Services.

111015 Hard The Saturday Delivery option cannot be combined with the Return Services option.

111020 Hard The Delivery Confirmation option cannot be combined with the Return Services
option.

111025 Hard The maximum declared amount was exceeded.

111030 Hard Packages must weigh more than zero pounds.

111031 Hard Packages must weigh more than zero kg.

111035 Hard The maximum per package weight for that service from the selected country is
%country.maxPkgWeight% pounds.

111036 Hard The maximum per package weight for that service from the selected country is
%country.maxPkgWeight% kg.

111040 Hard The Return Services accessories are unavailable with the requested service.

111045 Hard The Saturday Delivery option is unavailable with the requested service.

111047 Hard Saturday Delivery may not be combined with this product and container type.

111050 Hard Package exceeds the maximum size total constraints of %maxLengthGirth% (length
+ girth where girth is 2 x width plus 2 x height).

111055 Hard Package exceeds the maximum length constraint of 108 inches.

111056 Hard This package exceeds the maximum length constraint of 274 cm.

111057 Hard This measurement system is not valid for the selected country.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 102
Rating Package XML Developer Guide January 8, 2018

Code Severity Description

111060 Hard Hazardous Materials cannot be shipped in a UPS Letter.

111063 Hard The requested accessory cannot be combined with the selected service.

111065 Hard The shipment of Hazardous Materials to the selected location is unavailable.

111070 Hard The requested accessory is not allowed with this pickup method.

111075 Hard The International Declared Value accessory is not valid with a domestic service.

111077 Hard {0}

111080 Hard The Domestic Declared Value accessory is not valid with an international service.

111085 Hard The requested accessory cannot be added to this shipment.

111086 Hard Only one Authorized Return Service option is allowed.

111087 Hard The Authorized Return Service option is not allowed for shipments.

111090 Hard The requested billing zone is invalid for the selected product.

111091 Hard The selected service is unavailable to an extended area.

111095 Hard A zone cannot be determined for the package

111100 Hard The requested service is invalid for the selected site.

111105 Hard The requested accessory key is invalid for the selected site.

111106 Hard Unsupported country specified.

111107 Hard An origin postal code must be specified.

111108 Hard Shipments must have at least 1 package.

111109 Hard Delivery Area Surcharge Tier is invalid.

111110 Hard Typically indicates a syntax error in the cfg file

111115 Hard The COD amount must be greater than zero.

111116 Hard The declared value amount must be greater than zero.

111120 Hard The COD amount cannot exceed $1,000 when a cashiers check or money order is
requested.

111121 Hard The COD value entered exceeds the maximum allowed for cash

111125 Hard The COD amount cannot exceed $50,000.

111126 Hard The COD value entered exceeds the maximum allowed for check

111128 Hard The Access Point COD amount cannot exceed %COD.APAmountMax%
%COD.APCurrencyDest%.

111129 Hard The currency of the Access Point COD amount must be the same as the Destination
country’s currency: %COD.APCurrencyDest%.

111130 Hard The Saturday Pickup option cannot be combined with the Return Services option.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 103
Rating Package XML Developer Guide January 8, 2018

Code Severity Description

111135 Hard The Saturday Pickup option cannot be combined with the Saturday Delivery option.

111140 Hard The Saturday Pickup option is unavailable with the selected service.

111145 Hard Only one Delivery Confirmation option is allowed.

111150 Hard The Delivery Confirmation option is unavailable with the selected service.

111155 Hard The COD option is unavailable with the selected service.

111160 Hard The requested accessory option is unavailable with the selected billing option.

111165 Hard The Verbal Confirmation of Delivery option cannot be combined with the Return
Services option.

111170 Hard The Delivery Confirmation option cannot be combined with the Verbal Confirmation
of Delivery option.

111175 Hard The Verbal Confirmation of Delivery option is unavailable with the selected service.

111180 Hard Consignee Billing is unavailable with the selected service.

111185 Hard The selected service is unavailable to the desired country

111190 Hard Only one Return Services option is allowed.

111194 Hard The requested billing option is unavailable with the selected packaging.

111195 Hard The requested billing option is unavailable with the selected service.

111196 Hard The requested billing option is unavailable with UPS Letters.

111200 Hard The requested service Saturday Delivery is unavailable to the selected location.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 104
Rating Package XML Developer Guide January 8, 2018

111201 - 111526
Error Code Severity Description
111201 Hard Invalid Service Code

111202 Hard Invalid Accessorial

111203 Hard Upsell unavailable

111205 Hard The Additional Handling option is unavailable with the selected service.

111206 Hard The Additional Handling option is unavailable with UPS Letters.

111209 Hard Invalid Service Type

111210 Hard The requested service is unavailable between the selected locations.

111211 Hard The requested accessory option is unavailable between the selected locations.

111212 Hard The requested type of container is unavailable between the selected locations.

111213 Hard The requested billing option is unavailable between the selected locations.

111214 Hard Cannot ship between the selected locations.

111215 Hard The requested service is unavailable to residential destinations.

111216 Hard No Services available

111217 Hard The requested service is unavailable between the selected locations

111218 Hard Unsupported Country

111219 Hard The requested service is unavailable between the selected locations. Please check
your Documents Only, Letter/Envelope, and Saturday Delivery settings as these may
affect service availability.

111220 Hard The Ship Notification option cannot be combined with the Return Services option.

111222 Hard A shipment using the Return Services Electronic Return Label option must contain
only Goods in Free Circulation.

111225 Hard The Return Services option is unavailable to the selected location.

111230 Hard Next Day Air Early is unavailable with the selected service.

111231 Hard Switzerland Domestic Container must weigh greater than or equal to 2 KG.

111232 Hard Worldwide Express Plus from Europe to Switzerland must be UPS Envelope or
document only.

111235 Hard No more than %acsGrp.grpLimit% of the following may be combined:

%acsGrp.grpMembers%.

111240 Hard The requested accessory may not be applied to a package more than %accs.limit%
time(s).

111245 Hard The Saturday Pickup option cannot be combined with the Shipper Duty Fees option.

111250 Hard The Saturday Delivery option cannot be combined with the Shipper Duty Fees
option.

111255 Hard The Shipper Duty Fee option is unavailable with the selected service.

111260 Hard The Shipper Duty Fee option is unavailable with the selected billing option.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 105
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

111261 Hard The requested option is unavailable with the selected service.

111262 Hard The accessory is not valid with the selected option.

111265 Hard The requested billing option is unavailable to the selected location.

111266 Hard The requested currency is not a legal tender in this country.

111275 Hard Cannot create attribute %attrName%.

111280 Hard Cannot remove attribute %attrName%.

111285 Hard The postal code %postal% is invalid for %state% %country%.

111286 Hard %state% is not a valid state abbreviation for %country%.

111290 Hard The requested billing option is invalid.

111295 Hard Package %child.index% failed validation in shipment.

111300 Hard The Shipper Pays Duty - VAT Unpaid option is unavailable with the selected option.

111305 Hard The Shipper Pays Duty - VAT Unpaid option is unavailable with the selected service.

111310 Hard The Shipper Pays Duty - VAT Unpaid option is unavailable with the selected billing
option.

111315 Hard The Authorized Return Service option is unavailable with the selected accessory.

111320 Hard The Authorized Return Service option is unavailable with the selected service.

111325 Hard The Authorized Return Service is unavailable with the selected billing option.

111330 Hard The Certificate of Origin is unavailable with the selected accessory.

111335 Hard The Certificate of Origin is unavailable with the selected service.

111340 Hard The Certificate of Origin is unavailable with the selected billing option.

111343 Hard The Certificate of Origin is unavailable from the selected origin.

111345 Hard The Shipper Export Declaration is unavailable with the selected accessory.

111350 Hard The Shipper Export Declaration is unavailable with the selected service.

111355 Hard The Shipper Export Declaration is unavailable with the selected billing option.

111360 Hard The Worldwide Express Plus is unavailable with the selected service.

111363 Hard The One Time Pickup is unavailable with the selected service.

111365 Hard The requested service is not available through the selected acquisition type.

111370 Hard Unsupported acquisition type.

111375 Hard The requested service is not valid for shipments with more than 1 package.

111380 Hard The requested Package service may not be consolidated with the selected shipment
service.

111385 Hard The requested Package billing option does not match the selected shipment billing
option.

111390 Hard The requested Package billing tier does not match the selected shipment billing tier.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 106
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

111395 Hard Package consignee %pkg.dest.company% does not match the shipment consignee
%ship.dest.company%.

111400 Hard Package consignee street address %pkg.dest.street1% does not match the
shipment consignee street address %ship.dest.street1%.

111405 Hard Package consignee street address %pkg.dest.street2% does not match the
shipment consignee street address %ship.dest.street2%.

111410 Hard Package consignee street address %pkg.dest.street3% does not match the
shipment consignee street address %ship.dest.street3%.

111415 Hard Package consignee city %pkg.dest.city% does not match the shipment consignee
city %ship.dest.city%.

111420 Hard Package consignee state %pkg.dest.state% does not match the shipment consignee
state %ship.dest.state%.

111425 Hard Package consignee postal code does not match the shipment consignee postal
code.

111430 Hard Package consignee country does not match the shipment consignee country.

111431 Hard All packages in the shipment must have the same UPS shipper number as the
shipment.

111435 Hard All packages in the shipment must have the Saturday Delivery option if 1 package
has it.

111440 Hard All packages in the shipment must have the Saturday Pickup option if 1 package has
it.

111445 Hard UPS does not allow Hazardous Materials in shipments consisting of more than one
piece.

111448 Hard UPS Proactive Response must be present on a Category A shipment.

111450 Hard Only one type of Return Service option is allowed per package.

111455 Hard All packages in the shipment must have the Return Services option if 1 package has
it.

111456 Hard All packages in the shipment must have the Residential option if 1 package has it.

111457 Hard Shipments with the Residential option set must have the Residential option set on all
packages.

111460 Hard Shipments cannot exceed a COD amount of $5000 when requesting a cashiers
check or money order.

111465 Hard The selected Package access method does not match the shipment access method.

111500 Hard Special rates are unavailable for the selected service using requested containers.

111501 Hard The selected container is not valid with the requested accessory option.

111502 Hard The selected country allows Return Services only

111510 Hard Unsupported container type requested.

111511 Hard Unsupported accessory requested.

111512 Hard Unsupported billing option requested.

111513 Hard Unsupported service requested.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 107
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

111515 Hard Weight of %weight.actual% exceeds maximum for rating the requested
container. Using standard package rates.

111519 Hard The selected Package rating category does not match the shipment rating category.

111526 Hard UPS Access Point Economy Service shipments must have a
ShipmentIndicationType of 01 or 02 or must be a Return shipment.

111530 - 115582
Error Code Severity Description

111530 Warning User level discount not valid

for this User ID.

111531 Warning No user level discount applied for this shipment.

111532 Warning User level discount not valid for this shipment.

111533 Warning User level discount not applied, another promotion has been applied.

111534 Warning User level discount applied to the shipment.

111535 Hard Invalid Origin Postal Code and City.

111536 Hard Invalid Origin Country Code.

111537 Hard Invalid Origin City.

111538 Hard Invalid Origin.

111539 Hard Invalid Destination Postal Code and City.

111540 Hard Invalid Destination Country Code.

111541 Hard Invalid Destination City.

111542 Hard Invalid Destination.

111543 Hard Missing or Invalid Pickup Date.

111544 Hard Pickup Date is out of allowable range.

111545 Hard Invalid Pickup Time.

111546 Hard Invalid Weight.

111547 Hard Weight is out of allowable range.

111548 Hard Invalid Weight Unit of Measure.

111549 Hard Invalid Shipment Contents Value.

111550 Hard Invalid Shipment Contents Currency Code.

111551 Hard Invalid Bill Type.

111552 Hard Invalid Duty Type.

111553 Hard Invalid Residential Indicator.

111554 Hard Requested DropOffAtFacilityIndicator accessorial is valid with Bill type 04 only.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 108
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

111555 Hard Requested HoldForPickupIndicator accessorial is valid with Bill type 04 only.

111556 Hard Unable to determine origin for Time in Transit Information.

111557 Hard Unable to determine destination for Time in Transit Information.

111558 Hard Origin/Destination pair is invalid.

111559 Hard Origin or Destination Country Code invalid.

111560 Hard An Invalid Postal Code or City.

111561 Hard Missing or Invalid Package Bill Type.

111562 Hard No matching Rate and Transit times available.

111563 Hard Delivery Time Information Container is required for ratetimeintransit or

shoptimeintransit request options.

111564 Hard Package Bill Type 02 is required when indicating a Documents Only Shipment.

111570 Hard For Import Control movements, Bill Receiver is not a valid payer.

111571 Hard Bill Receiver is an invalid payer of an international return movement.

111572 Hard The payer of Duty and Tax charges is invalid for Split Duty VAT shipment.

111573 Hard GNIFC is not valid for Letters/Envelopes and documents with no commercial value.

111574 Hard Invalid Bill-To type.

111575 Hard Missing or Invalid Shipment Charge Type.

111576 Hard Missing or Invalid Account Number.

111577 Hard At least one Shipment Charge container must be present in the PaymentDetails
container.

111578 Hard A single payment method is required per shipment charge.

111579 Hard The payment details must be the same for both Transportation charges and Duty and
Tax charges when Bill to Shipper or Bill to Receiver is specified as the payer.

111580 Hard Missing or Invalid account number for Payment Details.

111581 Hard Country Code is required for Bill Third Party Shipment Charges.

111582 Hard Missing/Invalid InvoiceLineTotal Monetary Value

111583 Hard Missing or Invalid Bill Third Party Address Line.

111584 Hard Address container is required for Bill Third Party.

111585 Hard Missing or Invalid shipment payment method.

111586 Hard Bill to Shipper account number must be the same as Shipper account number.

111587 Hard The UPS account number specified for Transportation charges is invalid for Split Duty
VAT shipment.

111588 Hard Invalid SplitDutyVATIndicator.

111589 Hard The payer of Duty and Tax charges is not required for UPS Letter, Documents of No
Commercial Value or Qualified Domestic Shipments.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 109
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

111590 Hard No more than 3 Address Line are allowed for Bill Third Party address.

111591 Hard The payment method specified for Transportation charges is invalid for return service.

111592 Hard The payer of Transportation charges is invalid for Split Duty VAT shipment.

111593 Hard The payer of Transportation charges and the payer of Duty and Tax charges must not
be the same for Split Duty VAT shipment.

111594 Hard {0}

111595 Hard The UPS account number provided as the payment method cannot be billed, please
try another account.

111596 Hard Missing/Invalid PostalCode of payment account.

111597 Hard {0} The local Customer Service Center can be reached at 62-0807-1-877-877 to
arrange shipping services.

111598 Warning Time in Transit information unavailable.

111599 Hard Pickup container is required for ratetimeintransit or shoptimeintransit request options.

111600 Hard BillShipper payment method is not valid for this shipment.

111601 Hard Invalid DimWeight. No decimals are allowed in this field.

111602 Hard {0} The local Customer Service Center can be reached at 62-0807-1-877-877 to
arrange shipping services.

111603 Hard Payer of Transportation Charges is required.

111604 Hard Invalid sub-classification for SurePost less than 1LB service

111605 Hard Payer of Duties and Taxes is not required for a qualified domestic shipment.

111612 Hard Bill Third Party account or address is not required.

111613 Hard Consignee billing is only supported in US or Puerto Rico.

111614 Hard The requested service and lane combination requires a UPS account contract.

111615 Hard Invalid Origin Postal Code.

111616 Hard Invalid Destination Postal Code

111618 Hard Your UPS Account number is not authorized for shipping Proactive Response
Substances.

111619 Hard Your UPS Account number is not authorized for shipping Refrigerated Substances.

111630 Hard The requested accessorial is valid only for Hold for Pickup at UPS Access Point
shipment indication type.

111655 Hard The requested billing option/payment option is unavailable with the selected shipment
indication type for a shipment to a UPS Access Point.

112000 Hard Only one type of oversize can be set on a package

112001 Hard Oversize 1 (%overSize1MinWeight %) or Oversize 2 (%overSize2MinWeight %) or

Oversize 3 (%overSize3MinWeight %) waiver invalid.

112045 Hard The payer of transportation's country is not valid for Carbon Neutral shipments.

112050 Hard At least one rate information; either negotiated rates or rate chart indicator is required.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 110
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

112051 Hard Shipment total weight has exceeded the maximum shipment weight limit of 99,999.9
kgs or 99,999.9 pounds.

112052 Hard Total pieces in the shipment have exceeded the maximum allowed of 99,999 for a
shipment.

112053 Hard The number of pieces was not provided – Number of pieces in a shipment is required
to process the shipment.

112054 Hard Missing elements - Length, width and height are required for the pallet
%package.index% to process the shipment.

112055 Hard Exceeded maximum per pallet weight – The maximum per pallet weight for the
selected service from the selected origin is %maxWeightOrig% pounds.

112056 Hard Exceeded maximum per pallet weight – The maximum per pallet weight for the
selected service from the selected origin is %maxWeightOrig% kgs.

112057 Hard Exceeded maximum per pallet weight – The maximum per pallet weight for the
selected service to the selected destination is %maxWeightDest% pounds.

112058 Hard Exceeded maximum per pallet weight – The maximum per pallet weight for the
selected service to the selected destination is %maxWeightDest% kgs.

112059 Hard Exceeded maximum dimensions for a pallet - The maximum dimensions for a pallet
are %length% cm by %width% cm by %height% cm for the selected origin.

112060 Hard Exceeded maximum dimensions for a pallet - The maximum dimensions for a pallet
are %length% in by %width% in by %height% in for the selected origin.

112061 Hard Exceeded maximum dimensions for a pallet - The maximum dimensions for a pallet
are %length% cm by %width% cm by %height% cm for the selected destination.

112062 Hard Exceeded maximum dimensions for a pallet - The maximum dimensions for a pallet
are %length% in by %width% in by %height% in for the selected destination.

112063 Warning Please contact customer service center for capacity authorization.

112064 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.

112065 Hard Lift Gate for Pick Up accessorial is not allowed with Drop Off At UPS Facility
accessorial.

112066 Hard Lift Gate for Delivery accessorial is not allowed with Hold For Pick Up accessorial.

112067 Hard More than one type of insurance is not allowed for a shipment - only one type can
exist per shipment

112068 Hard The maximum declared amount was exceeded. Maximum value per pallet:
%maxDeclVal% %currencyCode%.

112082 Hard The maximum Dry Ice for a pallet/shipment is 200 kg or 440 lbs.

112083 Hard Invalid pallet dimensions, the length must be longer than the width.

112084 Hard Shipper is not eligible to ship Dry Ice.

112085 Hard Missing or Invalid Return Type.

112086 Hard Missing or Invalid Import Type.

112090 Hard Commercial Invoice Removal is valid only for Import Control shipments.

112091 Hard Missing or Invalid Regulation Set.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 111
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

112095 Hard DryIceWeight container with Dry Ice weight and UOM information is required for Dry
Ice.

112096 Hard Missing or Invalid Dry Ice Weight.

112097 Hard Missing or Invalid code for Dry Ice Unit of Measurement.

112098 Hard UnitOfMeasurement container with UOM code is required for Dry Ice.

112099 Hard Invalid Regulation Set. All packages with Dry Ice accessorial must contain the same
Regulation Set.

112100 Hard Invalid regulation set. The regulation set for non-US/PR origins/destinations should be
IATA.

112101 Hard Invalid weight. The Dry Ice weight is greater than the actual package weight.

112105 Hard Return and Import Shipment accessorial cannot be requested together in a shipment.

112106 Hard The Saturday Delivery option cannot be combined with the Return Services option.

112107 Hard The Saturday Delivery option cannot be combined with the UPS Import Control option.

112109 Hard Itemized Charges are not valid for this service.

112110 Hard Account is not authorized for UPS Exchange service.

112111 Hard Missing or Invalid Shipper Number.

112113 Hard UPS Account is not authorized for Hold for Pickup at UPS Access Point.

112114 Hard Alternate Delivery Address information is required for Hold for Pickup at UPS Access
Point.

112115 Hard The maximum declared value for Flexible Parcel Insurance has been exceeded.
Maximum value per package: %maxDeclVal% %currencyCode%.

112116 Hard The requested billing option is unavailable between the selected locations with the
selected options.

112117 Hard Package exceeds the maximum length constraint of

%rave.DTR_NAP_maxLength_IN% inches. Length is the longest side of a package.

112118 Hard Package exceeds the maximum length constraint of

%rave.DTR_NAP_maxLength_CM% cm. Length is the longest side of a package.

112119 Hard The maximum per package weight for the selected option is
%country.maxPkgWeight% pounds.

112120 Hard The maximum per package weight for the selected option is
%country.maxPkgWeight% kg.

112121 Hard Missing or Invalid Alternate Delivery Address Name.

112122 Hard Missing or Invalid Alternate Delivery Address Address Line 1.

112123 Hard Missing or Invalid Alternate Delivery Address Address Line 2.

112124 Hard Missing or Invalid Alternate Delivery Address Address Line 3.

112125 Hard Missing or Invalid Alternate Delivery Address City.

112126 Hard Missing or Invalid Alternate Delivery Address State/Province.

112127 Hard Missing or Invalid Alternate Delivery Address Postal Code.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 112
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

112128 Hard Missing or Invalid Alternate Delivery Address Country Code.

112129 Hard Missing or Invalid Shipment Indication Type.

112131 Hard Only 1 Shipment Indication Type allowed in a request.

112132 Hard Missing or Invalid Monetary value for Access point COD.

112133 Hard Missing or Invalid Currency code for Access point COD.

112134 Hard Alternate Delivery Address information is required for UPS Access Point Delivery.

112135 Hard The customs value entered exceeds the maximum allowed amount of $2300 USD or
$2500 CAD.

112136 Hard The Shipment Level Access Point COD option is unavailable with the selected service
and/or with the shipments origin/destination.

112137 Hard The Package Level Access Point COD is not valid for the shipment origin and/or
destination.

112138 Warning UPS Access Point Delivery Rates were applied to a shipment.

112139 Hard Request contains invalid data e.g. special characters etc. Please correct.

112140 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.

112141 Hard Your UPS Account number is not authorized for UPS Access Point Economy service
when selecting Returns.

112142 Warning The account used to create this shipment has Direct Delivery Only preference
selected.

112153 Warning Unregistered User

112154 Warning Full Rates Returned. Customer could not be found for that zip code.

112155 Warning Destination is a rural point.

113005 Hard A service may not guarantee Early arrival to dest.city dest.state dest.postal
dest.countryname;

113010 Hard A package in the shipment contains a warning.

113020 Hard {0}

113021 Hard {0}

113060 Warning The weight exceeds the limit for the UPS Letter/Envelope rate and will be rated using
the weight.

113109 Warning Packages not dropped off at a UPS Access Point location may incur additional cost
and/or transit time.

113138 Warning Shipper Number is not qualified to receive negotiated rates.

115581 Hard Unsupported Customer Classification Code

115582 Hard Invalid Customer Classification Code

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 113
Rating Package XML Developer Guide January 8, 2018

118400 - 190003
Error Code Severity Description
118400 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.

118401 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.

118402 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.

118403 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.

119001 Hard Additional Handling has automatically been set on Package %package.index%.

119002 Hard Extended Area surcharge applied.

119003 Hard The requested service may not guarantee Next Day arrival to the selected location.

119004 Hard Check the UPS Service Guide for supported Saturday delivery destinations within
the selected country.

119005 Hard The requested service may not guarantee Second Day arrival to the selected
location.

119006 Hard The Second Day Air service may not guarantee Second Day arrival to the selected
location.

119011 Hard The maximum declared value amount for the 1-Attempt option is $1,000

119012 Hard The maximum declared value amount for the Print and Mail option is $1,000.

119013 Hard The maximum declared value amount for the Print Return Label option is $1,000.

119014 Hard The maximum declared value amount for the Electronic Delivery option is $1,000.

119015 Hard The maximum declared value amount for the 3-Attempt option is $50,000.

119017 Hard Oversize 3 indicator has automatically been set on Package.

119018 Hard Oversize 3 does not apply, and has automatically been removed from Package.

119020 Warning When user indicated Residential indicator is different from AMS Classification.

119058 Hard Shipper Number {0} does not support pallet Contract Service.

119070 Hard Large Package Surcharge has been added to Package %package.index%.

119071 Hard Large Package indicator has been set and Large Package Surcharge has been
added to Package %package.index%.

119072 Hard Additional Handling has been removed. Large Package Surcharge has been;

119076 Hard All package types must be pallets.

119077 Warning A dimensional surcharge has been added to pallet {0}.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 114
Rating Package XML Developer Guide January 8, 2018

Error Code Severity Description

119078 Hard The maximum dimensions for a pallet are 200 cm by 160 cm by 120 cm.

119079 Hard The requested service is not valid with pallets with a weight greater than 1000kg.
Please select Dedicated Package Courier Same Day Service.

119080 Hard Pallet {0} exceeds maximum width.

119081 Hard Pallet {0} exceeds maximum height.

119082 Hard Pallet {0} exceeds maximum length.

119083 Hard Pallet {0} exceeds maximum weight.

120001 Hard XML Shipping System is unavailable, please try again later.

126098 Warning Account authentication is required to be completed to get negotiated rates.

150000 Hard Tracking service unavailable

190003 Warning Published rates are unavailable at this time

120902 Warning Negotiated rates cannot be returned without a valid account number.

New Error Codes

Error Code Severity Description
111448 Hard UPS Proactive Response must be present on a Category A shipment.

Your UPS Account number is not authorized for shipping Proactive Response
111618 Hard
Substances.

111619 Hard Your UPS Account number is not authorized for shipping Refrigerated Substances.

117143 Hard Emergency Response Info Provider must not match the Emergency Phone Number.

117144 Hard Emergency Phone Number contains an invalid entry.

The UPS Shipper Account number is invalid to be used as the Emergency Response
117145 Hard
Info Provider.

117146 Hard Technical Name must not match the Proper Shipping Name.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 115
Rating Package XML Developer Guide January 8, 2018

Accessorial / Surcharge Codes

Code Accessorial / Surcharge
100 ADDITIONAL HANDLING

110 COD

120 DELIVERY CONFIRMATION

121 SHIP DELIVERY CONFIRMATION

190 EXTENDED AREA

200 DRY ICE

201 ISC SEEDS

202 ISC PERISHABLES

203 ISC TOBACCO

204 ISC PLANTS

205 ISC ALCOHOLIC BEVERAGES

206 ISC BIOLOGICAL SUBSTANCES

207 ISC SPECIAL EXCEPTIONS

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

350 ELECTRONIC RETURN LABEL

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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 116
Rating Package XML Developer Guide January 8, 2018

Code Accessorial / Surcharge

402 SHIPPER RELEASE

403 CHECK TO SHIPPER

404 PROACTIVE MONITORING

405 GERMAN PICKUP

406 GERMAN ROAD TAX

407 EXTENDED AREA PICKUP

410 RETURN OF DOCUMENT

430 PEAK SEASON

431 LARGE PACKAGE SEASONAL SURCHARGE

432 ADDITIONAL HANDLING SEASONAL SURCHARGE

440 SHIP LARGE PACKAGE

441 CARBON NEUTRAL

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

464 EXCHANGE PRINT RETURN LABEL

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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 117
Rating Package XML Developer Guide January 8, 2018

Code Accessorial / Surcharge

541 DIRECT DELIVERY ONLY

541 NO ACCESS POINT

542 DELIVER TO ADDRESSEE ONLY

543 DIRECT TO RETAIL COD

544 RETAIL ACCESS POINT

546 ELECTRONIC PACKAGE RELEASE AUTHENTICATION

547 PAY AT STORE

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 118
Rating Package XML Developer Guide January 8, 2018

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
 EPI

Ship Delivery Confirmation Accessorial  Adult Signature Required

 Signature Required

Package Delivery Confirmation  Name and Date Required

Accessorial
 Signature and Date Required
 Adult Signature Required

Extended Area Surcharge  Alaska

 Hawaii
 Urban
 Rural
 Super Rural
 Super Urban
 Congested
 Suburban
 Extended Area Destination
 Base
 Remote
 Super Remote

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 119
Rating Package XML Developer Guide January 8, 2018

Accessorial/Surcharge SubType
Delivery Area Surcharge  Alaska Extended
 Hawaii Extended
 Urban
 Rural
 Rural Extended
 Metropolitan
 Congested Area
 Suburban

Extended Area Pickup Surcharge  Alaska

 Hawaii
 Urban
 Rural
 Super Rural
 Super Urban
 Congested
 Suburban
 Extended Area Origin

Peak Season Surcharge  Residentail_Seasonal_Surcharge

 Commercial_Seasonal_Surcharge
 CWT_ Residentail_Seasonal_Surcharge
 CWT_ Commercial_Seasonal_Surcharge

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 120
Rating Package XML Developer Guide January 8, 2018

COD Supported Countries

Rating and Shipping Package COD supported countries

Shipment Level

Country 1 9
Cash Check
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.

0 8 9
Country Check, Cash Cashier’s Check Personal Check
Cashier's Check Money Order
Money Order

Argentina (AR) Yes

Brazil (BR) Yes

Canada (CA) Yes Yes

Chile (CL) Yes

Mexico (MX) Yes

Puerto Rico (PR) Yes Yes

United States (US) Yes Yes

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 121
Rating Package XML Developer Guide January 8, 2018

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.

Destination Country Name Country Code Supported Supported

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

Azores A2 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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 122
Rating Package XML Developer Guide January 8, 2018

Destination Country Name Country Code Supported Supported

Forward Origin Return Origin
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

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 X

Cabo Verde CV

Cayman Islands KY X X

Central African Republic CF

Ceuta XC X

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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 123
Rating Package XML Developer Guide January 8, 2018

Destination Country Name Country Code Supported Supported

Forward Origin Return Origin
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

El Salvador SV X X

England EN X 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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 124
Rating Package XML Developer Guide January 8, 2018

Destination Country Name Country Code Supported Supported

Forward Origin Return Origin
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

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

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)

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 125
Rating Package XML Developer Guide January 8, 2018

Destination Country Name Country Code Supported Supported

Forward Origin Return Origin
Korea, South KR X X

Kosovo KV 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

Madeira A3 X

Malawi MW X X

Malaysia MY X X

Maldives MV

Mali ML X X

Malta MT X X

Marshall Islands MH

Martinique MQ

Mauritania MR X X

Mauritius MU X X

Mayotte YT

Melilla XL X

Mexico MX X X

Micronesia (Federated States of) FM

Moldova (Republic of) MD X

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 126
Rating Package XML Developer Guide January 8, 2018

Destination Country Name Country Code Supported Supported

Forward Origin Return Origin
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

Pitcairn PN

Poland PL X X

Ponape PO

Portugal PT X X

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 127
Rating Package XML Developer Guide January 8, 2018

Destination Country Name Country Code Supported Supported

Forward Origin Return Origin
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 X

Saint Croix (see Virgin Islands) C3 X

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 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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 128
Rating Package XML Developer Guide January 8, 2018

Destination Country Name Country Code Supported Supported

Forward Origin Return Origin
Swaziland SZ

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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 129
Rating Package XML Developer Guide January 8, 2018

Destination Country Name Country Code Supported Supported

Forward Origin Return Origin
Virgin Islands, US VI X X

Wales WL X X

Wallis and Futuna Islands WF

Yap YA

Yemen YE

Zambia ZM X X

Zimbabwe ZW X

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 130
Rating Package XML Developer Guide January 8, 2018

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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 131
Rating Package XML Developer Guide January 8, 2018

Country/Region Currency Name Currency Code

Bosnia and Herzegovina Convertible Marks BAM

Botswana Pula BWP

Bouvet Island Norwegian Krone NOK

Brazil Brazilian Real BRL

British Indian Ocean Territory US Dollar USD

Brunei Darussalam Brunei Dollar BND

Bulgaria Bulgarian Lev BGN

Burkina Faso CFA Franc BCEAO XOF

Burundi Burundi Franc BIF

Cambodia Riel KHR

Cameroon US Dollar USD

Canada Canadian Dollar CAD

Cape Verde Cape Verde Escudo CVE

Cayman Islands Cayman Islands Dollar KYD

Central African Republic CFA Franc BEAC XAF

Chad CFA Franc BEAC XAF

Chile Chilean Peso CLP

Chile Unidades de formento CLF

China Yuan Renminbi RMB

Christmas Island Australian Dollar AUD

Cocos (Keeling) Islands Australian Dollar AUD

Colombia Colombian Peso COP

Colombia Unidad de Valor Real COU

Comoros Comoro Franc KMF

Congo CFA Franc BEAC XAF

Congo, The Democratic Republic of Franc Congolais CDF

Cook Islands New Zealand Dollar NZD

Costa Rica Costa Rican Colon CRC

Côte Divoire CFA Franc BCEAO XOF

Croatia Croatian Kuna HRK

Cuba Cuban Peso CUP

Cyprus Euro EUR

Czech Republic Czech Koruna CZK

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 132
Rating Package XML Developer Guide January 8, 2018

Country/Region Currency Name Currency Code

Denmark Danish Krone DKK

Djibouti Djibouti Franc DJF

Dominica East Caribbean Dollar XCD

Dominican Republic Dominican Peso DOP

Ecuador US Dollar USD

Egypt Egyptian Pound EGP

El Salvador El Salvador Colon SVC

El Salvador US Dollar USD

Equatorial Guinea CFA Franc BEAC XAF

Eritrea Nakfa ERN

Estonia Euro EUR

Ethiopia Ethiopian Birr ETB

Falkland Islands (Malvinas) Falkland Islands Pound FKP

Faroe Islands Danish Krone DKK

Fiji Fiji Dollar FJD

Finland Euro EUR

France Euro EUR

French Guiana Euro EUR

French Polynesia CFP Franc XPF

French Southern Territories Euro EUR

Gabon CFA Franc BEAC XAF

Gambia Dalasi GMD

Georgia Lari GEL

Germany Euro EUR

Ghana Cedi GHS

Gibraltar Gibraltar Pound GIP

Greece Euro EUR

Greenland Danish Krone DKK

Grenada East Caribbean Dollar XCD

Guadeloupe Euro EUR

Guam US Dollar USD

Guatemala Quetzal GTQ

Guernsey Pound Sterling GBP

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 133
Rating Package XML Developer Guide January 8, 2018

Country/Region Currency Name Currency Code

Guinea Guinea Franc GNF

Guinea-Bissau Guinea-Bissau Peso GWP

Guinea-Bissau CFA Franc BCEAO XOF

Guyana Guyana Dollar GYD

Haiti Gourde HTG

Haiti US Dollar USD

Heard Island ond McDonald Islands Australian Dollar AUD

Holy See (Vatican City State) Euro EUR

Honduras Lempira HNL

Hong Kong Hong Kong Dollar HKD

Hungary Forint HUF

Iceland Iceland Krona ISK

India Indian Rupee INR

Indonesia Rupiah IDR

Iran (Islamic Republic of) Iranian Rial IRR

Iraq Iraqi Dinar IQD

Ireland Euro EUR

Israel New Israeli Sheqel ILS

Italy Euro EUR

Jamaica Jamaican Dollar JMD

Japan Yen JPY

Jersey Pound Sterling GBP

Jordan Jordanian Dinar JOD

Kazakhstan Tenge KZT

Kenya Kenyan Shilling KES

Kiribati Australian Dollar AUD

Korea, Democratic Peoples Republic of North Korean Won KPW

Korea, Republic of Won KRW

Kuwait Kuwaiti Dinar KWD

Kyrgyzstan Som KGS

Lao Peoples Democratic Republic Kip LAK

Latvia Euro EUR

Lebanon Lebanese Pound LBP

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 134
Rating Package XML Developer Guide January 8, 2018

Country/Region Currency Name Currency Code

Lesotho Rand ZAR

Lesotho Loti LSL

Liberia Liberian Dollar LRD

Libyan Arab Jamahiriya Libyan Dinar LYD

Liechtenstein Swiss Franc CHF

Lithuania Euro EUR

Luxembourg Euro EUR

Macao Pataca MOP

Macedonia, The Former Yugoslav Republic Denar MKD

of

Madagascar Malagascy Ariary MGA

Malawi Kwacha MWK

Malaysia Malaysian Ringgit MYR

Maldives Rufiyaa MVR

Mali CFA Franc BCEAO XOF

Malta Euro EUR

Marshall Islands US Dollar USD

Martinique Euro EUR

Mauritania Ouguiya MRO

Mauritius Mauritius Rupee MUR

Mayotte Euro EUR

Mexico Mexican Peso MXN

Mexico Mexican Unidad de Inversion (UID) MXV

Micronesia (Federated States of) US Dollar USD

Moldova, Republic of Moldovan Leu MDL

Monaco Euro EUR

Mongolia Tugrik MNT

Montenegro Euro EUR

Montserrat East Caribbean Dollar XCD

Morocco Moroccan Dirham MAD

Mozambique Metical MZN

Myanmar Kyat MMK

Namibia Rand ZAR

Namibia Namibian Dollar NAD

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 135
Rating Package XML Developer Guide January 8, 2018

Country/Region Currency Name Currency Code

Nauru Australian Dollar AUD

Nepal Nepalese Rupee NPR

Netherlands Euro EUR

Netherlands Antilles Netherlands Antillian Guilder ANG

New Caledonia CFP Franc XPF

New Zealand New Zealand Dollar NZD

Nicaragua Cordoba Oro NIO

Niger CFA Franc BCEAO XOF

Nigeria Naira NGN

Niue New Zealand Dollar NZD

Norfolk Island Australian Dollar AUD

Northern Mariana Islands US Dollar USD

Norway Norwegian Krone NOK

Oman Rial Omani OMR

Pakistan Pakistan Rupee PKR

Palau US Dollar USD

Panama Balboa PAB

Panama US Dollar USD

Papua New Guinea Kina PGK

Paraguay Guarani PYG

Peru Nuevo Sol PEN

Philippines Philippine Peso PHP

Pitcairn New Zealand Dollar NZD

Poland Zloty PLN

Portugal Euro EUR

Puerto Rico US Dollar USD

Qatar Qatari Rial QAR

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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 136
Rating Package XML Developer Guide January 8, 2018

Country/Region Currency Name Currency Code

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

Tajikistan Somoni TJS

Tanzania, United Republic of Tanzanian Shilling TZS

Thailand Baht THB

Timor-Leste US Dollar USD

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 137
Rating Package XML Developer Guide January 8, 2018

Country/Region Currency Name Currency Code

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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 138
Rating Package XML Developer Guide January 8, 2018

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 US50, PR, CA, VI) * border, worldwide)

*Refer to Country Codes in the Appendix.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 139
Rating Package XML Developer Guide January 8, 2018

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.

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 140
Rating Package XML Developer Guide January 8, 2018

HazMat Accessorial Code and SubType

UPS Worldwide Express Freight Service

Accessorial Code

Accessorial Code
HazMat Accessorial 199

SubType

Accessorial SubType
Freight IDG Class 9 Air Lithium C FLA

Freight IDG Class 9 Air Lithium FLI

Freight IDG Class 9 Cargo Quantity FZA

Freight IDG Class 9 Air FZI

Freight IDG Class 1-8 Air Cargo Quantity FNA

Freight IDG Class 1-8 Air FNI

Accessorial Charge Descriptor

Accessorial Charge Descriptor Description

HazMat Standard Charge STANDARD_CHARGE

HazMat Minimum Charge MINIMUM_CHARGE

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 141
Rating Package XML Developer Guide January 8, 2018

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 additional 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 Rico
 Undefined Countries
 All Countries

United States
Shipments originating in United States

Description Shipping Rating

UPS Standard 11 11

UPS Worldwide Express 07 07

UPS Worldwide Expedited 08 08

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 Ground 03 03

UPS Next Day Air 01 01

UPS Next Day Air Early 14 14

UPS Next Day Air Saver 13 13

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 142
Rating Package XML Developer Guide January 8, 2018

Canada
Description Category Shipping Rating
UPS Expedited Canadian domestic shipments 02 02

UPS Express Saver Canadian domestic shipments 13 13

UPS 3 Day Select Shipments originating in Canada to CA and US 48 12 12

UPS Access Point Economy Canadian domestic shipments 70 70

UPS Express Canadian domestic shipments 01 01

UPS Express Early Canadian domestic shipments 14 14

UPS Express Saver International shipments originating in Canada 65 65

UPS Standard Shipments originating in Canada (Domestic and Int’l) 11 11

UPS Worldwide Expedited International shipments originating in Canada 08 08

UPS Worldwide Express International shipments originating in Canada 07 07

UPS Worldwide Express Plus International shipments originating in Canada 54 54

UPS Express Early Shipments originating in Canada to CA and US 48 54 54

European Union
Description 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 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 Standard Shipments originating in Mexico 11 11

UPS Worldwide Express Plus Shipments originating in Mexico 54 54

UPS Worldwide Saver Shipments originating in Mexico 65 65

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 143
Rating Package XML Developer Guide January 8, 2018

Poland
Description Shipping Rating
UPS Access Point Economy Polish domestic shipments 70 70

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

UPS Expedited 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

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

Germany
Description Category Shipping Rating
UPS Express 12:00 German domestic shipments 74 74

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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 144
Rating Package XML Developer Guide January 8, 2018

Description Shipping Rating

UPS Worldwide Express Plus 54 54

UPS Worldwide Saver 65 65

All Countries
Shipments originating in All Countries

Description Shipping Rating

UPS Worldwide Express Freight 96 96

UPS Worldwide Express Freight Midday 71 71

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 145
Rating Package XML Developer Guide January 8, 2018

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

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 146
Rating Package XML Developer Guide January 8, 2018

SubVersion Details
Request Element Valid Values
/RateRequest/Request/SubVersion 1601, 1607, 1701, 1707, 1801

Rate Request Elements

UPS acknowledges HazMat aka Dangerous Goods functionality/elements in Rate API request only if SubVersion
value is greater than or equal to 1701 is present.

/RateRequest/Request/SubV New Request elements acknowledged in RateRequest

ersion
Greater than or equal to 1701 /Shipment/OriginRecordTransactionTimestamp
/Shipment/Package/PackageServiceptins/HazMat
/Shipment/Package/PackageServiceptins/HazMat/PackageIdentifier
/Shipment/Package/PackageServiceptins/HazMat/QValue
/Shipment/Package/PackageServiceptins/HazMat/verPackedIndicatr
/Shipment/Package/PackageServiceptins/HazMat/AllPackedInneIndicatr
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Chemic
alRecrdIdentifier
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/ClassDi
visinNumber
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/IDNumb
er
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Transprt
atinMde+G13
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Regulati
nSet
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Emerge
ncyPhne
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Emerge
ncyCntact
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Reprtabl
eQuantity
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/SubRisk
Class
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Packagi
ngGrupType
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Quantity
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/UM
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Packagi
ngInstructinCde
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/PrperSh
ippingName
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Technic
alName
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Additina
lDescriptin
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Packagi
ngType
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/HazardL
abelRequired
/Shipment/Package/PackageServiceptins/HazMat/HazMatChemicalRecrd/Packagi
ngTypeQuantity

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 147
Rating Package XML Developer Guide January 8, 2018

Rate Response Elements

/RateRequest/Request/SubV New Request elements acknowledged in RateResponse
ersion
Greater than or equal to 1601 /RatedShipment/ItemizedCharges
/RatedShipment/ItemizedCharges/Code
/RatedShipment/ItemizedCharges/Description
/RatedShipment/ItemizedCharges/CurrencyCode
/RatedShipment/ItemizedCharges/MonetaryValue
/RatedShipment/ItemizedCharges/SubType
/RatedShipment/NegotiatedRateCharges/ItemizedCharges
/RatedShipment/NegotiatedRateCharges/ItemizedCharges/Code
/RatedShipment/NegotiatedRateCharges/ItemizedCharges/Description
/RatedShipment/NegotiatedRateCharges/ItemizedCharges/CurrencyCode
/RatedShipment/NegotiatedRateCharges/ItemizedCharges/MonetaryValue
/RatedShipment/NegotiatedRateCharges/ItemizedCharges/SubType
Greater than or equal to 1607 /RatedShipment/RatedPackage/ItemizedCharges
/RatedShipment/RatedPackage/ItemizedCharges/Code
/RatedShipment/RatedPackage/ItemizedCharges/Description
/RatedShipment/RatedPackage/ItemizedCharges/CurrencyCode
/RatedShipment/RatedPackage/ItemizedCharges/MonetaryValue
/RatedShipment/RatedPackage/ItemizedCharges/SubType
/RatedShipment/RatedPackage/NegotiatedCharges
/RatedShipment/RatedPackage/NegotiatedCharges/ItemizedCharges
/RatedShipment/RatedPackage/NegotiatedCharges/ItemizedCharges/Code
/RatedShipment/RatedPackage/NegotiatedCharges/ItemizedCharges/Description
/RatedShipment/RatedPackage/NegotiatedCharges/ItemizedCharges/CurrencyCo
de
/RatedShipment/RatedPackage/NegotiatedCharges/ItemizedCharges/MonetaryVal
ue
/RatedShipment/RatedPackage/NegotiatedCharges/ItemizedCharges/SubType
1701 and greater /RatedShipment/BaseServiceCharge
/RatedShipment/BaseServiceCharge/CurrencyCode
/RatedShipment/BaseServiceCharge/MonetaryValue
/RatedShipment/RatedPackage/BaseServiceCharge
/RatedShipment/RatedPackage/BaseServiceCharge/CurrencyCode
/RatedShipment/RatedPackage/BaseServiceCharge/MonetaryValue
1707 and greater /RatedShipment/RatedPackage/Accessorial
/RatedShipment/RatedPackage/Accessorial/Code
1801 and greater /Fault/detail/Errors/ElementLevelInformation
/Fault/detail/Errors/ElementLevelInformation/Level
/Fault/detail/Errors/ElementLevelInformation/ElementIdentifier
/Fault/detail/Errors/ElementLevelInformation/ElementIdentifier/Code
/Fault/detail/Errors/ElementLevelInformation/ElementIdentifier/Value

© 2018 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 148