arrow-left

Only this pageAll pages
gitbookPowered by GitBook
1 of 18

Commerce Shipping providers

Loading...

Loading...

Commerce Products

DHL

Loading...

Loading...

Loading...

Loading...

EasyPost

Loading...

Loading...

Loading...

Loading...

Shipmondo

Loading...

Loading...

Loading...

Loading...

Overview

Getting Started with the DHL shipping provider for Umbraco Commerce.

The DHL shipping provider adds functionality to ship products via DHLarrow-up-right. It is a fully featured shipping provider including realtime rate retrieval for accurate shipment pricing.

hashtag
Install DHL

hashtag
In this Section

In this section, we will guide you through the key steps necessary to get you started with the DHL shipping provider for Umbraco Commerce.

It is assumed that before we begin you already have an Umbraco website configured and Umbraco Commerce installed. If you are not at this stage yet, read the to learn how to get started.

hashtag
Useful links

Below are a few useful links that might come in handy should you wish to learn more about the provider itself, and the DHL API.

core Umbraco Commerce documentationarrow-up-right
Shipping provider source codearrow-up-right
Shipping provider issue trackerarrow-up-right
DHL Express informationarrow-up-right
DHL Express documentationarrow-up-right

Configure DHL

Learn how to configure DHL in order to implement the integration with your Umbraco Commerce installation.

hashtag
Step 1: Sign up & Sign in

  1. Head to the MyDHL Express portalarrow-up-right.

  2. Select your region from the locations dropdown.

  3. Choose Register from the header menu.

  4. Complete the application form to apply for an account.

  5. A DHL representative will be in touch to provide you with the relevant credentials.

Configure Umbraco

Learn how to configure the Umbraco backoffice for enabling the use of DHL as a shipping method.

This article will give you details about how to configure Umbraco to start using the DHL shipping method with your Umbraco Commerce implementation.

hashtag
Step 1: Create a Shipping Method

The following steps are all handled through the Umbraco backoffice.

  1. Navigate to Settings > Commerce > Stores > {Store Name} > Shipping Methods section.

  2. Select the Create Shipping Method button to create a new shipping method.

  3. Choose DHL from the list of available shipping providers.

  4. Choose Realtime from the list of shipping method calculation modes.

hashtag
Step 2: Configure Shipping Provider Settings

The following steps are handled within the shipping method editor in the Umbraco backoffice.

  1. Configure the standard shipping method settings as required.

  2. Configure the DHL shipping provider settings as follows:

Name
Description
  1. Optionally configure the advanced DHL shipping provider settings as follows:

Name
Description

Test Password

The Test Password from the DHL portal.

Live Username

The Live Username from the DHL portal.

Live Password

The Live Password from the DHL portal.

Test Mode

Set whether to run in test mode.

Account Number

Your DHL account number

Shipping Timeframe

The number of days after an order is placed you generally ship by. 0 = same day, 1 = next day, etc

Next Business Day Fallback

When set to true and there are no products available within the shipping timeframe then products available for the next possible pickup date are returned.

Test Username

Product Codes

Comma-separated list of product codes to limit the rates to.

The Test Username from the DHL portal.

What are Shipping Providers?

Learn more about each of the available integrations for implementing shipping providers into your Umbraco Commerce installation.

Shipping providers are essential for your Umbraco Commerce installation when you want to give users and customers options for how they wish to ship products.

The Basic option comes with Umbraco Commerce out of the box. Integrations for different providers are available for you to add additional shipping options to your site.

hashtag
Available integrations

hashtag
Using These Docs

These docs are aimed at developers and users who have at least a basic understanding of , as well as Umbraco backoffice principles.

Release Notes

In this section, we have summarized the changes to the Shipmondo Shipping Provider for Commerce released in each version. Each version is presented with a link to the showing a list of issues resolved in the release. We also link to the individual issues themselves from the detail.

If there are any breaking changes or other issues to be aware of when upgrading they are also noted here.

hashtag
Release History

In this section, you can find the release notes for each version of Shipmondo Shipping Provider for Commerce. For each major version, you can find the details about each release.

Configure Shipmondo

Learn how to configure Shipmondo in order to implement the integration with your Umbraco Commerce installation.

hashtag
Step 1: Sign up & Sign in

  1. Head to the .

DHL

EasyPost

Shipmondo

Umbracoarrow-up-right
hashtag
Version 14 and above
  • For details of changes in v14 and above of the Shipmondo Shipping Provider for Umbraco Commerce, refer to the .

hashtag
Version 14.0.0 (August 23rd 2024)

  • Release for Umbraco v14.2.0 and Umbraco Commerce v14.0.0 support.

hashtag
Version 13.0.0 (February 21st 2024)

  • Public release closing off the RC period.

hashtag
Version 13.0.0-rc1 (February 6th 2024)

  • Initial release.

