UPS switches to OAuth 2.0 authentication model

  • pro
  • ui
  • consignments
  • ups
  • onboarding
  • eu
  • us

UPS has withdrawn access key authentication in favour of an OAuth 2.0 authentication model for their API suite.

After 5 August 2024, all integrations must utilise OAuth 2.0 to continue using UPS APIs.

If you use UPS, this guide will cover the steps you must carry out to allow Ship to pair your registered shipper number(s) with an authentication token for the new model.

What is OAuth 2.0?

OAuth 2.0 is a protocol for authentication and authorisation between two or more web applications. The OAuth 2.0 security model involves using access tokens, which are issued to a client application by an authorisation server.

An access token is a string of characters representing the authorisation that’s granted to a client application by a resource owner or user. This token is used to authenticate specific resources on behalf of the owner and is passed as a bearer token in an API request.

Get started

To start or edit your integration, you must complete the following steps:

  1. Register a UPS profile A registered UPS profile for your company is required to create an API integration. You will need the number ID of your accounts for use in step 2.

    For more information, scroll down to register a UPS profile.

    If you already have a configured UPS profile, skip to step 2.

  2. Create the connection in Sorted Ship. After your UPS profile is set up, you must connect your UPS accounts to Ship Consignments. For more information scroll down to create and connect a UPS OAuth token.

1. Register a UPS Profile

We require you to have a UPS profile set up and configured with your accounts. Make sure to note the number ID of each account as you will need it as a shipper_number when you create the connections in step 2.

If you don’t currently have a UPS login, click here to create a profile.

Once you have an account with your registered shipper numbers, continue to 2. Create the connection.

2. Create the connection for your Ship (Consignments) account

For your UPS integration to work successfully on your Ship account, you must pair each shipper number with an access token to authenticate the UPS integration. You can do this individually or group them under one auth token (see step 4. below).

Note

The connections page to set this up isn't currently available. We will provide the access link here shortly.

Follow the steps below to connect your Shipper Numbers:

  1. Firstly, access Sorted’s external apps page to connect your UPS profile and set up your auth tokens.

  2. Select your Account Type product from the dropdown and login. Login

  3. From the landing page, click Manage. Manage connections

  4. If this is your first connection set up, click Connect an account.

  5. Enter in each field your Connection name and Shipper number tags. Connect to Sorted

  6. (Optional) - Click Add shipper number, if you want to add multiple shipper numbers to this integration.

  7. (Mandatory) - Click Add api scope to include the scopes in this connection.

    Important

    It is mandatory that you define the transittimes and locator values on at least one of your connections in the API scope fields.

    For more information on these endpoints, visit the UPS Developer Kit.

  8. Click Submit, once you have input the details of the connection you want to create.

  9. You will be briefly redirected to the UPS developer portal.

    Enter your login credentials and make sure to tick the box below to authorise Sorted with access to your UPS data. UPS Profile login

  10. Click Continue.

  11. You will return to the connection page on your Sorted Ship account with the new integration displayed in the dashboard.

    To add more connections click Connect more accounts. Add more connections

Well done! You’ve created a connection to UPS on your Ship integration that’s now enhanced with OAuth 2.0 to further protect your data and reduce the risk of security breaches.

Manage connections

You can manage your connections if your shipper accounts and integrations need to be edited or removed.

These options can be accessed from the connections landing page, click here to access.

Click Actions in the connection row to access the options.

Manage connections

Edit connection

Click Edit to add/remove your shipper number(s) and API scope fields.

Refresh connection

Click Refresh to manually refresh the token on this connection.

Delete connection

Click Delete to remove the connection from your Sorted account.

You must confirm deletion by typing the connection name into the field to complete the action.

The token for this connection may still be cached for upto 5 hours following it's removal. Delete connection