UPS Shipping Method

UPS® Shipping Method allows your customers to get real-time shipping rates from UPS® via the REST API (OAuth 2.0 security model) during the checkout process. The extension primarily works with measurements in Inches (in) and weight in Pounds (lbs), but other units can be used and converted automatically. The currency used in shipping rate calculations is based on the origin country in the shipping method settings. UPS® can calculate quotes for both domestic and international parcels.

To create shipping labels, you can use our free WooCommerce Shipping extension which offers discounted UPS® rates, or you can purchase labels directly through UPS®. You can also explore other shipping solutions available in the WooCommerce marketplace. The UPS® Shipping Method extension focuses on providing live shipping rates at checkout and works alongside your preferred shipping label solution.

WooCommerce Shipping

$0.00

Print USPS, UPS, and DHL labels right from your WooCommerce dashboard and instantly save on shipping. WooCommerce Shipping is free to use and saves you time and money.

1. Head to https://developer.ups.com/.
2. Click the Create Application button.
   • If you aren’t already logged in, log in with your existing UPS account or create a new account. After logging in or signing up, you will be redirected away from the developer site. You’ll need to go back to https://developer.ups.com/ and click Create Application again (as described above).
3. Click the Add Apps link.
4. A modal will be displayed. Select I want to integrate UPS shipping capabilities to my business and the UPS account you want to associate with the app. Then click Next.
5. Fill out the contact details and click Next.
6. Enter a name for your app (e.g. UPS Shipping Method for WooCommerce).
7. Search for and add the Authorization (OAuth), Rating, and Address Validation products, then click Save.
8. Copy the Client ID and Client Secret keys. They’ll be required in the next step.
9. Logged into your site head to WooCommerce > Settings > Shipping > UPS and input the following settings:
   • UPS API type – REST.
   • UPS Account Number – Sent to you after signup.
   • UPS Client ID – Displayed on the UPS website in step 9).
   • UPS Client Secret – Displayed on the UPS website in step 9).
   • Customer Classification – Determines what rates are returned. Note that Retail Rates will match the online calculator.
   • Debug Mode – Enable/disable debug mode to show debugging information on your cart/checkout.
10. Click Save changes and proceed to the Configuration section below to continue setting up the extension.

Using the XML API (legacy; for reference only)

Note:

These instructions are only reference for merchants already using UPS Shipping Method. The REST API (described above) offers better performance and is the only connection option available in the UPS plugin from version 3.5.8+.

Additionally, UPS stopped issuing API keys for the XML API on June 5, 2023 and that connection will no longer work after August 5, 2024. The REST API (OAuth 2.0) connection will be required after that date. (The original deprecation date was June 3, 2024 but it was extended to August 5, 2024 by UPS.)

The legacy XML API connection requires that your server uses SimpleXML.

1. To create a UPS account and obtain your UPS API credentials, sign up at UPS Developer Kit.
2. After signing in, in the Access and Administration section select Manage Access Keys, then Request New Access Key.

3. Fill out the first two form fields as follows:

• I need an access key because: I was informed by a software vendor that I need to obtain an access key to share with them
• Software/Vendor Name: WooCommerce

4. Continue filling out the rest of the form.
5. After successfully signing up, please go to WooCommerce > Settings > Shipping > UPS and fill out the following fields and save changes:
   • UPS API type – XML (legacy).
   • UPS Account Number – Sent to you after signup.
   • UPS User ID – Set by you during signup.
   • UPS Password – Set by you during signup.
   • UPS Access Key – Sent to you after signup.
   • Customer Classification – Determines what rates are returned. Note that Retail Rates will match the online calculator.
   • Debug Mode – Enable/disable debug mode to show debugging information on your cart/checkout.
6. Click Save changes and proceed to the Configuration section below to continue setting up the extension.

1. Go to WooCommerce > Settings > Shipping > Shipping zones.

2. Click the Edit button on the shipping zone where you want to offer this method.

3. Inside the shipping zone, click the Add shipping method button.

4. Then, select the shipping method and click the Continue button.

Once UPS has been added to the Shipping Zone, click the Edit button on the right to configure the shipping method settings.

• Method Title – Name the shipping method. This is visible to customers.
• Tax Status – Select Taxable to charge taxes on shipping costs or None to not charge taxes. This setting is only shown if taxes are enabled in WooCommerce.
• Origin City – Enter the city you will be shipping from.
• Origin Postcode – Set to the postcode from where you ship. It is sent to the UPS API.
• Origin Country – Set to the country from where you ship. It is sent to the UPS API.

