How to Create Custom Shipping Mo

2018-05-07 本文已影响0人跨境小白

Transporting an item from one place to another is called Shipping, and to deliver an ordered product through a medium to your customer is called the Shipping Method.

Magento 2 already has built-in Shipping methods, but if you need custom Shipping Methods, then you have to create a custom Shipping Method. In this guide I am going to show you how to create a custom shipping module in Magento 2.

If you are not familiar with custom module, then first learn about it from this guide: Create Module in Magento 2.

Steps to Follow:

Registration and Configuration of Module
Create New Fields in Admin Panel
Define Shipping Model
Create Shipping Model
Run Commands

Registration and Configuration of Shipping Module

First of all, configuration and registration of a custom module is required. Let’s first configure and then register the module.

Subscribe to Get FREE Magento 2 eBook in Your Inbox!

Create** module.xml** in** app/code/Magenticians/Moduleshipping/etc** and add the following code in it to configure the module:

<?xml version="1.0"?>

</module>

</config>

Create** registration.php** in app/code/Magenticians/Moduleshipping and add the following code in it to register the module:

<?php

\Magento\Framework\Component\ComponentRegistrar::register(

\Magento\Framework\Component\ComponentRegistrar::MODULE,

'Magenticians_Moduleshipping',

DIR

);

Create New Fields in Admin Panel

Create** system.xml** in app/code/Magenticians/Moduleshipping/etc/adminhtml and add this code to it:

<?xml version="1.0"?>

<label>Magenticians Custom Shipping</label>

<label>Enabled</label>

<source_model>Magento\Config\Model\Config\Source\Yesno</source_model>

</field>

<label>Title</label>

</field>

<label>Method Name</label>

</field>

<label>Shipping Cost</label>

<validate>validate-number validate-zero-or-greater</validate>

</field>

<label>Displayed Error Message</label>

</field>

<label>Ship to Applicable Countries</label>

<frontend_class>shipping-applicable-country</frontend_class>

<source_model>Magento\Shipping\Model\Config\Source\Allspecificcountries</source_model>

</field>

<label>Ship to Specific Countries</label>

<source_model>Magento\Directory\Model\Config\Source\Country</source_model>

<can_be_empty>1</can_be_empty>

</field>

<label>Show Method if Not Applicable</label>

<source_model>Magento\Config\Model\Config\Source\Yesno</source_model>

</field>

<label>Sort Order</label>

</field>

</group>

</section>

</system>

</config>

Define Shipping Model

Now define the shipping model by creating **config.xml **in app/code/Magenticians/Moduleshipping/etc, add this code to it:

<?xml version="1.0"?>

<magenticians_moduleshipping>

<model>Magenticians\Moduleshipping\Model\Carrier\Customshipping</model>

<name>Custom Shipping</name>

<title>Magenticians Custom Shipping</title>

<specificerrmsg>This shipping method is not available. To use this shipping method, please contact us.</specificerrmsg>

</magenticians_moduleshipping>

</carriers>

</default>

</config>

Create Shipping Model Class

In the previous step I defined the Shipping Model class and now I am going to create it by creating Customshipping.php in app/code/Magenticians/Moduleshipping/Model/Carrier. Let’s add this code to it:

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

<?php

namespace Magenticians\Moduleshipping\Model\Carrier;

use Magento\Framework\App\Config\ScopeConfigInterface;

use Magento\Framework\DataObject;

use Magento\Shipping\Model\Carrier\AbstractCarrier;

use Magento\Shipping\Model\Carrier\CarrierInterface;

use Magento\Shipping\Model\Config;

use Magento\Shipping\Model\Rate\ResultFactory;

use Magento\Store\Model\ScopeInterface;

use Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory;

use Magento\Quote\Model\Quote\Address\RateResult\Method;

use Magento\Quote\Model\Quote\Address\RateResult\MethodFactory;

use Magento\Quote\Model\Quote\Address\RateRequest;

use Psr\Log\LoggerInterface;

class Customshipping extends AbstractCarrier implements CarrierInterface

{

/**

Carrier's code
@var string

protected $_code = 'magenticians_moduleshipping';

/**

Whether this carrier has fixed rates calculation
@var bool

protected $_isFixed = true;

/**

@var ResultFactory

protected $_rateResultFactory;

/**

@var MethodFactory

protected $_rateMethodFactory;

/**

@param ScopeConfigInterface $scopeConfig
@param ErrorFactory $rateErrorFactory
@param LoggerInterface $logger
@param ResultFactory $rateResultFactory
@param MethodFactory $rateMethodFactory
@param array $data

public function __construct(

ScopeConfigInterface $scopeConfig,

ErrorFactory $rateErrorFactory,

LoggerInterface $logger,

ResultFactory $rateResultFactory,

MethodFactory $rateMethodFactory,

array $data = []

) {

$this->_rateResultFactory = $rateResultFactory;

$this->_rateMethodFactory = $rateMethodFactory;

parent::__construct($scopeConfig, $rateErrorFactory, $logger, $data);

}

/**

Generates list of allowed carrier`s shipping methods
Displays on cart price rules page
@return array
@api

public function getAllowedMethods()

{

return [$this->getCarrierCode() => __($this->getConfigData('name'))];

}

/**

Collect and get rates for storefront
@SuppressWarnings(PHPMD.UnusedFormalParameter)
@param RateRequest $request
@return DataObject|bool|null
@api

public function collectRates(RateRequest $request)

{

/**

Make sure that Shipping method is enabled

if (!$this->isActive()) {

return false;

}

/** @var \Magento\Shipping\Model\Rate\Result $result */

$result = $this->_rateResultFactory->create();

$shippingPrice = $this->getConfigData('price');

$method = $this->_rateMethodFactory->create();

/**

Set carrier's method data

$method->setCarrier($this->getCarrierCode());

$method->setCarrierTitle($this->getConfigData('title'));

/**

Displayed as shipping method under Carrier

$method->setMethod($this->getCarrierCode());

$method->setMethodTitle($this->getConfigData('name'));

$method->setPrice($shippingPrice);

$method->setCost($shippingPrice);

$result->append($method);

return $result;

}

Run Commands

Great, you’re all done! Launch your SSH terminal and connect it to your store, and run the following commands in the root directory of your store:

php bin/magento module:status

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy

php bin/magento cache:clean

php bin/magento cache:flush

Now let’s check out the result!

First, go to STORES → Configuration from the admin panel of your store. Then click onShipping Methods under the** SALES** tab.

magento shipping method

Here, you will see the new shipping Method section: Magenticians Custom Shipping. Enable the Custom Shipping method and set its values according to your need.

magento custom shipping method

Now go to the checkout page of your Magento 2 store and you will see the Magenticians Custom Shipping Method.

Select Custom shipping method

Review and Payments- Custom shipping method

Wrapping Up

After following this guide, you should be able to create a custom shipping method module in Magento 2. Hopefully, all the steps mentioned above were easy to follow and you didn’t get stuck anywhere. However, if you still have any issues or confusions, just leave your thoughts below!

How to Create Custom Shipping Mo

Steps to Follow:

Registration and Configuration of Shipping Module

Create New Fields in Admin Panel

Define Shipping Model

Create Shipping Model Class

Run Commands

Wrapping Up

猜你喜欢

热点阅读