Rating - Package

RESTful Developer Guide

October 22, 2024.

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.

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

Disclaimer
UPS Freight Less-than-Truckload (“LTL”) transportation services are offered by TFI International Inc., its
affiliates or divisions (including without limitation TForce Freight), which are not affiliated with United Parcel
Service, Inc. or any of its affiliates, subsidiaries or related entities (“UPS”). UPS assumes no liability in
connection with UPS Freight LTL transportation services or any other services offered or provided by TFI
International Inc. or its affiliates, divisions, subsidiaries or related entities.

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

Chapter 2: Understanding the Rating Package RESTful API ..................................................... 9

UPS Simple Rate Business Processes and Rules ............................................................................. 10

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

Integration Testing and Production URLs .......................................................................................... 12

Chapter 4: Rating Package RESTful API Elements and Details ................................................ 13

Header..................................................................................................................................................... 14
URL .................................................................................................................................................... 14
URL Parameters ................................................................................................................................ 14
Query Parameters .............................................................................................................................. 15
Request................................................................................................................................................... 16
RateRequest ...................................................................................................................................... 16
Response................................................................................................................................................ 45
RateResponse ................................................................................................................................... 45
API Sample Scenario ............................................................................................................................. 64
Error Codes ............................................................................................................................................ 68
HTTP Status Codes ........................................................................................................................... 68
Common Error Codes ........................................................................................................................ 68
Rate Error Codes ............................................................................................................................... 68
Accessorial / Surcharge Codes ........................................................................................................... 86
Accessorial & Surcharge Subtypes.................................................................................................... 89
COD Supported Countries or Territories ............................................................................................ 92
Country or Territory Codes .................................................................................................................. 93
Currency Codes ................................................................................................................................... 102
Delivery Confirmation Origin-Destination Pairs ............................................................................... 110
Disclaimer Codes and Messages ....................................................................................................... 111
HazMat Accessorial Code and SubType ........................................................................................... 111
Service Codes ...................................................................................................................................... 112
United States.................................................................................................................................... 112
Canada ............................................................................................................................................. 113
European Union ............................................................................................................................... 113
Mexico .............................................................................................................................................. 113
Poland .............................................................................................................................................. 114
Puerto Rico ...................................................................................................................................... 114
Germany .......................................................................................................................................... 114
Unefined Countries or Territories ..................................................................................................... 114
All Countries or Territories ............................................................................................................... 115

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary iv
 Tax Type Values / Abbreviations ....................................................................................................... 115
Rating Package RESTful API FAQs ................................................................................................... 116
SubVersion Details .............................................................................................................................. 120
Rate Requests ................................................................................................................................. 120
Rate Responses............................................................................................................................... 122

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary v
Rating Package RESTful Developer Guide October 22, 2024.

Chapter 1: Introduction
This document contains implementation instructions for integrating the Rating Package RESTful API into your
application, service, or system.

In this guide, you will find:

• Rate functionality and business rules
• Header, URL, request and response elements
• Error response code descriptions

Intended Audience
• This guide is intended for developers who will be integrating the Rate 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.
• Web APIs
• 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.
• Chapter 3: Customer Integration Environment (CIE) contains information on UPS integration environments.
• Chapter 4: Rate API Elements and Details contains an overview of the containers and elements that comprise the
Rate request, Rate response and examples.
• Reference tables and error codes are located in the Appendices.

Technical Specifications

The application creating the return is a Java REST Web Service providing Interface to client applications in Support
of Chapter 3: Customer Integration Environment (CIE)

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 6
Rating Package RESTful Developer Guide October 22, 2024.

Release Features

October 2024
Description

XOLT Rate API (OAuth) will be able to support both the Published and Incented modifiers.

Subversion 2407 and greater to support the following Rate Response Containers/Elements

New Response Containers/Elements

• /RateResponse /RatedShipment/NegotiatedRateCharges/RateModifier
• /RateResponse /RatedShipment/NegotiatedRateCharges/RateModifier/ModifierType
• /RateResponse /RatedShipment/NegotiatedRateCharges/RateModifier/ModifierDesc
• /RateResponse /RatedShipment/NegotiatedRateCharges/RateModifier/Amount
• /RateResponse /RatedShipment/RatedPackage/NegotiatedCharges/RateModifier
• /RateResponse /RatedShipment/RatedPackage/NegotiatedCharges/RateModifier/ModifierType
• /RateResponse /RatedShipment/RatedPackage/NegotiatedCharges/RateModifier/ModifierDesc
• /RateResponse /RatedShipment/RatedPackage/NegotiatedCharges/RateModifier/Amount

September 2024

Description
Accessorial Code for Peak Surcharge.
• New Peak Surcharge Accessorials & codes added - Please refer to appendix for new codes.
• Accessorial & Surcharge Subtypes section updated to include New Peak Surcharge subtypes

July 2024

Description

New Global checkout Indicator added.

• Rate API changed to support incented rates if applicable for GLC rating request.
• Rate API enhanced to accept GlobalCheckoutIndicator as an indicator as part of
ShipmentServiceOptions in request.
• Rate API enhanced to pass “GLC” as an accessorial as part of shipment level accessorial container.

August 2023

Description

Updated Response Container/Element for RoarRateIndicator:

Current Response Containers/Elements:
• /RateResponse/RatedShipment/RoarRatedIndicator
New Response Containers/Elements:
• /RateResponse/RatedShipment/RateConstructTypeIndicator

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 7
Rating Package RESTful Developer Guide October 22, 2024.

February 2023

Description

• Rate Type table removed

• New Surepost Additional Handling options added

January 2023

Description

The Rate API will support future date quoting when Subversion 2205 is sent in the request (available only to API
customer with a contract).

Updated Request Containers/Elements

• /RateRequest/Shipment/DeliveryTimeInformation/Pickup/Date

New Response Containers/Elements

• /RateResponse/RatedShipment/ScheduledDeliveryDate
• /RateResponse/RatedShipment/RoarRatedIndicator

New Warning Codes - Please refer to the Appendix for error codes.

October 2022
Description

New subversion 2205 is being introduced to support the following Rate Request Containers/Elements
Updated Request Containers/Elements
• /RateRequest/Request/SubVersion

New Response Containers/Elements

• /RateResponse/RatedShipment/RatedPackage/RateModifier
• /RateResponse/RatedShipment/RatedPackage/RateModifier/ModifierType
• /RateResponse/RatedShipment/RatedPackage/RateModifier/ModifierDesc
• /RateResponse/RatedShipment/RatedPackage/RateModifier/Amount

New Error Codes - Please refer to the Appendix for error codes
Rate Types Table Update
• If negotiated rates are requested then the published rate returned will be those associated to the account
number, regardless of the CustomerClassification requested.

January 2022

Description

• Within the Extended Area Surcharge group, Congested is updated to Remote Area.
• Surcharge category of Peak Season Surcharge is updated to Peak/Demand Surcharge, and Subtypes
have been updated.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 8
Rating Package RESTful Developer Guide October 22, 2024.

Chapter 2: Understanding the Rating Package RESTful API

The Rating Package RESTul API is used when rating or shopping a shipment. The Rating Package RESTful 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 Package
RESTful API.
• Any customers/developers abusing or data mining the Rating Package RESTful 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 RESTful API provides published and negotiated rates.

Negotiated Rates
The Rating Package RESTful 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 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
Package RESTful
 API.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 9
Rating Package RESTful Developer Guide October 22, 2024.

 Make sure that all requests are identical when comparing shipping charges between applications and
APIs that provide UPS Negotiated Rates.
 Working through discrepancies requires knowledge of all parameters posted, defaults, numeric rounding,
and the rate table used by the applications being compared.
You can check your results against the UPS Calculate Time and Cost program: [Link]

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 Package RESTful 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).

 Saturday Delivery is available in select cities for the non-premium services of UPS Three Day Select and UPS
Ground. There is no additional charge for eligible residential destinations but a fee will apply for eligible
commercial destinations. To return ‘SaturdayDelivery’ in the response you must send a ‘Ratetimeintransit’ or
‘Shoptimeintransit’ request. For commercial destinations you may send a ‘Shoptimeintransit’ without the
‘SaturdayDelivery’ element. For Ratetimeintransit requests shipping to commercial addresses to return a service
level resulting in a Saturday Delivery, please add the ‘SaturdayDeliveryIndicator’ to the request.

UPS Simple Rate Business Processes and Rules

UPS Simple Rate enables shippers to use their own packaging to ship anywhere in the U.S. for a flat rate. UPS
Simple Rate offers five different rate options based on package size and is available for UPS Ground, UPS 2nd Day
Air, UPS 3 Day Select and Next Day Air Saver services. It includes guaranteed delivery complete with UPS tracking
and visibility.
UPS Simple Rate rates are exempt from residential, delivery area extended, delivery area, and fuel surcharge fees.
All other surcharges and value added accessorials apply.
• The following information describes business rules for UPS Simple Rate:
• Must not contain dangerous goods
• Shipment is prepaid
• Not valid for freight collect or third party shipments
• Only valid for a single piece shipment
• Up to 50 lbs.
• Simple Rate Box Descriptions:
• XS (Extra Small )
o Size Range: 1 to 100 cu in3
• S (Small)
o Size Range: 101 to 250 cu in3

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 10
Rating Package RESTful Developer Guide October 22, 2024.

• M (Medium)
o Size Range: 251 to 650 cu in3
• L (Large)
o Size Range: 651 to 1050 cu in3
• XL (Extra Large)
o Size Range: 1051 to 1728 cu in3

• Simple Rate is available within the U.S. 50 States

• Only Valid for the following services (code):
• UPS Ground (03)
• UPS 3 Day Select (12)
• UPS 2nd Day Air (02)
• UPS Next Day Air Saver (13)

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 11
Rating Package RESTful Developer Guide October 22, 2024.

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 API 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

Integration Testing and Production URLs

Testing: [Link]

Production: [Link]

Note that valid value of requestoption is Rate, Shop

Valid ersion values are v1, v1601, v1607, v1701, v1707, v1801

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 12
Rating Package RESTful Developer Guide October 22, 2024.

Chapter 4: Rating Package RESTful API Elements and Details

The following constraints applies to all APIs referenced in this developer guide.

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

Element constraints are defined as follows:

Name
The element or container name.

Constraints

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.
• Array – collection of values that allows to provide a list of values. An array begins with [ (left bracket) and ends
with ] (right bracket). Its values are separated by , (comma).
• Header – header parameter
• Path – URL path parameter
• Query – URL query parameter

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.

Description
A description of the element or container. Also any validation rules associated with the element/container.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 13
Rating Package RESTful Developer Guide October 22, 2024.

Header
Name Constraint Description
Required: Yes
transId An identifier unique to the
Type: Header
request.
Length: 32
Required: Yes
transactionSrc Identifies the client/source
Type: Header
application that is calling
Length: 512
Authorization: Access Key
Required: Yes obtained through on-
AccessLicenseNumber Type: Header boarding process. Contact
Length: 16 your UPS representative for
additional information.
Required: Yes
Username The customers MyUPS
Type: Header
username
Length: 16
Required: Yes
Password The customers MyUPS
Type: Header
password
Length: 26
Used to authorize the
Authentication Token Required: No access to API. Can be used
Type: Header in place of Username and
Password
Used to authorize the
Authorization Required: No access to API. Can be used
Type: Header in place of Username and
Password

URL
[Link]

URL Parameters
Name Constrint Description
Indicates Rate API to display the new release features in
Required: Yes Rate API response based on Rate release. See the New
version Type: Path section for the latest Rate release. Supported values: v1,
Length: 5 v1601, v1607, v1701, 1801 , 2205
Valid Values:
Rate = The server rates (The default Request option is
Rate if a Request Option is not provided).
Required: Yes
requestoption Type: Path Shop = The server validates the shipment, and returns
Length: 10 rates for all UPS products from the ShipFrom to the
ShipTo addresses.
Rate is the only valid request option for Ground Freight
Pricing requests.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 14
Rating Package RESTful Developer Guide October 22, 2024.

Query Parameters
Name Constrint Description
Valid Values:
Required: Yes timeintransit = The server rates with transit time
additionalinfo Type: Query information combined with requestoption in URL.
Length: 15
Rate is the only valid request option for Ground Freight
Pricing requests.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 15
Rating Package RESTful Developer Guide October 22, 2024.

Request

RateRequest
Name Constraint Description
{“RateRequest”: {}}
RateRequest Required: Yes RateRequest
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“PickupType”: {}}}
PickupType Required: No Pickup Type container tag.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“PickupType”: {“Code”: {}}}}
Code Required: Yes* Pickup Type Code.
Type: String
Max Allowed: 1 Valid values: 01 - Daily Pickup (Default - used when an
Length: 2 invalid pickup type code is provided) 03 - Customer
Counter 06 - One Time Pickup 19 - Letter Center 20 - Air
Service Center
Length is not validated. When negotiated rates are
requested, 07 (onCallAir) will be ignored.
Refer to the Rate Types Table in the Appendix for rate
type based on Pickup Type and Customer Classification
Code.
{“RateRequest”: {“CustomerClassification”: {}}}
CustomerClassification Required: No Customer classification container. Valid if ShipFrom
Type: Container country or territory is “US”
Max Allowed: 1
Length: N/A
{“RateRequest”: {“CustomerClassification”: {“Code”: {}}}}
Code Required: Yes* Customer classification code.
Type: String
Max Allowed: 1 Valid values:
Length: 2 00 - Rates Associated with Shipper Number
01 - Daily Rates
04 - Retail Rates
05 - Regional Rates
06 - General List Rates
07 - Alternative Zoning
08 - General List Rates II
09 - SMB Loyalty
10 - All Inclusive
11 - Value Bundle I
53 - Standard List Rates
Length is not validated.
{“RateRequest”: {“Shipment”: {}}}
Shipment Required: Yes Container for Shipment Information.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {Shipment”: {“OriginRecordTransactionTimestamp”: {}}}}
OriginRecordTransactionTi Required: No The time that the request was made from the originating
mestamp Type: String system. UTC time down to milliseconds. Example - 2016-
Max Allowed: 1 07-14T12:01:33.999
Length: N/A

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 16
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Applicable only for HazMat request and with subversion
greater than or equal to 1701
{“RateRequest”: {“Shipment”: {“Shipper”: {}}}}
Shipper Required: Yes Shipper container. Information associated with the UPS
Type: Container account number.
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Shipper”: {“Name”: {}}}}}
Name Required: No Shipper's name or company name.
Type: String
Max Allowed: 1 Length is not validated.
Length: 1…35
{“RateRequest”: {“Shipment”: {“Shipper”: {“ShipperNumber”: {}}}}}
ShipperNumber Required: Cond Shipper's UPS account number.
Type: String
Max Allowed: 1 A valid account number is required to receive negotiated
Length: 6 rates. Optional otherwise. Cannot be present when
requesting UserLevelDiscount.
{“RateRequest”: {“Shipment”: {“Shipper”: {“Address”: {}}}}}
Address Required: Yes Address Container.
Type: Container
Max Allowed: 1 If the ShipFrom container is not present then this address
Length: N/A will be used as the ShipFrom. If this address is used as
the ShipFrom, the shipment will be rated from this origin
address.
{“RateRequest”: {“Shipment”: {“Shipper”: {“Address”: {“AddressLine”: {}}}}}}
AddressLine Required: No Shipper's street address including name and number
Type: String (when applicable).
Max Allowed: 3
Length: 1…35 Maximum Occurrence should be three. Length is not
validated.
{“RateRequest”: {“Shipment”: {“Shipper”: {“Address”: {“City”: {}}}}}}
City Required: Cond Shipper's city.
Type: String
Max Allowed: 1 Required if country or territory does not utilize postal
Length: 1…30 codes. Length is not validated.
{“RateRequest”: {“Shipment”: {“Shipper”: {“Address”: {“StateProvinceCode”: {}}}}}}
StateProvinceCode Required: No Shipper's state code.
Type: String
Max Allowed: 1 Length is not validated.
Length: 2
{“RateRequest”: {“Shipment”: {“Shipper”: {“Address”: {“PostalCode”: {}}}}}}
PostalCode Required: Cond Shipper's postal code.
Type: String
Max Allowed: 1 Length is not validated.
Length: 1…9
{“RateRequest”: {“Shipment”: {“Shipper”: {“Address”: {“CountryCode”: {}}}}}}
CountryCode Required: Yes Country or Territory code. Refer to the Supported Country
Type: String or Territory Tables located in Appendix.
Max Allowed: 1
Length: 2
{“RateRequest”: {“Shipment”: {“ShipTo”: {}}}}
ShipTo Required: Yes Ship To Container
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“ShipTo”: {“Name”: {}}}}}
Name Required: No Destination attention name or company name.
Type: String
Max Allowed: 1 Length is not validated.
Length: 1…35
{“RateRequest”: {“Shipment”: {“ShipTo”: {“Address”: {}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 17
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Address Required: Yes Address Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“ShipTo”: {“Address”: {“AddressLine”: {}}}}}}
AddressLine Required: No Destination street address including name and number
Type: String (when applicable).
Max Allowed: 3
Length: 1…35 Max Occurrence can be 3. Length is not validated.
{“RateRequest”: {“Shipment”: {“ShipTo”: {“Address”: {“City”: {}}}}}}
City Required: Cond Destination city.
Type: String
Max Allowed: 1 Required if country or territory does not utilize postal
Length: 1…30 codes. Length is not validated.
Note: City is suggested when using Ratetimeintransit or
Shoptimeintransit request to ensure system accuracy
{“RateRequest”: {“Shipment”: {“ShipTo”: {“Address”: {“StateProvinceCode”: {}}}}}}
StateProvinceCode Required: Cond Destination state code.
Type: String
Max Allowed: 1
Length: 2
{“RateRequest”: {“Shipment”: {“ShipTo”: {“Address”: {“PostalCode”: {}}}}}}
PostalCode Required: Cond Destination postal code.
Type: String
Max Allowed: 1 Required if country or territory utilizes postal codes (i.e.
Length: 1…9 US and PR).
{“RateRequest”: {“Shipment”: {“ShipTo”: {“Address”: {“CountryCode”: {}}}}}}
CountryCode Required: Yes Destination country or territory code. Refer to the
Type: String Supported Country or Territory Tables located in the
Max Allowed: 1 Appendix.
Length: 2
{“RateRequest”: {“Shipment”: {“ShipTo”: {“Address”: {“ResidentialAddressIndicator”: {}}}}}}
ResidentialAddressIndicator Required: No Residential Address flag. This field is a flag to indicate if
Type: String the destination is a residential location. True if
Max Allowed: 1 ResidentialAddressIndicator tag exists; false otherwise.
Length: 0 This element does not require a value and if one is
entered it will be ignored.
Empty Tag
{“RateRequest”: {“Shipment”: {“ShipFrom”: {}}}}
ShipFrom Required: No Ship From Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“ShipFrom”: {“Name”: {}}}}}
Name Required: No Origin attention name or company name.
Type: String
Max Allowed: 1 Length is not validated.
Length: 1…35
{“RateRequest”: {“Shipment”: {“ShipFrom”: {“Address”: {}}}}}
Address Required: Yes* Type: Address container for Ship From.
Container Max
Allowed: 1 Length:
N/A
{“RateRequest”: {“Shipment”: {“ShipFrom”: {“Address”: {“AddressLine”: {}}}}}}
AddressLine Required: No The origin street address including name and number
Type: String (when applicable).
Max Allowed: 3
Length: 1…35 Length is not validated.
{“RateRequest”: {“Shipment”: {“ShipFrom”: {“Address”: {“City”: {}}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 18
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

City Required: Cond Origin city.
Type: String
Max Allowed: 1 Required if country or territory does not utilize postal
Length: 1…30 codes. Length is not validated.
{“RateRequest”: {“Shipment”: {“ShipFrom”: {“Address”: {“StateProvinceCode”: {}}}}}}
StateProvinceCode Required: Cond Origin state code.
Type: String
Max Allowed: 1 A StateProvinceCode and valid account number are
Length: 2 required when requesting negotiated rates. Otherwise the
StateProvinceCode is optional. If the
TaxInformationIndicator flag is present in the request, a
StateProvinceCode must be entered for tax charges to be
accurately calculated in the response.
{“RateRequest”: {“Shipment”: {“ShipFrom”: {“Address”: {“PostalCode”: {}}}}}}
PostalCode Required: Cond Origin postal code.
Type: String
Max Allowed: 1 Required if country or territory utilizes postal codes (e.g.
Length: 1…9 US and PR).
{“RateRequest”: {“Shipment”: {“ShipFrom”: {“Address”: {“CountryCode”: {}}}}}}
CountryCode Required: Yes* Origin country or territory code. Refer to the Supported
Type: String country or territory Tables located in the Appendix.
Max Allowed: 1
Length: 2 Required, but defaults to US.
{“RateRequest”: {“Shipment”: {“AlternateDeliveryAddress”: {}}}}
AlternateDeliveryAddress Required: Cond Alternate Delivery Address container. Applies for
Type: Container deliveries to UPS Access Point™ locations. Required for
Max Allowed: 1 the following ShipmentIndicationType values: 01 - Hold
Length: N/A for Pickup at UPS Access Point™ 02 - UPS Access
Point™ Delivery
{“RateRequest”: {“Shipment”: {“AlternateDeliveryAddress”: {“Name”: {}}}}}
Name Required: No UPS Access Point™ location name.
Type: String
Max Allowed: 1
Length: 1…35
{“RateRequest”: {“Shipment”: {“AlternateDeliveryAddress”: {“Address”: {}}}}}
Address Required: Yes* Address container for Alternate Delivery Address.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“AlternateDeliveryAddress”: {“Address”: {“AddressLine”: {}}}}}}
AddressLine Required: Yes* The UPS Access Point's street address, including name
Type: String and number (when applicable).
Max Allowed: 3
Length: 1…35 Length is not validated.
{“RateRequest”: {“Shipment”: {“AlternateDeliveryAddress”: {“Address”: {“City”: {}}}}}}
City Required: Cond UPS Access Point city.
Type: String
Max Allowed: 1
Length: 1…30
{“RateRequest”: {“Shipment”: {“AlternateDeliveryAddress”: {“Address”: {“StateProvinceCode”: {}}}}}}
StateProvinceCode Required: Cond UPS Access Point State or Province code.
Type: String
Max Allowed: 1
Length: 2
{“RateRequest”: {“Shipment”: {“AlternateDeliveryAddress”: {“Address”: {“PostalCode”: {}}}}}}
PostalCode Required: Cond UPS Access Point Postal code.
Type: String
Max Allowed: 1
Length: 1…9
{“RateRequest”: {“Shipment”: {“AlternateDeliveryAddress”: {“Address”: {“CountryCode”: {}}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 19
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

CountryCode Required: Yes* UPS Access Point country or territory code.
Type: String
Max Allowed: 1
Length: 2
{“RateRequest”: {“Shipment”: {“AlternateDeliveryAddress”: {“Address”: {“ResidentialAddressIndicator”: {}}}}}}
ResidentialAddressIndicator Required: No Presence/Absence Indicator. Any value inside is
Type: String [Link] field is a flag to indicate if the Alternate
Max Allowed: 1 Delivery location is a residential location. True if
Length: 0 ResidentialAddressIndicator tag exists.
{“RateRequest”: {“Shipment”: {“AlternateDeliveryAddress”: {“Address”: {“POBoxIndicator”: {}}}}}}
POBoxIndicator Required: No Presence/Absence Indicator. Any value inside is ignored.
Type: String This field is a flag to indicate if the Alternate Delivery
Max Allowed: 1 location is a PO box location. True if POBoxIndicator tag
Length: 0 exists; false otherwise.
Not valid with Shipment Indication Types: 01 Hold for
Pickup at UPS Access Point 02 UPS Access Point™
Delivery
{“RateRequest”: {“Shipment”: {“ShipmentIndicationType”: {}}}}
ShipmentIndicationType Required: Cond Container to hold shipment indication type.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“ShipmentIndicationType”: {“Code”: {}}}}}
Code Required: Yes* Code for Shipment Indication Type. Valid valuese: 01 -
Type: String Hold for Pickup at UPS Access Point 02 - UPS Access
Max Allowed: 1 Point™ Delivery
Length: 2
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {}}}}
PaymentDetails Required: No Payment details container for detailed shipment charges.
Type: Container The two shipment charges that are available for
Max Allowed: 1 specification are Transportation charges and Duties and
Length: N/A Taxes.
This container is used for Who Pays What functionality
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {}}}}}
ShipmentCharge Required: Yes* If Duty and Tax charges are applicable to a shipment and
Type: Container a payer is not specified, the default payer of Duty and Tax
Max Allowed: 2 charges is Bill to Receiver. There will be no default payer
Length: N/A of Duty and Tax charges for DDU and DDP service.
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“Type”: {}}}}}}
Type Required: Yes* Values are 01 = Transportation, 02 = Duties and Taxes
Type: String
Max Allowed: 1
Length: 2
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“BillShipper”: {}}}}}}
BillShipper Required: Cond Container for the BillShipper billing option.
Type: Container
Max Allowed: 1 This element or its sibling element, BillReceiver,
Length: N/A BillThirdParty or ConsigneeBilledIndicator, must be
present but no more than one can be present.
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“BillShipper”: {“AccountNumber”: {}}}}}}}
AccountNumber Required: Yes* UPS account number
Type: String
Max Allowed: 1 Must be the same UPS account number as the one
Length: 6 provided in Shipper/ShipperNumber
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“BillReceiver”: {}}}}}}
BillReceiver Required: Cond Container for the BillReceiver billing option.
Type: Container
Max Allowed: 1 This element or its sibling element, BillShipper,
Length: N/A BillThirdParty or Consignee Billed, must be present but no

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 20
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