• Services – Choose to rename services in the Name field and/or rearrange the order that these options are shown to customers by clicking-and-dragging that list.
• Offer Rates – Select whether to display all rates available or only the cheapest.
• Negotiated Rates – Enable negotiated rates or not.
  • More at: Account-Specific Negotiated Rates. This must be approved by UPS, or the API returns an error. It is sent to the UPS API.
• Delivery Confirmation – Optionally you may charge customers for delivery confirmation. This just adds the specified amount to the returned rates.
• Parcel Packing Method – See below.
• UPS Packaging – You can select from a built-in list of standard UPS packaging to use.
• Custom Boxes – Here you can add custom box sizes to pack into.

• Origin Address – Sometimes you may need to enter the address for the sender/origin.
• Residential – Choose whether to indicate deliveries as residential or commercial addresses.
  • Users are permitted to enter PO Boxes as a shipping address, even though UPS does not allow it.
• Destination Address Validation – Choose whether to validate the destination address at checkout.
  • If enabled, users will only be able to checkout with a UPS validated address.
  • Requires the Address Validation service enabled within your UPS app as outlined in the “Connecting Your UPS Account” section.
• Insured value – Request Insurance to be included in UPS rates.
• Fallback – Enter a fallback amount for shipping, if no rates are found.
• Weight/Dimension Units – Only change this if you’re getting the “This measurement system is not valid for the selected country method.”

There are two packing methods with UPS and each affects the parcels you send to the API: Pack items individually (Default) and Pack into boxes with weights and dimensions (Recommended).

This packing method assumes that every physical (non-Virtual) item in the cart is shipped in its own package, based on the weight and dimensions that have been entered for each individual product. Shipping rates are calculated separately for each item and then combined into the total shipping cost. Only the weight is required but also entering product dimensions produces a more accurate quote. For even more accuracy, we recommend the box packer method.

To use this method, add a new product then scroll down to Product Data > Shipping to enter the product dimensions.

Using this method, you create your own custom box sizes in UPS Settings. The extension uses the weight/dimensions of products added to the cart, filling the custom box size from smallest to largest based on volume and size, then sends the number of boxes/size to the UPS API for a shipping estimate. Both product weight and dimensions are needed for this option to accurately calculate what boxes are needed.

Selecting this option you must follow the steps listed below for UPS Packaging or Custom Box Packing for this method to work.

UPS offers standard boxes for shipping. UPS Packaging:

Start typing the package you want to include, and it auto-populates the field for you.

The box packer included with this shipping method groups items into boxes that you define by height, width, length, weight, and max-weight. The packing is mainly volume based, but also considers item sizes.

1. Go to: WooCommerce > Settings > Shipping.
2. Select your Shipping Zone containing UPS, then click UPS
3. Scroll down to Custom Boxes and select Add Box to set up box dimensions:

Outer dimensions are used for parcel dimensions and are passed to the API.

Inner dimensions are used for packing, and items should fit within these.

Box weight is the weight of the actual box, and is added to the weight of contents.

Max weight is the maximum weight your box can hold. This includes contents weight and box weight. (Note: This value should never be set to 0 , as that will result in that box not being used due to the Max Weight limitation being met before any items are packed inside.)

The packer:

1. Finds boxes that fit items being packed (uses L x W x H).
2. Packs all fitting items into boxes (using volume).
3. Uses the smallest box that fits 100% of items *or* uses the highest % packed box, and then passes unpacked items back and repeats the process.
4. Packs unpackable items alone, using item dimensions.
5. Returns all packed boxes.

To add handling fees to shipping calculations, you can use a Price Adjustment column in the Services section. Each UPS service can be increased or decreased (by adding the “-” sign) separately, using price adjustment columns in the row.

Use the Price Adjustment ($) column to add a flat amount to the shipping quote. In this example, the 3-Day Select and Ground shipping methods are increased by $3.50.

Use the Price Adjustment (%) to increase the shipping quote by a percentage. In this example, the 3-Day Select and Ground shipping methods are increased by 1% of the quote returned by UPS.

Customers get quotes, after inputting their address, from two places:

• Cart page – via the shipping calculator
• Checkout page – via the shipping and billing forms

Rates can be selected by customers as normal.

These services are included with the UPS Shipping extension:

No. It provides the integration between UPS and WooCommerce and calculates live shipping during checkout, so you can charge your customers accurate shipping costs based on the items being purchased.

For shipping labels, we recommend our free WooCommerce Shipping extension. You can purchase discounted UPS shipping labels directly from your orders and automatically send tracking information to your customers when the order status is marked as “Completed”.

