Updating UPS for new UPSAPI (August 5, 2024)

Modified on Mon, 03 Jun 2024 at 04:55 PM

Many of our clients websites are using or want to use UPS real time shipping rates on their storefront. On August 5th, 2024, UPS will change it's access key authentication, and all users will need to update their settings to be ready. If you've seen the message below, we're here to help you be ready.

UPS has deprecated access key authentication in favor of an OAuth 2.0 security model for all APIs. Beginning August 5, 2024, access keys will no longer be supported for authentication to any UPS APIs. After this date, all integrations must utilize the OAuth 2.0 authentication model to continue to transact with UPS APIs. 

In May of 2024, Vortx has rolled out an update to your website code base. Your UPS real time shipping account will continue to work until August 5th, but for your shipping rates to continue working after August 5th, you'll need to update your settings in your website. The old UPS integrations will be removed in a future release as they will no longer function.

*Important note: This is only intended to update your UPS real time rates. If you are also using other carriers like USPS, FedEx, DHL, etc.,  you do not need to adjust those settings. You can leave your other carriers in place and only change your UPS settings in your admin panel.

Action Items

To seamlessly continue transacting with UPS APIs after August 5th, you will need to obtain OAuth API Credentials: 

*this was on UPS website as of 4/30/24

When clicking you should see your "My Apps" which may be blank. If you already have an app, you may not need to create a new App. If you don't have an app, follow along. If you do have an app that you'd like to use, you can skip the next few steps of creating an app and pick up the instructions where it shows you how to grab your keys.

Click on "Add Apps"

Request to integrate on this screen. Select your UPS account that you'd like to use and hit next: 

Fill out your Primary contact information and click next. 

On this next page, please configure this with your information. 

  • App Name: you can make up a name for the app. Best to call it something that is representative of your website. 
  • Callback URL: use your full url including https:// and a slash after the .com.
  • Billing Account Number: You should see your account in the drop-down. If you have multiple accounts, please select the correct one you'd like to use for your website.
  • Add Products: Please add Authorization (OAuth), Shipping, and Rating products. If you can't add shipping and rating, please add OAuth first and save. Then edit the app and add shipping and rating, then save again.

Now you should have an app in your "my Apps" page:

If you click into your app, or create a new one, you should be able to view your Client ID and Client secret key: 

Keeping this tab open

In a new tab, log into your Prefix website admin. 

Go to Configuration > Settings 

Search for "RTShipping.ActiveCarrier" - and set that to "UPSAPI." 

*If you currently are using UPS along with other RT shipping carriers, you can leave those other carriers in place. Just be sure you've removed "UPS" and replaced it with "UPSAPI". If you are using UPS2, you can remove that as well. UPSAPI will replace the need for using UPS2.

Search for "UPS-assigned" and you should see the username and password setting.

  • RTShipping.UPS.UserName: Value field will be your UPS "Client ID" from above
  • RTShipping.UPS.Password: Value field will be your UPS "Client Secret" from above

All other RTShipping and RTShipping.UPS settings will continue to work for the new UPS API options just the same as they did on the older Real-Time shipping integrations. 


If you are using UPS rates for domestic and international shipping, you'll need to update those for UPSAPI as well. Or leave them blank if you're not using them. 

You can leave these blank, or if you're using different carriers for domestic and international, you should use the UPSAPI option instead of UPS or UPS2.

There are three new Configuration > Settings that are specific to the UPSAPI.

  • RTShipping.UPS.API.DeliveryConfirmation: whether to request a delivery confirmation on the shipment.
  • RTShipping.UPS.API.Server: The live UPS API URL (Do not change)
  • RTShipping.UPS.API.TestServer: The test UPS API URL (Do not change)

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article