Overview

The Shipping Module provides the ability to extend shipping provider list with custom providers and also provides an interface and API for managing these shipping providers.

Key Features

1. Register shipping methods using the code;
2. Receive the list of Shipping methods on UI on admin side;
3. Edit shipping method settings;
4. Connect the shipping methods to a Store;
5. API to work with shipping method list.

The selected Shipping methods will be available for selection on the Storefront.

Scenarios

Select Shipping Method

1. Go to More->Store->select the Store;
2. In the opened Store details select the 'Shipping methods' widget;
3. The system will display the list of registered shipping methods;
4. Select the shipping methods that you want to be connected to the Store and displayed on the Storefront;
5. Save the changes made;
6. The selected shipping methods will be available for selection on the Storefront.

Edit Shipping Method

1. Select the Shipping method on Shipping methods blade and click on it;

2. On the 'Edit shipping method' blade you can edit the following:

   1. Activate or de-activate the shipping method using the 'Is Active' button;
   2. Select the 'Tax type' from the drop down;
   3. Add a new Tax type if needed
   4. Save the changes by clicking the 'Save' button;
   5. The Shipping method will be edited.

Add a Tax type to the list

1. On the 'Edit shipping method' blade click the 'Edit' icon next to the Tax type;
2. Enter the value and click 'Add';
3. Save the new Tax type;
4. The new Tax type will appear in the list and will be available for selection.

Edit Settings

1. On the 'Edit shipping method' blade select the 'Settings' widget;
2. Specify the Ground shipping rate and the 'Air shipping rate';
3. Click 'OK';
4. Save the changes made;
5. The new rates will be displayed on the Storefront.

---

Last update: February 1, 2024