Important

You are browsing documentation for version 5.0 of OroCommerce, supported until January 2025. Read the documentation for version 6.0 (the latest LTS version) to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Available in OroCommerce

Configure UPS Shipping Integration in the Back-Office 

Hint

This section is part of the Shipping Configuration topic that provides a general understanding of the shipping concept in OroCommerce.

UPS shipping integration section describes the steps that are necessary to expose UPS as a shipping method in OroCommerce orders and quotes.

Note

See a short demo on how to set up a shipping integration in OroCommerce or keep reading the step-by-step guidance below.

Prepare for Integration 

First, ensure you have registered with UPS.com and have opened a UPS Account with the necessary shipping services level.

Next:

  1. Log in to ups.com.

  2. Navigate to UPS Developer Kit in the Support > Technology Support section.

  3. Request an access key (e.g., 5F235F292A54F51F).

Please, ensure that you have requested separate access keys for your test and production environments.

Configure a UPS Integration in OroCommerce 

Note

UPS has package weight and size limits for shipping. Please check the UPS website for more details.

To enable communication with UPS in order to request the shipping cost estimate and/or request the shipping services, establish a connection with UPS API:

  1. Navigate to the Manage Integrations page by clicking System > Integrations > Manage Integrations in the main menu.

  2. Click Create Integration and select UPS as integration type:

    ../../../../../../_images/CreateUPSIntegration.png

  3. Type in Basic Information:

  • Name – the shipping method name that is shown as an option for shipping configuration in the OroCommerce back-office.

  • Label – the shipping method name/label that is shown as a shipping option for the buyer in the OroCommerce storefront on the checkout.

  • Short label – the shipping method name/label that is shown in the order details in the OroCommerce back-office and storefront after the order is submitted.

  • Status - set the status to Active to enable the integration.

  1. Set the Test Mode into the necessary state. Enable it if you are using the test UPS access key and disable for production access.

    Note

    For security reasons, it is critically important to use the mode that matches your environment and the UPS access key type.

    Warning

    Never use the UPS access key that is dedicated for the production environment in your sandbox/test OroCommerce environment.

    Never enable the Test Mode for the UPS integration on your production instance of OroCommerce.

  2. Provide the UPS connection details: OAuth Client Id and OAuth Client Secret to connect. Click Check UPS Connection to ensure UPS API is accessible.

    Note

    For the case when you update existing integration, you may see the additional deprecated API user (Deprecated), API Password (Deprecated), and API Key (Deprecated) fields.

    Please follow the UPS Migration Guide to finalize the migration to OAuth authentication.

    ../../../../../../_images/UpdateUPSIntegration.png

    Warning

    As of June 2024, you will no longer be able to transact with UPS APIs using an access key for authentication and are required to update your security model to OAuth 2.0

  3. Provide the UPS service account details:

    • Shipping account name

    • Shipping account number

  4. Select the pickup type that shall apply to the deliveries for the shipping methods via this integration. Available options are:

    • Regular Daily Pickup

    • Customer Counter

    • One Time Pickup

    • On Call Air

    • Letter Center

  5. Select unit of weight to use for the shipping price calculation.

    Note

    The unit of weight should be in sync with the options that are supported by your UPS account.

  6. Select the destination country. To support shipping globally, create a dedicated UPS integration (e.g., UPS USA, UPS UK, UPS Germany, etc) for every country you would like to cover with UPS shipping services.

    Once you select the destination, the list of shipping services appears.

  7. Select the UPS shipping services that should be supported in the OroCommerce shipping options. Use Ctrl/Shift to select multiple options.

  8. Set status to Active to enable the integration.

  9. Click Save.

Next, set up a shipping rule via the Shipping Rules Configuration page to enable this shipping method for all or some customer orders.

Once the shipping method is added to the shipping rule, provide the information that configures the shipping fee components and the method to calculate it following the Configure a Shipping Method in a Shipping Rule topic.

Related Topics