# UPS Web Services Account Integration

## Overview

UPS is one of the largest logistics and supply chain companies, delivering millions of packages daily for businesses and individuals worldwide. In this article, you will learn how to integrate UPS with Shipbridge using the **UPS Web Services** to [Calculate Rates](https://descartessystems.aha.io/pages/7630855055954070628), [Print Shipping Labels](https://descartessystems.aha.io/pages/7630854129237682056), and receive tracking details in real time.

## Prerequisites

Before you can use the **UPS Web Services** through Shipbridge, you must complete the following requirements.

- Download the latest Shipbridge version from the [Sellercloud Support Portal](https://support.sellercloud.com/Applications/Applications.aspx).
- If you don’t have a UPS shipping account, you must first [create one](https://www.ups.com/doapp/signup?loc=en_US). Next, you must register on the [UPS Developer Portal](https://developer.ups.com/) and obtain your **Client ID** and **Secret**. For detailed guidance and support, refer to the [UPS Developer Resource Center](https://developer.ups.com/get-started?loc=en_US).

### Obtain your API Credentials

1. [Sign in](https://developer.ups.com/apps?loc=en_US) and click **My Apps** at the top right.
2. Click **Add Apps**.
3. Under **I need API credentials because**, select **I want to integrate UPS technology into my business**. Then select a shipper account or create a new one, check the box to accept the agreement, and continue.
4. For your contact details, consider using a group email available to others on your development team. You can’t change this email later. Enter your **Primary Contact** information and continue.
5. Under **App Name**, type **Shipbridge**.
6. Under **Add Products**, select which UPS products to associate with the new API connection. Make sure to enable **Rating**, **Tracking**, **Authorization (oAuth)**, **Shipping,** and **Address Validation.**
7. Click **Save**.
8. Under **Credentials**, you can now get your **Client ID** and **Client Secret**, which are required for the next steps in the setup.

For this setup to work, you must add all five products described in step 8— **Rating, Tracking, Authorization (oAuth),** **Shipping,** and **Address Validation**—to your UPS Account. For more information, see [Getting Started with UPS APIs](https://developer.ups.com/get-started?loc=en_US).

## Configure UPS Web Services in Shipbridge

To connect your UPS account to Shipbridge:

1. Go to **Menu** > **Options** > **Carriers** > **UPS.**
2. Select **Use UPS Web Services**.
3. Check **Upgrade to UPS OAuth 2.0 Security Model** and **Use production server.** Once these are enabled, the former **Username** and **Password** fields will be replaced with **Client ID** and **Client Secret**.
4. Fill in the **Client ID** and **Client Secret** fields with the **API Credentials** you got in Step 10 of the [Prerequisites](https://descartessystems.aha.io/pages/7630858231920367072) section.
5. Add **Shipper Number**:
   1. If you are migrating an existing UPS integration, keep the **Shipper Number** you already have. If you are integrating for the first time, fill in this field.
   2. Optionally, you can click **Additional shipper numbers** to add up to 2 more. They should be linked to the same UPS account. Once filled in, Shipbridge will take them into account when calculating rates and rate shopping.
       
       The calculator will show rates for all **Shipper Numbers** only if the calculated rates are distinct for each one. To view all rates, even when they are the same dollar amount, enable the setting **Show rates for additional shipper numbers even if the amounts are identical** in **Menu** > **Options** > **Rates.**
6. Click **Save**.
7. Click **Test Credentials** to verify the connection.

### Per-Company Configuration

If you are using merchant-specific credentials for multiple companies, you must also migrate the per-company configuration to the new UPS OAuth 2.0. To enter your credentials per company:

1. Go to **Menu** > **Options** > **Carriers** > **UPS.**
2. **Use UPS Web Services,** **Use production server,** and **Upgrade to UPS OAuth 2.0 Security Model** must be enabled.
3. Click **Per-company credentials**.
4. Check **Use merchant-specific credentials for UPS Web Services**.
5. Click **Edit** next to a company in the list.
6. Enter your **Shipper Number,** **Client ID,** and **Client Secret**. Click **Test Credentials**.
7. If the test is successful, click **Save**.

### UPS-Specific Order Options

You can enable UPS-specific shipping and delivery options for your orders from Shipbridge, such as:

- Carbon-neutral shipping
- Collect on delivery
- Verbal confirmation
- Dry ice shipping
- Quantum View notifications

To manage UPS-specific order options:

1. Right-click an order in the Shipbridge grid and select **Edit Order.**
2. Select the **Order Details** tab.
3. Set the **Shipping Service** to **UPS**.
4. Click the **UPS Accessories** button.
5. Enable and configure any preferred services and click **Save**.

### Consignee Accounts

You can also enable consignee billing, where the customer pays the shipping charges using their own carrier account. For this setup to work correctly, the customer account must be configured in both Sellercloud and Shipbridge. In Sellercloud, this is done through the customer’s [Shipping Preferences](https://descartessystems.aha.io/pages/7630849732234296013), and Shipbridge enforces it by applying the customer’s carrier account number from the **Consignee Accounts** list when the order is matched to that same customer record.

Consignee billing only applies when the Sellercloud customer and Shipbridge consignee account match.

In Shipbridge, the Customer Number in **Set consignee accounts** is the consignee’s carrier account number, not the Sellercloud customer ID.

1. In Sellercloud, go to **Customers** > **Manage Customers**.
2. Click **Toolbox** > **Shipping Preferences**.
3. Check the **Enable Customer Shipping Account** box and enter the **Account #**.
4. In Shipbridge, go to **Menu** > **Options** > **Carriers** > **UPS.**
5. Access the **Advanced** settings dropdown and click **Set Consignee Accounts**.
6. Enter the same UPS **Account #** you used in step 3 and click **Add**.
7. Click **Save**.

## Configure UPS Web Services in Sellercloud

To connect your UPS account and calculate rates in Sellercloud, you must configure your company's [Shipping API](https://descartessystems.aha.io/pages/7630844621139336229) settings. To do that:

1. Go to [Company Settings](https://descartessystems.aha.io/pages/7630848954242562863).
2. **Toolbox** > **Shipping >** **Shipping API Settings** > **Edit**.
3. Enable **UPS** in the **Shipping Rates** panel.
4. Next, select the **Enable UPS OAuth** checkbox in the **UPS API** panel.
5. Click **Fetch UPS API Access Token**.
6. You will be directed to the UPS login page and prompted to enter your credentials.
7. If the login is successful, you will be redirected back to the **Shipping API** page and the token fields will automatically populate.
8. Click **Save**.

### Test Credentials

Once you've successfully obtained the UPS OAuth token, you can validate the connection by using the available actions:

- **Test UPS Rate Estimate**
- **Test UPS Address Validation**
- **Generate UPS Request/Response XMLs**