more than one can be present. For a return shipment, Bill
Receiver is invalid for Transportation charges.
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“BillReceiver”: {“AccountNumber”: {}}}}}}}
AccountNumber Required: Yes* The UPS account number.
Type: String
Max Allowed: 1 The account must be a valid UPS account number that is
Length: 6 active. For US, PR and CA accounts, the account must be
a daily pickup account, an occasional account, a
customer B.I.N account, or a dropper shipper account. All
other accounts must be either a daily pickup account, an
occasional account, a drop shipper account, or a non-
shipping account.
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“BillReceiver”: {“Address”: {}}}}}}}
Address Required: Cond Container for additional information for the bill receiver’s
Type: Container UPS accounts address.
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“BillReceiver”: {“Address”: {“PostalCode”:
{}}}}}}}}
PostalCode Required: Yes* The postal code for the UPS account's pickup address.
Type: String The pickup postal code was entered in the UPS system
Max Allowed: 1 when the account was set-up.
Length: 1…9
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“BillThirdParty”: {}}}}}}
BillThirdParty Required: Cond Container for the third party billing option.
Type: Container
Max Allowed: 1 This element or its sibling element, BillShipper,
Length: N/A BillReceiver or Consignee Billed, must be present but no
more than one can be present.
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“BillThirdParty”: {“AccountNumber”: {}}}}}}}
AccountNumber Required: Yes* The UPS account number of the third party shipper.
Type: String
Max Allowed: 1 The account must be a valid UPS account number that is
Length: 6 active. For US, PR and CA accounts, the account must be
either a daily pickup account, an occasional account, or a
customer B.I.N account, 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.
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“BillThirdParty”: {“Address”: {}}}}}}}
Address Required: Yes* Container for additional information for the third party UPS
Type: Container accounts address.
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“BillThirdParty”: {“Address”: {“PostalCode”:
{}}}}}}}
PostalCode Required: Yes* Origin postal code.
Type: String
Max Allowed: 1 The postal code must be the same as the UPS account
Length: 1…9 pickup address postal code. Required for United States
and Canadian UPS accounts and/or if the UPS account
pickup address has a postal code. If the UPS account's
pickup country or territory 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 or territory 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.
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“BillThirdParty”: {“Address”: {“CountryCode”:
{}}}}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 21
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

CountryCode Required: Yes* Origin country or territory code. Refer to the Supported
Type: String country or territory Tables located in the Appendix.
Max Allowed: 1
Length: 2
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“ShipmentCharge”: {“ConsigneeBilledIndicator”: {}}}}
ConsigneeBilledIndicator Required: Cond Consignee Billing payment option indicator. The presence
Type: String indicates consignee billing option is selected. The
Max Allowed: 1 absence indicates one of the other payment options is
Length: 0 selected.
Empty Tag. This element or its sibling element,
BillShipper, BillReceiver or BillThirdParty, must be present
but no more than one can be present. This billing option is
valid for a shipment charge type of Transportation only.
Only applies to US/PR and PR/US shipment origins and
destination.
{“RateRequest”: {“Shipment”: {“PaymentDetails”: {“SplitDutyVATIndicator”: {}}}}}
SplitDutyVATIndicator Required: No Split Duty VAT Indicator. The presence indicates the
Type: String payer specified for Transportation Charges will pay
Max Allowed: 1 transportation charges and any duties that apply to the
Length: 0 shipment. The payer specified for Duties and Taxes will
pay the VAT (Value-Added Tax) only.
Empty Tag. The payment method for Transportation
charges must be UPS account. The UPS account must be
a daily pickup account or an occasional account.
{“RateRequest”: {“Shipment”: {“FRSPaymentInformation”: {}}}}
FRSPaymentInformation Required: Cond Ground Freight Pricing (GFP) Payment Information
Type: Container container.
Max Allowed: 1
Length: N/A Required only for GFP and when the FRSIndicator is
present.
{“RateRequest”: {“Shipment”: {“FRSPaymentInformation”: {“Type”: {}}}}}
Type Required: Yes* GFP Payment Information Type container.
Type: Container
Max Allowed: 1 GFP only.
Length: N/A
{“RateRequest”: {“Shipment”: {“FRSPaymentInformation”: {“Type”: {“Code”: {}}}}}}
Code Required: Yes* Payer Type code for FRS Rate request.
Type: String
Max Allowed: 1 Valid Values are: 01 = Prepaid 02 = FreightCollect 03 =
Length: 2 BillThirdParty
{“RateRequest”: {“Shipment”: {“FRSPaymentInformation”: {“AccountNumber”: {}}}}}
AccountNumber Required: No UPS Account Number.
Type: String
Max Allowed: 1
Length: 6
{“RateRequest”: {“Shipment”: {“FRSPaymentInformation”: {“Address”: {}}}}}
Address Required: Cond Payer Address Container.
Type: Container
Max Allowed: 1 Address container may be present for FRS Payment
Length: N/A Information type = 02 and required when the FRS
Payment Information type = 03.
{“RateRequest”: {“Shipment”: {“FRSPaymentInformation”: {“Address”: {“PostalCode”: {}}}}}}
PostalCode Required: Cond Postal Code for UPS accounts billing address.
Type: String
Max Allowed: 1 Postal Code may be present when the FRS Payment
Length: 1...9 Information type = 02 and type = 03.
{“RateRequest”: {“Shipment”: {“FRSPaymentInformation”: {“Address”: {“CountryCode”: {}}}}}}
CountryCode Required: Yes* Country or Territory code for the UPS accounts & billing
Type: String address.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 22
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Max Allowed: 1 Country or Territory Code is required when the FRS
Length: 2 Payment Information type = 02 and type= 03.
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {}}}}
FreightShipmentInformation Required: No Container to hold Freight Shipment information.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {}}}}}
FreightDensityInfo Required: Cond Freight Density Info container.
Type: Container
Max Allowed: 1 Required if DensityEligibleIndicator is present.
Length: N/A
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“AdjustedHeightIndicator”:
{}}}}}}
AdjustedHeightIndicator Required: No The presence of the AdjustedHeightIndicator allows UPS
Type: String to do height reduction adjustment for density based rate
Max Allowed: 1 request.
Length: 0
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“AdjustedHeight”: {}}}}}}
AdjustedHeight Required: Cond Container to hold Adjusted Height information.
Type: Container
Max Allowed: 1 Required if AdjustedHeightIndicator is present
Length: N/A
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“AdjustedHeight”: {“Value”:
{}}}}}}}
Value Required: Yes* Adjusted Height value for the handling unit.
Type: String
Max Allowed: 1
Length: 1…19
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“AdjustedHeight”:
{“UnitOfMeasurement”: {}}}}}}}
UnitOfMeasurement Required: Yes* Unit of Measurement container for the Adjusted height.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“AdjustedHeight”:
{“UnitOfMeasurement”: {“Code”: {}}}}}}}}
Code Required: Yes* Code associated with Unit of Measurement for the
Type: String Adjusted height. Valid value is IN
Max Allowed: 1
Length: 2 Unit of measurement code for Adjusted height is validated
only when Handling unit type is SKD = Skid or PLT =
Pallet.
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“HandlingUnits”: {}}}}}}
HandlingUnits Required: Yes* Handling Unit for Density based rating container.
Type: Container
Max Allowed: UNB
Length: N/A
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“HandlingUnits”: {“Quantity”:
{}}}}}}}
Quantity Required: Yes* Handling Unit Quantity for Density based rating.
Type: String
Max Allowed: 1
Length: 8
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“HandlingUnits”: {“Type”:
{}}}}}}}
Type Required: Yes* Handling Unit Type for Density based rating.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“HandlingUnits”: {“Type”:
{“Code”: {}}}}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 23
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Code Required: Yes* The code associated with Handling Unit Type.
Type: String
Max Allowed: 1 Valid values: SKD = Skid CBY = Carboy PLT = Pallet
Length: 3 TOT = Totes LOO = Loose OTH = Other
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“HandlingUnits”:
{“Dimensions”: {}}}}}}}
Dimensions Required: Yes* Dimension of the HandlingUnit container for density
Type: Container based pricing.
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“HandlingUnits”:
{“Dimensions”: {“UnitOfMeasurement”: {}}}}}}}}
UnitOfMeasurement Required: Yes* UnitOfMeasurement container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“HandlingUnits”:
{“Dimensions”: {“UnitOfMeasurement”: {“Code”: {}}}}}}}}}
Code Required: Yes* Code for UnitOfMeasurement for the line item dimension.
Type: String Valid value: IN = Inches
Max Allowed: 1
Length: 2
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“HandlingUnits”:
{“Dimensions”: {“Length”: {}}}}}}}}
Length Required: Yes* The length of the line item used to determine dimensional
Type: String weight.
Max Allowed: 1
Length: 1…19
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“HandlingUnits”:
{“Dimensions”: {“Width”: {}}}}}}}}
Width Required: Yes* The width of the line item used to determine dimensional
Type: String weight.
Max Allowed: 1
Length: 1…19
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“FreightDensityInfo”: {“HandlingUnits”:
{“Dimensions”: {“Height”: {}}}}}}}}
Height Required: Yes* The height of the line item used to determine dimensional
Type: String weight.
Max Allowed: 1
Length: 1…19
{“RateRequest”: {“Shipment”: {“FreightShipmentInformation”: {“DensityEligibleIndicator”: {}}}}}
DensityEligibleIndicator Required: No The presence of the tag indicates that the rate request is
Type: String density based. For Density Based Rating (DBR), the
Max Allowed: 1 customer must have DBR Contract Service.
Length: 0
{“RateRequest”: {“Shipment”: {“GoodsNotInFreeCirculationIndicator”: {}}}}
GoodsNotInFreeCirculationI Required: No Goods Not In Free Circulation indicator.
ndicator Type: String
Max Allowed: 1 This is an empty tag, any value inside is ignored. This
Length: 0 indicator is invalid for a package type of UPS Letter and
DocumentsOnly.
{“RateRequest”: {“Shipment”: {“Service”: {}}}}
Service Required: Cond Service Container.
Type: Container
Max Allowed: 1 Only valid with RequestOption = Rate for both Small
Length: N/A package and GFP Rating requests
{“RateRequest”: {“Shipment”: {“Service”: {“Code”: {}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 24
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Code Required: Yes* The code for the UPS Service associated with the
Type: String shipment. Valid domestic values: NOTE: For all values,
Max Allowed: 1 refer to Service Codes in the Appendix. 01 = Next Day Air
Length: 2 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.
{“RateRequest”: {“Shipment”: {“NumOfPieces”: {}}}}
NumOfPieces Required: No Total number of pieces in all pallets. Required for UPS
Type: String Worldwide Express Freight and UPS Worldwide Express
Max Allowed: 1 Freight Midday shipments.
Length: 1…5
{“RateRequest”: {“Shipment”: {“ShipmentTotalWeight”: {}}}}
ShipmentTotalWeight Required: Cond Shipment Total Weight Container. This container is only
Type: Container applicable for "ratetimeintransit" and "shoptimeintransit"
Max Allowed: 1 request options.
Length: N/A
Required for all international shipments when retreiving
time in transit information, including letters and
documents shipments.
{“RateRequest”: {“Shipment”: {“ShipmentTotalWeight”: {“UnitOfMeasurement”: {}}}}}
UnitOfMeasurement Required: Yes* UnitOfMeasurement Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“ShipmentTotalWeight”: {“UnitOfMeasurement”: {“Code”: {}}}}}}
Code Required: Yes* Code representing the unit of measure associated with
Type: String the package weight. Codes are: LBS = Pounds, KGS =
Max Allowed: 1 Kilograms.
Length: 3
{“RateRequest”: {“Shipment”: {“ShipmentTotalWeight”: {“Weight”: {}}}}}
Weight Required: Yes* Non-zero total weight of all packages in the shipment.
Type: String
Max Allowed: 1
Length: 1..3
{“RateRequest”: {“Shipment”: {“DocumentsOnlyIndicator”: {}}}}
DocumentsOnlyIndicator Required: No Valid values are Document and Non-document. If the
Type: String indicator is present then the value is Document else Non-
Max Allowed: 1 Document. Note: Not applicable for FRS rating requests.
Length: 0
Empty Tag.
{“RateRequest”: {“Shipment”: {“Package”: {}}}}
Package Required: Yes Package Container.
Type: Container
Max Allowed: 200
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackagingType”: {}}}}}
PackagingType Required: Cond Packaging Type Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackagingType”: {“Code”: {}}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 25
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Code Required: Yes* The code for the UPS packaging type associated with the
Type: String package.
Max Allowed: 1
Length: 2 Valid values: 00 = UNKNOWN 01 = UPS Letter 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.
For FRS rating requests the only valid value is customer
supplied packaging “02”.
{“RateRequest”: {“Shipment”: {“Package”: {“Dimensions”: {}}}}}
Dimensions Required: No Dimensions Container. This container is not applicable for
Type: Container GFP Rating request.
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“Dimensions”: {“UnitOfMeasurement”: {}}}}}}
UnitOfMeasurement Required: Yes* UnitOfMeasurement Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“Dimensions”: {“UnitOfMeasurement”: {“Code”: {}}}}}}}
Code Required: Yes* Package dimensions unit of measurement code. Codes
Type: String are: ‘IN’ = Inches, ‘CM’ = Centimeters.
Max Allowed: 1
Length: 2 Valid codes are: ‘IN’ or ‘CM’.
{“RateRequest”: {“Shipment”: {“Package”: {“Dimensions”: {“Length”: {}}}}}}
Length Required: Cond Length of the package used to determine dimensional
Type: String weight.
Max Allowed: 1
Length: 6 Required for GB to GB and Poland to Poland shipments.
{“RateRequest”: {“Shipment”: {“Package”: {“Dimensions”: {“Width”: {}}}}}}
Width Required: Cond Width of the package used to determine dimensional
Type: String weight.
Max Allowed: 1
Length: 6 Required for GB to GB and Poland to Poland shipments.
{“RateRequest”: {“Shipment”: {“Package”: {“Dimensions”: {“Height”: {}}}}}}
Height Required: Cond Height of the package used to determine dimensional
Type: String weight.
Max Allowed: 1
Length: 6 Required for GB to GB and Poland to Poland shipments.
{“RateRequest”: {“Shipment”: {“Package”: {“DimWeight”: {}}}}}
DimWeight Required: No Package Dimensional Weight container. Values in this
Type: Container container are ignored when package dimensions are
Max Allowed: 1 provided. Please visit [Link] for instructions on
Length: N/A calculating this value.
Only used for non-US/CA/PR shipments.
{“RateRequest”: {“Shipment”: {“Package”: {“DimWeight”: {“UnitOfMeasurement”: {}}}}}}
UnitOfMeasurement Required: No UnitOfMeasurement Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“DimWeight”: {“UnitOfMeasurement”: {“Code”: {}}}}}}}
Code Required: No Code representing the unit of measure associated with
Type: String the package weight. Codes are: LBS = Pounds, KGS =
Max Allowed: 1 Kilograms.
Length: 3
Valid values: “LBS” = Pounds (default) and “KGS” =
Kilograms.
{“RateRequest”: {“Shipment”: {“Package”: {“DimWeight”: {“Weight”: {}}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 26
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Weight Required: No Dimensional weight of the package. Decimal values are
Type: String not accepted, however there is one implied decimal place
Max Allowed: 1 for values in this field (i.e. 115 = 11.5).
Length: 6
{“RateRequest”: {“Shipment”: {“Package”: {“PackageWeight”: {}}}}}
PackageWeight Required: Cond Package Weight Container.
Type: Container
Max Allowed: 1 Required for a GFP Rating request. Otherwise optional.
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackageWeight”: {“UnitOfMeasurement”: {}}}}}}
UnitOfMeasurement Required: Yes* UnitOfMeasurement Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackageWeight”: {“UnitOfMeasurement”: {“Code”: {}}}}}}}
Code Required: Yes* Code representing the unit of measure associated with
Type: String the package weight. Unit of Measurement "OZS" is the
Max Allowed: 1 only valid UOM for Worldwide Economy DDU Shipments.
Length: 3
Valid values: LBS = Pounds (default) KGS = Kilograms
OZS = Ounces
{“RateRequest”: {“Shipment”: {“Package”: {“PackageWeight”: {“Weight”: {}}}}}}
Weight Required: Yes* Actual package weight.
Type: String
Max Allowed: 1 Weight accepted for letters/envelopes.
Length: 6
{“RateRequest”: {“Shipment”: {“Package”: {“Commodity”: {}}}}}
Commodity Required: Cond Commodity Container.
Type: Container
Max Allowed: 1 Required only for GFP rating when FRSShipmentIndicator
Length: N/A is requested.
{“RateRequest”: {“Shipment”: {“Package”: {“Commodity”: {“FreightClass”: {}}}}}}
FreightClass Required: Yes* Freight Classification. Freight class partially determines
Type: String the freight rate for the article.
Max Allowed: 1
Length: 10
{“RateRequest”: {“Shipment”: {“Package”: {“Commodity”: {“NMFC”: {}}}}}}
NMFC Required: No NMFC Commodity container.
Type: Container
Max Allowed: 1 For GFP Only.
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“Commodity”: {“NMFC”: {“PrimeCode”: {}}}}}}}
PrimeCode Required: Yes* Value of NMFC Prime. Contact your service
Type: String representative if you need information concerning NMFC
Max Allowed: 1 Codes.
Length: 4..6
Required if NMFC Container is present. For GFP Only.
{“RateRequest”: {“Shipment”: {“Package”: {“Commodity”: {“NMFC”: {“SubCode”: {}}}}}}}
SubCode Required: Cond Value of NMFC Sub. Contact your service representative
Type: String if you need information concerning NMFC Codes.
Max Allowed: 1
Length: 2 Needs to be provided when the SubCode associated with
the PrimeCode is other than 00. API defaults the sub
value to 00 if not provided. If provided the Sub Code
should be associated with the PrimeCode of the NMFC.
{“RateRequest”: {“Shipment”: {“Package”: {“LargePackageIndicator”: {}}}}}
LargePackageIndicator Required: No This element does not require a value and if one is
Type: String entered it will be ignored.
Max Allowed: 1
Length: 0 If present, it indicates the shipment will be categorized as
a Large Package.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 27
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

PackageServiceOptions Required: No PackageServiceOptions container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DeliveryConfirmation”: {}}}}}}
DeliveryConfirmation Required: No Delivery Confirmation Container. For a list of valid
Type: Container origin/destination countries or territories please refer to
Max Allowed: 1 appendix.
Length: N/A
DeliveryConfirmation and COD are mutually exclusive.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DeliveryConfirmation”: {“DCISType”: {}}}}}}}
DCISType Required: Yes* Type of delivery confirmation.
Type: String
Max Allowed: 1 Valid values: 1 - Unsupported 2 - Delivery Confirmation
Length: 1 Signature Required 3 - Delivery Confirmation Adult
Signature Required
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“AccessPointCOD”: {}}}}}}
AccessPointCOD Required: No Access Point COD indicates Package COD is requested
Type: Container for a shipment.
Max Allowed: 1
Length: N/A Valid only for : 01 - Hold For Pickup At UPS Access Point,
Shipment Indication 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
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“AccessPointCOD”: {“CurrencyCode”:
{}}}}}}}
CurrencyCode Required: Yes* Access Point COD Currency Code.
Type: String
Max Allowed: 1 Required if Access Point COD container is present. UPS
Length: 3 does not support all international currency codes. Refer to
the appendix for a list of valid codes.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“AccessPointCOD”: {“MonetaryValue”:
{}}}}}}}
MonetaryValue Required: Yes* Access Point COD Monetary Value.
Type: String
Max Allowed: 1 Required if Access Point COD container is present.
Length: 8
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“COD”: {}}}}}}
COD Required: No COD Container. Indicates COD is requested.
Type: Container
Max Allowed: 1 Valid for the following country or territory combinations:
Length: N/A US/PR to US/PR CA to CA CA to US Not allowed for CA
to US for packages that are designated as Letters or
Envelopes.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“COD”: {“CODFundsCode”: {}}}}}}}
CODFundsCode Required: Yes* Indicates the type of funds that will be used for the C.O.D.
Type: String payment.
Max Allowed: 1
Length: 1 For valid values, refer to Rating and Shipping COD
Supported Countries or Territories
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“COD”: {“CODAmount”: {}}}}}}}
CODAmount Required: Yes* CODAmount Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“COD”: {“CODAmount”: {“CurrencyCode”:
{}}}}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 28
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

