DocumentationCommerceStores and Purchase Experience

United Parcel Service (UPS)

Last update: Wed Mar 27 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Beginner
  • Intermediate
  • Admin
  • User

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

IMPORTANT
Beginning June 2024, Adobe Commerce merchants can no longer transact with the current UPS integration. This is because the United Parcel Service (UPS) APIs used by the native Adobe Commerce integration do not currently support the required OAuth 2.0 security model. To learn more about this change, refer to Developer Portal Access Key Migration Guide.
Merchants should apply a quality patch update to their store to migrate from the SOAP API to the RESTful API, which supports OAuth 2.0 authentication protocols.
NOTE
UPS can use dimensional weight to determine some shipping rates. However, Adobe Commerce supports only weight-based shipping cost calculation.

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 panel on the left, under Sales, choose Delivery Methods.

  3. Expand Expansion selector the UPS section.

  4. Set Enabled for Checkout to Yes.

  5. For a UPS REST account (default), do the following:

    • Enter your UPS credentials: UPS ClientID as User ID, UPS Client Secret as 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 URL that is required to send requests. Use a sandbox URL for test mode and a production URL for live requests.

    • Verify the Tracking URL that is required to get tracking information. Use a sandbox URL for test mode and a production URL for live requests.

    • Set Origin of the 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.

    • 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.
    note note
    NOTE
    The standard United Parcel Service type is scheduled for deprecation. For new configurations, use the default United Parcel Service REST type. The REST type is also required to generate shipping labels.

    For the 2.4.7 release, UPS Type is removed because UPS and UPS XML types are scheduled for deprecation and UPS REST is the default. The United Parcel Service (UPS) APIs used by the native Adobe Commerce integration are temporarily deprecated because it does not currently support the OAuth 2.0 security model.
    note important
    IMPORTANT
    UPS is discontinuing support of HTTP, which is used in the current default (system value). Clear the Use system value checkbox and modify the URL to use HTTPS. Example: https://www.ups.com/using/services/rave/qcostcgi.cgi

  6. 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.

    Enable UPS {width="600" modal="regular"}

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:

    • Customer Packaging
    • UPS Letter Envelope
    • Customer Supplied Package
    • UPS Tube
    • PAK
    • UPS Express Box
    • UPS Worldwide 25 kilo
    • UPS Worldwide 10 kilo
    • Pallet
    • Small Express Box
    • Medium Express Box
    • Large Express Box

  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:

    • LBS
    • KGS

  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 {width="600" modal="regular"}

Step 4: Set up handling fees

The handling fee is optional and appears as an extra charge that is added to the UPS shipping cost. If you want to include a handling fee, do the following:

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

    • Fixed
    • Percent

  2. To determine how the handling fee is applied, 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 {width="600" modal="regular"}

Step 5: Specify allowed methods and applicable countries

  1. For Allowed Methods, choose each UPS shipping method to be available to your customers.

    The methods appear under UPS during checkout. To select multiple methods, hold down the Ctrl key (PC) or the Command key (Mac) and click each option.

  2. If you want to provide a Free Shipping option through UPS, set the free shipping options:

    • Set Free Method to the method you want to use for free shipping. If you don’t want to offer free shipping through UPS, choose None.

    • To require a minimum order amount that qualifies an order for free shipping with UPS, set Enable Free Shipping Threshold to Enable. Then, enter the minimum value in Free Shipping Amount Threshold.

  3. If needed, change the Displayed Error Message.

    This text box is preset with a default message, but you can enter a different message that you want to appear if UPS becomes unavailable.

    Allowed Methods {width="600" modal="regular"}

  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 delivery method.
    • Specific Countries - When you choose this option, the Ship to Specific Countries list appears. Select each country in the list where this delivery method can be used.

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

    • Yes - Lists all available UPS shipping methods during checkout, including methods that do not apply to the shipment.
    • No - Lists only the UPS shipping methods that are applicable to the shipment.

    Applicable Countries {width="600" modal="regular"}

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

  7. For Sort Order, enter a number to determine the sequence in which UPS appears when listed with other delivery methods during checkout.

    0 = first, 1 = second, 2 = third, and so on.

  8. Click Save Config.

Step 6: Set up shipping origin address

  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 {width="600" modal="regular"}

  5. Click Save Config.

NOTE
Commerce does not declare the full order price to UPS when calculating shipping charges. This behavior cannot be changed.
recommendation-more-help
dacea746-44a9-4368-b3fb-3bcff64c6be1