Commerce Shipmondo Shipping Provider issue trackerarrow-up-right
Complete the application form to apply for an account.
  1. Head to the .

  2. Sign in to your account.

hashtag
Step 2: API Keys

In order for Umbraco Commerce to communicate with Shipmondo securely we need to retrieve a series of API keys used for authentication.

  1. Access the Shipmondo Portal.

  2. Choose the Settings > API > Access menu item.

Here you will find your API Username and key. Note these down as you will need to enter them into the Umbraco Commerce UI shortly.

Shipmondo Signup pagearrow-up-right
Releases section on GitHubarrow-up-right
Shipmondo Login pagearrow-up-right
The interface when signing up for a Shipmondo account.
The interface when signing in to your Shipmondo account.
The interface when accessing your Shipmondo API keys.

Release Notes

In this section, we have summarized the changes to the EasyPost Shipping Provider for Commerce released in each version. Each version is presented with a link to the Commerce EasyPost Shipping Provider issue trackerarrow-up-right showing a list of issues resolved in the release. We also link to the individual issues themselves from the detail.

If there are any breaking changes or other issues to be aware of when upgrading they are also noted here.

hashtag
Release History

In this section, you can find the release notes for each version of EasyPost Shipping Provider for Commerce. For each major version, you can find the details about each release.

hashtag
Version 14 and above

  • For details of changes in v14 and above of the EasyPost Shipping Provider for Umbraco Commerce, refer to the .

hashtag
Version 14.0.0 (August 23rd 2024)

  • Release for Umbraco v14.2.0 and Umbraco Commerce v14.0.0 support.

hashtag
Version 13.0.0 (February 21st 2024)

  • Public release closing off the RC period.

hashtag
Version 13.0.0-rc1 (February 6th 2024)

  • Initial release.

Releases section on GitHubarrow-up-right

Configure Umbraco

Learn how to configure the Umbraco backoffice for enabling the use of Shipmondo as a shipping method.

This article will give you details about how to configure Umbraco to start using the Shipmondo shipping method with your Umbraco Commerce implementation.

hashtag
Step 1: Create a Shipping Method

The following steps are all handled through the Umbraco backoffice.

  1. Navigate to Settings > Commerce > Stores > {Store Name} > Shipping Methods section.

  2. Select the Create Shipping Method button to create a new shipping method.

  3. Choose Shipmondo from the list of available shipping providers.

  4. Choose Realtime from the list of shipping method calculation modes.

hashtag
Step 2: Configure Shipping Provider Settings

The following steps are handled within the shipping method editor in the Umbraco backoffice.

  1. Configure the standard shipping method settings as required.

  2. Configure the Shipmondo shipping provider settings as follows:

Name
Description

Configure EasyPost

Learn how to configure EasyPost in order to implement the integration with your Umbraco Commerce installation.

hashtag
Step 1: Sign up & Sign in

  1. Head to the .

API User

The Api User from the Shipmondo portal.

API Key

The API Key from the Shipmondo portal.

Test Mode

Set whether to run in test mode.

Complete the application form to apply for an account.
The interface when signing up for a EasyPost account.
  1. Head to the EasyPost Login pagearrow-up-right.

  2. Sign in to your account.

The interface when signing in to your EasyPost account.

hashtag
Step 2: API Keys

In order for Umbraco Commerce to communicate with EasyPost securely we need to retrieve a series of API keys used for authentication.

  1. Access the EasyPost Portal.

  2. Click the Account Settings item in the left hand menu.

  3. Choose the API keys heading in the main content panel.

The interface when accessing your EasyPost API keys.

Here you will find your Test and Live API keys. Note these down as you will need to enter them into the Umbraco Commerce UI shortly.

hashtag
Step 4: Carriers

To enable carriers on your account, you will need to enable them. You may also need to sign up with the specific carrier.

  1. Access the EasyPost Portal.

  2. Click the Account Settings item in the left hand menu.

  3. Choose the Carriers heading in the main content panel.

  4. Click Add Carrier to add a new carrier, completing the on screen form.

The interface when add a carrier to your EasyPost account.
EasyPost Signup pagearrow-up-right

Release Notes

In this section, we have summarized the changes to the DHL Shipping Provider for Commerce released in each version. Each version is presented with a link to the Commerce DHL Shipping Provider issue trackerarrow-up-right showing a list of issues resolved in the release. We also link to the individual issues themselves from the detail.

If there are any breaking changes or other issues to be aware of when upgrading they are also noted here.

hashtag
Release History

In this section, you can find the release notes for each version of DHL Shipping Provider for Commerce. For each major version, you can find the details about each release.

hashtag
Version 14 and above

  • For details of changes in v14 and above of the DHL Shipping Provider for Umbraco Commerce, refer to the .

hashtag
Version 14.0.0 (August 23rd 2024)

  • Release for Umbraco v14.2.0 and Umbraco Commerce v14.0.0 support.

hashtag
Version 13.0.0 (February 21st 2024)

  • Public release closing off the RC period.

