Using the UPS Shipping Method

Liferay DXP 2024.Q3+/Portal 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 the UPS Client Extension

1. Log into your Liferay account at marketplace.liferay.com.

2. Search for Liferay Commerce Connector to UPS and select it.

3. Click Get App.

4. Select your account and check the box to confirm you’ve read the End User License Agreement and the Terms of Service.

5. Click Get App.

   The app is ready for provisioning. Click Continue to Install to go the app’s App Provisioning page. Click Actions () → Install. You can also install the app by selecting View Details → Install.

   This page also has a Details tab where you can view the order details.

6. Select a project from the list. You cannot select projects that don’t have enough resources.

7. Choose an environment. You must have an environment that has an EXT prefix.

8. Click Install.

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