CurrencyCode Required: Yes* Currency Code.
Type: String
Max Allowed: 1 Required if a value for the COD amount exists in the
Length: 3 MonetaryValue tag. Must match one of the IATA currency
codes. UPS does not support all international currency
codes. Refer to Currency Codes in the Appendix for a list
of valid codes.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“COD”: {“CODAmount”: {“MonetaryValue”:
{}}}}}}}}
MonetaryValue Required: Yes* The COD value for the package.
Type: String
Max Allowed: 1 Required if COD option is present. The maximum amount
Length: 8 allowed is 50,000 USD.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DeclaredValue”: {}}}}}}
DeclaredValue Required: No Declared Value Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DeclaredValue”: {“CurrencyCode”: {}}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the declared
Type: String value amount for the package.
Max Allowed: 1
Length: 3 Required if a value for the package declared value
amount exists in the MonetaryValue tag. Must match one
of the IATA currency codes. Length is not validated. UPS
does not support all international currency codes. Refer to
Currency Codes in the Appendix for a list of valid codes.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DeclaredValue”: {“MonetaryValue”: {}}}}}}}
MonetaryValue Required: Yes* The monetary value for the declared value amount
Type: String associated with the package.
Max Allowed: 1
Length: 8 Max value of 5,000 USD for Local and 50,000 USD for
Remote. Absolute maximum value is 21474836.47
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“ShipperDeclaredValue”: {}}}}}}
ShipperDeclaredValue Required: No Shipper Paid Declared Value Charge at Package level.
Type: Container
Max Allowed: 1 Valid for UPS World Wide Express Freight shipments.
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“ShipperDeclaredValue”: {“CurrencyCode”:
{}}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the amount for
Type: String the package.
Max Allowed: 1
Length: 3 UPS does not support all international currency codes.
Refer to the appendix for a list of valid codes.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“ShipperDeclaredValue”: {“MonetaryValue”:
{}}}}}}}
MonetaryValue Required: Yes* The monetary value for the amount associated with the
Type: String package.
Max Allowed: 1
Length: 1…19
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“ShipperReleaseIndicator”: {}}}}}}
ShipperReleaseIndicator Required: No The presence indicates that the package may be released
Type: String by driver without a signature from the consignee.
Max Allowed: 1
Length: 0 Empty Tag. Only available for US50/PR to US50/PR
packages without return service.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“RefrigerationIndicator”: {}}}}}}
RefrigerationIndicator Required: No Presence/Absence Indicator. Any value is ignored. If
Type: String present, indicates that the package contains an item that
needs refrigeration.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 29
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Max Allowed: 1 Shippers account needs to have a valid contract for
Length: 0 Refrigeration.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“Insurance”: {}}}}}}
Insurance Required: No Insurance Accesorial. Only one type of insurance can
Type: Container exist at a time on the shipment.
Max Allowed: 1
Length: N/A Valid for UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“Insurance”: {“BasicFlexibleParcelIndicator”:
{}}}}}}}
BasicFlexibleParcelIndicator Required: No Container to hold Basic Flexible Parcel Indicator
Type: Container information.
Max Allowed: 1
Length: N/A Valid for UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“Insurance”: {“BasicFlexibleParcelIndicator”:
{“CurrencyCode”: {}}}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the amount for
Type: String the package.
Max Allowed: 1
Length: 3 UPS does not support all international currency codes.
Refer to the appendix for a list of valid codes. Valid for
UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“Insurance”: {“BasicFlexibleParcelIndicator”:
{“MonetaryValue”: {}}}}}}}}
MonetaryValue Required: Yes* The monetary value associated with the package.
Type: String
Max Allowed: 1 Valid for UPS World Wide Express Freight shipments.
Length: 8
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“Insurance”:
{“ExtendedFlexibleParcelIndicator”: {}}}}}}}
ExtendedFlexibleParcelIndic Required: No Container for Extended Flexible Parcel Indicator
ator Type: Container
Max Allowed: 1 Valid for UPS World Wide Express Freight shipments.
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“Insurance”:
{“ExtendedFlexibleParcelIndicator”: {“CurrencyCode”: {}}}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the amount for
Type: String the package.
Max Allowed: 1
Length: 3 UPS does not support all international currency codes.
Refer to the appendix for a list of valid codes. Valid for
UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“Insurance”:
{“ExtendedFlexibleParcelIndicator”: {“MonetaryValue”: {}}}}}}}}
MonetaryValue Required: Yes* The monetary value associated with the package.
Type: String
Max Allowed: 1 Valid for UPS World Wide Express Freight shipments.
Length: 8
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“Insurance”:
{“TimeInTransitFlexibleParcelIndicator”: {}}}}}}}
TimeInTransitFlexibleParcelI Required: No Container to hold Time In Transit Flexible Parcel Indicator
ndicator Type: Container information.
Max Allowed: 1
Length: N/A Valid for UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“Insurance”:
{“TimeInTransitFlexibleParcelIndicator”: {“CurrencyCode”: {}}}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the amount for
Type: String the package.
Max Allowed: 1
Length: 3 UPS does not support all international currency codes.
Refer to the appendix for a list of valid codes. Valid for
UPS World Wide Express Freight shipments.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 30
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“Insurance”:
{“TimeInTransitFlexibleParcelIndicator”: {“MonetaryValue”: {}}}}}}}}
MonetaryValue Required: Yes* The monetary value associated with the package.
Type: String
Max Allowed: 1 Valid for UPS World Wide Express Freight shipments.
Length: 8
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“UPSPremiumCareIndicator”: {}}}}}}
UPSPremiumCareIndicator Required: No An UPSPremiumCareIndicator indicates special handling
Type: String is required for shipment having controlled substances.
Max Allowed: 1
Length: 0 Empty Tag means indicator is present. Valid only for
Canada to Canada movements. Available for the following
Return Services: Returns Exchange (available with a
contract) Print Return Label Print and Mail Electronic
Return Label Return Service Three Attempt May be
requested with following UPS services: UPS Express®
Early UPS Express UPS Express Saver UPS Standard.
Not available for packages with the following: Delivery
Confirmation - Signature Required Delivery Confirmation -
Adult Signature Required.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {}}}}}}
HazMat Required: No Container to hold HazMat information.
Type: Container
Max Allowed: 1 Applies only if SubVersion is greater than or equal to
Length: N/A 1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“PackageIdentifier”: {}}}}}}}
PackageIdentifier Required: Cond Identifies the package containing Dangerous Goods.
Type: String
Max Allowed: 1 Required if SubVersion is greater than or equal to 1701.
Length: 1…5
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“QValue”: {}}}}}}}
QValue Required: Cond QValue is required when a HazMat shipment specifies
Type: String AllPackedInOneIndicator and the regulation set for that
Max Allowed: 1 shipment is IATA.
Length: 3
Applies only if SubVersion is greater than or equal to
1701. Valid values are : 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7;
0.8; 0.9; 1.0
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“OverPackedIndicator”: {}}}}}}}
OverPackedIndicator Required: No Presence/Absence Indicator. Any value is ignored.
Type: String Presence indicates that shipment is overpack.
Max Allowed: 1
Length: 0 Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“AllPackedInOneIndicator”:
{}}}}}}}
AllPackedInOneIndicator Required: No Presence/Absence Indicator. Any value is ignored.
Type: String Indicates the hazmat shipment/package is all packed in
Max Allowed: 1 one.
Length: 0
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{}}}}}}}
HazMatChemicalRecord Required: Yes* Container to hold HazMat Chemical Records.
Type: Container
Max Allowed: 3
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“ChemicalRecordIdentifier”: {}}}}}}}}
ChemicalRecordIdentifier Required: Cond Identifies the Chemcial Record.
Type: String

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 31
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Max Allowed: 1 Required if SubVersion is greater than or equal to 1701.
Length: 1…3
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“ClassDivisionNumber”: {}}}}}}}}
ClassDivisionNumber Required: Cond This is the hazard class associated to the specified
Type: String commodity. Required if CommodityRegulatedLevelCode
Max Allowed: 1 is ‘LQ’ or ‘FR’
Length: 1…7
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“IDNumber”: {}}}}}}}}
IDNumber Required: Cond This is the ID number (UN/NA/ID) for the specified
Type: String commodity. Required if CommodityRegulatedLevelCode =
Max Allowed: 1 LR, LQ or FR and if the field applies to the material by
Length: 1…6 regulation. UN/NA/ID Identification Number assigned to
the specified regulated good. (Include the UN/NA/ID as
part of the entry).
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“TransportationMode”: {}}}}}}}}
TransportationMode Required: Yes* The method of transport by which a shipment is approved
Type: String to move and the regulations associated with that method.
Max Allowed: 1 Only required when the CommodityRegulatedLevelCode
Length: 2 is FR or LQ. Valid values: 01 - Highway 02 - Ground 03 -
Passenger Aircraft 04 - Cargo Aircraft Only
Applies only if SubVersion is greater than or equal to
1701. For multiple ChemicalRecords per package having
different TransportationMode, TransportationMode of first
ChemicalRecord would be considered for validating and
rating the package. All 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.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“RegulationSet”: {}}}}}}}}
RegulationSet Required: Yes* The Regulatory set associated with every regulated
Type: String shipment. It must be the same across the shipment. Valid
Max Allowed: 1 values: ADR - For Europe to Europe Ground Movement
Length: 3…4 CFR - For HazMat regulated by US Dept. of
Transportation within the U.S. or ground shipments to
Canada, IATA - For Worldwide Air movement TDG - For
Canada to Canada ground movement or Canada to U.S.
standard movement.
Applies only if SubVersion is greater than or equal to
1701. For multiple ChemicalRecords per package or
multiple packages containing different RegulationSet,
RegulationSet of first ChemicalRecord would be
considered for validating and rating the entire shipment.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“EmergencyPhone”: {}}}}}}}}
EmergencyPhone Required: No 24 Hour Emergency Phone Number of the shipper. Valid
Type: String values for this field are (0) through (9) with trailing blanks.
Max Allowed: 1 For numbers within the U.S., the layout is '1', area code,
Length: 1…25 7-digit number. For all other countries or territories the
layout is country or territory code, area code, number.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 32
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Applies only if SubVersion is greater than or equal to
1701.
The following are restricted in the phone number
“period “.”, dash “-“, plus sign “+” and conventional
parentheses “(“ and “)”, “EXT or OPT”
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“EmergencyContact”: {}}}}}}}}
EmergencyContact Required: Cond The emergency information, contact name and/or contact
Type: String number, required to be communicated when a call is
Max Allowed: 1 placed to the EmergencyPhoneNumber. The information
Length: 1…35 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.
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“ReportableQuantity”: {}}}}}}}}
ReportableQuantity Required: Cond Required if CommodityRegulatedLevelCode = LQ or FR
Type: String and if the field applies to the material by regulation. If
Max Allowed: 1 reportable quantity is met, 'RQ' should be entered.
Length: 1…2
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“SubRiskClass”: {}}}}}}}}
SubRiskClass Required: Cond Required if CommodityRegulatedLevelCode = LQ or FR
Type: String and if the field applies to the material by regulation.
Max Allowed: 1 Secondary hazardous characteristics of a package.
Length: 1…100 (There can be more than one – separate each with a
comma).
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“PackagingGroupType”: {}}}}}}}}
PackagingGroupType Required: Cond This is the packing group category associated to the
Type: String specified commodity. Required if
Max Allowed: 1 CommodityRegulatedLevelCode = LQ or FR and if the
Length: 1…10 field applies to the material by regulation. Must be shown
in Roman Numerals. Valid values are: I, II, III, blank.
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“Quantity”: {}}}}}}}}
Quantity Required: Cond Required if CommodityRegulatedLevelCode = LQ or FR.
Type: String The numerical value of the mass capacity of the regulated
Max Allowed: 1 good.
Length: 15
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“UOM”: {}}}}}}}}
UOM Required: Cond Required if CommodityRegulatedLevelCode = LQ or FR.
Type: String The unit of measure used for the mass capacity of the
Max Allowed: 1 regulated good. For Example: ml, L, g, mg, kg, cylinder,
Length: 1…10 pound, pint, quart, gallon, ounce etc.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 33
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“PackagingInstructionCode”: {}}}}}}}}
PackagingInstructionCode Required: Cond The packing instructions related to the chemical record.
Type: String Required if CommodityRegulatedLevelCode = LQ or FR
Max Allowed: 1 and if the field applies to the material by regulation.
Length: 1…353
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“ProperShippingName”: {}}}}}}}}
ProperShippingName Required: Cond The Proper Shipping Name assigned by ADR, CFR or
Type: String IATA. Required if CommodityRegulatedLevelCode = LR,
Max Allowed: 1 LQ or FR.
Length: 1…250
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“TechnicalName”: {}}}}}}}}
TechnicalName Required: Cond The technical name (when required) for the specified
Type: String commodity. Required if CommodityRegulatedLevelCode =
Max Allowed: 1 LQ or FR and if the field applies to the material by
Length: 1…300 regulation.
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“AdditionalDescription”: {}}}}}}}}
AdditionalDescription Required: Cond Additional remarks or special provision information.
Type: String Required if CommodityRegulatedLevelCode = LQ or FR
Max Allowed: 1 and if the field applies to the material by regulation.
Length: 1…75 Additional information that may be required by regulation
about a hazardous material, such as, “Limited Quantity”,
DOT-SP numbers, EX numbers.
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“PackagingType”: {}}}}}}}}
PackagingType Required: Cond The package type code identifying the type of packaging
Type: String used for the commodity. (Ex: Fiberboard Box). Required if
Max Allowed: 1 CommodityRegulatedLevelCode = LQ or FR.
Length: 1…255
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“HazardLabelRequired”: {}}}}}}}}
HazardLabelRequired Required: Cond Defines the type of label that is required on the package
Type: String for the commodity. Not applicable if
Max Allowed: 1 CommodityRegulatedLevelCode = LR or EQ.
Length: 1…50
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“PackagingTypeQuantity”: {}}}}}}}}
PackagingTypeQuantity Required: Cond The number of pieces of the specific commodity.
Type: String Required if CommodityRegulatedLevelCode = LQ or FR.
Max Allowed: 1 Valid values are 1 to 999.
Length: 1…3

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 34
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“CommodityRegulatedLevelCode”: {}}}}}}}}
CommodityRegulatedLevelC Required: Cond Indicates the type of commodity - Fully Regulated (FR),
ode Type: String Limited Quantity (LQ), Excepted Quantity (EQ), Lightly
Max Allowed: 1 Regulated (LR). Default value is FR. Valid values are LR,
Length: 2 FR, LQ, EQ.
Applies only if SubVersion is greater than or equal to
1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“TransportCategory”: {}}}}}}}}
TransportCategory Required: No Transport Category. Valid values are 0 to 4.
Type: String
Max Allowed: 1 Applies only if SubVersion is greater than or equal to
Length: 1 1701.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”: {“HazMatChemicalRecord”:
{“TunnelRestrictionCode”: {}}}}}}}}
TunnelRestrictionCode Required: No Defines what is restricted to pass through a tunnel.
Type: String
Max Allowed: 1 Applies only if SubVersion is greater than or equal to
Length: 1…10 1701
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DryIce”: {}}}}}}
DryIce Required: No Container to hold Dry Ice information.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DryIce”: {}}}}}}
DryIce Required: No Container to hold Dry Ice information.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DryIce”: {“RegulationSet”: {}}}}}}}
RegulationSet Required: Yes* Regulation set for DryIce Shipment. Valid values: CFR =
Type: String For HazMat regulated by US Dept of Transportation within
Max Allowed: 1 the U.S. or ground shipments to Canada, IATA = For
Length: 3…4 Worldwide Air movement.
The following values are valid: CFR and IATA.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DryIce”: {“DryIceWeight”: {}}}}}}}
DryIceWeight Required: Yes* Container for Weight information for Dry Ice.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DryIce”: {“DryIceWeight”:
{“UnitOfMeasurement”: {}}}}}}}}
UnitOfMeasurement Required: Yes* Container for Unit Of Measurement for Dry Ice.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DryIce”: {“DryIceWeight”:
{“UnitOfMeasurement”: {“Code”: {}}}}}}}}}
Code Required: Yes* DryIce weight unit of measurement code. Valid values: 00
Type: String = KG (Metric Unit of Measurements) or KGS 01 = LB
Max Allowed: 1 (English Unit of Measurements) or LBS
Length: 2
The following values are valid : 00 , 01
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DryIce”: {“DryIceWeight”: {“Weight”: {}}}}}}}}
Weight Required: Yes* Weight for Dry Ice.
Type: String

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 35
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Max Allowed: 1 Cannot be more than package weight. Should be more
Length: 1…5 than 0.0. Valid characters are 0-9 and "." (Decimal point).
Limit to 1 digit after the decimal. The maximum length of
the field is 5 including "." and can hold up to 1 decimal
place.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DryIce”: {“MedicalUseIndicator”: {}}}}}}}
MedicalUseIndicator Required: No Presence/Absence Indicator. Any value inside is ignored.
Type: String Relevant only in CFR regulation set. If present it is used
Max Allowed: 1 to designate the Dry Ice is for any medical use and rates
Length: 0 are adjusted for DryIce weight more than 2.5 KGS or 5.5
LBS.
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“DryIce”: {“AuditRequired”: {}}}}}}}
AuditRequired Required: No Presence/Absence Indicator. Any value inside is ignored.
Type: String Indicates a Dry Ice audit will be performed per the
Max Allowed: 1 Regulation Set requirements. Empty tag means indicator
Length: 0 is present.
{“RateRequest”: {“Shipment”: {“Package”: {“AdditionalHandlingIndicator”: {}}}}}
AdditionalHandlingIndicator Required: No A flag indicating if the packages require additional
Type: String handling. True if AdditionalHandlingIndicator tag exists;
Max Allowed: 1 false otherwise. Additional Handling indicator indicates it’s
Length: 0 a non-corrugated package.
Empty Tag.
{“RateRequest”: {“Shipment”: {“Package”: {“ UPSPremier”: {}}}}}
UPSPremier Required: No UPSPremier Container
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“Package”: {“UPSPremier”: {“Category”: {}}}}}}
Category Required: Yes* UPS Premier Category
Type: String
Max Allowed: 1 Valid values are 01,02,03
Length: 2 UPS Premier Silver - 01
UPS Premier Gold - 02
UPS Premier Platinum - 03

{"RateRequest": {"Shipment": {"Package": {" SimpleRate": {}}}}}

SimpleRate Required: No Simple Rate Container.
Type: Container
Max Allowed: 1
Length: N/A
{"RateRequest": {"Shipment": {"Package": {"SimpleRate": {"Code: ""}}}}}
Code Required: Yes* Simple Rate Code
Type: String XS = Extra Small
Max Allowed: 1 S = Small
Length: 2 M = Medium
L = Large
XL = Extra Large
{"RateRequest": {"Shipment": {"Package": {"SimpleRate": {"Description: ""}}}}}
Category Required: No Simple Rate description of the code above.
Type: String
Max Allowed: 1
Length: 1
{“RateRequest”: {“Shipment”: {“Package”: {“OversizeIndicator”: {}}}}}
OversizeIndicator Required: No
Type: String
Max Allowed: 1
Length: 0
{“RateRequest”: {“Shipment”: {“Package”: {“MinimumBillableWeightIndicator”: {}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 36
Rating Package RESTful Developer Guide October 22, 2024.

MinimumBillableWeightIndic Required: No
ator Type: String
Max Allowed: 1
Length: 0
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {}}}}
ShipmentServiceOptions Required: No Shipment level Accessorials are included in this container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“SaturdayPickupIndicator”: {}}}}}
SaturdayPickupIndicator Required: No A flag indicating if the shipment requires a Saturday
Type: String pickup. True if SaturdayPickupIndicator tag exists; false
Max Allowed: 1 otherwise. Not available for GFP rating requests.
Length: 0
Empty Tag.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“SaturdayDeliveryIndicator”: {}}}}}
SaturdayDeliveryIndicator Required: No A flag indicating if a shipment must be delivered on a
Type: String Saturday. True if SaturdayDeliveryIndicator tag exists;
Max Allowed: 1 false otherwise
Length: 0
Empty Tag.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“AccessPointCOD”: {}}}}}
AccessPointCOD Required: No Access Point COD indicates Shipment level Access Point
Type: Container COD is requested for a shipment.
Max Allowed: 1
Length: N/A Valid only for "01 - Hold For Pickup At UPS Access Point"
Shipment Indication type. Shipment Access Point COD is
valid only for countries or territories within E.U. Not valid
with (Shipment) COD. Not available to shipment with
return service.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“AccessPointCOD”: {“CurrencyCode”: {}}}}}}
CurrencyCode Required: Yes* Access Point COD Currency Code.
Type: String
Max Allowed: 1 Required if Access Point COD container is present. UPS
Length: 3 does not support all international currency codes. Refer to
the appendix for a list of valid codes.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“AccessPointCOD”: {“MonetaryValue”: {}}}}}}
MonetaryValue Required: Yes* Access Point COD Monetary Value.
Type: String
Max Allowed: 1 Required if Access Point COD container is present.
Length: 8…2
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“DeliverToAddresseeOnlyIndicator”: {}}}}}
DeliverToAddresseeOnlyIndi Required: No Presence/Absence Indicator. Any value inside is ignored.
cator Type: String DeliverToAddresseeOnlyIndicator is shipper specified
Max Allowed: 1 restriction that requires the addressee to be the one who
Length: 0 takes final delivery of the "Hold For PickUp at UPS
Access Point" package. Presence of indicator means
shipper restriction will apply to the shipment.
Only valid for Shipment Indication type "01 - Hold For
PickUp at UPS Access Point".
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“DirectDeliveryOnlyIndicator”: {}}}}}
DirectDeliveryOnlyIndicator Required: No Presence/Absence Indicator. Any value inside is ignored.
Type: String Direct Delivery Only (DDO) accessorial in a request would
Max Allowed: 1 ensure that delivery is made only to the Ship To address
Length: 0 on the shipping label.
This accessorial is not valid with Shipment Indication
Types: 01 - Hold For Pickup At UPS Access Point 02 -
UPS Access Point™ Delivery"
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“COD”: {}}}}}
COD Required: No If present, indicates C.O.D. is requested for the shipment.
Type: Container

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 37
Rating Package RESTful Developer Guide October 22, 2024.

Max Allowed: 1 Shipment level C.O.D. is only available for EU origin

Length: N/A countries or territories. C.O.D. shipments are only
available for Shippers with Daily Pickup and Drop
Shipping accounts.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“COD”: {“CODFundsCode”: {}}}}}}
CODFundsCode Required: Yes* For valid values, refer to COD Supported Countries or
Type: String Territories in the Appendix.
Max Allowed: 1
Length: 1
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“COD”: {“CODAmount”: {}}}}}}
CODAmount Required: Yes* CODAmount Container.
Type: Container
Max Allowed: 1 UPS does not support all international currency codes.
Length: N/A Refer to the appendix for a list of valid codes.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“COD”: {“CODAmount”: {“CurrencyCode”: {}}}}}}}
CurrencyCode Required: Yes* COD amount currency code type.
Type: String
Max Allowed: 1
Length: 3
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“COD”: {“CODAmount”: {“MonetaryValue”: {}}}}}}}
MonetaryValue Required: Yes* COD Amount.
Type: String
Max Allowed: 1
Length: 8
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“DeliveryConfirmation”: {}}}}}}
DeliveryConfirmation Required: No Delivery Confirmation Container.
Type: Container
Max Allowed: 1 DeliveryConfirmation and C.O.D. are mutually exclusive.
Length: N/A Refer to the Appendix for a list of valid origin-destination
country or territory pairs associated with each
confirmation
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“DeliveryConfirmation”: {“DCISType”: {}}}}}}
DCISType Required: Yes* Type of delivery confirmation.
Type: String
Max Allowed: 1 Valid values: 1 - Delivery Confirmation Signature
Length: 1 Required 2 - Delivery Confirmation Adult Signature
Required
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“ReturnOfDocumentIndicator”: {}}}}}
ReturnOfDocumentIndicator Required: No Return of Documents Indicator - If the flag is present, the
Type: String shipper has requested the ReturnOfDocument accessorial
Max Allowed: 1 be added to the shipment
Length: 0
Valid for Poland to Poland shipment.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“UPScarbonneutralIndicator”: {}}}}}
UPScarbonneutralIndicator Required: No UPS carbon neutral indicator. Indicates the shipment will
Type: String be rated as carbon neutral.
Max Allowed: 1
Length: 0
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“CertificateOfOriginIndicator”: {}}}}}
CertificateOfOriginIndicator Required: No The empty tag in request indicates that customer would
Type: String be using UPS prepared SED form.
Max Allowed: 1
Length: 0 Valid for UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“PickupOptions”: {}}}}}
PickupOptions Required: No Shipment Service Pickup Options Container.
Type: Container
Max Allowed: 1 Valid for UPS Worldwide Express Freight and UPS
Length: N/A Worldwide Express Freight Midday shipments.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“PickupOptions”: {“LiftGateAtPickupIndicator”: {}}}}}}
LiftGateAtPickupIndicator Required: No The presence of the tag LiftGatePickupRequiredIndicator
Type: String indicates that the shipment requires a lift gate for pickup.
Max Allowed: 1
Length: 0

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 38
Rating Package RESTful Developer Guide October 22, 2024.

