Using the UPS Shipping Method

Liferay DXP 2024.Q3+/Portal 7.4 GA125+

Liferay provides a client extension that integrates with UPS. It uses the shipping engine client extension as a base. See Configuring Shipping Methods to read more about the shipping methods available out-of-the-box with Liferay.

Note

Currently, the UPS client extension is only compatible with Liferay SaaS.

Install and Deploy the UPS Client Extension

1. Go to the Liferay Marketplace and search for Liferay Commerce Connector to UPS.

2. Click Get App, select your account or create one, and accept the end user license agreement and terms of service.

3. Click Continue.

4. Select a project from the ones available to you.

5. Click Get App.

6. Note the order ID. You must use it to install the app from your Cloud dashboard.

7. Click Go to Console.

8. Go to Services and click New App.

9. Enter the order ID from before and complete the installation.

10. Log in as an administrator and verify that the OAuth Application User Agent was added to Liferay. Open the Global Menu () and go to Control Panel → OAuth2 Administration. Verify the creation of a new entry called Liferay UPS Commerce Shipping Engine OAuth Application User Agent.

Verifying the Addition of UPS as a Shipping Method

1. Open the Global Menu () and go to Control Panel → Sites.

2. Add a new Minium site.

3. Open the Global Menu () and go to Commerce → Channels.

4. Select Minium Portal and scroll down to the Shipping Methods section. Verify the creation of UPS as a new shipping method here. It is inactive by default.

5. Select the new shipping engine and activate it using the Active toggle.

6. Click Save. A new Configuration tab appears for the shipping method.

   The configuration tab contains an input field. You must add the following few key-value pairs for the shipping method to work correctly.

   clientId=[CLIENT_ID]
   clientSecret=[CLIENT_SECRET]
   dimensionsUnitOfMeasurementCode=
   packageWeightUnitOfMeasurementCode=
   packagingTypeCode=
   ratingCodes=
   shipperAddressLine1=
   shipperAddressLine2=
   shipperAddressLine3=
   shipperCountryCode=
   shipperPostalCode=
   simpleRateCode=
   

   Replace [CLIENT_ID] and [CLIENT_SECRET] with the appropriate values from your UPS Developer Dashboard. For valid values of other fields, see links below:

   • dimensionsUnitOfMeasurementCode
   • packageWeightUnitOfMeasurementCode
   • packagingTypeCode
   • ratingCodes
   • simpleRateCode

7. Click Save.

8. Open the site and use the account selector to create a new account.

9. Add a few items to your cart.

10. Open the mini cart and click Submit. This starts the checkout flow.

Continue checking out until you reach the shipping method page. You can see the UPS shipping options on this page. Select the method of your choice and continue checking out.

See Getting Started with UPS APIs for more information on setting up your UPS Developer account.