Who This Applies To

This update only applies to stores currently using legacy UPS credentials (Access Key authentication). If your store is already using UPS OAuth credentials (Client ID and Client Secret), no action is required.

Important Notice

UPS phased out legacy API authentication methods in 2024 in favor of OAuth 2.0 authentication.

At the time, stores using legacy UPS credentials should have received migration notices from both UPS and Spirit Sale. While some stores continued functioning temporarily after the transition period, we are now seeing checkout issues affecting stores still using the older UPS authentication method.

Stores using legacy UPS credentials may experience:

• UPS shipping rate failures

• 500 checkout errors during checkout

To avoid interruptions to your checkout process, we strongly recommend updating your UPS integration as soon as possible.

Before You Begin

Before updating your settings in Spirit Sale, you must first create your new UPS OAuth credentials.

Please follow this guide first:

https://help.spiritsale.com/portal/en/kb/articles/how-to-get-ups-api-credentials-for-spirit-sale

You will need:

• UPS Client ID

• UPS Client Secret

Important:

• Use Production credentials and not Sandbox/Test credentials

• Older UPS Access Keys are not compatible with the OAuth integration

Step 1: Disable UPS for Active Stores

Before updating your UPS credentials, UPS must first be disabled for each active or scheduled store where UPS shipping is currently enabled.

For each store:

1. Go to:
   Store Fronts → Stores

2. Click the Edit button (pencil icon) for a store using UPS shipping

3. Go to:
   Shipping Methods

4. Click the UPS box so it is no longer highlighted in green

5. Click the green UPDATE button

Repeat these steps for each active or scheduled store with UPS enabled.

Step 2: Enable OAuth Integration

1. Go to:
   Settings → Shipping Setup → UPS

2. Enable:
   USE OAUTH INTEGRATION

3. Click:
   Update

Step 3: Enter Your UPS OAuth Credentials

1. Refresh the page

2. Enter your:

   • UPS CLIENT ID

   • UPS CLIENT SECRET

3. Click:
   Update

Step 4: Verify Required UPS API Subscriptions

A common issue after updating credentials is that Spirit Sale accepts the UPS Client ID and Client Secret, but UPS shipping rates still do not appear during checkout.

This usually means the required UPS API subscriptions are not enabled for the application created in the UPS Developer Portal.

We recommend ensuring the following APIs are enabled and approved for your UPS application:

• Rating

• Tracking

• Address Validation

• Authorization (OAuth)

• Shipping

The Rating API is required for UPS shipping rates to appear during checkout.

Step 5: Re-Enable UPS for Your Stores

After successfully updating your UPS credentials:

1. Go to:
   Store Fronts → Stores

2. Click the Edit button (pencil icon) for each store

3. Go to:
   Shipping Methods

4. Click the UPS box so it is highlighted in green

5. Click the green:
   UPDATE
   button

Repeat these steps for each store that should offer UPS shipping.

Step 6: Test Your Checkout

After updating your credentials:

1. Add a product to cart

2. Proceed through checkout

3. Verify UPS shipping rates are loading properly

Common Issues

Still Receiving Checkout Errors

Please verify:

• OAuth integration is enabled

• The correct UPS Client ID and Client Secret were entered

• You are using Production credentials

• Your UPS application is active within the UPS Developer Portal

• The required UPS API subscriptions are enabled and approved

UPS Credentials Are Accepted But Rates Do Not Appear

This is usually caused by missing API subscriptions within the UPS Developer Portal, especially the Rating API.

UPS Credentials Are Not Working

If UPS does not allow you to generate or activate Production credentials, you may need to contact UPS directly to complete account verification.

Need Assistance?

If you continue experiencing issues after updating your UPS credentials, please contact Spirit Sale Support.