{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“PickupOptions”: {“HoldForPickupIndicator”: {}}}}}}

HoldForPickupIndicator Required: No The presence of the tag HoldForPickupIndicator indicates
Type: String that the user opted to hold the shipment at UPS location
Max Allowed: 1 for pickup.
Length: 0
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“DeliveryOptions”: {}}}}}
DeliveryOptions Required: No Shipment Service Delivery Options Container.
Type: Container
Max Allowed: 1 Valid for UPS Worldwide Express Freight and UPS
Length: N/A Worldwide Express Freight Midday shipments.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“DeliveryOptions”: {“LiftGateAtDeliveryIndicator”: {}}}}}}
LiftGateAtDeliveryIndicator Required: No The presence of the tag LiftGateAtDeliveryIndicator
Type: String indicates that the shipment requires a lift gate for delivery.
Max Allowed: 1
Length: 0
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“DeliveryOptions”: {“DropOffAtUPSFacilityIndicator”:
{}}}}}}
DropOffAtUPSFacilityIndicat Required: No The presence of the tag DropOffAtUPSFacilityIndicator
or Type: String indicates the package will be dropped at a UPS facility for
Max Allowed: 1 shipment.
Length: 0
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“RestrictedArticles”: {}}}}}
RestrictedArticles Required: No Restricted Articles container.
Type: Container
Max Allowed: 1 Valid for UPS World Wide Express Freight shipments.
Length: N/A
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“RestrictedArticles”: {“AlcoholicBeveragesIndicator”:
{}}}}}}
AlcoholicBeveragesIndicator Required: No This field is a flag to indicate if the package has Alcohol.
Type: String True if present; false otherwise.
Max Allowed: 1
Length: 0 Valid for UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“RestrictedArticles”: {“DiagnosticSpecimensIndicator”:
{}}}}}}
DiagnosticSpecimensIndicat Required: No This field is a flag to indicate if the package has Biological
or Type: String substances. True if present; false otherwise.
Max Allowed: 1
Length: 0 Valid for UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“RestrictedArticles”: {“PerishablesIndicator”: {}}}}}}
PerishablesIndicator Required: No This field is a flag to indicate if the package has
Type: String Perishables. True if present; false otherwise.
Max Allowed: 1
Length: 0 Valid for UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“RestrictedArticles”: {“PlantsIndicator”: {}}}}}}
PlantsIndicator Required: No This field is a flag to indicate if the package has Plants.
Type: String True if present; false otherwise.
Max Allowed: 1
Length: 0 Valid for UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“RestrictedArticles”: {“SeedsIndicator”: {}}}}}}
SeedsIndicator Required: No This field is a flag to indicate if the package has Seeds.
Type: String True if present; false otherwise.
Max Allowed: 1
Length: 0 Valid for UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“RestrictedArticles”: {“SpecialExceptionsIndicator”:
{}}}}}}
SpecialExceptionsIndicator Required: No This field is a flag to indicate if the package has Special
Type: String Exceptions Restricted Materials. True if present; false
Max Allowed: 1 otherwise.
Length: 0
Valid for UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“RestrictedArticles”: {“TobaccoIndicator”: {}}}}}}
TobaccoIndicator Required: No This field is a flag to indicate if the package has Tobacco.
Type: String True if present; false otherwise.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 39
Rating Package RESTful Developer Guide October 22, 2024.

Max Allowed: 1 Valid for UPS World Wide Express Freight shipments.
Length: 0
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“RestrictedArticles”: {“ECigarretesIndicator”: {}}}}}}
ECigarettesIndicator Required: No This field is a flag to indicate if the package has E-
Type: String Cigarettes. True if present; false otherwise.
Max Allowed: 1
Length: 0
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“RestrictedArticles”: {“HempCBDIndicator”: {}}}}}}
HempCBDIndicator Required: No This field is a flag to indicate if the package has
Type: String Hemp/CBD. True if present; false otherwise.
Max Allowed: 1
Length: 0
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“ShipperExportDeclarationIndicator”: {}}}}}
ShipperExportDeclarationIn Required: No The empty tag in request indicates that customer would
dicator Type: String be using UPS prepared SED form.
Max Allowed: 1
Length: 0 Valid for UPS World Wide Express Freight shipments.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“CommercialInvoiceRemovalIndicator”: {}}}}}
CommercialInvoiceRemovalI Required: No Presence/Absence Indicator. Any value inside is ignored.
ndicator Type: String CommercialInvoiceRemovalIndicator - empty tag means
Max Allowed: 1 indicator is present. CommercialInvoiceRemovalIndicator
Length: 0 allows a shipper to dictate that UPS remove the
Commercial Invoice from the user's shipment before the
shipment is delivered to the ultimate consignee.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“ImportControl”: {}}}}}
ImportControl Required: No Container for type of Import Control shipments.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“ImportControl”: {“Code”: {}}}}}}
Code Required: Yes* Code for type of Import Control shipment.
Type: String
Max Allowed: 1 Valid values are:
Length: 2 '01' = ImportControl Print and Mail
'02' = ImportControl One-Attempt
'03' = ImportControl Three-Attempt
'04' = ImportControl Electronic Label
'05' = ImportControl Print Label.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“ReturnService”: {}}}}}
ReturnService Required: No Container for type of Return Services.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“ReturnService”: {“Code”: {}}}}}}
Code Required: Yes* Type: Code for type of Return shipment.
String Max Allowed: 1
Length: 1…2 Valid values are:
'2' = UPS Print and Mail Return Label
'3' =UPS One-Attempt Return Label
'5' = UPS Three Attempt Return Label
'8' = UPS Electronic Return Label
'9' = UPS Print Return Label
'10' = UPS Exchange Print Return Label
'11' = UPS Pack & Collect Service 1-Attempt Box 1
'12' = UPS Pack & Collect Service 1-Attempt Box 2
'13' = UPS Pack & Collect Service 1-Attempt Box 3
'14' = UPS Pack & Collect Service 1-Attempt Box 4
'15' = UPS Pack & Collect Service 1-Attempt Box 5
'16' = UPS Pack & Collect Service 3-Attempt Box 1
'17' = UPS Pack & Collect Service 3-Attempt Box 2
'18' = UPS Pack & Collect Service 3-Attempt Box 3
'19' = UPS Pack & Collect Service 3-Attempt Box 4
'20' = UPS Pack & Collect Service 3-Attempt Box 5

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 40
Rating Package RESTful Developer Guide October 22, 2024.

#5 and #10 - Three Attempt Return Label are not valid for
UPS WorldWide Express Freight and UPS Worldwide
Express Freight Midday Services. #3 is not valid return
service with UPS Premium Care accessorial.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“SDLShipmentIndicator”: {}}}}}
SDLShipmentIndicator Required: No Empty Tag means the indicator is present. This field is a
Type: String flag to indicate if the receiver needs SDL rates in
Max Allowed: 1 response. True if SDLShipmentIndicator tag exists; false
Length: 0 otherwise.
If present, the State Department License (SDL) rates will
be returned in the response. This service requires that the
account number is enabled for SDL.
{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“EPRAIndicator”: {}}}}}
EPRAIndicator Required: No Presence/Absence Indicator. Any value inside is ignored.
Type: String This field is a flag to indicate Package Release Code is
Max Allowed: 1 requested for shipment. This accessorial is only valid with
Length: 0 ShipmentIndicationType ‘01’ - Hold for Pickup at UPS
Access Point™.
{“RateRequest”: {“Shipment”: {“ShipmentRatingOptions”: {}}}}
ShipmentRatingOptions Required: No Shipment Rating Options container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“ShipmentRatingOptions”: {“NegotiatedRatesIndicator”: {}}}}}
NegotiatedRatesIndicator Required: Cond NegotiatedRatesIndicator - Required to display two types
Type: String of discounts: 1) Bids or Account Based Rates 2)
Max Allowed: 1 Web/Promotional Discounts Bids Account Based Rates: If
Length: 0 the indicator is present, the Shipper is authorized, and the
Rating Package RESTful Request is configured to return
Negotiated Rates, then Negotiated Rates should be
returned in the response. Web/Promotional Discounts: If
the indicator is present, the Shipper is authorized for
Web/Promotional Discounts then Negotiated Rates should
be returned in the response.
{“RateRequest”: {“Shipment”: {“ShipmentRatingOptions”: {“FRSShipmentIndicator”: {}}}}}
FRSShipmentIndicator Required: Cond FRS Indicator. The indicator is required to obtain rates for
Type: String UPS Ground Freight Pricing (GFP).
Max Allowed: 1
Length: 0 The account number must be enabled for GFP.
{“RateRequest”: {“Shipment”: {“ShipmentRatingOptions”: {“RateChartIndicator”: {}}}}}
RateChartIndicator Required: Cond RateChartIndicator - If present in a request, the response
Type: String will contain a RateChart element.
Max Allowed: 1
Length: 0
{“RateRequest”: {“Shipment”: {“ShipmentRatingOptions”: {“UserLevelDiscountIndicator”: {}}}}}
UserLevelDiscountIndicator Required: No UserLevelDiscountIndicator - required to obtain rates for
Type: String User Level Promotions.
Max Allowed: 1
Length: 0 This is required to obtain User Level Discounts. There
must also be no ShipperNumber in the Shipper container.
{“RateRequest”: {“Shipment”: {“ShipmentRatingOptions”: {“TPFCNegotiatedRatesIndicator”: {}}}}}
TPFCNegotiatedRatesIndica Required: No This indicator applies for a third party (3P) / Freight collect
tor Type: String (FC) shipment only.
Max Allowed: 1
Length: 0 For 3P/FC shipment if the shipper wishes to request for
the negotiated rates of the third party then this indicator
should be included in the request.

If authorized the 3P/FC negotiated rates will be applied to

