ssossossosso
Documentation Home »User Guide »Shipping »Shipping Configuration »Shipping Method Integration
current version

Shipping Method Integration

You may configure integration with third-party providers to offer their shipping services for the quotes and orders placed using OroCommerce.

Out of the box, you may integrate OroCommerce with UPS and Flat Rate shipping.

UPS Shipping Integration

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

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 the ups.com <https://ups.com>.
  2. Navigate to the 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

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:

  3. Type in the Common Integration Details:

    • Name – the shipping method name that is shown as an option for shipping configuration in the OroCommerce Management Console.
    • Label – the shipping method name/label that is shown as a shipping option for the buyer in the OroCommerce Store Front on the checkout.
    • Short label – the shipping method name/label that is shown in the order details in the OroCommerce Management Console and Front Store after the order is submitted.
    • Status – set the status to Active to enable the integration.
  4. 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 production environment in your sandbox/test OroCommerce environment.

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

  5. Provide the UPS connection details: API user, password, and API key to connect. Click Check UPS Connection to ensure UPS API is accessible.

  6. Provide the UPS service account details:

    • Shipping account name
    • Shipping account number
  7. Select the pickup type that shall apply to the deliveries for the shipping methods via this integration. Awailable options are:

    • Regular Daily Pickup
    • Customer Counter
    • One Time Pickup
    • On Call Air
    • Letter Center
  8. 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.

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

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

  11. Set status to Active to enable the integration.

  12. Click Save.

Next, set up a shipping rule that enables this shipping methods for all or some customer orders.

Flat Rate Shipping Integration

This section describes the steps that are necessary to expose flat rate shipping as a shipping method in OroCommerce orders and quotes.

To enable flat rate shipping:

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

  2. Click Create Integration and select Flat Rate Shipping as integration type:

  3. Type in the integration name and label (e.g. Flat Rate). Add label translations, if necessary.

  4. Set status to Active to enable the integration.

  5. Click Save.

Next, set up a shipping rule that defines enables this shipping methods for all or some customer orders.

Delete Shipping Integration

This section describes the steps that are necessary to delete integration with the shipping provider and disable shipping methods they offer in OroCommerce orders and quotes.

To delete an integration and related shipping methods:

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

  2. Hover over the more actions menu on the right side of the line with the necessary integration and click .

    The confirmation box is shown.

    If any shipping rule depends on the integration that is being deleted, the affected shipping methods in those shipping rules will be disabled. The shipping rule might also be disabled if none of its shipping methods remain enabled.

  3. If necessary, review the shipping rules using the link in the confirmation box.

    Note

    The shipping rules open in a new tab in your browser.

  4. Once you are ready to delete the integration, click Delete.

The shipping methods created due to this integration are no longer usable in OroCommerce and cannot be enabled in the shipping rule.