Tracking® RESTful Developer Guide

August 08, 2022

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.

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

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary iii
 Table of Contents
Chapter 1: Introduction ......................................................................................................... 5

Chapter 2: Understanding the Tracking RESTful API ............................................................... 6

Tracking Usage Guidelines .................................................................................................................... 6
Business Rules ........................................................................................................................................ 6

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

Chapter 4: Common Element Constraints............................................................................... 8

Chapter 5: Tracking REST Elements and Details ...................................................................... 9

Headers..................................................................................................................................................... 9
URL ........................................................................................................................................................... 9
URL Parameters ....................................................................................................................................... 9
Query Parameters .................................................................................................................................... 9
Track Response ..................................................................................................................................... 10
API Sample Scenario ............................................................................................................................. 13
Scenario ............................................................................................................................................. 13

Appendices ......................................................................................................................... 16
Error Codes ........................................................................................................................................... 16
HTTP Status Codes ........................................................................................................................... 16
Common Error Codes ........................................................................................................................ 16
Tracking Error Codes ......................................................................................................................... 17
State / Province Codes.......................................................................................................................... 18
Locale Codes ......................................................................................................................................... 21

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary iv
UPS Tracking RESTful Developer Guide August 08, 2022

Chapter 1: Introduction
In this document, you will find guidance and instructions for integrating Tracking RESTful into your application,
service, or system.

In this guide, you will find:

• Tracking RESTful API functionality and business rules
• RESTful API request and response elements
• Header and URL elements
• Sample request, response and error response
• Error response code descriptions
• Service code references

This guide applies to the following API:

• Tracking RESTful API

Intended Audience
This guide is intended for developers who will be integrating the Tracking RESTful 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 services
• Software development

How to Use this Guide

• If this is your first time working with the UPS Developer Kit, begin with the Introduction to the UPS Developer Kit
guide. This guide serves as the foundation for all API-specific developer guides.
• If you are experienced with the UPS Developer Kit but have not yet worked with the Tracking RESTful API,
continue with Chapter 2: Understanding the Tracking RESTful API. There you will find an overview of the Tracking
functionality and business rules.
• Chapter 3: Customer Integration Environment (CIE) contains information on UPS integration environments.
• Chapter 5 contains an overview of the elements that comprise the response.
• Reference tables and error codes are located in the Appendices.

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 5
UPS Tracking RESTful Developer Guide August 08, 2022

Chapter 2: Understanding the Tracking RESTful API

The Tracking RESTful API supports Package, Ground Freight and Air Freight shipments. Signature Tracking and
BCDN are not supported in Tracking RESTful API at this time, however it will be available in a future release.
• Some Tracking data may not be returned in the response because the data rolled off. Database retention times:
o Manifest information, and Manifest Voided scans: 120 days
o Exception scans: 120 days
o In Transit scans like Origin/Arrivals/Departures/Destination scans: 120 days
• UPS uses tracking numbers to identify and track packages in its system. Applications can use the tracking
number to track, locate, and verify arrival of a package.

Tracking Usage Guidelines

The following guidelines are included so all UPS customers can use UPS Tracking without delays:
• Ensure tracking requests are valid. If your request returns an error message such as "tracking number not found",
"no information available", or "invalid tracking number", you should research the cause of the error before
continuing to track the same number.
• When the results of a tracking request indicate a “delivered” status, do not continue to track the package.
• Track packages during “off hours” whenever possible. Off hours are from 5:00 pm to 8:00 am East Coast time.
• Avoid automatic access between 10:00 am to 3:00 pm EST. However, you may track critical packages during this
time.
• Evenly distribute your information requests over the remaining 19-hour window.
• Refrain from tracking the same numbers continually throughout the day. Unique tracking numbers should be
tracked no more than once per hour or a maximum of 24 times in a single day.

 If daily/weekly tracking requests exceed daily shipping volume by a large margin, UPS reserves the right to
suspend tracking for that account until the situation is rectified. If a resolution cannot be found and implemented,
tracking for that account may be terminated.