the shipment and rates will be returned in response.
{“RateRequest”: {“Shipment”: {“InvoiceLineTotal”: {}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 41
Rating Package RESTful Developer Guide October 22, 2024.

InvoiceLineTotal Required: Cond Container to hold InvoiceLineTotal Information.

Type: Container
Max Allowed: 1 Required if the shipment is from US/PR Outbound to non
Length: N/A US/PR destination with the PackagingType of UPS
PAK(04). Required for international shipments when using
request option "ratetimeintransit" or "shoptimeintransit".
{“RateRequest”: {“Shipment”: {“InvoiceLineTotal”: {“CurrencyCode”: {}}}}}
CurrencyCode Required: No Invoice Line Total Currency type. Defaults to the rating
Type: String currency used in the shipper's country or territory. If
Max Allowed: 1 entered, the Currency code should match the origin
Length: 3 country’s or territory’s currency code, otherwise the
currency code entered will be ignored.
Note: UPS doesn't support all international currency
codes. Please check the developer guides for Supported
Currency codes.
{“RateRequest”: {“Shipment”: {“InvoiceLineTotal”: {“MonetaryValue”: {}}}}}
MonetaryValue Required: Yes* Total amount of the invoice accompanying the shipment.
Type: String Required when the InvoiceLineTotal container exists in
Max Allowed: 1 the rate request.
Length: 1..19
Valid values are from 1 to 99999999.
{“RateRequest”: {“Shipment”: {“RatingMethodRequestedIndicator”: {}}}}
RatingMethodRequestedIndi Required: No Presence/Absence Indicator. Any value inside is ignored.
cator Type: String RatingMethodRequestedIndicator is an indicator. If
Max Allowed: 1 present, Billable Weight Calculation method and Rating
Length: 0 Method information would be returned in response.
{“RateRequest”: {“Shipment”: {“TaxInformationIndicator”: {}}}}
TaxInformationIndicator Required: No Presence/Absence Indicator. Any value inside is ignored.
Type: String TaxInformationIndicator is an indicator. The Tax related
Max Allowed: 1 information includes any type of Taxes, corresponding
Length: 0 Monetary Values, Total Charges with Taxes and
disclaimers (if applicable) would be returned in response.
If present, any taxes that may be applicable to a shipment
would be returned in response. If this indicator is
requested with NegotiatedRatesIndicator, Tax related
information, if applicable, would be returned only for
Negotiated Rates and not for Published Rates.
{“RateRequest”: {“Shipment”: {“PromotionalDiscountInformation”: {}}}}
PromotionalDiscountInforma Required: No PromotionalDiscountInformation container. This container
tion Type: Container contains discount information that the customer wants to
Max Allowed: 1 request each time while placing a shipment.
Length: N/A
{“RateRequest”: {“Shipment”: {“PromotionalDiscountInformation”: {“PromoCode”: {}}}}}
PromoCode Required: Yes* Promotion Code. A discount that is applied to the user.
Type: String
Max Allowed: 1 Required if PromotionalDiscountInformation container is
Length: 9 present.
{“RateRequest”: {“Shipment”: {“PromotionalDiscountInformation”: {“PromoAliasCode”: {}}}}}
PromoAliasCode Required: Yes* Promotion Alias code
Type: String
Max Allowed: 1 Required if PromotionalDiscountInformation container is
Length: 20 present.
{“RateRequest”: {“Shipment”: {“DeliveryTimeInformation”: {}}}}
DeliveryTimeInformation Required: No Container for requesting Time In Transit Information.
Type: Container Required to view time in transit information.
Max Allowed: 1
Length: N/A Required to view any time in transit information.
{“RateRequest”: {“Shipment”: {“DeliveryTimeInformation”: {“PackageBillType”: {}}}}}
PackageBillType Required: Yes* Valid values are:
Type: String 02 - Document only
03 - Non-Document

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 42
Rating Package RESTful Developer Guide October 22, 2024.

Max Allowed: 1 04 - WWEF Pallet

Length: 2 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.
{“RateRequest”: {“Shipment”: {“DeliveryTimeInformation”: {“Pickup”: {}}}}}
Pickup Required: No Pickup container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateRequest”: {“Shipment”: {“DeliveryTimeInformation”: {“Pickup”: {“Date”: {}}}}}}
Date Required: No Shipment Date. The user is allowed to query up to 35
Type: String days into the past and 60 days into the future.
Max Allowed: 1
Length: 8 For Subversion of 2205, user can send up to 7 days in the
future with current date as day zero. Format: YYYYMMDD

If a date is not provided or is invalid, it will be defaulted to

the current system date.

{“RateRequest”: {“Shipment”: {“DeliveryTimeInformation”: {“Pickup”: {“Time”: {}}}}}}

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

{“RateRequest”: {“Shipment”: {“MasterCartonIndicator”: “ “} } }

MasterCartonIndicator Required: No The presence of the indicator implies that shipment is
Type: String Master Carton type.
Max Allowed: 1
Length: 0
To show false, omit the element.
To show True:
{“MasterCartonIndicator”: “any value”}
Or
{“MasterCartonIndicator”: “ ”}

{“RateRequest”: {“Shipment”: {“WWEShipmentIndicator”: “ “} } }

WWEShipmentIndicator Required: No The presence of the indicator implies that WWE service
Type: String details are requested for RequestOption=Shop or
Max Allowed: 1 RequestOption=Shoptimeintransit
Length: 0

To show false, omit the element.

To show True:
{“WWEShipmentIndicator”: “any value”}
Or
{“WWEShipmentIndicator”: “ ”}
Note: In order get rates for Worldwide Economy
shipments the Subversion 2108 must be present in the
reques

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 43
Rating Package RESTful Developer Guide October 22, 2024.

{“RateRequest”: {“Shipment”: {“ShipmentServiceOptions”: {“GlobalCheckoutIndicator”: {}}}}}

GlobalCheckoutIndicator Required: No A flag indicating if the shipment requires a
Type: String GlobalCheckoutIndicator.
Max Allowed: 1
Length: 0 True if GlobalCheckoutIndicator tag exists.
False if GlobalCheckoutIndicator tag doesn’t exists.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 44
Rating Package RESTful Developer Guide October 22, 2024.

Response

RateResponse
Name Constraint Description
{“RateResponse”: {}}
RateResponse Required: Yes
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“Response”: {}}}
Response Required: Yes Response Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“Response”: {“ResponseStatus”: {}}}}
ResponseStatus Required: Yes Response Status Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“Response”: {“ResponseStatus”: {“Code”: {}}}}}
Code Required: Yes Identifies the success or failure of the transaction.
Type: String
Max Allowed: 1 1 = Successful
Length: 1
{“RateResponse”: {“Response”: {“ResponseStatus”: {“Description”: {}}}}}
Description Required: Yes Describes Response Status Code. Returns text of
Type: String "Success" for a valid request.
Max Allowed: 1
Length: 1…35
{“RateResponse”: {“Response”: {“Alert”: {}}}}
Alert Required: No Alert container. There can be zero to many alert
Type: Container containers with code and description.
Max Allowed:
UNB Length: N/A
{“RateResponse”: {“Response”: {“Alert”: {“Code”: {}}}}}
Code Required: Yes* Warning code returned by the system.
Type: String
Max Allowed: 1
Length: 1…10
{“RateResponse”: {“Response”: {“Alert”: {“Description”: {}}}}}
Description Required: Yes* Warning messages returned by the system.
Type: String
Max Allowed: 1
Length: 1…150
{“RateResponse”: {“Response”: {“AlertDetail”: {}}}}
AlertDetail Required: No Alert Detail Container.
Type: Container
Max Allowed: Currently applies to and returned only for request
Unbounded containing HazMat and SubVersion greater than or equal
Length: N/A to 1701.
{“RateResponse”: {“Response”: {“AlertDetail”: {“Code”: {}}}}}
Code Required: Yes* Warning code returned by the system.
Type: String
Max Allowed: 1
Length: 1…10
{“RateResponse”: {“Response”: {“AlertDetail”: {“Description”: {}}}}}
Description Required: Yes* Warning messages returned by the system.
Type: String
Max Allowed: 1
Length: 1…150
{“RateResponse”: {“Response”: {“AlertDetail”: {“ElementLevelInformation”: {}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 45
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

ElementLevelInformation Required: Cond Provides more information about the element that
Type: Container represents the alert.
Max Allowed: 1
Length: N/A
{“RateResponse”: {“Response”: {“AlertDetail”: {“ElementLevelInformation”: {“Level”: {}}}}}}
Level Required: Yes* Define type of element in request. Possible values are -
Type: String 'H’ for the header details level, ‘S’ for the shipment level,
Max Allowed: 1 ‘P’ for the package level, ‘C’ for the commodity level.
Length: 1
{“RateResponse”: {“Response”: {“AlertDetail”: {“ElementLevelInformation”: {“ElementIdentifier”: {}}}}}}
ElementIdentifier Required: Cond Contains more information about the type of element.
Type: Container Returned if Level is 'P' or 'C'.
Max Allowed:
Unbounded
Length: N/A
{“RateResponse”: {“Response”: {“AlertDetail”: {“ElementLevelInformation”: {“ElementIdentifier”: {“Code”: {}}}}}}}
Code Required: Yes* Represents the type of element. Possible values are 'P'
Type: String and 'C'.
Max Allowed: 1
Length: 1
{“RateResponse”: {“Response”: {“AlertDetail”: {“ElementLevelInformation”: {“ElementIdentifier”: {“Value”: {}}}}}}}
Value Required: Yes* Represents the value of element.
Type: String
Max Allowed: 1
Length: 1…5
{“RateResponse”: {“Response”: {“TransactionReference”: {}}}}
TransactionReference Required: No Transaction Reference Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“Response”: {“TransactionReference”: {“CustomerContext”: {}}}}}
CustomerContext Required: No The CustomerContext Information which will be echoed
Type: String during response.
Max Allowed: 1
Length: 1…512
{“RateResponse”: {“RatedShipment”: {}}}
RatedShipment Required: Yes RatedShipment Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“Disclaimer”: {}}}}
Disclaimer Required: Cond Disclaimer is used to provide more information to the
Type: Container shipper regarding the processed shipment. It is used to
Max Allowed: notify the shipper about possible taxes and duties that
UNB Length: N/A might have been added or might apply to the shipment.
Refer to the Appendix for various disclaimers. This field
may be returned only if TaxInformationIndicator is present
in the request.
{“RateResponse”: {“RatedShipment”: {“Disclaimer”: {“Code”: {}}}}}
Code Required: Yes* Code representing type of Disclaimer. Refer to the
Type: String Appendix for possible code values.
Max Allowed: 1
Length: 2
{“RateResponse”: {“RatedShipment”: {“Disclaimer”: {“Description”: {}}}}}
Description Required: Yes* Disclaimer description. Please refer to Appendix for
Type: String possible descriptions.
Max Allowed: 1
Length: UNB
{“RateResponse”: {“RatedShipment”: {“Service”: {}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 46
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Service Required: Yes Service Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“Service”: {“Code”: {}}}}}
Code Required: Yes The UPS service code.
Type: String
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“Service”: {“Description”: {}}}}}
Description Required: No The UPS service Description.
Type: String
Max Allowed: 1
Length: 1…35
{“RateResponse”: {“RatedShipment”: {“RateChart”: {}}}}
RateChart Required: No Rate Type with which Shipment is rated. Possible
Type: String RateChart values for different regions will be: US 48
Max Allowed: 1 origin: 1 – Daily Rates 3 – Standard List Rates 4 – Retail
Length: 1 Rates. Alaska/Hawaii origin: 1 – Daily Rates 3 – Standard
List Rates 4 – Retail Rates. All Other origins: 1 – Rates 5
- Regional Rates 6 - General List Rates. 3 and 4 do not
apply
{“RateResponse”: {“RatedShipment”: {“RatedShipmentAlert”: {}}}}
RatedShipmentAlert Required: No Rated Shipment Alert container. There can be zero to
Type: Container many RatedShipmentAlert containers with code and
Max Allowed: description.
UNB Length: N/A
{“RateResponse”: {“RatedShipment”: {“RatedShipmentAlert”: {“Code”: {}}}}}
Code Required: Yes* The rated shipments warning code returned by the
Type: String system.
Max Allowed: 1
Length: 1…10
{“RateResponse”: {“RatedShipment”: {“RatedShipmentAlert”: {“Description”: {}}}}}
Description Required: Yes* The rated shipment warning Description returned by the
Type: String system.
Max Allowed: 1
Length: 1…150
{“RateResponse”: {“RatedShipment”: {“BillableWeightCalculationMethod”: {}}}}
BillableWeightCalculationMethod Required: Cond Indicates whether the billable weight calculation method
Type: String is utilized at the package or shipment level. This
Max Allowed: 1 information will be returned only if
Length: 2 RatingMethodRequestedIndicator is present in the
request.
Possible values: 01 = Shipment Billable Weight 02 =
Package Billable Weight
{“RateResponse”: {“RatedShipment”: {“RatingMethod”: {}}}}
RatingMethod Required: Cond Billing Weight Container.
Type: Container
Max Allowed: 1 Possible values: 01 = Shipment level 02 = Package level
Length: N/A
{“RateResponse”: {“RatedShipment”: {“BillingWeight”: {}}}}
BillingWeight Required: Yes Billing Weight Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“BillingWeight”: {“UnitOfMeasurement”: {}}}}}
UnitOfMeasurement Required: Yes Unit Of Measurement Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“BillingWeight”: {“UnitOfMeasurement”: {“Code”: {}}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 47
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Code Required: Yes The code associated with the unit of measure for the
Type: String billable weight of a shipment. Possible values are KGS or
Max Allowed: 1 LBS.
Length: 3
{“RateResponse”: {“RatedShipment”: {“BillingWeight”: {“UnitOfMeasurement”: {“Description”: {}}}}}}
Description Required: Yes The description for the billable weight associated with the
Type: String shipment.
Max Allowed: 1
Length: 1…35
{“RateResponse”: {“RatedShipment”: {“BillingWeight”: {“Weight”: {}}}}}
Weight Required: Yes The value for the billable weight associated with the
Type: String shipment.
Max Allowed: 1
Length: 5 When using a negotiated divisor different from the
published UPS divisor (139 for inches and 5,000 for cm),
the weight returned is based on the published divisor.
Rates, however, are based on the negotiated divisor.
{“RateResponse”: {“RatedShipment”: {“TransportationCharges”: {}}}}
TransportationCharges Required: Yes Transportation Charges Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“TransportationCharges”: {“CurrencyCode”: {}}}}}
CurrencyCode Required: Yes The IATA currency code associated with the
Type: String transportation costs for the shipment.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“TransportationCharges”: {“MonetaryValue”: {}}}}}
MonetaryValue Required: Yes The value for the transportation costs associated with the
Type: String shipment.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“BaseServiceCharge”: {}}}}
BaseServiceCharge Required: Cond Base Service Charge Container.
Type: Container
Max Allowed: 1 These charges would be returned only when subversion
Length: N/A is greater than or equal to 1701
{“RateResponse”: {“RatedShipment”: {“BaseServiceCharge”: {“CurrencyCode”: {}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the base service
Type: String charge costs for the shipment.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“BaseServiceCharge”: {“MonetaryValue”: {}}}}}
MonetaryValue Required: Yes* The base value of the specific service for the shipment.
Type: String This is equal to transportation charges - fuel surcharges.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“ItemizedCharges”: {}}}}
ItemizedCharges Required: Cond Itemized Charges are returned only when the subversion
Type: Container element is present and greater than or equal to '1601'.
Max Allowed:
UNB Length: N/A These charges would be returned only when subversion
is greater than or equal to 1601
{“RateResponse”: {“RatedShipment”: {“ItemizedCharges”: {“Code”: {}}}}}
Code Required: Yes* Identification code for itemized charge.
Type: String
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“ItemizedCharges”: {“Description”: {}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 48
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Description Required: No Description of Itemized Charge that had been charged.
Type: String
Max Allowed: 1
Length: 1…50
{“RateResponse”: {“RatedShipment”: {“ItemizedCharges”: {“CurrencyCode”: {}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the Itemized
Type: String Charge costs for the shipment.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“ItemizedCharges”: {“MonetaryValue”: {}}}}}
MonetaryValue Required: Yes* The value for Itemized Charge costs associated with the
Type: String shipment.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“ItemizedCharges”: {“SubType”: {}}}}}
SubType Required: No The sub-type of Itemized Charge type.
Type: String
Max Allowed: 1
Length: 1…50
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {}}}}
FRSShipmentData Required: Cond FRSShipmentData container.
Type: Container
Max Allowed: 1 Only returned when the FRSShipmentIIndicator is used.
Length: N/A UPS Ground Freight Pricing Only.
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“TransportationCharges”: {}}}}}
TransportationCharges Required: Yes* Transportation Charges Container
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“TransportationCharges”: {“GrossCharge”: {}}}}}}
GrossCharge Required: Yes* Gross Transportation Charges Container
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“TransportationCharges”: {“GrossCharge”:
{“CurrencyCode”: {}}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the
Type: String transportation costs for the shipment.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“TransportationCharges”: {“GrossCharge”:
{“MonetaryValue”: {}}}}}}}
MonetaryValue Required: Yes* Total charges Monetary value. Valid values are from 0 to
Type: String 9999999999999999.99
Max Allowed: 1
Length: 1..19
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“TransportationCharges”: {“DiscountAmount”: {}}}}}}
DiscountAmount Required: Yes* Discount Container
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“TransportationCharges”: {“DiscountAmount”:
{“CurrencyCode”: {}}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the
Type: String transportation costs for the shipment.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“TransportationCharges”: {“DiscountAmount”:
{“MonetaryValue”: {}}}}}}}
MonetaryValue Required: Yes* Total charges Monetary value. Valid values are from 0 to
Type: String 9999999999999999.99
Max Allowed: 1
Length: 1..19

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 49
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“TransportationCharges”: {“DiscountPercentage”:
{}}}}}}
DiscountPercentage Required: Yes* Discount Percentage
Type: String
Max Allowed: 1
Length: 2
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“TransportationCharges”: {“NetCharge”: {}}}}}}
NetCharge Required: Yes* Net Transportation Rate Container
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“TransportationCharges”: {“NetCharge”:
{“CurrencyCode”: {}}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the
Type: String transportation costs for the shipment.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“TransportationCharges”: {“NetCharge”:
{“MonetaryValue”: {}}}}}}}
MonetaryValue Required: Yes* Total charges Monetary value. Valid values are from 0 to
Type: String 9999999999999999.99
Max Allowed: 1
Length: 1..19
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“FreightDensityRate”: {}}}}}
FreightDensityRate Required: No FreightDensityRate container for Density based rating.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“FreightDensityRate”: {“Density”: {}}}}}}
Density Required: Yes* Density is returned if the Shipper is eligible for Density
Type: String based rate. Valid values:0 to 999.9
Max Allowed: 1
Length: 1…5
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“FreightDensityRate”: {“TotalCubicFeet”: {}}}}}}
TotalCubicFeet Required: Yes* TotalCubic feet is returned if the Shipper is eligible for
Type: String Density based rate. Valid values:0 to 99999.999
Max Allowed: 1
Length: 1…9
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {}}}}}
HandlingUnits Required: No Handling Unit for Density based rating container.
Type: Container
Max Allowed:
UNB Length: N/A
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“Quantity”: {}}}}}}
Quantity Required: Yes* Handling Unit Quantity for Density based rating.
Type: String
Max Allowed: 1
Length: 8
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“Type”: {}}}}}}
Type Required: Yes* Handling Unit Type for Density based rating.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“Type”: {“Code”: {}}}}}}}
Code Required: Yes* The code associated with Handling Unit Type.
Type: String
Max Allowed: 1 Valid values:
Length: 3 SKD = Skid
CBY = Carboy
PLT = Pallet
TOT = Totes
LOO = Loose
OTH = Other

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 50
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“Type”: {“Description”: {}}}}}}}
Description Required: No A description of the code for the Handling Unit type.
Type: String
Max Allowed: 1
Length: 1…35
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“Dimensions”: {}}}}}}
Dimensions Required: Yes* Dimension of the HandlingUnit container for density
Type: Container based pricing.
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“Dimensions”:
{“UnitOfMeasurement”: {}}}}}}}
UnitOfMeasurement Required: Yes* UnitOfMeasurement container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“Dimensions”:
{“UnitOfMeasurement”: {“Code”: {}}}}}}}}
Code Required: Yes* Code for UnitOfMeasurement for the line item dimension.
Type: String Valid value: IN = Inches
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“Dimensions”:
{“UnitOfMeasurement”: {“Description”: {}}}}}}}}
Description Required: No Description for UnitOfMeasurement for the line item
Type: String dimension.
Max Allowed: 1
Length: 1…35
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“Dimensions”: {“Length”: {}}}}}}}
Length Required: Yes* The length of the line item used to determine dimensional
Type: String weight.
Max Allowed: 1
Length: 1…19
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“Dimensions”: {“Width”: {}}}}}}}
Width Required: Yes* The width of the line item used to determine dimensional
Type: String weight.
Max Allowed: 1
Length: 1…19
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“Dimensions”: {“Height”: {}}}}}}}
Height Required: Yes* The height of the line item used to determine dimensional
Type: String weight.
Max Allowed: 1
Length: 1…19
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“AdjustedHeight”: {}}}}}}
AdjustedHeight Required: Cond Container to hold Adjusted Height information.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“AdjustedHeight”: {“Value”: {}}}}}}}
Value Required: Yes* Adjusted Height value for the handling unit.
Type: String
Max Allowed: 1 Adjusted Height is done only when Handling unit type is
Length: 1…19 SKD = Skid or PLT = Pallet.
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“AdjustedHeight”:
{“UnitOfMeasurement”: {}}}}}}}
UnitOfMeasurement Required: Yes* Unit of Measurement container for the Adjusted height.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“AdjustedHeight”:
{“UnitOfMeasurement”: {“Code”: {}}}}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 51
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Code Required: Yes* Code associated with Unit of Measurement for the
Type: String Adjusted height.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“FRSShipmentData”: {“HandlingUnits”: {“AdjustedHeight”:
{“UnitOfMeasurement”: {“Description”: {}}}}}}}}
Description Required: No Description for Code associated with Unit of
Type: String Measurement for the Adjusted height.
Max Allowed: 1
Length: 1…35
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“BaseServiceCharge”: {}}}}}
BaseServiceCharge Required: Cond Base Service Charge Container.
Type: Container
Max Allowed: 1 These charges would be returned only when subversion
Length: N/A is greater than or equal to 1701
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“BaseServiceCharge”: {“CurrencyCode”: {}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the base service
Type: String charge costs for the shipment.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“BaseServiceCharge”: {“MonetaryValue”: {}}}}}}
MonetaryValue Required: Yes* The base value of the specific service for the shipment.
Type: String This is equal to transportation charges - fuel surcharges.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“ServiceOptionsCharges”: {}}}}
ServiceOptionsCharges Required: Yes Service Options Charges Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“ServiceOptionsCharges”: {“CurrencyCode”: {}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the accessorial
Type: String charges for the package.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“ServiceOptionsCharges”: {“MonetaryValue”: {}}}}}
MonetaryValue Required: Yes* The value for the accessorial charges associated with the
Type: String package.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“TaxCharges”: {}}}}
TaxCharges Required: Cond TaxCharges container are returned only when
Type: Container TaxInformationIndicator is present in request and when
Max Allowed: Negotiated Rates are not applicable. TaxCharges
UNB Length: N/A container contains Tax information for a given shipment.
{“RateResponse”: {“RatedShipment”: {“TaxCharges”: {“Type”: {}}}}}
Type Required: Yes* Tax Type code. The code represents the type of Tax
Type: String applied to a shipment. Please refer to Appendix I for
Max Allowed: 1 possible Tax Type codes.
Length: 1…9
{“RateResponse”: {“RatedShipment”: {“TaxCharges”: {“MonetaryValue”: {}}}}}
MonetaryValue Required: Yes* Tax Monetary Value represent the Tax amount.
Type: String
Max Allowed: 1 Valid values are from 0 to 99999999999999.99
Length: 16
{“RateResponse”: {“RatedShipment”: {“TotalCharges”: {}}}}
TotalCharges Required: Yes Total Charges Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“TotalCharges”: {“CurrencyCode”: {}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 52
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

CurrencyCode Required: Yes The IATA currency code associated with the total charges
Type: String for the shipment.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“TotalCharges”: {“MonetaryValue”: {}}}}}
MonetaryValue Required: Yes The value for the total charges associated with the
Type: String shipment.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“TotalChargesWithTaxes”: {}}}}
TotalChargesWithTaxes Required: Cond TotalChargesWithTaxes container would be returned only
Type: Container if TaxInformationIndicator is present in request and when
Max Allowed: 1 Negotiated Rates are not applicable.
Length: N/A TotalChargesWithTaxes contains total charges including
total taxes applied to a shipment.
{“RateResponse”: {“RatedShipment”: {“TotalChargesWithTaxes”: {“CurrencyCode”: {}}}}}
CurrencyCode Required: Yes* TotalChargesWithTaxes currency code type. The
Type: String currency code used in the Shipment request is returned.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“TotalChargesWithTaxes”: {“MonetaryValue”: {}}}}}
MonetaryValue Required: Yes* TotalChargesWithTaxes monetary value amount.
Type: String
Max Allowed: 1 Valid values are from 0 to 99999999999999.99
Length: 16
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {}}}}
NegotiatedRateCharges Required: No Negotiated Rate Charges Container.
Type: Container
Max Allowed: 1 For tiered rates and promotional discounts, if a particular
Length: N/A shipment 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.
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“BaseServiceCharge”: {}}}}}
BaseServiceCharge Required: Yes Negotiated base service charge container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“BaseServiceCharge”: {“CurrencyCode”: {}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the base service
Type: String Charge
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“BaseServiceCharge”: {“MonetaryValue”: {}}}}}}
MonetaryValue Required: Yes* The value for base service charge
Type: String
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“ItemizedCharges”: {}}}}}
ItemizedCharges Required: Cond Itemized Charges are returned only when the subversion
Type: Container element is present and greater than or equal to '1601'.
Max Allowed:
UNB Length: N/A These charges would be returned only when subversion
is greater than or equal to 1601
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“ItemizedCharges”: {“Code”: {}}}}}}
Code Required: Yes* Identification code for itemized charge.
Type: String
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“ItemizedCharges”: {“Description”: {}}}}}}
Description Required: No Description of Itemized Charge that had been charged.
Type: String

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 53
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Max Allowed: 1
Length: 1…50
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“ItemizedCharges”: {“CurrencyCode”: {}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the Itemized
Type: String Charge costs for the shipment.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“ItemizedCharges”: {“MonetaryValue”: {}}}}}}
MonetaryValue Required: Yes* The value for Itemized Charge costs associated with the
Type: String shipment.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“ItemizedCharges”: {“SubType”: {}}}}}}
SubType Required: No The sub-type of Itemized Charge type.
Type: String
Max Allowed: 1
Length: 1…50
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“TaxCharges”: {}}}}}
TaxCharges Required: Cond TaxCharges container are returned only when
Type: Container TaxInformationIndicator is present in request.
Max Allowed: TaxCharges container contains Tax information for a
UNB Length: N/A given shipment.
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“TaxCharges”: {“Type”: {}}}}}}
Type Required: Yes* Tax Type code. The code represents the type of Tax
Type: String applied to a shipment. Please refer to Appendix I for
Max Allowed: 1 possible Tax Type codes.
Length: 1…9
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“TaxCharges”: {“MonetaryValue”: {}}}}}}
MonetaryValue Required: Yes* Tax Monetary Value represent the Tax amount.
Type: String
Max Allowed: 1
Length: 16 Valid values are from 0 to 99999999999999.99
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“TotalCharge”: {}}}}}
TotalCharge Required: Yes Total Charges Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“TotalCharge”: {“CurrencyCode”: {}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the Negotiated
Type: String Rate total charges for the shipment.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“TotalCharge”: {“MonetaryValue”: {}}}}}}
MonetaryValue Required: Yes* The value for the Negotiated Rate total charges
Type: String associated with the shipment.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“TotalChargesWithTaxes”: {}}}}}
TotalChargesWithTaxes Required: Cond TotalChargesWithTaxes container would be returned only
Type: Container if TaxInformationIndicator is present in request.
Max Allowed: 1 TotalChargesWithTaxes contains total charges including
Length: N/A total taxes applied to a shipment.
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“TotalChargesWithTaxes”: {“CurrencyCode”:
{}}}}}}
CurrencyCode Required: Yes* TotalChargesWithTaxes currency code type. The
Type: String currency code used in the Shipment request is returned.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”: {“TotalChargesWithTaxes”: {“MonetaryValue”:
{}}}}}}
MonetaryValue Required: Yes* TotalChargesWithTaxes monetary value amount.
Type: String

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 54
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Max Allowed: 1 Valid values are from 0 to 99999999999999.99
Length: 16
{"RateResponse":{"RatedShipment":{"NegotiatedRateCharges":{"RateModifier":{}}}}}
RateModifier Required: Yes RateModifier inside NegotiatedRate charges Container to
Type: String hold Modifier charges at shipment level.
Max Allowed: 1
Length: 3
{"RateResponse":{"RatedShipment":{"NegotiatedRateCharges":{"RateModifier":{"ModifierType":{}}}}}}
ModifierType Required: Yes Rate Modifier Type.
Type: String Example- "ORM"
Max Allowed: 1
Length: 3
{"RateResponse":{"RatedShipment":{"NegotiatedRateCharges":{"RateModifier"{"ModifierDesc":{}}}}}}
ModifierDesc Required: Yes Rate Modifier Description.
Type: String Example- "Origin Modifier"
Max Allowed: 1
Length: 50
{"RateResponse":{"RatedShipment":{"NegotiatedRateCharges":{"RateModifier":{"Amount":{}}}}}}
Amount Required: Yes Amount.
Type: String
Max Allowed: 1 Example- "-1.00","0.25"
Length: 16 It contains positive or negative values.
{“RateResponse”: {“RatedShipment”: {“GuaranteedDelivery”: {}}}}
GuaranteedDelivery Required: No Guaranteed Delivery Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“GuaranteedDelivery”: {“BusinessDaysInTransit”: {}}}}}
BusinessDaysInTransit Required: No The rated shipments guaranteed delivery date. Denotes
Type: String UPS published guarantee times. (i.e. 3DaySelect = 3)
Max Allowed: 1
Length: 1…8
{“RateResponse”: {“RatedShipment”: {“GuaranteedDelivery”: {“DeliveryByTime”: {}}}}}
DeliveryByTime Required: No The rated shipments committed delivery time.
Type: String
Max Allowed: 1
Length: 1…6
{“RateResponse”: {“RatedShipment”: {“ScheduledDeliveryDate”: {}}}}
ScheduledDeliveryDate Required: No The rated shipments scheduled delivery date.
Type: String
Max Allowed: 1
Length: 8
{“RateResponse”: {“RatedShipment”: {“RateConstructTypeIndicator”: {}}}}
RateConstructTypeIndicator Required: No Informational only
Type: String
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {}}}}
RatedPackage Required: Yes Rated Package Container.
Type: Container
Max Allowed:
UNB Length: N/A
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“TransportationCharges”: {}}}}}
TransportationCharges Required: No Transportation Charges Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“TransportationCharges”: {“CurrencyCode”: {}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the
Type: String transportation costs for the package.
Max Allowed: 1
Length: 1…3

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 55
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“TransportationCharges”: {“MonetaryValue”: {}}}}}}
MonetaryValue Required: Yes* The value for the transportation costs associated with the
Type: String package.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ServiceOptionsCharges”: {}}}}}
ServiceOptionsCharges Required: No Service Options Charges Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ServiceOptionsCharges”: {“CurrencyCode”: {}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the accessorial
Type: String charges for the package.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ServiceOptionsCharges”: {“MonetaryValue”: {}}}}}}
MonetaryValue Required: Yes* The value for the accessorial charges associated with the
Type: String package.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“TotalCharges”: {}}}}}
TotalCharges Required: No Total Charges Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“TotalCharges”: {“CurrencyCode”: {}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the total charges
Type: String for the package.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“TotalCharges”: {“MonetaryValue”: {}}}}}}
MonetaryValue Required: Yes* The value for the total charges associated with the
Type: String package.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“Weight”: {}}}}}
Weight Required: No The weight of the package in the rated Package.
Type: String
Max Allowed: 1
Length: 5
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“BillingWeight”: {}}}}}
BillingWeight Required: No Billing Weight Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“BillingWeight”: {“UnitOfMeasurement”: {}}}}}}
UnitOfMeasurement Required: Yes* Unit Of Measurement Container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“BillingWeight”: {“UnitOfMeasurement”: {“Code”: {}}}}}}}
Code Required: Yes* The code associated with the unit of measure for the
Type: String billable weight of a package.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“BillingWeight”: {“UnitOfMeasurement”: {“Description”:
{}}}}}}}
Description Required: Yes* The Description for the Unit Of Measurement.
Type: String
Max Allowed: 1
Length: 1…35
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“BillingWeight”: {“Weight”: {}}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 56
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Weight Required: Yes* The value for the billable weight associated with the
Type: String package.
Max Allowed: 1
Length: 5 When using a negotiated divisor different from the
published UPS divisor (139 for inches and 5,000 for cm),
the weight returned is based on the published divisor.
Rates, however, are based on the negotiated divisor.
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“Accessorial”: {}}}}}
Accessorial Required: Cond The container for Accessorial indicators. This information
Type: Container would be returned only if ItemizedChargesRequested
Max Allowed: was present during Rate request. This is valid only for
UNB Length: N/A UPS Worldwide Express Freight Service.
This is valid only for UPS Worldwide Express Freight
Service.
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“Accessorial”: {“Code”: {}}}}}}
Code Required: Yes* Code for Accessorial Indicator.
Type: String
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“Accessorial”: {“Description”: {}}}}}}
Description Required: No Description for Accessorial Indicator.
Type: String
Max Allowed: 1
Length: 1…50
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ItemizedCharges”: {}}}}}
ItemizedCharges Required: Cond Itemized Charges are returned only when the subversion
Type: Container element is present and greater than or equal to '1607'.
Max Allowed:
UNB Length: N/A These charges would be returned only when subversion
is greater than or equal to 1607.
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ItemizedCharges”: {“Code”: {}}}}}}
Code Required: Yes* Identification code for itemized charge.
Type: String
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ItemizedCharges”: {“Description”: {}}}}}}
Description Required: No Description of Itemized Charge that had been charged.
Type: String
Max Allowed: 1
Length: 1…50
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ItemizedCharges”: {“CurrencyCode”: {}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the Itemized
Type: String Charge costs for the shipment.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ItemizedCharges”: {“MonetaryValue”: {}}}}}}
MonetaryValue Required: Yes* The value for Itemized Charge costs associated with the
Type: String shipment.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ItemizedCharges”: {“SubType”: {}}}}}}
SubType Required: No The sub-type of Itemized Charge type.
Type: String
Max Allowed: 1
Length: 1…50
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {}}}}}
NegotiatedCharges Required: Cond Negotiated Rates container.
Type: Container
Max Allowed: 1 These charges would be returned only when - 1)
Length: N/A subversion is greater than or equal to 1607 2) if

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 57
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

