Skip to content
  • There are no suggestions because the search field is empty.

How to Update Your UPS Account for OAuth 2.0 Authentication in Webgility Desktop

This article informs Webgility Desktop users with existing UPS accounts about the mandatory upgrade to UPS's new OAuth 2.0 authentication requirements, effective June 3, 2024. Completing this update is essential to maintain uninterrupted shipping services through UPS Direct within Webgility Desktop.

Overview

UPS is transitioning its API authentication from older access key methods to the more secure OAuth 2.0 standard. To ensure your UPS Direct integration in Webgility Desktop continues to function without disruption, you must upgrade your Webgility Desktop application to version v9.7 or later and re-authenticate your UPS account(s). This guide outlines the necessary steps for a smooth transition.

Who Needs to Upgrade?

  • If you currently have a UPS Account Registered with Webgility Desktop, this upgrade applies to you.
  • For new UPS account integrations: If you are integrating a new UPS account with Webgility Desktop, ensure you are using the latest version of Webgility Desktop. Follow the steps outlined in this guide: How to Integrate UPS with Webgility Desktop.

Why is this Upgrade Necessary?

Webgility is upgrading its system to comply with the new UPS API authentication requirements. Effective June 3, 2024, UPS will no longer support access key authentication, and all integrations must migrate to OAuth 2.0. As a result, we are releasing Webgility Desktop version v9.7, which requires all UPS customers to upgrade to the latest version and re-authenticate their UPS accounts.

This upgrade is essential to ensure uninterrupted service for our UPS customers. Failure to comply with UPS norms by June 3, 2024, may result in service disruptions. To facilitate a smooth transition, we have created this help article outlining the upgrade process.

Completing the steps below will ensure that your UPS integration in Webgility Desktop is upgraded to the latest OAuth 2.0 authentication model, preventing service disruptions.

Step-by-Step Upgrade Process

Follow these steps carefully to upgrade your UPS integration:

Step 1: Log into Webgility Desktop

  • Open the Webgility Desktop application and log in to your account.
  • Upon successful login, you may see a UPS Compliance warning window. If this window does not appear, proceed to the next step.

Step 2: Create a Database Backup

  • Before beginning the migration process, it is crucial to create a database backup. This will facilitate a smooth reversal of the migration process if needed.
  • Go to System > Database > Backup.
  • Select a location on your computer to save the backup file and click “Ok“.

Step 3: Upgrade the Webgility Desktop App to the Latest Version

  • Before proceeding with the UPS integration upgrade, it's important to ensure you're running the latest version of Webgility Desktop (v9.7 or newer).
  • Follow the steps outlined in this guide: How to Update Your Webgility Desktop Software to upgrade the application.

Step 4: Upgrade UPS Integration to OAuth 2.0

  1. Navigate to Integrations → Shipping → Shipping Settings.
  2. Ensure the UPS Direct box is checked, then click Save & Continue.
  3. Click the Migrate to UPS OAuth Flow button.
    • Important Note: If all your UPS accounts share the same UPS account number across all profiles, or if you only have a single UPS profile, you only need to follow the remaining steps below once. However, if you have different UPS account numbers registered for different profiles within Webgility Desktop, you must select each of your UPS registered accounts one by one from the dropdown menu in the Shipping Settings and then repeat the following steps for each individual account.
  4. Review your UPS account details displayed in the new window, then click "Sign in with UPS Direct". This will open a browser window for UPS authentication.
  5. Login with your UPS Direct account credentials (your UPS.com username and password).
  6. Upon successful migration and authentication with UPS, you will see a success window in Webgility Desktop confirming the upgrade.
  7. Close the success window, then click Save and Close in the Shipping Settings to confirm the changes. You can now continue using shipping with the new OAuth 2.0 authentication flow.