Yes. Multiple UPS methods in the same zone with different origin addresses will return the appropriate rates for each method. Multiple API requests are made and each origin address is used.

UPS will use the currency that is enabled on your account. So if your site uses a different currency then the one which is set on the account, the rates won’t be returned. If the debug setting is enabled this will be indicated with a warning like:
[UPS] Rate for Standard (UPS) is in USD but store currency is EUR.

If you need to convert these rates to the correct currency we would suggest using the Multi Currency extension and setting up a conversion rate for both the account currency and the store currency.

• Confirm that your API credentials are correct.
• Enable development mode, or turn on WP_DEBUG to see debugging information on the cart page. This often reveals the issue.
• Check that your products have sizes and weights set – without this, the calculation cannot be performed.

If you see Invalid Authentication Information in the “UPS RESPONSE” section of the Debug output on your site, there is a problem with the API credentials or the App in your UPS account dashboard. To resolve this error, do the following:

1. Log in to https://developer.ups.com/ and click on “My Apps”. Then, click on the link in the “App Name” column.
2. Confirm that your App has “Rating” and “Authorization ( OAuth)” listed in the Product In Use column. If either of those are not listed there, click the “Add Products” button. Next, click the + icon on the right for any missing products and save the changes.
3. Confirm that both the “Rating” and “Authorization ( OAuth)” products show “Approved” in the Status column when viewing the App info screen (described in Step 1). If any products show as “Pending“, try removing them with the “Remove” link on the right and re-adding them via the “Add Products” button (as described above).
4. Even if your API credentials show as “Authenticated” on the UPS plugin settings page on your site (WooCommerce > Settings > Shipping > UPS), delete the information in the UPS Account Number, UPS Client ID, and UPS Client Secret fields, making sure that there aren’t any ‘spaces’ or any other characters in those fields and they are completely blank. Then, on the App Info/Credentials page described in Step 1, copy the Billing Account number and paste it into the UPS Account Number field in the UPS plugin settings on your site. Next, copy the Client ID in the App and paste it into the UPS Client ID field in the UPS plugin settings on your site. Finally, copy the Client Secret in the App and paste it into the UPS Client Secret field in the UPS plugin settings on your site and save the changes. (Note: The “Client ID” and “Client Secret” info is not visible in the App by default but you can click on the ‘eye’ icon to reveal that info and you can click the ‘clipboard’ icon to copy it.)
5. Once those steps have been completed, do another test on the front end of your site with Debug enabled to see if the error has been resolved. If you continue to see Invalid Authentication Information in the “UPS RESPONSE”, reach out to the UPS Support team and let them know that you are receiving this error.

If you would like to remove UPS as a shipping option for some shipping classes you can use the WooCommerce Conditional Shipping and Payments extension.

Or you can use code to do this. You can add the following code to your functions.php. You need to change shipping classes used on the 14th line:

/**
 * Check the cart for specific classes, remove UPS Shipping method if they are present
 * 
 * REMOVE THE TOP <?php if there is no ?> before (or you have an error after adding this)
 * 
 * Add the code to your theme functions.php file
 */
add_filter( 'woocommerce_package_rates', 'unset_ups_shipping_method' , 10, 2 );
function unset_ups_shipping_method( $rates, $package ) {
 
    // Setup an array of shipping classes that do not allow UPS Shipping (@todo change this)
    $shippingclass_array = array( 'no-ups' );
 
    /**
     * loop through the cart looking for the products in the array above
     * and unset the Free shipping methods as necessary
     */ 
    foreach ( WC()->cart->get_cart() as $cart_item_key => $values ) {
        $shipping_class = get_the_terms( $values['product_id'], 'product_shipping_class' );

        if ( isset( $shipping_class[0]->slug ) && in_array( $shipping_class[0]->slug, $shippingclass_array ) ) {
            /**
             * Unset the shipping methods here
             */
            unset( $rates['ups:01'] );
            unset( $rates['ups:02'] );
            unset( $rates['ups:03'] );
            unset( $rates['ups:04'] );
            unset( $rates['ups:05'] );
            unset( $rates['ups:06'] );
            unset( $rates['ups:07'] );
            unset( $rates['ups:08'] );
            unset( $rates['ups:09'] );
            unset( $rates['ups:10'] );
            unset( $rates['ups:11'] );
            unset( $rates['ups:12'] );
            unset( $rates['ups:13'] );
            unset( $rates['ups:14'] );
            unset( $rates['ups:15'] );
 
            // The rates have been removed, no point in carrying on
            //break;
        }
    }
 
    // Return what's left of the $rates array
    return $rates;
}