negotiated rates were requested for GFP shipments and
account number is eligible to receive negotiated rates.
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“BaseServiceCharge”: {}}}}
BaseServiceCharge Required: Cond Negotiated base service charge container.
Type: Container
Max Allowed: 1 These charges would be returned only when subversion
Length: N/A is greater than or equal to 2201.
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“BaseServiceCharge”:
{“CurrencyCode”: {}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the base service
Type: String charge.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“BaseServiceCharge”:
{“MonetaryValue”: {}}}}}
MonetaryValue Required: Yes* The value for base service charge.
Type: String
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“TransportationCharges”: {}}}}
TransportationCharges Required: Cond Negotiated transportation charge container.
Type: Container
Max Allowed: 1 These charges would be returned only when subversion
Length: N/A is greater than or equal to 2201.
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“TransportationCharges”:
{“CurrencyCode”: {}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the
Type: String transportation charge.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“TransportationCharges”:
{“MonetaryValue”: {}}}}}
MonetaryValue Required: Yes* The value for transportation Charge.
Type: String
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“ServiceOptionsCharges”: {}}}}
ServiceOptionsCharges Required: Cond Negotiated service options charge container.
Type: Container
Max Allowed: 1 These charges would be returned only when subversion
Length: N/A is greater than or equal to 2201.
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“ServiceOptionsCharges”:
{“CurrencyCode”: {}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the service
Type: String options Charge
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“ServiceOptionsCharges”:
{“MonetaryValue”: {}}}}}
MonetaryValue Required: Yes* The value for service options charge.
Type: String
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“TotalCharge”: {}}}}
TotalCharge Required: Cond Negotiated total charge container.
Type: Container These charges would be returned only when subversion
Max Allowed: 1 is greater than or equal to 2201.
Length: N/A
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“TotalCharge”: {“CurrencyCode”:
{}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the total charge
Type: String

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 58
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“TotalCharge”: {“MonetaryValue”:
{}}}}}
MonetaryValue Required: Yes* The value for total Charge
Type: String
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“ItemizedCharges”: {}}}}}}
ItemizedCharges Required: Cond Negotiated Itemized Accessorial and Sur Charges.
Type: Container
Max Allowed: These charges would be returned only when subversion
UNB Length: N/A is greater than or equal to 1607.
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“ItemizedCharges”: {“Code”: {}}}}}}}
Code Required: Yes* Identification code for itemized charge.
Type: String
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“ItemizedCharges”: {“Description”:
{}}}}}}}
Description Required: No Description of Itemized Charge that had been charged.
Type: String
Max Allowed: 1
Length: 1…50
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“ItemizedCharges”:
{“CurrencyCode”: {}}}}}}}
CurrencyCode Required: Yes* The IATA currency code associated with the Itemized
Type: String Charge costs for the shipment.
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“ItemizedCharges”:
{“MonetaryValue”: {}}}}}}}
MonetaryValue Required: Yes* The value for Itemized Charge costs associated with the
Type: String shipment.
Max Allowed: 1
Length: 16
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“NegotiatedCharges”: {“ItemizedCharges”: {“SubType”:
{}}}}}}}
SubType Required: No The sub-type of Itemized Charge type.
Type: String
Max Allowed: 1
Length: 1…50
{"RateResponse":{"RatedShipment":{"RatedPackage":{"NegotiatedCharges":{"RateModifier":{}}}}}}
RateModifier Required: RateModifier inside Negotiated charges container to hold
Optional Modifier charges at package level.
Type: Container
Max Allowed:
UNB
Length: N/A
{"RateResponse":{"RatedShipment":{"RatedPackage":{"NegotiatedCharges":{"RateModifier":{"ModifierType":{}}}}}}}
ModifierType Required: Yes Rate Modifier Type
Type: String Example- "ORM"
Max Allowed: 1
Length: 3
{"RateResponse":{"RatedShipment":{"RatedPackage":{"NegotiatedCharges":{"RateModifier":{"ModifierDesc":{}}}}}}
ModifierDesc Required: Yes Rate Modifier Description.
Type: String Example- "Origin Modifier"
Max Allowed: 1
Length: 50
{"RateResponse":{"RatedShipment":{"RatedPackage":{"NegotiatedCharges":{"RateModifier":{"Amount":{}}}}}}}
Amount Required: Yes Amount.
Type: String

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 59
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Max Allowed: 1 Example- "-1.00","0.25"
Length: 16
It contains positive or negative values.
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“SimpleRate”: {}}}}}
SimpleRate Required: No Simple Rate Container
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“SimpleRate”: {“Code”: {}}}}}}
Code Required: Yes* Simple Rate Code
Type: String
Max Allowed: 1 XS = Extra Small
Length: 2 S = Small
M = Medium
L = Large
XL = Extra Large
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“RateModifier”: {}}}}}
RateModifier Required: No Container for Rate Modifier information.
Type: Container
Max Allowed:
UNB Length: N/A
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ RateModifier”: {“ModifierType”: {}}}}}}
ModifierType Required: Yes* Rate Modifier Type.
Type: String Example- "ORM"
Max Allowed: 1
Length: 3
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ RateModifier”: {“ModifierDesc”: {}}}}}}
ModifierDesc Required: Yes* Rate Modifier Description.
Type: String Example- "Origin Modifier"
Max Allowed: 1
Length: 50
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ RateModifier”: {“Amount”: {}}}}}}
Amount Required: Yes* Amount
Type: String Example- "-1.00","0.25".
Max Allowed: 1 It contains positive or negative values.
Length: 16
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {}}}}
TimeInTransit Required: Cond Container for returned Time in Transit information.
Type: Container
Max Allowed: 1 Will only be returned if request option was either
Length: N/A "ratetimeintransit" or "shoptimeintransit" and
DeliveryTimeInformation container was present in
request.
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“PickupDate”: {}}}}}
PickupDate Required: Yes* The date the user requests UPS to pickup the package
Type: String from the origin. Format: YYYYMMDD. In the event this
Max Allowed: 1 Pickup date differs from the Pickup date in the Estimated
Length: 8 Arrival Container, a warning will be returned.
In the event this Pickup date differs from the Pickup date
in the Estimated Arrival Container, a warning will be
returned.
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“DocumentsOnlyIndicator”: {}}}}}
DocumentsOnlyIndicator Required: Cond If the indicator is present then the shipment was
Type: String processed as Document Only.
Max Allowed: 1
Length: 0
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“PackageBillType”: {}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 60
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

PackageBillType Required: Cond Package bill type for the shipment. Valid values:
Type: String 02 - Document only
Max Allowed: 1 03 - Non-Document
Length: 2 04 - Pallet
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {}}}}}
ServiceSummary Required: Yes* Container for all available service information.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“Service”: {}}}}}}
Service Required: Yes* Container for the the UPS service selected for a
Type: Container shipment.
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“Service”: {“Description”: {}}}}}}}
Description Required: No Optional. Description of service. Example, UPS Next Day
Type: String Air, UPS Ground etc, as referenced by the Service Code.
Max Allowed: 1
Length: 1..35
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“GuaranteedIndicator”: {}}}}}}
GuaranteedIndicator Required: Cond Empty Tag. Indicates whether the service will be
Type: String guaranteed or not. Required for International Requests.
Max Allowed: 1
Length: 0
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“Disclaimer”: {}}}}}}
Disclaimer Required: Cond The Disclaimer is provided based upon the Origin and
Type: String Destination country or territory Codes provided in the
Max Allowed: 1 request document. The disclaimer is returned as a
Length: conditional statement to the validity of the service being
unbounded guaranteed. The possible disclaimers that can be
returned are available in the Service Guaranteed
Disclaimers table.
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”: {}}}}}}
EstimatedArrival Required: Yes* Container for the Time-In-Transit arrival information by
Type: Container service
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”: {“Arrival”: {}}}}}}}
Arrival Required: Yes* Container for the Time-In-Transit arrival information by
Type: Container service. This is the most accurate delivery information
Max Allowed: 1 available via the Rating Package RESTful API and will
Length: N/A reflect changes in delivery schedules due to peak
business seasons or holidays.
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”: {“Arrival”: {“Date”:
{}}}}}}}}
Date Required: Yes* Scheduled Local Delivery Date. Format: YYYYMMDD
Type: String
Max Allowed: 1
Length: 8
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”: {“Arrival”: {“Time”:
{}}}}}}}}
Time Required: Cond The time UPS will pick up the shipment. This is commit
Type: String Time. Military Time Format HHMMSS or HHMM
Max Allowed: 1
Length: 4...6
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”:
{“BusinessDaysInTransit”: {}}}}}}}
BusinessDaysInTransit Required: Yes* Number of business days from Origin to Destination
Type: String Locations.
Max Allowed: 1
Length: 1...5
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”: {“Pickup”: {}}}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 61
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Pickup Required: Yes* The date and pick up time container.
Type: Container
Max Allowed: 1
Length: N/A
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”: {“Pickup”: {“Date”:
{}}}}}}}}
Date Required: Yes* The date UPS picks up the package from the origin.
Type: String Format: YYYYMMDD. In the event the Pickup date differs
Max Allowed: 1 from the Ship On Date, provided in the request, a warning
Length: 8 message will be returned.
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”: {“Pickup”: {“Time”:
{}}}}}}}}
Time Required: Cond The time UPS will pick up the shipment. Military Time
Type: String Format HHMMSS or HHMM
Max Allowed: 1
Length: 4...6
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”: {“DayOfWeek”:
{}}}}}}}
DayOfWeek Required: Yes* Day of week for arrival. Valid values are:
Type: String MON
Max Allowed: 1 TUE
Length: 1...9 WED
THU
FRI
SAT
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”:
{“CustomerCenterCutoff”: {}}}}}}}
CustomerCenterCutoff Required: Cond Customer Service call time. Returned for domestic as
Type: String well as international requests.
Max Allowed: 1
Length: 1...6
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”: {“DelayCount”:
{}}}}}}}
DelayCount Required: Cond Number of days delayed at customs. Returned for
Type: String International requests
Max Allowed: 1
Length: 1...3
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”: {“HolidayCount”:
{}}}}}}}
HolidayCount Required: Cond Number of National holidays during transit. Returned for
Type: String International requests.
Max Allowed: 1
Length: 1...2
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”: {“RestDays”:
{}}}}}}}
RestDays Required: Cond Number of rest days, i.e. non movement. Returned for
Type: String International requests.
Max Allowed: 1
Length: 1...2
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“EstimatedArrival”:
{“TotalTransitDays”: {}}}}}}}
TotalTransitDays Required: Cond The total number of days in transit from one location to
Type: String the next. Returned for International requests.
Max Allowed: 1
Length: 1...5
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“SaturdayDelivery”: {}}}}}}
SaturdayDelivery Required: No Saturday delivery information for a service. Values are
Type: String
Max Allowed: 1 1 - Saturday Delivery Available with additional charges
Length: 0 - Saturday Delivery not available or available with no
additional charge for eligible addresses, please check
Delivery Date to confirm if the Delivery will be Saturday

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 62
Rating Package RESTful Developer Guide October 22, 2024.

Name Constraint Description

Please see Saturday Delivery business rules section for

more information.
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“ServiceSummary”: {“SaturdayDeliveryDisclaimer”: {}}}}}}
SaturdayDeliveryDisclaimer Required: No Saturday delivery disclaimer message.
Type: String
Max Allowed: 1
Length:
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“AutoDutyCode”: {}}}}}
AutoDutyCode Required: Cond Required output for International requests. If Documents
Type: String indicator is set for Non-document a duty is automatically
Max Allowed: 1 calculated. The possible values to be returned are: 01 -
Length: 2 Dutiable
02 - Non-Dutiable
03 - Low-value
04 - Courier Remission
05 - Gift
06 - Military
07 - Exception
08 - Line Release
09 - Section 321 low value.
{“RateResponse”: {“RatedShipment”: {“TimeInTransit”: {“Disclaimer”: {}}}}}
Disclaimer Required: Cond The Disclaimer is provided based upon the Origin and
Type: String Destination country or territory Codes provided in the
Max Allowed: 1 request document. The possible disclaimers that can be
Length: N/A returned are available in the Service Guaranteed
Disclaimers table.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 63
Rating Package RESTful Developer Guide October 22, 2024.

API Sample Scenario

Credential is not needed for published rate.
URL [Link]
Verb POST
Request header AccessLicenseNumber AAA
Password PPP
Content-Type application/json
transId Tran123
transactionSrc XOLT
Username UUU
Request {
"RateRequest":{
"Request":{
"SubVersion":"1703",
"TransactionReference":{
"CustomerContext":" "
}
},
"Shipment":{
"ShipmentRatingOptions":{
"UserLevelDiscountIndicator":"TRUE"
},
"Shipper":{
"Name":"Billy Blanks",
"ShipperNumber":" ",
"Address":{
"AddressLine":"366 Robin LN SE",
"City":"Marietta",
"StateProvinceCode":"GA",
"PostalCode":"30067",
"CountryCode":"US"
}
},
"ShipTo":{
"Name":"Sarita Lynn",
"Address":{
"AddressLine":"355 West San Fernando Street",
"City":"San Jose",
"StateProvinceCode":"CA",
"PostalCode":"95113",
"CountryCode":"US"
}
},
"ShipFrom":{
"Name":"Billy Blanks",
"Address":{
"AddressLine":"366 Robin LN SE",
"City":"Marietta",
"StateProvinceCode":"GA",
"PostalCode":"30067",
"CountryCode":"US"
}
},
"Service":{
"Code":"03",
"Description":"Ground"
},
"ShipmentTotalWeight":{
"UnitOfMeasurement":{
"Code":"LBS",
"Description":"Pounds"
},
"Weight":"10"

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 64
Rating Package RESTful Developer Guide October 22, 2024.

},
"Package":{
"PackagingType":{
"Code":"02",
"Description":"Package"
},
"Dimensions":{
"UnitOfMeasurement":{
"Code":"IN"
},
"Length":"10",
"Width":"7",
"Height":"5"
},
"PackageWeight":{
"UnitOfMeasurement":{
"Code":"LBS"
},
"Weight":"7"
}
}
}
}
}
Response {
"RateResponse": {
"Response": {
"ResponseStatus": {
"Code": "1",
"Description": "Success"
},
"Alert": [
{
"Code": "110971",
"Description": "Your invoice may vary from the displayed reference rates"
},
{
"Code": "111531",
"Description": "No user level discount applied for this shipment."
}
],
"TransactionReference": {
"CustomerContext": "trans123",
"TransactionIdentifier": "xwsspta11bl6GskNQPcV4b"
}
},
"RatedShipment": {
"Service": {
"Code": "03",
"Description": ""
},
"RatedShipmentAlert": [
{
"Code": "110971",
"Description": "Your invoice may vary from the displayed reference rates"
},
{
"Code": "111531",
"Description": "No user level discount applied for this shipment."
}
],
"BillingWeight": {
"UnitOfMeasurement": {
"Code": "LBS",
"Description": "Pounds"

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 65
Rating Package RESTful Developer Guide October 22, 2024.

},
"Weight": "7.0"
},
"TransportationCharges": {
"CurrencyCode": "USD",
"MonetaryValue": "15.54"
},
"BaseServiceCharge": {
"CurrencyCode": "USD",
"MonetaryValue": "0.00"
},
"ServiceOptionsCharges": {
"CurrencyCode": "USD",
"MonetaryValue": "0.00"
},
"TotalCharges": {
"CurrencyCode": "USD",
"MonetaryValue": "15.54"
},
"RatedPackage": {
"TransportationCharges": {
"CurrencyCode": "USD",
"MonetaryValue": "15.54"
},
"BaseServiceCharge": {
"CurrencyCode": "USD",
"MonetaryValue": "14.46"
},
"ServiceOptionsCharges": {
"CurrencyCode": "USD",
"MonetaryValue": "0.00"
},
"ItemizedCharges": [
{
"Code": "376",
"CurrencyCode": "USD",
"MonetaryValue": "0.00",
"SubType": "Urban"
},
{
"Code": "375",
"CurrencyCode": "USD",
"MonetaryValue": "1.08"
}
],
"TotalCharges": {
"CurrencyCode": "USD",
"MonetaryValue": "15.54"
},
"Weight": "7.0",
"BillingWeight": {
"UnitOfMeasurement": {
"Code": "LBS",
"Description": "Pounds"
},
"Weight": "7.0"
}
}
}
}
}
Example Error {
Response
"response": {
"errors": [

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 66
Rating Package RESTful Developer Guide October 22, 2024.

{
"code": "110001",
"message": " Rating and Service Selection Service Unavailable "
}
]
}
}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 67
Rating Package RESTful Developer Guide October 22, 2024.

Error Codes
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.

HTTP Status Codes

Code Message Description
200 OK Success: Everything is working

400 Bad Request The request was invalid or cannot be served. The exact error should be
explained in the error payload. E.g. The request is not valid“
401 Unauthorized The request requires authentication

404 Not found URL does not exist or resource not found

405 Method not allowed Method not allowed

500 An internal server error An internal server error occurred; API developers should avoid this error. If
occurred an error occurs in the global catch blog, the stracktrace should be logged
and not returned as response.
503 Internal Server Error The service/resource is not available. There are external component
DOWN issues that the client will not be able to resolve

Common Error Codes

The following error codes can apply:

Code HTTP Status Description

10013 400 The message is too large to be processed by the Application.

20001 500 General process failure.

20002 400 The specified service name, {0}, and version number, {1}, combination is invalid.

20003 400 Please check the server environment for the proper J2EE ws apis.

20006 400 Invalid request action.

20007 400 Missing Required field, {0}.

20008 400 The field, {0}, contains invalid data, {1}.

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

250001 401 Invalid Access License for the tool. Please re-license.

250003 401 Invalid Access License number.

250005 401 No Access and Authentication Credentials provided.

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

250009 401 License Number not found in the UPS database.

250019 401 Invalid Field value.

250050 500 License system not available.