Business Rules
General
• UPS expects elements as defined in the request structure without spelling or structural deviations. Elements that
are not defined in the data request or do not conform to the structure will be ignored by UPS.
• Only users that plan to ship packages manifested, tendered, and delivered by UPS can use the API.
• Any customers/developers abusing or data mining the API will have their access revoked.
• To access API documentation the user must have or create a UPS profile.
• To access testing and production sites the user must have an Access Key. To get an Access Key you must have a
UPS profile and an associated shipping account. For additional information, refer to the UPS Developer Kit User
Guide.

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 6
UPS Tracking RESTful Developer Guide August 08, 2022

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.

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.

Integration Testing

 All API URLs are case sensitive.

For integration testing, direct your Tracking RESTful API to:
https://wwwcie.ups.com/track/v1/details/{inquiryNumber}

Production

 All API URLs are case sensitive.

Once testing is complete, direct your Tracking RESTful API to the production URL:
https://onlinetools.ups.com/track/v1/details/{inquiryNumber}

Tracking Numbers for Testing CIE

The following table contains tracking numbers for use in the testing environment and describes the result that
developers should expect when attempting a Track RESTful Request.
When using tracking numbers other than those designated for testing in CIE, an error response will be returned.

Type Value Description

Small Package 1Z5338FF0107231059 Delivery Attempted

Mail Innovations 92055900100111152280003029 Activity List
Freight 7798339175 Activity List
Overnight 572254454 Delivered

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 7
UPS Tracking RESTful Developer Guide August 08, 2022

Chapter 4: Common Element Constraints

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

 UPS expects elements as defined in the request 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.

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 8
UPS Tracking RESTful Developer Guide August 08, 2022

Chapter 5: Tracking REST Elements and Details

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

 UPS expects elements as defined in the tables 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.

Headers
Name Constraint Description

Required: Yes
transId Type: Header An identifier unique to the request
Length: 32
Required: Yes
Customer provided data. Echoed back in the
transactionSrc Type: Header
response if provided.
Length: 512
Required: Cond Authorization: Access Key obtained through on-
AccessLicenseNumber Type: Header boarding process. Contact your UPS
Length: 16 representative for additional information.
Required: Cond
Username Type: Header The customers MyUPS user ID/username.
Length: 16
Required: Cond The customers MyUPS password. Required if
Password Type: Header the AuthenticationToken is not present.
Length: 26
Used to authenticate the API. Can be used in
place of Username and Password
AuthenticationToken Required: Cond
Type: Header example: AuthenticationToken:<value>

Authorization Required: Cond Used to authorize the access to API. Can be

Type: Header used in place of Username and Password

URL
https://onlinetools.ups.com/track/v1/details/{inquiryNumber}

URL Parameters
Name Constraint Description

The tracking number for which tracking

information is requested. The number must be
Required: Yes between 7 and 34 characters in length.
Type: Path
inquiryNumber
Max Allowed: 1
Length: 34

Query Parameters
Name Constraint Description

Required: No The language and country code combination. If

locale Type: Query not provided will default to “en_US”.
Length: 5

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 9
UPS Tracking RESTful Developer Guide August 08, 2022

TrackResponse
Name Constraint Description Validation
{“trackResponse”: {} }
TrackResponse Required: Yes The root element/container for the TrackResponse
Type:
Container
Max Allowed: 1
Length: N/A

{“trackResponse”: {“shipment”: [{}] } }

Shipment Required: Yes A container element which contains the Shipment
Type: Container details associated to the inquiry numbers.
Max Allowed: 1
Length: N/A

{“trackResponse”: {“shipment”: [{“package”: [{}] } ]} }

Package Required: Yes A container element which contains the Package
Type: Container details
Max Allowed: 1
Length: N/A

{“trackResponse”: {“shipment”: [{“package”: [{“trackingNumber”: “ “}] } ]} }

TrackingNumber Required: Yes The small package, mail innovations, freight or
Type: String overnight tracking number
Max Allowed: 1
Length: 34

