After July 2021, the 2.3.x release line no longer received quality updates or user guide updates. PHP 7.3 reached end of support in December 2021, and Adobe Commerce 2.3.x reached end of support in September 2022. We strongly recommend upgrading to Adobe Commerce 2.4.x to help maintain PCI compliance.

UPS

This site contains archived merchant documentation for a version of Adobe Commerce and Magento Open Source that has reached end-of-support. The documentation available here is intended for historical reference only and is not maintained. The Adobe Commerce Merchant Documentation for current releases is published on the Adobe Experience League.

United Parcel Service offers domestic and international shipping services by land and air to more than 220 countries.

UPS is discontinuing support of HTTP for its standard CGI service gateway. If a standard UPS account integration is already enabled for your Magento installation, make sure that the Gateway URL uses the HTTPS protocol in the UPS Shipping Method configuration. If needed, update the Gateway URL manually to change the protocol to HTTPS. If you are enabling a new UPS configuration for your Magento installation, use the default “United Parcel Service XML” UPS Type.

UPS uses dimensional weight to determine some shipping rates. Dimensional weight, sometimes called volumetric weight, is a common industry practice that bases the transportation price on a combination of weight and package volume. In simple terms, dimensional weight determines the shipping rate based on the amount of space a package occupies in the cargo area of the carrier. Dimensional weight is typically used when a package is relatively light compared to its volume.

Step 1: Open a UPS shipping account

To offer this shipping method to your customers, you must first open an account with UPS.

Step 2: Enable UPS for your store

  1. On the Admin sidebar, go to Stores > Settings > Configuration.

  2. In the left panel, expand Sales and choose Shipping Methods.

  3. Expand the UPS section.

  4. Set Enabled for Checkout to Yes.

    Enable UPS

  5. For a UPS XML account (default), set UPS Type to United Parcel Service XML and do the following:

    • Enter the following UPS credentials: User ID, Access License Number, and Password

    • Set Mode to Live to send data to the UPS shipping system over a secure connection. (Development mode does not send data over a secure connection.)

    • Verify the Gateway XML URL that is required to send requests by XML file.

    • Set Order of Shipment to the region where the shipment originates.

    • If you have special rates with UPS, set Enable Negotiated Rates to Yes and enter the six-digit Shipper Number assigned to you by UPS.

  6. For a standard UPS account, set UPS Type to United Parcel Service and do the following:

    The standard United Parcel Service type is scheduled for deprecation. For new configurations, you should use the default “United Parcel Service XML” type. The XML type is also required to generate shipping labels.

    • Set Live Account to one of the following:

      Yes Runs UPS in production mode, and offers UPS as a shipping method to your customers.
      No Runs UPS in a test mode.

    • For Gateway URL, enter the URL that is used to calculate UPS shipping rates.

      UPS is discontinuing support of HTTP, which is used in the current default (system value). You must clear the Use system value checkbox and modify the URL to use HTTPS. Example: https://www.ups.com/using/services/rave/qcostcgi.cgi

  7. For Title, enter the name of this shipping option as you want it to appear during checkout.

    By default, this field is set to United Parcel Service.

Step 3: Complete the container description

  1. Set Packages Request Type to one of the following:

    • Use origin weight (few requests)
    • Divide to equal weight (one request)

  2. For Container, specify the typical packaging type that is used for shipment.

    • LBS
    • KGS

  3. Set Weight Unit to the system you use to measure product weight.

    The weight system supported by UPS varies by country. If in doubt, ask UPS which weight system you should use. Options include:

  4. Set Destination Type to one of the following:

    Residential Most of your shipments are business to consumer (B2C).
    Commercial Most of your shipments are business to business (B2B).

  5. Enter the Maximum Package Weight allowed by the carrier.

  6. Set Pickup Method to one of the following:

    • Regular Daily Pickup
    • On Call Air
    • One Time Pickup
    • Letter Center
    • Customer Counter

  7. Enter the Minimum Package Weight allowed by the carrier.

    Container Description

Step 4: Set up handling fees

  1. Set Calculate Handling Fee to one of the following methods:

    • Fixed
    • Percent

  2. Set Handling Applied to one of the following:

    • Per Order
    • Per Package

  3. Enter the amount of the Handling Fee to be charged. To enter a percentage, use the decimal format. For example, enter 0.25 for 25%.

    Handling Fee

Step 5: Specify allowed methods and applicable countries

  1. In the Allowed Methods list, select each UPS method offered to your customers. The methods appear under UPS during checkout. (Hold the Ctrl key down to select multiple options).

  2. Set Free Method to the UPS service you want to use for offers of free shipping. Then, do one of the following:

    • Set Free Shipping with Minimum Order Amount to Enable. Then, enter the Minimum Order Amount for Free Shipping.

    • Set Free Shipping with Minimum Order Amount to Disable.

  3. For Displayed Error Message, you can either leave the default message or enter the message that you want to appear if UPS shipping becomes unavailable.

    Allowed Methods

  4. Set Ship to Applicable Countries to one of the following:

    All Allowed Countries Customers from all countries specified in your store configuration can use this shipping method.
    Specific Countries After choosing this option, the Ship to Specific Countries list appears. Select each country in the list where this shipping method can be used.

  5. Set Show Method if Not Applicable to one of the following:

    Yes To list all UPS shipping methods to customers, regardless of their availability.
    No To list only the methods which are available to customers.

    Applicable Countries

  6. To create a log file with the details of UPS shipments made from your store, set Debug to Yes.

  7. If you offer multiple shipping carriers/methods, enter a number for Sort Order to determine where in the sequence UPS appears.

    This is relative to the other shipping carriers/methods. (0 = first, 1 = second, 2 = third, and so on.)

    Debug and Sort Order

  8. Click Save Config.

Step 6: Setup the shipping origin

  1. Make sure that your Store Information is complete.

  2. On the Admin sidebar, go to Stores > Settings > Configuration.

  3. In the left panel, expand Sales and select Shipping Settings.

  4. Expand Expansion selector Origin on the page and configure the shipping origin address.

    Sales configuration - shipping origin address options

  5. Click Save Config.

© 2024 Adobe. All rights reserved.