Rate Error Codes

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 68
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
10001 400 The request is not well formed
10002 400 The request is well formed but the request is not valid
10003 400 The request is either empty or null
10006 400 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 400 The message is too large to be processed by the Application
20001 400 General process failure
20002 400 The specified service name, {0}, and version number, {1}, combination is invalid
20003 400 Please check the server environment for the proper J2EE ws apis
20004 400 Cannot access the high level business components, {0}
20005 400 Cannot access the low level business components, {0}
20006 400 Invalid request action
20007 400 Missing required field, {0}
20008 400 The field, {0}, contains invalid data, {1}
20010 400 The phone number contains invalid characters
20011 400 The Integration Indicator is no longer supported
20012 400 The Client Information exceeds its Maximum Limit of {0}
110000 400 XML Rating and Service Selection Service Unavailable
110001 500 XML Rating and Service Selection Service Unavailable
110002 400 No packages in shipment.
110003 400 Maximum number of packages exceeded ({0})
110099 400 RATING_FAILURE.Rating failure, no more specific reason available.
110208 400 Missing/Illegal ShipTo/Address/CountryCode
110308 400 Invalid or unsupported origin country code
110500 400 RATING_NO_SERVICE_SELECTED. Null service sent into Rater
110527 400 Cannot use multiple types of currency in a shipment.
110528 400 A shipment can have only one type of UnitOfMeasurement for Dimensions.
110529 400 A shipment can have only one type of UnitOfMeasurement for a Weight.
110548 400 A shipment cannot have a KGS/IN or LBS/CM as its unit of measurements
110601 400 Missing or invalid package weight for package {0}.
110604 400 Invalid package declared monetary value for package {0}. Valid length is 0 to 8 numeric and can
hold up to 2 decimal places.
110609 400 All package dimensions are required and each must be greater than 0 for package {0}.
110610 400 Missing or invalid COD monetary value for {0}. Valid length is 0 to 8 numeric and can hold up to
2 decimal places
110626 400 Invalid COD Funds Code for {0}.
110646 400 Package Level COD is not valid for the shipment origin and/or destination
110647 400 Invalid COD currency code. Please use the destination country currency code.
110710 400 Invalid package Delivery Confirmation type for package {0}.
110720 400 The Account Number for FRS Payment is not FRS Enabled.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 69
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
110920 200 When user indicated Residential indicator is different from AMS Classification.
110921 400 UPS account number that was provided as the payment method is missing or invalid.
110950 400 Customer Classification Code is required with the requested Pickup Type
110971 200 For all successful response it will return message as Your invoice may vary from the displayed
reference rates
111000 400 Verify that the supplied country code for the ship from and/or ship to is correct and is in
uppercase (Cannot locate site).
111000 400 Only one type of LargePackage can be set on a package.
111005 400 COD and Call Tags cannot be applied to the same package.
111010 400 Hazardous materials cannot be shipped using Call Tags.
111015 400 Saturday Delivery and Call Tags cannot be applied to the same package.
111020 400 Delivery Confirmation and Call Tags cannot be applied to the same package.
111025 400 The maximum declared amount was exceeded.
111030 400 Packages must weigh more than zero pounds.
111031 400 Packages must weigh more than zero kg.
111035 400 The maximum per package weight for that service from the selected country is
%[Link]% pounds.
111036 400 The maximum per package weight for that service from the selected country is
%[Link]% kg.
111040 400 The Return Services accessories are unavailable with the requested service.
111045 400 The Saturday Delivery option is unavailable with the requested service.
111047 400 Saturday Delivery may not be combined with this product and container type.
111050 400 Package exceeds the maximum size total constraints of %maxLengthGirth% (length + girth
where girth is 2 x width plus 2 x height).
111055 400 Package exceeds the maximum length constraint of 108 inches.
111056 400 This package exceeds the maximum length constraint of 270 cm.
111057 400 This measurement system is not valid for the selected country.
111058 400 The length width and height must each be less than {description} inches or {description}
centimeters.
111060 400 Hazardous materials cannot be shipped in a UPS Letter.
111063 400 The requested accessory cannot be combined with the selected service.
111065 400 The shipment of Hazardous Materials to the selected location is unavailable.
111070 400 The requested accessory is not allowed with this pickup method.
111075 400 The International Declared Value accessory is not valid with a domestic service.
111080 400 The Domestic Declared Value accessory is not valid with an international service.
111085 400 The requested accessory cannot be added to this shipment.
111086 400 Only one Authorized Return Service option is allowed.
111087 400 The Authorized Return Service option is not allowed for shipments.
111090 400 The requested billing zone is invalid for the selected product.
111091 400 The selected service is unavailable to an extended area.
111100 400 The requested service is invalid from the selected origin.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 70
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
111105 400 The requested accessory key is invalid for the selected site.
111106 400 Unsupported country specified.
111107 400 An origin postal code must be specified.
111108 400 Shipments must have at least 1 package.
111109 400 Delivery Area Surcharge Tier is invalid.
111115 400 The COD amount must be greater than zero.
111120 400 The COD amount cannot exceed $1,000 when a cashiers check or money order is requested.
111121 400 The COD value entered exceeds the maximum allowed for cash of %[Link]%
(%[Link] %).
111125 400 The COD amount cannot exceed 50,000 (%[Link] %).
111126 400 The COD value entered exceeds the maximum allowed for check of %[Link]%
(%[Link] %).
111130 400 The Saturday Pickup option cannot be combined with the Return Services option.
111135 400 The Saturday Pickup option cannot be combined with the Saturday Delivery option.
111140 400 The Saturday Pickup option is unavailable with the selected service.
111145 400 Only one Delivery Confirmation option is allowed.
111150 400 The Delivery Confirmation option is unavailable with the selected service.
111155 400 The COD option is unavailable with the selected service.
111160 400 The requested accessory option is unavailable with the selected billing option.
111190 400 Only one Return Services option is allowed.
111195 400 The requested billing option is unavailable with the selected service.
111196 400 The requested billing option is unavailable with UPS Letters.
111200 400 The requested service with Saturday Delivery is unavailable to the selected location.
111205 400 The Additional Handling option is unavailable with the selected service.
111206 400 The Additional Handling option is unavailable with UPS envelopes.
111208 400 UPS Next Day Air Early A.M. service is not available to the requested destination. Please select
UPS Next Day Air service as an alternative.
111209 400 RATING_INVALID_SERVICE_TYPE
111210 400 The requested service is unavailable between the selected locations.
111211 400 The requested accessory option is unavailable between the selected locations.
111212 400 The requested Package Type is unavailable for the selected service between the selected
locations.
111213 400 The requested billing option is unavailable between the selected locations.
111214 400 Cannot ship between the selected locations.
111215 400 The requested service is unavailable to residential destinations.
111219 400 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 400 The Ship Notification option cannot be combined with the Return Services option.
111222 400 A shipment using the Return Services Electronic Return Label option must contain only Goods in
Free Circulation.
111225 400 The Return Services option is unavailable to the selected location.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 71
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
111230 400 Next Day Air Early AM is unavailable with the selected service.
111235 400 No more than %[Link]% of the following may be combined: %[Link]%.
111240 400 The requested accessory may not be applied to a package more than %[Link]% time(s).
111245 400 The Saturday Pickup option cannot be combined with the Shipper Duty Fees option.
111250 400 The Saturday Delivery option cannot be combined with the Shipper Duty Fees option.
111255 400 The Shipper Duty Fee option is unavailable with the selected service.
111260 400 The Shipper Duty Fee option is unavailable with the selected billing option.
111261 400 The requested option is unavailable with the selected service.
111262 400 The accessory is not valid with the selected option.
111265 400 The requested billing option is unavailable to the selected location.
111266 400 The requested currency is not a legal tender in this country.
111275 400 Cannot create attribute %attrName%.
111280 400 Cannot remove attribute %attrName%.
111285 400 The postal code %postal% is invalid for %state% %country%.
111286 400 %state% is not a valid state abbreviation for %country%.
111290 400 The requested billing option is invalid.
111295 400 Package %[Link]% failed validation in shipment.
111300 400 The Shipper Pays Duty - VAT Unpaid option is unavailable with the selected option.
111305 400 The Shipper Pays Duty - VAT Unpaid option is unavailable with the selected service.
111310 400 The Shipper Pays Duty - VAT Unpaid option is unavailable with the selected billing options
111315 400 The Authorized Return Service option is unavailable with the selected accessory.
111320 400 The Authorized Return Service option is unavailable with the selected service.
111325 400 The Authorized Return Service is unavailable with the selected billing option.
111330 400 The Certificate of Origin is unavailable with the selected accessory.
111335 400 The Certificate of Origin is unavailable with the selected service.
111340 400 The Certificate of Origin is unavailable with the selected billing option.
111343 400 The Certificate of Origin is unavailable from the selected origin.
111345 400 The Shipper Export Declaration is unavailable with the selected accessory.
111350 400 The Shipper Export Declaration is unavailable with the selected service.
111355 400 The Shipper Export Declaration is unavailable with the selected billing option.
111360 400 UPS Express Plus is unavailable with the selected service.
111363 400 The One Time Pickup is unavailable with the selected service.
111365 400 The requested service is not available through the selected acquisition type.
111370 400 Unsupported acquisition type.
111375 400 The requested service is not valid for shipments with more than 1 package.
111380 400 The requested Package service may not be consolidated with the selected shipment service.
111385 400 The requested Package billing option does not match the selected shipment billing option.
111390 400 The requested Package billing tier does not match the selected shipment billing tier.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 72
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
111395 400 Package consignee %[Link]% does not match the shipment consignee
%[Link]%.
111400 400 Package consignee street address %[Link].street1% does not match the shipment consignee
street address %[Link].street1%.
111405 400 Package consignee street address %[Link].street2% does not match the shipment consignee
street address %[Link].street2%.
111410 400 Package consignee street address %[Link].street3% does not match the shipment consignee
street address %[Link].street3%.
111415 400 Package consignee city %[Link]% does not match the shipment consignee city
%[Link]%.
111420 400 Package consignee state %[Link]% does not match the shipment consignee state
%[Link]%.
111425 400 Package consignee postal code does not match the shipment consignee postal code.
111430 400 Package consignee country does not match the shipment consignee country.
111431 400 All packages in the shipment must have the same UPS shipper number as the shipment.
111435 400 All packages in the shipment must have the Saturday Delivery option if 1 package has it.
111440 400 All packages in the shipment must have the Saturday Pickup option if 1 package has it.
111445 400 UPS does not allow Hazardous Materials in shipments consisting of more than one piece.
111450 400 Only one type of Return Service option is allowed per package.
111455 400 All packages in the shipment must have the Return Services option if 1 package has it.
111456 400 All packages in the shipment must have the Residential option if 1 package has it.
111457 400 Shipments with the Residential option set must have the Residential option set on all packages.
111460 400 Shipments cannot exceed a COD amount of $5,000 when requesting a cashiers check or money
order.
111465 400 The selected Package access method does not match the shipment access method.
111500 400 The selected service is not valid with the selected packaging.
111501 400 The selected packaging is not valid with the requested accessory option.
111510 400 Unsupported packaging requested.
111511 400 Unsupported accessory requested.
111512 400 Unsupported billing option requested.
111513 400 Unsupported service requested.
111515 400 Weight of %[Link]% exceeds maximum for rating the requested packaging. Using
standard package rates.
111519 400 The selected Package rating category does not match the shipment rating category.
111520 Hard International Special Commodities Alcohol is not allowed with "Documents Only" shipments.
111526 Hard UPS Access Point Economy Service shipments must have a ShipmentIndicationType of 01 or 02
or must be a Return shipment.
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.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 73
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 74
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
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 400 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.
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
111619 Hard Your UPS Account number is not authorized for shipping Refrigerated Substances.
111620 Hard Account is not authorized for Heavy Goods services.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 75
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
111623 Warning Commercial Inside Release applied as per account preference to Package {0}
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.
The maximum dimensions for a package are %maxLength% in (length) by %maxWidth% in
111660 Hard
(width) by %maxHeight% in (height) for the selected service.
The maximum dimensions for a package are %maxLength% cm (length) by %maxWidth% cm
111661 Hard
(width) by %maxHeight% cm (height) for the selected service.
Length width and height are required for the package %[Link]% to process the
111662 Hard
shipment.
111663 Hard Heavy Goods Service is not available for this destination.
111664 Hard Master Carton shipment is not valid with Goods Not in Free Circulation between EU countries.
111665 Hard The Worldwide Economy shipment must be single piece only.
111666 Hard UPS Account is not authorized for Worldwide Economy DDU service.
111667 Hard UPS Account is not authorized for Worldwide Economy DDP service.
111668 Hard Master Carton shipment must be single piece only.
111675 Hard Missing or Invalid UPS Premier Category Code for package {0}
111676 Hard UPS Account is not authorized for UPS Premier Silver.
111677 Hard UPS Account is not authorized for UPS Premier Gold.
111678 Hard UPS Account is not authorized for UPS Premier Platinum.
111701 Hard The requested accessory is not allowed with the selected Delivery Day Request
112002 400 Missing or Invalid Commodity Freight Class for Package {0}.
112031 400 Missing or Invalid FRS payment Type code.
112045 400 The payer of transportation's country is not valid for Carbon Neutral shipments..
112051 400 Shipment total weight has exceeded the maximum shipment weight limit of 99,999.9 kgs or
99,999.9 pounds.
112052 400 Total pieces in the shipment have exceeded the maximum allowed of 99,999 for a shipment.
112053 400 The number of pieces was not provided – Number of pieces in a shipment is required to process
the shipment.
112054 400 Missing elements - Length, width and height are required for the pallet %[Link]% to
process the shipment.
112055 400 Exceeded maximum per pallet weight – The maximum per pallet weight for the selected service
from the selected origin is %maxWeightOrig% pounds.
112056 400 Exceeded maximum per pallet weight – The maximum per pallet weight for the selected service
from the selected origin is %maxWeightOrig% kgs.
112057 400 Exceeded maximum per pallet weight – The maximum per pallet weight for the selected service
to the selected destination is %maxWeightDest% pounds.
112058 400 Exceeded maximum per pallet weight – The maximum per pallet weight for the selected service
to the selected destination is %maxWeightDest% kgs.
112059 400 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 400 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.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 76
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
112061 400 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 400 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 200 Please contact customer service center for capacity authorization.
112064 400 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 400 Lift Gate for Pick Up accessorial is not allowed with Drop Off At UPS Facility accessorial.
112066 400 Lift Gate for Delivery accessorial is not allowed with Hold For Pick Up accessorial.
112067 400 More than one type of insurance is not allowed for a shipment - only one type can exist per
shipment
112068 400 The maximum declared amount was exceeded. Maximum value per pallet: %maxDeclVal%
%currencyCode%.
112082 400 The maximum Dry Ice for a pallet/shipment is 200 kg or 440 lbs.
112083 400 Invalid pallet dimensions, the length must be longer than the width.
112084 400 Shipper is not eligible to ship Dry Ice.
112085 400 Missing or Invalid Return Type.
112086 400 Missing or Invalid Import Type.
112090 400 Commercial Invoice Removal is valid only for Import Control shipments.
112091 400 Missing or Invalid Regulation Set.
112095 400 DryIceWeight container with Dry Ice weight and UOM information is required for Dry Ice.
112096 400 Missing or Invalid Dry Ice Weight.
112097 400 Missing or Invalid code for Dry Ice Unit of Measurement.
112098 400 UnitOfMeasurement container with UOM code is required for Dry Ice.
112099 400 Invalid Regulation Set. All packages with Dry Ice accessorial must contain the same Regulation
Set.
112100 400 Invalid regulation set. The regulation set for non-US/PR origins/destinations should be IATA.
112101 400 Invalid weight. The Dry Ice weight is greater than the actual package weight.
112105 400 Return and Import Shipment accessorial cannot be requested together in a shipment.
112106 400 The Saturday Delivery option cannot be combined with the Return Services option.
112107 400 The Saturday Delivery option cannot be combined with the UPS Import Control option.
112109 400 Itemized Charges are not valid for this service.
112110 400 Account is not authorized for UPS Exchange service.
112111 400 Missing or Invalid Shipper Number.
112113 400 UPS Account is not authorized for Hold for Pickup at UPS Access Point.
112114 400 Alternate Delivery Address information is required for Hold for Pickup at UPS Access Point.
112115 400 The maximum declared value for Flexible Parcel Insurance has been exceeded. Maximum value
per package: %maxDeclVal% %currencyCode%.
112116 400 The requested billing option is unavailable between the selected locations with the selected
options.
112117 400 Package exceeds the maximum length constraint of %rave.DTR_NAP_maxLength_IN% inches.
Length is the longest side of a package.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 77
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
112118 400 Package exceeds the maximum length constraint of %rave.DTR_NAP_maxLength_CM% cm.
Length is the longest side of a package.
112119 400 The maximum per package weight for the selected option is %[Link]% pounds.
112120 400 The maximum per package weight for the selected option is %[Link]% kg.
112121 400 Missing or Invalid Alternate Delivery Address Name.
112122 400 Missing or Invalid Alternate Delivery Address Address Line 1.
112123 400 Missing or Invalid Alternate Delivery Address Address Line 2.
112124 400 Missing or Invalid Alternate Delivery Address Address Line 3.
112125 400 Missing or Invalid Alternate Delivery Address City.
112126 400 Missing or Invalid Alternate Delivery Address State/Province.
112127 400 Missing or Invalid Alternate Delivery Address Postal Code.
112128 400 Missing or Invalid Alternate Delivery Address Country Code.
112129 400 Missing or Invalid Shipment Indication Type.
112130 400 No more than 3 address lines are allowed for Alternate Delivery Address.
112131 400 Only 1 Shipment Indication Type allowed in a request.
113005 400 The selected service may not guarantee early AM arrival to the requested location.
113005 200 The selected service may not guarantee Early AM arrival to the requested location.
113010 400 Package(s) within the shipment contain warnings.
113010 200 Package(s) within the shipment contain warnings.
113020 400 The Origin postal code is invalid for the selected location.
113020 200 The Origin postal code is invalid for the selected location.
113021 400 The Ship To postal code is invalid for the selected location.
113021 200 The Ship To postal code is invalid for the selected location.
113060 200 The weight exceeds the limit for the UPS Letter/Envelope rate and will be rated using the weight.
115582 400 Invalid Customer Classification Code
119000 400 Oversize 1 indicator has automatically been set on Package %[Link]%.
119001 200 Additional Handling has automatically been set on Package %[Link]%.
119002 400 An Extended Area surcharge has been added to the service cost.
119002 200 An Extended Area surcharge of %xtndCharge% has been added to the service cost.
119003 200 The requested service may not guarantee Next Day arrival to the selected location.
119004 200 Check the UPS Service Guide for supported Saturday delivery destinations within the selected
country.
119005 200 The requested service may not guarantee Second Day arrival to the selected location.
119006 200 The Second Day Air service may not guarantee Second Day arrival to the selected location.
119007 400 Oversize 2 indicators have automatically been set on Package %[Link]%.
119008 400 Weight is greater than or equal to %localOverSize1MinWeight%lbs. and less than
%localOverSize2MinWeight% lbs., Oversize 2 has automatically been set on Package
%[Link]%.
119009 400 Oversize 1 does not apply, and has automatically been removed from Package
%[Link]%.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 78
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
119010 400 Oversize 2 does not apply, and has automatically been removed from Package
%[Link]%.
119011 200 The maximum declared value amount for the 1-Attempt option is $1,000.
119012 200 The maximum declared value amount for the Print and Mail option is $1,000.
119013 200 The maximum declared value amount for the Print Return Label option is $1,000.
119014 200 The maximum declared value amount for the Electronic Delivery option is $1,000.
119015 200 The maximum declared value amount for the 3-Attempt option is $50,000.
119016 400 Weight is greater than or equal to %localOverSize2MinWeight% lbs., Oversize 3/Large Package
has automatically been set on Package %[Link]%.
119017 400 Oversize 3/Large Package indicator has automatically been set on Package %[Link]%.
119017 200 Large Package indicator has automatically been set on Package %[Link]%.
119018 400 Oversize 3/Large Package does not apply, and has automatically been removed from Package
%[Link]%.
119018 200 Large Package does not apply, and has automatically been removed from Package
%[Link]%.
119020 200 Large Package and Additional Handling both cannot exist on a Package
119070 200 Large Package Surcharge has been added to Package %[Link]%.
119071 200 Large Package indicator has been set and Large Package Surcharge has been added to
Package %[Link]%.
119072 200 Additional Handling has been removed. Large Package Surcharge has been added to Package
%[Link]%.
119076 400 All package types must be pallets.
119077 200 A dimensional surcharge has been added to pallet {0}.
119078 400 The maximum dimensions for a pallet are 200 cm by 160 cm by 120 cm.
119079 400 The requested service is not valid with pallets with a weight greater than 1000kg. Please select
Dedicated Package Courier Same Day Service.
119083 400 Pallet {0} exceeds maximum weight.
119084 200 Missing or Invalid Shipper Number. Returned rates are Retail Rates.
120001 400 XML Shipping System is unavailable, please try again later.
126098 200 Account authentication is required to be completed to get negotiated rates.
150000 400 Tracking service unavailable
190003 200 Published rates are unavailable at this time
250000 400 No XML declaration in the XML document
250001 401 Invalid Access License for the tool. Please re-license.
250002 401 Invalid UserId/Password
250002 401 Invalid UserId/Password
250003 401 Invalid Access License number
250004 401 Incorrect UserId or Password
250005 401 No Access and Authentication Credentials provided
250006 401 The maximum number of user access attempts was exceeded
250007 401 The UserId is currently locked out; please try again in 24 hours.
250009 401 License Number not found in the UPS database

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 79
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
250010 400 Illegal Request Action
250011 400 Illegal Request Option
250012 400 No tool is requested
250019 400 Invalid field value
250020 400 Invalid developer license number
250021 400 The data length is in error for CompanyName
250022 400 The data length is in error for AddressLine1
250023 400 The data length is in error for AddressLine2
250024 400 The data length is in error for AddressLine3
250025 400 The data length is in error for City
250026 400 Invalid country code
250027 400 The data is in error for StateProvinceCode
250028 400 The data length is in error for PostalCode
250029 400 The data is in error for phone number
250030 400 Invalid e-mail address
250031 400 Invalid URL
250032 400 Invalid Country Code in AccessLicenseProfile
250033 400 Invalid Language Code in AccessLicenseProfile
250034 400 Invalid ToolVersion
250035 400 The data length is in error for the name of contact person
250036 400 The data length is in error for the title of contact person
250037 400 The data is in error for fax number
250038 400 Error in Shipper Number
250040 400 Client software profile is missed for the 3rd party developer license
250041 400 Invalid ToolID
250042 400 Tool Version not available for the Access License
250043 400 Tool ID not available for the Access License
250044 400 Tool Version not licensed for developer
250045 400 Tool already licensed
250046 400 User already has a license
250047 400 License number revoked
250048 400 Missing License Agreement Text
250049 400 Invalid License Agreement Text
250050 400 License system not available
250051 400 Not allowed to create new license
250052 400 Authorization system is currently unavailable
250060 400 The data length is in error for the Software Installer
250061 400 The data length is in error for the Software Product Name
250062 400 The data length is in error for the Software Provider

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 80
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
250063 400 The data length is in error for the Software Version Number
250064 400 Invalid ToolID/ToolVersion
9110001 400 Missing pickup type Code.
9110002 400 Missing customer classification code.
9110003 400 Missing shipment information.
9110004 400 Missing shipper information.
9110005 400 Missing shipper number.
9110006 400 Missing shipper address information.
9110007 400 No more than 3 address line information can be given for shipper address.
9110008 400 Missing shipper country code.
9110009 400 Missing ship to information.
9110010 400 Missing ship to address information.
9110011 400 No more than 3 address line information can be given for ship to address.
9110012 400 Missing ship to state province code.
9110013 400 Missing ship to country code.
9110014 400 Missing Ship From address information.
9110015 400 No more than 3 address line information can be given for ship from address.
9110016 400 Missing ship from state province code.
9110017 400 Missing ship from country code.
9110018 400 Missing shipment service code.
9110019 400 Missing package type code for package {0}.
9110020 400 Missing package dimensions unit of measurement information for package {0}.
9110021 400 Missing or invalid package dimensions unit of measurement code for package {0}. Valid values
are: IN or CM.
9110022 400 Missing package weight unit of measurement information for package {0}.
9110023 400 Missing or invalid package weight unit of measurement code for package {0}. Valid values are:
KGS or LBS
9110024 400 Delivery confirmation option cannot be combined with the cod information under package service
options for package {0}.
9110025 400 Missing schedule information for on call pickup.
9110026 400 Missing pickup day for on call pickup.
9110027 400 Missing method for on call pickup.
9110028 400 At least one shipment rating option either negotiated or FRS rates or RateChart indicator is
required.
9110029 400 Missing COD Funds Code Information for {0}.
9110030 400 Missing COD Amount Information for {0}.
9110031 400 Missing COD currency Code for {0}.
9110032 400 Missing package declared currency code for package {0}.
9110033 400 Missing package declared monetary value for package {0}.
9110034 400 Missing or invalid request option.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 81
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
9110035 400 FRS Indicator is not allowed with Rate request option as Shop
9110036 400 Missing FRS Payment Information
9110037 400 Missing FRS payment Type.
9110039 400 Missing Account Number for FRS Payment Information.
9110040 400 Missing Address for FRS Payment Information.
9110041 400 Missing Country Code for FRS Payment Information Address.
9110042 400 Missing Commodity for package {0}.
9110044 400 Missing NMFC Prime Code for package {0}.
9110045 400 Missing Ship To Postal Code.
9110046 400 Missing Ship From Postal Code
9110047 400 Missing Package Weight container information for package {0}.
9110048 400 Missing Packaging Type for package {0}.
9110049 400 Missing Service Information.
9110721 400 Invalid Shipment Delivery Confirmation Type
9111000 400 Invalid RSS Request Document
112132 400 Missing or Invalid Monetary value for Access point COD.
112133 400 Missing or Invalid Currency code for Access point COD.
112134 400 Alternate Delivery Address information is required for UPS Access Point Delivery.
112135 400 The customs value entered exceeds the maximum allowed amount of $2300 USD or $2500
CAD.
112136 400 The Shipment Level Access Point COD option is unavailable with the selected service and/or
with the shipments origin/destination.
112137 400 The Package Level Access Point COD is not valid for the shipment origin and/or destination.
111128 400 The Access Point COD amount cannot exceed %[Link]%
%[Link]%.
111129 400 The currency of the Access Point COD amount must be the same as the Destination country’s
currency: %[Link]%.
111630 400 The requested accessorial is valid only for Hold for Pickup at UPS Access Point shipment
indication type.
112138 200 UPS Access Point Delivery Rates were applied to a shipment.
112139 400 Request contains invalid data e.g. special characters etc. Please correct.
111116 400 The declared value amount must be greater than zero.
111655 400 The requested billing option/payment option is unavailable with the selected shipment indication
type for a shipment to a UPS Access Point.
111701 400 The requested accessory is not allowed with the selected Delivery Day Request
117147 400 Emergency Phone Number is required for dangerous good shipments with TDG regulation set.
117148 400 Invalid Emergency contact. If a third party is being used the contact field must include both the
name and the customer account with that provider.
117149 400 Specified commodity is not permitted from Canada to US through TDG ground service.
111681 Hard UPS Worldwide Economy DDU Oversize does not apply and has automatically been removed
from Package {0}.
111682 Hard UPS Worldwide Economy DDU Oversize indicator has automatically been set on Package {0}.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 82
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
111683 Hard UPS Worldwide Economy DDU Oversize Surcharge has been added to Package {0}.
111684 Hard Export Processing Site address is not available in shipper account profile. Please contact your
Account Representative for resolution.
111685 Warning TPFCNegotiatedRatesIndicator is applicable only for Third party/Freight Collect
shipments.
111686 Warning Shipper not authorized to request for the Third Party/Freight Collect negotiated rates
for this shipment.
111687 Warning Negotiated rates are unavailable at this time.
111691 Hard Missing or Invalid shipment accessory
111692 Hard Missing or Invalid Package accessory
111693 Hard Missing or Invalid shipment properties
111694 Hard Missing or Invalid rating options
111695 Hard Missing or Invalid shipping account
111696 Hard Missing or Invalid shipping account
111697 Hard Missing or Invalid Agent Properties
111698 Hard Missing or Invalid OrigIATA
111699 Hard Missing or Invalid DestIATA
111700 Hard Missing or Invalid ThirdPartyCountry
111702 Hard Invalid OrigIATA Length
111703 Hard Invalid DestIATA Length
111704 Hard Invalid OriginCountry Length
111705 Hard Invalid DestinationCountry Length
111706 Hard Invalid RequesterCountry Length
111707 Hard Invalid ThirdPartyCountry Length
111708 Hard Missing or Invalid MeasurementCode
111709 Hard Missing or Invalid Length, Width or Height
111710 Hard Missing or Invalid PickupDate
111711 Hard Missing or Invalid CityOPDType
111712 Hard Missing or Invalid ShipmentType
111713 Hard Missing or Invalid FilterType
111714 Hard Missing or Invalid Document Type
111715 Hard Missing or Invalid Paperless Type
111716 Hard Missing or Invalid Contract Code
111717 Hard Missing or Invalid RequestCode
111718 Hard Missing or Invalid Service, Accessory, ContainerType, or BillingOption
111719 Hard Missing Service, Accessory, ContainerType, or BillingOption for filtertype
111720 Hard Missing Request Information
111721 Hard Missing Request Information: Agent

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 83
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
111722 Hard Missing or Invalid Request - Invalid Role
111723 Hard Missing or Invalid Request - Country Code
111724 Hard Missing or Invalid Carrier Name
111725 Hard Missing or Invalid AccountNumber
111726 Hard Invalid AccountNumber Length
111727 Hard Missing transId
111728 Hard Missing transactionSrc
111729 Hard Invalid CountryCode Length
112128 Hard Missing or Invalid CountryName
112128 Hard Missing or Invalid CountryCode
110308 Hard Missing or Invalid OriginCountry
110208 Hard Missing or Invalid DestinationCountry
110108 Hard Missing or Invalid RequesterCountry
112127 Hard Missing or Invalid Postal Code
111057 Hard Invalid Unit of Measurement for the given country
110007 Hard No services found;
112200 Warning Country Field Missing
112201 Warning State Field Missing
112202 Warning Postal Code Field Missing
112203 Warning Rcc Code Field Missing
112204 Warning Rcc Type Field Missing
112205 Warning Pickup Date Field Missing
112206 Warning Country Code Field Missing
112207 Warning Shipper Number Field Missing
112208 Warning Currency Code Field Missing
112209 Warning Zone Field Missing
112210 Warning NRF Transaction ID Field Missing
112211 Warning Service Type Field Missing
112212 Warning Pkg Height Field Missing
112213 Warning Pkg Length Field Missing
112214 Warning Pkg Width Field Missing
112215 Warning Pkg Actual Weight Field Missing
112216 Warning Pkg BillableWeight Field Missing
112217 Warning Pkg DimWeight Field Missing
112218 Warning Pkg UOMWeight Field Missing
112219 Warning Pkg UOMDim Field Missing

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 84
Rating Package RESTful Developer Guide October 22, 2024.

