1. Home
  2. Carriers
  3. Parcel
  4. UPS
  5. UPS OAuth Account Setup

UPS OAuth Account Setup

UPS has implemented an OAuth 2.0 security model for all APIs to enhance overall security. As part of the process to keep customers secure, UPS will deprecate the existing Access Key-based authorization for our APIs. Beginning February 1st, 2024, UPS will no longer distribute new access keys, and after June 3rd, 2024, UPS will not support all existing access keys, so we have implemented the OAuth security model by sending a bearer token with every API request. You will need to re-authorize each existing shipping account after onboarding UPS OAuth.

Edit Existing UPS Account

  1. Open the StarShip Web Client and log in. Navigate to Setup -> Carrier Interfaces -> UPS.
  2. Navigate to the ACCOUNTS tab. If there are existing UPS accounts, proceed to edit them.
  3. Click AUTHORIZEIt will redirect the user to the ups.com site. Enter the Username and Password on the opened UPS page and log in. After a 5-second delay, it will return to the StarShip page. 
    Pre-conditions

    Customers need to be aware of their UPS profile account linked to the provided UPS shipping account.

  4. The token will be saved automatically; click the Save button. The Edit and Authenticate process will be completed.
    Note

    • A change in the Rating tab, where the Invoice Information section is hidden and no longer needed for UPS OAuth.
    • You must authenticate all existing UPS accounts individually if you intend to use all of them.

  5. The users can effectively use UPS carrier services for shipping now.

Add New UPS Account

  1. Login to the StarShip Web Client and navigate to Setup -> Carrier Interfaces -> UPS.
  2. Read the UPS Technology Agreement and proceed by clicking Next to agree.
  3. Navigate to the ACCOUNTS tab and click NEW ACCOUNT to create a new UPS account.
  4. Click NEXT.
  5. Enter the Account Name and Account Number, then click AUTHORIZEIt will redirect the user to the ups.com site. Enter the Username and Password on the opened UPS page and log in. After a 5-second delay, it will return to the StarShip page.
    Pre-conditions

    Customers need to be aware of their UPS profile account linked to the provided UPS shipping account.

  6. The system automatically saves the Token Info and click NEXT.
  7. Enter the Billing Address and Shipping Address details and click NEXT.
  8. Select the account’s Contract Services and Internal Settings, and proceed by clicking the NEXT button until completed.
    Note

    A change is observed in the Rating tab, where the Invoice Information section is hidden and not required for UPS OAuth.

  9. The users can effectively utilize the UPS carrier services for shipping now.

Desktop only Customers

For customers who have only installed the desktop application without the Web Client, you need to install the Web Client, log in to the web interface, and authorize the existing UPS accounts through OAuth; then, the UPS accounts can be used in the desktop application.

Follow the instructions for the StarShip Web Installation.

Authorize Existing UPS Accounts

  1. Open the StarShip Web Client and log in. Then, navigate to Setup -> Carrier Interfaces -> UPS.
  2. Switch to the ACCOUNTS tab, where you should find existing UPS accounts. From there, proceed to edit the desired UPS accounts.
  3. Click AUTHORIZE.It will redirect the user to the ups.com site. Enter the Username and Password on the opened UPS page and log in. After a 5-second delay, it will return to the StarShip page.
    Note

    Customers need to know their UPS profile accounts bond to the existing UPS shipping accounts. If the entered UPS shipping account is not matched with the one under the UPS user profile, then when using UPS carrier service to ship, it can allow you to rate successfully but ship failed, which is designed by the UPS side. 

  4. The system automatically saves the Token Info and click Save. The Edit and Authenticate process must be completed. Customers need to authenticate each existing UPS account individually before usage.
  5. Open and log in to the desktop application. Then, creating, rating, and processing shipments with the authorized UPS account should be successful.