Sorry, you need to enable JavaScript to visit this website.
Skip to main content


What types of APIs does UPS support?

UPS supports RESTful APIs. REST is an acronym for Representational State Transfer and an architectural style for distributed hypermedia systems. A RESTful API is an architectural style for an application program interface (API) that uses HTTP requests to access and use data. That data can be used to GET, PUT, POST and DELETE data types, which refers to the reading, updating, creating and deleting of operations concerning resources.

How do I see the current status of the APIs?

UPS provides the health status of some of our featured APIs on our API Monitoring Dashboard. More APIs will be integrated into the dashboard in the future. You can view details to see a log of any incidents that have occurred in the past 24 hours.



How do I obtain API credentials?

To get your client ID and secret for API access, you will need a login and UPS shipper account. After you are logged in, create an application, subscribe to API products and obtain your client ID and secret to transact with the APIs. For step-by-step instructions refer to the Build page.


Can I share my client ID and secret?

No, you should not, sharing credentials is not secure. Any entity asking you to share your credentials should be using an Auth-Code grant type instead.

I have an existing API integration with UPS using an access key, why should I switch to client ID and secret using OAuth?

There are several key benefits to switching which include improved security for your applications and customers with OAuth 2.0, modern RESTful API products, a robust testing environment and continued support from UPS.

Can I still get an access key?

Access keys will continue to function, but will be sunset in the near future. UPS will notify all integrators in advance to allow enough time to migrate their integrations.

Where can I find additional help and support?

Please see below to contact the Help Desk.

What is OAuth 2.0?

OAuth 2.0, which stands for “Open Authorization”, is a standard designed to allow a website or application to access resources hosted by other web apps on behalf of a user. It provides consented access and restricts actions of what the client app can perform on resources on behalf of the user, without ever sharing the user's credentials.

For authentication, should I use client credential or Auth-Code flow?

To represent a single entity in the transaction, use the simple client credential flow. In client credential flow, only UPS accounts that are linked to the client ID and secret during the app creation process can be represented. To enable others to represent themselves through your application, use the Auth-Code flow.

Can I use an existing XML or Web Service payload with OAuth 2.0?

No, you must use the RESTful version of our APIs.

Where can I access Open API spec docs for each API?

Open API spec documents are available on the API documentation pages.

Can I use localhost as my callback URL for testing?

No, localhost is not supported.

Is there a limit to the number of API calls I can request at one time?

Yes. UPS limits the number of requests to the API per second per user. Rate limits in the test environment are lower than production. Users that are throttled will receive error code “10429 - Too Many Requests” in the response.

Where can I find sample code and use-case examples?

Sample code and use-case examples can be found in the API catalog documentation pages.

Where can I find additional help and support?

Please see below to contact the Help Desk.