Skip to content

Magento 2 Green Delivery extension user guide

Introduction

Green Delivery extension helps you offer eco-friendly shipping to your customers. It adds two features that you can use together or separately:

  • the Green Delivery shipping method, a separate shipping method with its own price, icon, font color and description that stands out in the list of shipping methods at checkout;
  • the Green Delivery option, a toggle under the shipping methods at checkout. Customers can turn it on for the shipping methods you choose, and its cost is added to the shipping amount.

Requirements and Installation

Green Delivery supports Open source (Community), Commerce (Enterprise) editions and Commerce cloud. The current version of the Magento installed on your website can be found in the lower right corner of any backend page.

Green Delivery has 3 separate ways of installation:

1) Copy the code (ready-to-paste package);
2) Use MageWorx Repository;
3) Use local Composer.

Configuration

Green Delivery option

Log into the Magento Admin panel and go to STORES ⟶ Configuration ⟶ MageWorx tab ⟶ Green Delivery ⟶ Green Delivery Option:

  • Enable - enables or disables the Green Delivery option at checkout. Default: No.
  • Title - the label of the option at checkout. It is also added in brackets to the shipping method name of the order, for example Flat Rate - Fixed (Green delivery). Default: Green delivery.
  • Description - the text shown below the option at checkout. Leave it empty to show no description.
  • Apply to shipping methods - the shipping methods the option is available for. The option is shown only when the customer selects one of these methods. If you do not select any method, the option is available for all shipping methods.
  • Cost - the amount added to the shipping amount when the customer turns the option on. Enter 0 or leave it empty to offer the option for free. This setting can be set per website, not per store view.
The cost is set in the base currency of the website. At checkout it is converted to the currency the customer has selected.

Green Delivery shipping method

The shipping method has its own settings group among the other carriers. Go to STORES ⟶ Configuration ⟶ SALES ⟶ Delivery Methods ⟶ Mageworx Green Delivery:

  • Enabled - enables or disables the Green Delivery shipping method. Default: No.
  • Title - the carrier title shown at checkout. Default: Green Delivery.
  • Method Name - the method name shown at checkout next to the title. Default: Green Delivery.
  • Description - the text shown in a separate row right below the method in the list of shipping methods at checkout. Leave it empty to show no description.
  • Cost - the price of the shipping method. It is a fixed amount for the whole order. Default: 0.00.
  • Icon - the image shown before the method name at checkout. Allowed file types: PNG, GIF, JPG, JPEG.
  • Font color - the color of the method title and name at checkout. Click the field to pick a color.
  • Calculate Handling Fee and Handling Fee - the standard Magento handling fee fields.
  • Ship to Applicable Countries - choose All Allowed Countries or Specific Countries.
  • Ship to Specific Countries - the countries the method is available for when Specific Countries is selected above.
  • Show Method if Not Applicable - if set to Yes, the method is still shown for countries it does not ship to, with the error message below.
  • Displayed Error Message - the message shown when the method is not available for the customer's country. Default: This shipping method is not available. To use this shipping method, please contact us.
  • Sort Order - the position of the method in the list of shipping methods.
You can use the shipping method and the option at the same time. For example, add the Green Delivery shipping method to **Apply to shipping methods** if the option should be available for it too.

Front-end

Checkout

Green Delivery shipping method

When the shipping method is enabled, it appears in the list of shipping methods on the shipping step of the checkout. Its title and name use the Font color, the Icon is shown before the method name, and the Description is shown in a row right below the method.

Green Delivery option

When the option is enabled, a toggle appears below the list of shipping methods on the shipping step of the checkout. Its label shows the Title and the cost, for example Green delivery - $5.00, or Green delivery - Free if the cost is 0. The Description is shown below the toggle.

The toggle is shown only when the selected shipping method is listed in Apply to shipping methods (or for any method if that list is empty). When the customer turns the toggle on:

  • the Cost of the option is added to the shipping amount of the order;
  • the Title of the option is added in brackets to the shipping method name, for example Flat Rate - Fixed (Green delivery).

The customer's choice is saved right away, so it is kept if the customer leaves the checkout and comes back.

PayPal Express Checkout

If the customer pays with PayPal Express Checkout and reviews the order on your store before placing it, the review page shows:

  • the Green Delivery option toggle under the shipping method selector, for the shipping methods set in Apply to shipping methods. The page reloads after the customer turns the toggle on or off, to update the totals;
  • the Description of the Green Delivery shipping method, when this method is selected.

Orders

The shipping method name of an order placed with the Green Delivery option includes the option Title in brackets, for example Flat Rate - Fixed (Green delivery). The shipping amount of the order includes the option cost.

The extension also adds the Green Delivery Option column (Yes / No) to the orders grid in SALES ⟶ Orders. The column is hidden by default: enable it in the Columns drop-down. You can filter the orders by this column to find all orders placed with the Green Delivery option.

Got Questions?

Need help with the extensions? Feel free submit a ticket from https://www.mageworx.com/support/

Mageworx offers outstanding services developing custom-tailored solutions for Magento platform to attain your eCommerce objectives. Our professional impassioned team provides profound and custom oriented development of your project in a short timeframe.