Code HTTP Message

Status
112220 Warning Pkg Type Field Missing
112221 Warning Shipment ActualWeight Missing
112222 Warning Shipment BillableWeight Missing
112223 Warning NumberOfPieces Missing
112224 Warning ShipperCountry Missing
112225 Warning Role Missing
112226 Warning RaveserviceId Missing
112227 Warning Residential Missing
112228 Warning AveragePkgWeightInd Missing
112229 Warning PackageId Missing
112230 Warning ShipperNumber field data is missing
112231 Warning BillingOption field data is missing
112232 Warning [Link] field data is missing
112233 Warning Zone field data is missing
112234 Warning [Link] field data is missing
112235 Warning DocumentState field contains invalid data
112236 Warning CWT Shipments are invalid.
112237 Warning Modifier is applied on Package(s).
112238 Warning BRE call failed in RBS
112239 Warning International movement is not in scope
111730 Warning Invalid Date. Changed to today's date
112240 Warning Non-Standard Cube Charge has automatically been added to package(s)
112241 Warning Non-Standard Extra Length Charge has automatically been added to package(s)
112242 Warning Non-Standard Length Charge has automatically been added to package(s)
112243 Warning Non-Machinable is not applicable and has been removed from package(s)
112244 Warning Additional Handling is not applicable and has been removed from package(s)
111042 Warning Fastlane Rate call failed
111041 Hard The UPS Import Control accessories are unavailable with the requested service.
112245 Hard Verify that the supplied country code for the ship from and/or ship to is correct and is in
uppercase
112246 Warning Package dimensions missing Package did not meet qualification based on Dimensions
provided - default rate was applied
112247 Warning Package did not meet qualification based on Weight provided - default rate was applied
112258 Hard UPS Account is not authorized for Global Checkout service

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 85
Rating Package RESTful Developer Guide October 22, 2024.

Accessorial / Surcharge Codes

Code Accessorial / Surcharge

100 ADDITIONAL HANDLING

110 COD

120 DELIVERY CONFIRMATION

121 SHIP DELIVERY CONFIRMATION

190 EXTENDED AREA

199 HAZ MAT

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 INTERNATIONAL PROCESSING FEE

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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 86
Rating Package RESTful Developer Guide October 22, 2024.

Code Accessorial / Surcharge

380 EXPRESS PLUS SURCHARGE

400 INSURANCE

401 SHIP ADDITIONAL HANDLING

402 SHIPPER RELEASE

403 CHECK TO SHIPPER

405 GERMAN PICKUP

406 GERMAN ROAD TAX

407 EXTENDED AREA PICKUP

410 RETURN OF DOCUMENT

430 PEAK/DEMAND SEASON

431 LARGE PACKAGE SEASONAL SURCHARGE

432 ADDITIONAL HANDLING SEASONAL SURCHARGE

434 SURGE FEE

436 SURGE FEE ADDITIONAL HANDLING

437 SURGE FEE LARGE PACKAGE

438 SURGE FEE OVER MAXIMUM

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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 87
Rating Package RESTful Developer Guide October 22, 2024.

Code Accessorial / Surcharge

512 DROP OFF AT UPS FACILITY

515 UPS PREMIUM CARE

520 OVERSIZE PALLET

530 FREIGHT DELIVERY SURCHARGE

531 FREIGHT PICKUP SURCHARGE

540 DIRECT TO RETAIL

541 DIRECT DELIVERY ONLY

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

549 INSIDE DELIVERY

550 ITEM DISPOSAL

551 UK BORDER FEE

555 UPS PREMIER SILVER

556 UPS PREMIER GOLD

557 UPS PREMIER PLATINUM

558 DDU OVERSIZE

563 GLOBAL CHECKOUT

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 88
Rating Package RESTful Developer Guide October 22, 2024.

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
• Suburban
• Extended Area Destination
• Base
• Remote
• Super Remote

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 89
Rating Package RESTful Developer Guide October 22, 2024.

Accessorial/Surcharge SubType
Delivery Area Surcharge • Alaska Extended
• Hawaii Extended
• Urban
• Rural
• Rural Extended
• Metropolitan
• Remote Area
• Suburban

Extended Area Pickup Surcharge • Alaska

• Hawaii
• Urban
• Rural
• Super Rural
• Super Urban
• Remote
• Suburban
• Extended Area Origin

Peak Season Surcharge • Residentail_Seasonal_Surcharge

• Commercial_Seasonal_Surcharge
• CWT_ Residentail_Seasonal_Surcharge
• CWT_ Commercial_Seasonal_Surcharge

Surge Fee • Surge Fee Commercial

• Surge Fee Residential
• CWT Surge Fee- Com
• CWT Surge Fee- Resi
• Surge Fee Additional Handling
• Surge Fee Large Package
• Surge Fee Over Maximum

Large Package Surcharge • Residential

• Commercial
• Longest side Residential
• Longest side Commercial

Additional Handling Surcharge • Weight

• NLN - Non Standard Length Charge
• NLP - Non Standard Extra Length Charge
• NCB - Non Standard Cube Charge

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 90
Rating Package RESTful Developer Guide October 22, 2024.

Accessorial/Surcharge SubType
Inside Delivery • White Glove
• Room of Choice
• Installation

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 91
Rating Package RESTful Developer Guide October 22, 2024.

COD Supported Countries or Territories

Rating Package COD supported countries or territories

Shipment Level

Country or Territory 1 9
Cash Check
Cashier's Check
Money Order

All European Union (EU) countries or territories supported by the API, Yes Yes
exceptions noted below.
For additional information, refer to Country or Territory Codes in the
Appendix.

Russia Yes No

United Arab Emirates Yes No

Package Level
NOTE: No EU countries or territories currently support Package level COD.

0 8 9
Country or Territory 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 92
Rating Package RESTful Developer Guide October 22, 2024.

Country or Territory Codes

Rating Package API Supported Countries or Territories
UPS country or territory code abbreviations generally follow the recommendations of the International Standards
Organization (ISO), which publishes a list of country or territory abbreviations in ISO Standard 3166.
The following table lists the country or territory codes defined by ISO at the time of this publication. The latest
information is available from the ISO web site: [Link]

NOTE: Not all UPS services are available in every country or territory. Refer to the UPS Rate and
Service Guide at [Link] for more information on UPS services.

Destination Country or Territory Country or Supported Supported

Name Territory Code Forward Origin Return Origin
Afghanistan AF X

Aland Islands AX X

Albania AL X X

Algeria DZ X X

American Samoa AS

Andorra AD

Angola AO X

Anguilla AI

Antarctica AQ

Antigua and Barbuda AG X X

Argentina AR X X

Armenia AM X X

Aruba AW X X

Australia AU X X

Austria AT X X

Azerbaijan AZ X X

Azores A2 X

Bahamas BS X X

Bahrain BH X X

Bangladesh BD X X

Barbados BB X X

Belarus BY X

Belgium BE X X

Belize BZ

Benin BJ

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 93
Rating Package RESTful Developer Guide October 22, 2024.

Destination Country or Territory Country or Supported Supported

Name Territory Code 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 Mainland 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 94
Rating Package RESTful Developer Guide October 22, 2024.

Destination Country or Territory Country or Supported Supported

Name Territory Code 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

Falkland 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 95
Rating Package RESTful Developer Guide October 22, 2024.

Destination Country or Territory Country or Supported Supported

Name Territory Code 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 SAR, China 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)

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 96
Rating Package RESTful Developer Guide October 22, 2024.

Destination Country or Territory Country or Supported Supported

Name Territory Code 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 (Macao) SAR, China 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 97
Rating Package RESTful Developer Guide October 22, 2024.

Destination Country or Territory Country or Supported Supported

Name Territory Code 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 98
Rating Package RESTful Developer Guide October 22, 2024.

Destination Country or Territory Country or Supported Supported

Name Territory Code 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 99
Rating Package RESTful Developer Guide October 22, 2024.

Destination Country or Territory Country or Supported Supported

Name Territory Code Forward Origin Return Origin
Swaziland SZ

Sweden SE X X

Switzerland CH X X

Tahiti TA

Taiwan, 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 100
Rating Package RESTful Developer Guide October 22, 2024.

Destination Country or Territory Country or Supported Supported

Name Territory Code 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 101
Rating Package RESTful Developer Guide October 22, 2024.

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:
[Link]
Countries or Territories 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 or territories.

Country or Territory or 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 102
Rating Package RESTful Developer Guide October 22, 2024.

Country or Territory or 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 Mainland 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 103
Rating Package RESTful Developer Guide October 22, 2024.

Country or Territory or 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 104
Rating Package RESTful Developer Guide October 22, 2024.

Country or Territory or 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 SAR, China 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 105
Rating Package RESTful Developer Guide October 22, 2024.

Country or Territory or 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

Macau (Macao) SAR, China 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 106
Rating Package RESTful Developer Guide October 22, 2024.

Country or Territory or 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 107
Rating Package RESTful Developer Guide October 22, 2024.

Country or Territory or 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, China New Taiwan Dollar TWD

Tajikistan Somoni TJS

Tanzania, United Republic of Tanzanian Shilling TZS

Thailand Baht THB

Timor-Leste US Dollar USD

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 108
Rating Package RESTful Developer Guide October 22, 2024.

Country or Territory or 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 109
Rating Package RESTful Developer Guide October 22, 2024.

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 with signature required (DC-SR)
• Delivery confirmation with adult signature required (DC-ASR)

Origin Destination DC-SR DC-ASR

US50 US50, PR P P

CA, VI S S

Intl other than CA, PR, VI S S

Canada (CA) US50, PR, VI S S

CA P P

Intl other than US50, PR, VI S S

Puerto Rico (PR) US50, PR P P

CA, VI S S

Intl other than US50, CA, VI S S

International-supported origin countries or International (national, trans S S

territories (not US50, PR, CA, VI) * border, worldwide)

*Refer to Country or Territory Codes in the Appendix.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 110
Rating Package RESTful Developer Guide October 22, 2024.

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.

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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 111
Rating Package RESTful Developer Guide October 22, 2024.

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:
[Link]
• United States
• Canada
• European Union
• Mexico
• Poland
• Puerto Rico
• Undefined Countries or Territories
• All Countries or Territories

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

UPS Heavy Goods 75 75

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 112
Rating Package RESTful Developer Guide October 22, 2024.

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 Category Shipping Rating
UPS Access Point Economy Shipments within the European Union 70 70

UPS Expedited Shipments originating in the European Union 08 08

UPS Express Shipments originating in the European Union 07 07

UPS Standard Shipments originating in the European Union 11 11

UPS Worldwide Express Plus Shipments originating in the European Union 54 54

UPS Worldwide Saver Shipments originating in the European Union 65 65

Mexico
Description Category Shipping Rating
UPS Access Point Economy Mexican domestic shipments 70 70

UPS Expedited Shipments originating in Mexico 08 08

UPS Express Shipments originating in Mexico 07 07

UPS 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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 113
Rating Package RESTful Developer Guide October 22, 2024.

Poland
Description Category Shipping Rating
UPS Access Point Economy Polish domestic shipments 70 70

UPS Today Dedicated Courrier 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

Unefined Countries or Territories

Use for all countries or territories other than United States, Canada, European Union, Mexico, Poland, and Puerto
Rico

Description Shipping Rating

UPS Express 07 07

UPS Standard 11 11

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 114
Rating Package RESTful Developer Guide October 22, 2024.

Description Shipping Rating

UPS Worldwide Expedited 08 08

UPS Worldwide Express Plus 54 54

UPS Worldwide Saver 65 65

All Countries or Territories

Shipments originating in all countries or territories

Description Shipping Rating

UPS Worldwide Express Freight 96 96

UPS Worldwide Express Freight Midday 71 71

UPS Worldwide Economy DDU 17 17

UPS Worldwide Economy DDP 72 72

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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 115
Rating Package RESTful Developer Guide October 22, 2024.

Rating Package RESTful 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 No, it does not support 3rd Party Billing.
API support 3rd Party billing
requests?

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

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

ChemicalRecordIdentifie What is a Chemical Record Identifier is the chemicals in the

r ChemicalRecordIdentifier shipment. If there are 3 chemicals then they need to be
numbered in that field with 1, 2, 3 as values in the
container.

Choosing a service Can a customer compare Yes. Use the “Shop” value, instead of the “Rate” value, in
services for a shipment using the RequestOption element of the ../Request container to
the Rating API? retrieve 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 Yes. A list of currencies and currency codes are available
any currency other than in the appendix of this guide. The currency returned in
USD? If so, what currencies the response is based on the shipper’s country or
are supported? territory of origin.

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

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

Extended Area Is Extended Area Surcharge Yes. The Extended Area Surcharge (EAS) is returned
Surcharge included within the rating with the 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 Freight Does Rating Package API No.

support Freight LTL or UPS
Air Freight services?

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

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 116
Rating Package RESTful Developer Guide October 22, 2024.

Category Question Answer

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

Hundredweight (CWT) Does Rating API support Yes

UPS 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 Extended Does the Rating Package Yes.

Area Surcharge API support international
extended area surcharges?

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

Lightly Regulated (LR) What is Lightly Regulated Lightly Regulated is referencing Lithium Ion batteries
(LR) versus some other regulated materials.
Maximum Packages What is the maximum When using the Rate option, there is a 200-package
Rated number of packages that can maximum allowed for each API request. Each package
be rated through the Rating container in the request can contain 1 package.
Package API?
When using the Shop option, there is a 50-package
maximum limit allowed for each API request.

N/A What is N/A? Not Applicable

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

Negotiated Rates How do I get negotiated Contact your Account Representative.

rates?

Negotiated Rates/ABR Does Rating API support Yes.

Account Based Rating
(ABR)?

Negotiated Rates or Is there a delay in activating The availability of negotiated rates is dependent on the
Account Based Rates a new or modified account in setup of your account.
(ABR) ABR for Rating or Shipping
APIs? 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.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 117
Rating Package RESTful Developer Guide October 22, 2024.

Category Question Answer

Negotiated Rates or What do negotiated rates Negotiated rates include:
Account Based Rates include?
(ABR) • Basic incentives
• 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 & Negotiated Can the Rating API provide Yes.

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

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

Rating for Web Are rates across all UPS Yes. The rates for other Web applications should not
applications Web applications always the differ from the Rating API. The only time rates would be
same? 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 [Link], 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 Scheduled Time Does the Rating API return Yes.

the time of day in its
response?

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 118
Rating Package RESTful Developer Guide October 22, 2024.

Category Question Answer

Residential versus Does Rating API UPS only classifies residential and commercial address
Commercial automatically validate classification for U.S. and Canada.
Residential verses
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 Services Does the Rating API support Yes.

Return Services?

Saturday Delivery Will the Rating API - Since Saturday delivery is an accessorial, an indication
Package allow a customer to must be included in the Rating API request. If it is
know if Saturday delivery is available then the response will specify that the delivery
available? will be on Saturday. The Rating API does not specify
guaranteed delivery times

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

labels via the Rating
Package API?

Suppression of Service Why does Rating API, Time The Time in Transit API uses logic in its calculations and
Types in Transit API and Calculate will suppress services that are more expensive if they will
Time and Cost on [Link] not deliver the shipment any quicker than those shown in
provide different results? the 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 Production Are separate test IDs No.

environments necessary to access the test
verses production
environment?

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

Time in Transit Why am I getting an “11542 - One possibility is that if the "PostalCode" is assigned to
Invalid Destination” error in multiple cities then the “ShipTo” city must be provided.
my “Ratetimeintransit” or
“Shoptimeintransit” request?

UNB What is UNB? Unbounded: Having no limits.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 119
Rating Package RESTful Developer Guide October 22, 2024.

SubVersion Details
Request Element Valid Values
"RateRequest": { "Request": {"SubVersion": ""} 1601, 1607, 1701, 1707, 1801, 2108, 2205

Rate Requests
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.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 120
Rating Package RESTful Developer Guide October 22, 2024.

"RateRequest": { Request": New Request elements acknowledged in RateRequest

{"SubVersion": ""}
Greater than or equal to 1701 {“RateRequest”: {Shipment”: {“OriginRecordTransactionTimestamp”: {}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“PackageIdentifier”: {}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“QValue”: {}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“OverPackedIndicator”: {}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“AllPackedInOneIndicator”: {}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“ChemicalRecordIdentifier”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“ClassDivisionNumber”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“IDNumber”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“TransportationMode”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“RegulationSet”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“EmergencyPhone”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“EmergencyContact”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“ReportableQuantity”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“SubRiskClass”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“PackagingGroupType”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“Quantity”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“UOM”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“PackagingInstructionCode”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“ProperShippingName”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“TechnicalName”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“AdditionalDescription”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“PackagingType”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“HazardLabelRequired”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“PackagingTypeQuantity”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“CommodityRegulatedLevelCode”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“TransportCategory”: {}}}}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“PackageServiceOptions”: {“HazMat”:
{“HazMatChemicalRecord”: {“TunnelRestrictionCode”: {}}}}}}}}
Greater than or equal to 2108 {“RateRequest”: {“Shipment”: {“Package”: {“OversizeIndicator”: {}}}}}
{“RateRequest”: {“Shipment”: {“Package”: {“MinimumBillableWeightIndicator”: {}}}}}
Note: In order get rates for Worldwide Economy shipments the Subversion 2108
must be present in the request.

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 121
Rating Package RESTful Developer Guide October 22, 2024.

"RateRequest": { Request": New Request elements acknowledged in RateRequest

{"SubVersion": ""}
Greater than or equal to 2205 {“RateRequest”: {“Shipment”: {“DeliveryTimeInformation”: {“Pickup”: {“Date”: {}}}}}}

Rate Responses
/RateRequest/Request/SubV New Request elements acknowledged in RateResponse
ersion
Greater than or equal to 1601 {“RateResponse”: {“RatedShipment”: {“ItemizedCharges”: {}}}}
{“RateResponse”: {“RatedShipment”: {“ItemizedCharges”: {“Code”: {}}}}}
{“RateResponse”: {“RatedShipment”: {“ItemizedCharges”: {“Description”: {}}}}}
{“RateResponse”: {“RatedShipment”: {“ItemizedCharges”: {“CurrencyCode”: {}}}}}
{“RateResponse”: {“RatedShipment”: {“ItemizedCharges”: {“MonetaryValue”: {}}}}}
{“RateResponse”: {“RatedShipment”: {“ItemizedCharges”: {“SubType”: {}}}}}
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”:
{“ItemizedCharges”: {}}}}}
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”:
{“ItemizedCharges”: {“Code”: {}}}}}}
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”:
{“ItemizedCharges”: {“Description”: {}}}}}}
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”:
{“ItemizedCharges”: {“CurrencyCode”: {}}}}}}
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”:
{“ItemizedCharges”: {“MonetaryValue”: {}}}}}}
{“RateResponse”: {“RatedShipment”: {“NegotiatedRateCharges”:
{“ItemizedCharges”: {“SubType”: {}}}}}}
Greater than or equal to 1607 {“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ItemizedCharges”: {}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ItemizedCharges”:
{“Code”: {}}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ItemizedCharges”:
{“Description”: {}}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ItemizedCharges”:
{“CurrencyCode”: {}}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ItemizedCharges”:
{“MonetaryValue”: {}}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“ItemizedCharges”:
{“SubType”: {}}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”:
{“NegotiatedRateCharges”: {“ItemizedCharges”: {}}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”:
{“NegotiatedRateCharges”: {“ItemizedCharges”: {“Code”: {}}}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”:
{“NegotiatedRateCharges”: {“ItemizedCharges”: {“Description”: {}}}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”:
{“NegotiatedRateCharges”: {“ItemizedCharges”: {“CurrencyCode”: {}}}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”:
{“NegotiatedRateCharges”: {“ItemizedCharges”: {“MonetaryValue”: {}}}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”:
{“NegotiatedRateCharges”: {“ItemizedCharges”: {“SubType”: {}}}}}}}

1701 and greater {“RateResponse”: {“RatedShipment”: {“BaseServiceCharge”: {}}}}

{“RateResponse”: {“RatedShipment”: {“BaseServiceCharge”: {“CurrencyCode”:
{}}}}}
{“RateResponse”: {“RatedShipment”: {“BaseServiceCharge”: {“MonetaryValue”:
{}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 122
Rating Package RESTful Developer Guide October 22, 2024.

/RateRequest/Request/SubV New Request elements acknowledged in RateResponse

ersion
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“BaseServiceCharge”:
{}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“BaseServiceCharge”:
{“CurrencyCode”: {}}}}}}
{“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“BaseServiceCharge”:
{“MonetaryValue”: {}}}}}}
1707 and greater {“RateResponse”: {“RatedShipment”: {“RatedPackage”: {“Accessorial”: {}}}}}
{“RateResponse”: {“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": ""}}}}
2205 and greater {“ RateResponse”: {“RatedShipment”: {“PackageResults”: {“RateModifier”: {}}}}}
{“ RateResponse”: {“RatedShipment”: {“PackageResults”: {“RateModifier”:
{“ModifierType”: ""}}}}}
{“ RateResponse”: {“RatedShipment”: {“PackageResults”: {“RateModifier”:
{"ModifierDesc”: ""}}}}}
{“ RateResponse”: {“RatedShipment”: {“PackageResults”: {“RateModifier”:
{“Amount”: ""}}}}}
{“ RateResponse”: {“RatedShipment”: {“ScheduledDeliveryDate”: ""}}}
{“ RateResponse”: {“RatedShipment”: {“RateConstructTypeIndicator”: ””}}}
2407 and greater (Rate {"RateResponse":{"RatedShipment":{"NegotiatedRateCharges":{"RateModifier":{}}}
Oauth) }}
{"RateResponse":{"RatedShipment":{"NegotiatedRateCharges":{"RateModifier":{"
ModifierType":{}}}}}}
{"RateResponse":{"RatedShipment":{"NegotiatedRateCharges":{"RateModifier":{"
ModifierDesc":{}}}}}}
{"RateResponse":{"RatedShipment":{"NegotiatedRateCharges":{"RateModifier":{"A
mount":{}}}}}}
{"RateResponse":{"RatedShipment":{"RatedPackage":{"NegotiatedCharges":{"Rat
eModifier":{}}}}}}
{"RateResponse":{"RatedShipment":{"RatedPackage":{"NegotiatedCharges":{"Rat
eModifier":{"ModifierType":{}}}}}}}
{"RateResponse":{"RatedShipment":{"RatedPackage":{"NegotiatedCharges":{"Rat
eModifier":{"ModifierDesc":{}}}}}}}
{"RateResponse":{"RatedShipment":{"RatedPackage":{"NegotiatedCharges":{"Rat
eModifier":{"Amount":{}}}}}}}

© 2023 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 123