Make a selection

UPS V2 Migration Guide

Laurel
Laurel
  • Updated

Beginning June 3, 2024, access keys will no longer be supported for authentication to any UPS APIs. UPS has deprecated access key authentication in favor of an OAuth 2.0 security model. You can read more about this update on the UPS website.

If you are currently using UPS custom carrier rates in Bold Cashier which have been authenticated using an API access key, you must update to the OAuth security model in order to ensure your custom UPS rates continue to work in Cashier.

Note: This article is relevant to those with existing custom-carrier UPS accounts connected in Bold Cashier. If you are using the default UPS carrier-calculated rates in Bold Cashier you do not need to make any changes.

 


 

Setup

To ensure your custom UPS rates work in Cashier, you must add the Bold Cashier callback URL in your UPS developer account, connect to USP V2 in Cashier, and update your rates in any relevant shipping zones. To do this, please follow the steps below.

Step 1: Configure the Callback URL for Bold in your UPS developer account

  1. Log in to your UPS developer account.
  2. Click My Apps in the top right.
  3. Select the relevant app from your My Apps list.
  4. Ensure Rating appears in the Products in Use column. If not, click Add Products, check the Rating card, and click Save to add it.
  5. Click on Edit App.
  6. Add the following Callback URL:
     https://cashier.boldcommerce.com/api/admin/v1/carrier_credentials/ups/onboarding_url/done
  7. Click Save.

Step 2: Connect to UPS V2 in Bold Cashier

  1. In the Bold Cashier admin, navigate to Shipping > Custom carriers.
  2. Click Setup custom carrier.
  3. In the Name field, enter a unique name to distinguish your custom rates from the default UPS rates available in Bold Cashier.
  4. Expand the Carrier dropdown menu and select UPS v2.
  5. Enter your Account Number.
  6. Click Connect. This directs you to to the UPS login page.
  7. Enter your login credentials, and check the box to authorize the connection. Once this is done, you are redirected back to Bold Cashier and the custom rate will appear.
  8. Delete the old UPS custom carrier by clicking the x icon.

Step 3: Update your existing rates to the new UPS version

  1. In the Bold Cashier admin, navigate to Shipping > Shipping zones.
  2. Click the edit icon next to your existing shipping zones.

    Edit shipping zone

  3. In the Carrier-calculated rates section, click the x icon to remove the old custom UPS rates.
  4. Expand the Carrier dropdown menu, and select the name of the new rate that you defined for UPS v2 (in step 2.3 above).
  5. Click Save.