{“trackResponse”: {“shipment”: [{“package”: [{“deliveryDate”: [{}] }] } }

DeliveryDate Required: No A container element which stores Delivery date
Type: Container details associated with the package
Max Allowed:
Many
Length:

{“trackResponse”: {“shipment”: [{“package”: [{“deliveryDate”: [{“type”: “”} ]}] } ]} }

Type Required: Yes Delivery Date Type. Valid values:
Type: String
Max Allowed: 1 RDD – Rescheduled Delivery Date
Length: 3 SDD – Scheduled Delivery Date
DEL – Delivery Date

{“trackResponse”: {“shipment”: [{“package”: [{“deliveryDate”: [{“date”: “”}] }] } ]} }

Date Required: Yes Date of the transaction.
Type: String
Max Allowed: 1 Format: MMDDYYYY
Length: 10

{“trackResponse”: {“shipment”: [{“package”: [{“deliveryTime”: {} }] }] } }

DeliveryTime Required: No Container which stores Delivery times associated
Type: Container with the package
Max Allowed: 1
Length:

{“trackResponse”: {“shipment”: [{“package”: [ {“deliveryTime”: {“startTime”: “”} } ]}] } }

StartTime Required: Yes The start time, committed time or delivered time
Type: String
Max Allowed: 1 Format: HHMMSS – 24 hours
Length: N/A Local time

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 10
UPS Tracking RESTful Developer Guide August 08, 2022

Name Constraint Description Validation

{“trackResponse”: {“shipment”: [{“package”: [{“deliveryTime”: {“endTime”: “”}} ]}] } }
EndTime Required: Cond The end time of the window. Only returned with the
Type: String Type is EDW, CDW or IDW.
Max Allowed: 1
Length: 1…13 Format: HHMMSS – 24 hours
Local time

{“trackResponse”: {“shipment”: [{“package”: [{“deliveryTime”: {“type”: “”}} ]}] } }

Type Required: Yes Indicates the type of delivery
Type: String
Max Allowed: 1 Valid values:
Length: 3 DEL Delivery Time
CDW Confirm Delivery Window
IDW Imminent Delivery Window
EDW Estimated Delivery Window
CMT Commit Time
EOD End of Day

{“trackResponse”: {“shipment”: [{“package”:[ {“activity”: [{}] }] }] } }

Activity Required: No A container element containing the scan activity
Type: Container associated with the inquiryNumber
Max Allowed: 1
Length: N/A

{“trackResponse”: {“shipment”: [{“package”: [{“activity”: [{“location”: {} }] } ] } ]} }

Location Required: No Container which holds the location where activity
Type: Container occurred
Max Allowed:
Many
Length:

{“trackResponse”: {“shipment”: [{“package”: [{“activity”:[{“location”: {“address”: {} } } ] } } ]} }

Address Required: No Container which stores the Address details
Type: String
Max Allowed: 1
Length:

{“trackResponse”: {“shipment”: [{“package”: [{“activity”: [{“location”: {“address”: {“city”: “”} } }] }] } ]} }

City Required: No City name
Type: String
Max Allowed: 1
Length: 50

{“trackResponse”: {“shipment”: [{“package”: [{“activity”: [{“location”: {“address”: {“stateProvince”: “”}} }] }] } ]} }

StateProvince Required: No State or Province name
Type: String
Max Allowed: 1
Length:

{“trackResponse”: {“shipment”: [{“package”: [{“activity”: [{“location”: {“address”: {“postalCode”: “”}} }] }] } ]} }

PostalCode Required: No Postal code of state or province (if applicable)
Type: String
Max Allowed: 1 Ex. 55555
Length: 15

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 11
UPS Tracking RESTful Developer Guide August 08, 2022

Name Constraint Description Validation

{“trackResponse”: {“shipment”: [{“package”: [{“activity”: [{“location”: {“address”: {“countryCode”: “”}} }] }] } ]} }
CountryCode Required: No Two digit country code.
Type: String
Max Allowed: 1 Ex. US
Length: 2

{“trackResponse”: {“shipment”: [{“package”: [{“activity”: [{“status”: {} }] }] }] } }

Status Required: Yes Container which stores the Status associated to the
Type: Container activity
Max Allowed: 1
Length: N/A

{“trackResponse”: {“shipment”: [{“package”: [{“activity”: [{“status”: {“type”: “”} } }] }] } }

Type Required: Yes Valid values:
Type: String
Max Allowed: 1 D Delivered
Length: I In Transit
M Billing Information Received
MV Billing Information Voided
P Pickup
X Exception
RS Returned to Shipper
DO Delivered Origin CFS (Freight Only)
DD Delivered Destination CFS (Freight Only)
W Warehousing (Freight Only)
NA Not Available
O Out for Delivery
{“trackResponse”: {“shipment”: [{“package”: [{“activity”: [{“status”: {“description”: “”} } }] }] } }
Description Required: Yes The status description
Type: String
Max Allowed: 1
Length:

{“trackResponse”: {“shipment”: [{“package”: [{“activity”: [{“status”: {“code”: “”} }] }] }] } }

Code Required: Yes Status code
Type: String
Max Allowed: 1
Length: 10

{“trackResponse”: {“shipment”: [{“package”: [{“activity”: [{“date”: “”}] }] } ]} }

Date Required: Yes The date of the activity
Type: String
Max Allowed: 1 Format: YYYYMMDD
Length: 10

{“trackResponse”: {“shipment”: [{“package”: [{“activity”: [{“time”: “”}] } ]}] } }

Time Required: Time The time of the activity
Type: String
Max Allowed: 1 Format: HHMMSS (24 hr)
Length: 1…16 Local time

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 12
UPS Tracking RESTful Developer Guide August 08, 2022

Name Constraint Description Validation

{“trackResponse”: {“shipment”: [{“package”: [{“flightIndicator”: “”} ]}] } }
FlightIndicator Required:No This indicator will be used to display a plane icon
and details on the status of the UPS Premier
Type:String Package so that the user will know their package is
Max Allowed:1 currently on a plane. The locations will update once
the package is no longer in flight
Length:N/A
Returns true if flight indicator is available and return
false if flight indicator is not available.

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 13
 UPS Tracking RESTful Developer Guide August 08, 2022

API Sample Scenario

Scenario:
Client application is searching for a restricted trading partner by name.
Method GET

Header transId: 12345

Elements
transactionSrc: TestTrack
Username: user name
AccessLicenseNumber: accesslicensenumber
Content-Type: application/json
Accept: application/json
Example https://onlinetools.ups.com/track/v1/details/1Zxxxxxxxxxxxxxx?locale=en_US
URL
Example {
Response
“trackResponse”: {
“shipment”: [
{
“package”: [
{
“trackingNumber”: “1Zxxxxxxxxxxxxxx “,
“activity”: [
{
“location”: {
“address”: {
“city”: “Sparks”,
“stateProvince”: “MD”,
“postalCode”: “”,
“country”: “US”
}
},
“status”: {
“type”: “X”,
“description”: “Delay”,
“code”: “CK”
},
“date”: “20200115”,
“time”: “104600”
},
{
“location”: {
“address”: {

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 14
 UPS Tracking RESTful Developer Guide August 08, 2022

“city”: “”,
“stateProvince”: “”,
“postalCode”: “”,
“country”: “US”
}
},
“status”: {
“type”: “M”,
“description”: “Order Processed: Ready for UPS “,
“code”: “MP”
},
“date”: “20200115”,
“time”: “075518”
}
]
}
]
}
]
}
}
Example {
Error
Response “response”: {
“errors”: [
{
“code”: “TV1002”,
“message”: “Invalid inquiry number”
}
]
}
}

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 15
UPS Tracking RESTful Developer Guide August 08, 2022

Appendices
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 JSON 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 to all RESTful and other APIs.

Code Severity Description

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

250000 400 No XML declaration in the XML document.

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

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 16
UPS Tracking RESTful Developer Guide August 08, 2022

Code Severity Description

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 30 minutes.

250009 401 License Number not found in the UPS database.

250019 401 Invalid Field value.

250050 500 License system not available.

Tracking Error Codes

Error Code Severity Description
TV1001 400 Missing Inquiry Number

TV1002 400 Invalid Inquiry Number

TV1003 400 Unsupported inquiry number type

TW0001 200 Tracking Information Not Found

TX0002 503 Tracking Information Not Available at this time

TX0001 500 Generic web service internal failure error

10429 429 Too Many Request

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 17
UPS Tracking RESTful Developer Guide August 08, 2022

State / Province Codes

United States
State Code
Alaska AK

Alabama AL

Arkansas AR

Arizona AZ

California CA

Colorado CO

Connecticut CT

District of Columbia DC

Delaware DE

Florida FL

Georgia GA

Hawaii HI

Iowa IA

Idaho ID

Illinois IL

Indiana IN

Kansas KS

Kentucky KY

Louisiana LA

Massachusetts MA

Maryland MD

Maine ME

Michigan MI

Minnesota MN

Missouri MO

Mississippi MS

Montana MT

North Carolina NC

North Dakota ND

Nebraska NE

New Hampshire NH

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 18
UPS Tracking RESTful Developer Guide August 08, 2022

State Code
New Jersey NJ

New Mexico NM

Nevada NV

New York NY

Ohio OH

Oklahoma OK

Oregon OR

Pennsylvania PA

Rhode Island RI

South Carolina SC

South Dakota SD

Tennessee TN

Texas TX

Utah UT

Virginia VA

Vermont VT

Washington WA

Wisconsin WI

West Virginia WV

Wyoming WY

Canada
Province Code
Alberta AB

British Columbia BC

Manitoba MB

New Brunswick NB

Newfoundland and Labrador NL

Nova Scotia NS

Northwest Territories NT

Nunavut NU

Ontario ON

Prince Edward Island PE

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 19
UPS Tracking RESTful Developer Guide August 08, 2022

Province Code
Quebec QC

Saskatchewan SK

Yukon Territory YT

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 20
UPS Tracking RESTful Developer Guide August 08, 2022

Locale codes
The following table lists all supported locale codes (country/territory and language combination). Refer to the
Country/Territory Codes Appendix section for Country/Territory details.
Locale is accepted in below format Example: - Locale - en_US means ‘LanguageCode_CountryCode’

Locale Code

bg_BG

cs_CZ

da_DK

de_AT

de_CH

de_DE

el_CY

el_GR

en_AE

en_AG

en_AI

en_AL

en_AR

en_AT

en_AU

en_AW

en_AZ

en_BA

en_BB

en_BD

en_BE

en_BG

en_BH

en_BL

en_BM

en_BO

en_BQ

en_BR

en_BS

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 21
UPS Tracking RESTful Developer Guide August 08, 2022

en_CA

en_CB

en_CH

en_CI

en_CL

en_CN

en_CO

en_CR

en_CW

en_CY

en_CZ

en_DE

en_DK

en_DM

en_DO

en_DZ

en_EC

en_EE

en_EG

en_ES

en_EU

en_FI

en_FR

en_GB

en_GD

en_GH

en_GI

en_GP

en_GR

en_GT

en_GY

en_HK

en_HN

en_HR

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 22
UPS Tracking RESTful Developer Guide August 08, 2022

en_HT

en_HU

en_ID

en_IE

en_IL

en_IN

en_IT

en_JM

en_JO

en_JP

en_KE

en_KN

en_KR

en_KW

en_KY

en_KZ

en_LB

en_LC

en_LT

en_LU

en_LV

en_MA

en_MD

en_MO

en_MS

en_MT

en_MU

en_MX

en_MY

en_NG

en_NI

en_NL

en_NO

en_NZ

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 23
UPS Tracking RESTful Developer Guide August 08, 2022

en_OM

en_PA

en_PE

en_PH

en_PK

en_PL

en_PR

en_PT

en_PY

en_QA

en_RE

en_RO

en_RS

en_RU

en_SA

en_SE

en_SG

en_SI

en_SK

en_SR

en_ST

en_SV

en_SX

en_TH

en_TN

en_TR

en_TT

en_TW

en_UA

en_US

en_UY

en_VC

en_VE

en_VG

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 24
UPS Tracking RESTful Developer Guide August 08, 2022

en_VI

en_VN

en_ZA

en_ZW

es_AR

es_BO

es_CL

es_CO

es_CR

es_DO

es_EC

es_ES

es_GT

es_HN

es_MX

es_NI

es_PA

es_PE

es_PR

es_PY

es_SV

es_US

es_UY

es_VE

et_EE

fi_FI

fr_BE

fr_CA

fr_CH

fr_DZ

fr_FR

fr_LU

fr_MA

fr_TN

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 25
UPS Tracking RESTful Developer Guide August 08, 2022

he_IL

hu_HU

it_IT

ja_JP

ko_KR

lt_LT

lv_LV

nl_BE

nl_NL

no_NO

pl_PL

pt_BR

pt_PT

ro_RO

ru_RU

sk_SK

sv_SE

tr_TR

vi_VN

zh_CN

zh_HK

zh_MO

zh_TW

© 2021 United Parcel Service of America, Inc. All Rights Reserved. Confidential and Proprietary 26