hashtag
Version 13.0.0-rc1 (February 6th 2024)

  • Initial release.

Configure Umbraco

Learn how to configure the Umbraco backoffice for enabling the use of EasyPost as a shipping method.

This article will give you details about how to configure Umbraco to start using the EasyPost shipping method with your Umbraco Commerce implementation.

hashtag
Step 1: Create a Shipping Method

The following steps are all handled through the Umbraco backoffice.

Overview

Getting Started with the Shipmondo shipping provider for Umbraco Commerce.

The Shipmondo shipping provider adds functionality to ship products via . It is a fully featured shipping provider including realtime rate retrieval for accurate shipment pricing.

hashtag

hashtag

Navigate to Settings > Commerce > Stores > {Store Name} > Shipping Methods section.
  • Select the Create Shipping Method button to create a new shipping method.

  • Choose EasyPost from the list of available shipping providers.

  • Choose Realtime from the list of shipping method calculation modes.

  • hashtag
    Step 2: Configure Shipping Provider Settings

    The following steps are handled within the shipping method editor in the Umbraco backoffice.

    1. Configure the standard shipping method settings as required.

    2. Configure the EasyPost shipping provider settings as follows:

    Name
    Description

    Test API Key

    The Test API Key from the EasyPost portal.

    Live API Key

    The Live API Key from the EasyPost portal.

    Test Mode

    Set whether to run in test mode.

    1. Optionally configure the advanced EasyPost shipping provider settings as follows:

    Name
    Description

    Carrier Accounts

    Comma-separated list of carriers to limit which services to fetch rates for.

    Releases section on GitHubarrow-up-right
    In this Section

    In this section, we will guide you through the key steps necessary to get you started with the Shipmondo shipping provider for Umbraco Commerce.

    It is assumed that before we begin you already have an Umbraco website configured and Umbraco Commerce installed. If you are not at this stage yet, read the core Umbraco Commerce documentationarrow-up-right to learn how to get started.

    hashtag
    Useful links

    Below are a few useful links that might come in handy should you wish to learn more about the provider itself, and the Shipmondo API.

    • Shipping provider source codearrow-up-right

    • Shipping provider issue trackerarrow-up-right

    • Shipmondo informationarrow-up-right

    Shipmondoarrow-up-right
    Install Shipmondo
    Shipmondo documentationarrow-up-right

    Install shipping providers

    Learn how to install and add shipping providers to your Umbraco Commerce implementation.

    When you need to install a shipping provider into your Umbraco Commerce implementation it is done via NuGet.

    The installation can be handled in one of two ways as explained below.

    hashtag
    Install via the NuGet Manager Console

    1. Open the NuGet Manage Console.

    2. Type in the following command:

    Use the to ensure you get the correct package name for the provider you want to install.

    hashtag
    Install via the NuGet Package Manager

    1. Open the NuGet Package Manager.

    2. Search for the Shipping Provider you want to install.

    3. Ensure the "Browse" tab is selected.

    4. Install the package into your solution.

    Alternatively, you can also find and install the NuGet package via the NuGet Package Manager.

    hashtag
    Available Shipping Providers

    Shipping Provider
    NuGet Package name

    hashtag
    Upgrading

    circle-exclamation

    Before upgrading, it is always advisable to take a complete backup of your site and database.

    Umbraco Commerce uses Umbraco Migrations to install all of its features. Upgrades follow the same process as the installation processes detailed above, by installing the latest version over the top of the existing package installation. By using this process the installation will only install new features and features that are missing.

    DHL

    Umbraco.Commerce.ShippingProviders.Dhl

    EasyPost

    Umbraco.Commerce.ShippingProviders.EasyPost

    Shipmondo

    Umbraco.Commerce.ShippingProviders.Shipmondo

    table of available Shipping Providers
    Installing Umbraco Commerce via the NuGet Package Manager
    PM> Install-Package Umbraco.Commerce.ShippingProviders.PROVIDER

    Overview

    Getting Started with the EasyPost shipping provider for Umbraco Commerce.

    The EasyPost shipping provider adds functionality to ship products via EasyPostarrow-up-right. It is a fully featured shipping provider including realtime rate retrieval for accurate shipment pricing.

    hashtag
    Install EasyPost

    hashtag
    In this Section

    In this section, we will guide you through the key steps necessary to get you started with the EasyPost shipping provider for Umbraco Commerce.

    It is assumed that before we begin you already have an Umbraco website configured and Umbraco Commerce installed. If you are not at this stage yet, read the to learn how to get started.

    hashtag
    Useful links

    Below are a few useful links that might come in handy should you wish to learn more about the provider itself, and the EasyPost API.

    core Umbraco Commerce documentationarrow-up-right
    Shipping provider source codearrow-up-right
    Shipping provider issue trackerarrow-up-right
    EasyPost informationarrow-up-right
    EasyPost documentationarrow-up-right