Documentation Home »User Guide: Commerce »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, FedEx, DPD, and Flat Rate shipping.

Note

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

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 Storefront 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. Available 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 method for all or some customer orders.

FedEx Shipping Integration

FedEx is a largest multinational delivery service company that provides a variety of shipping methods solutions, both ground and airfreight, day and overnight, to meet the customers’ requirements.

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

Prerequisites for Integration

Before adding FedEx as a shipping method in OroCommerce, you need to create a FedEx business account and obtain a dedicated shipping account number and a meter number via the official FedEx website.

Create a FedEx Business Account

To register a business account and enable a checkout shipping integration with OroCommerce, follow the next steps:

  1. Navigate to the FedEx login page.

  2. Click Sign In and then Create Account.

  3. Click Business account benefits to check out the rewarded benefits for your business and proceed to a business account creation.

  4. Click Open a business account to complete the registration in several steps.

  5. Fill in the registration form with your personal contact information and a credit card number. Agree to the terms and conditions and check the benefits you can get at the final step.

Obtain a Set of Testing Credentials

Once the registration is complete, you can now obtain the necessary test keys to set up the integration between FedEx and OroCommerce and make sure the integration is working properly.

  1. Navigate to the FedEx Web Services page.

  2. Complete the four steps required by FedEx to test the integration:

    • Read the documentation.
    • Request the testing credentials and test the integration.
    • Certify the OroCommerce application with FedEx.
    • Receive new production credentials to replace your current test ones and move to production.
  3. Click Move to development and then Get your test key.

  4. Confirm your contact information and accept the FedEx license to complete the registration process.

  5. Receive an email with the corresponding test credentials:

    • Key
    • Password
    • Account ID
    • Meter Number

Configure a FedEx Integration in OroCommerce

To enable the integration with FedEx in order to request the shipping cost estimation and/or request the shipping services:

  1. Navigate System > Integrations > Manage Integrations in the main menu.

  2. Click Create Integration.

  3. On the Create Integration page, select FedEx for Type.

  4. 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 storefront during the checkout.

Click the Translations icon to provide spelling for different languages. Click the Default Language icon to return to the single-language view.

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

    Note

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

    Warning

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

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

  2. Provide the connection credentials which you have received from FedEx:

    • User Credential Key – is the authentication key provided by FedEx and used for accessing your FedEx account.
    • User Credential Password – is the production password provided by FedEx.
    • Shipping Account Number – is the account ID provided by FedEx.
    • Meter Number – is the meter number provided by FedEx.
  3. Select the available pickup type that applies to the deliveries for the shipping methods via this integration:

    • Regular Pickup – enables you to schedule a regular delivery pickup if you deal with a large volume of shipments.
    • Request Courier – with this type selected, you can request a FedEx courier to come and pick up the shipments.
    • Drop Box – requires you to deliver the shipments to your closest FedEx drop box.
    • Business Service Center – requires you to deliver the shipments to your local FedEx business service center.
    • Station – requires you to deliver the shipments to your local FedEx station.
  4. Select a unit of weight to use for the shipping price calculation: a pound or kilogram.

Note

The unit of weight should match the options supported by your FedEx account.

  1. Select the FedEx shipping services that are supported in the OroCommerce shipping options. Hold the CTRL key to select/deselect multiple options.
  2. Click Check FedEx Connection to ensure FedEx API is accessible.
  3. Set the status to Active to enable the integration.
  4. The Default Owner field is prepopulated with the user creating the integration. You can change this value to another user if necessary.
  5. Click Save and Close.

Next, set up a shipping rule following the Configure a Shipping Method in a Shipping Rule guide to enable this shipping method for all or some customer orders.

Obtain a Set of Production Credentials

Once you have successfully configured the OroCommerce FedEx integration, and the connection to the test environment is working properly, you can move to a production stage and request a new set of credentials.

  1. Navigate to the FedEx Web Services page.

  2. Click the Move to production link and then Get Production Key to load another registration form page.

  3. Complete the form and accept the agreement to continue.

  4. Receive an email with the corresponding production keys from FedEx.

  5. Follow the steps described in the aforementioned Configure a FedEx Integration in OroCommerce section to set up the production integration between FedEx and OroCommerce.

    Important

    Make sure that the Test Mode check box is NOT selected as you are configuring the production integration.

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

Browse maintained versions:
current1.6

You will be redirected to [title]. Would you like to continue?

Yes No
ssossossosso