Create Shipping Method Magento 2

Follow the below steps to create a new shipping method in Magento 2 PHPCodez_Easyship

Declare  Module РCreate module.xml

File : app/code/PHPCode/Easyship/etc/module.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/internal/Magento/Framework/Module/etc/module.xsd">
 <module name="PHPCodez_Easyship" setup_version="0.0.0"/>
</config>

Register the Module

File : app/code/PHPCodez/Easyship/registration.php

<?php
\Magento\Framework\Component\ComponentRegistrar::register(
 \Magento\Framework\Component\ComponentRegistrar::MODULE,
 'PHPCodez_Easyship',
 __DIR__
);

Create config.xml

File : app/code/PHPCodez/Easyship/etc/config.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
 <default>
 <carriers>
 <easyship>
 <active>1</active>
 <sallowspecific>0</sallowspecific>
 <model>PHPCodez\Easyship\Model\Carrier\Shipping</model>
 <name>PHPCodez Easy Shipping</name>
 <price>10.00</price>
 <title>PHPCodez Easy Shipping</title>
 <type>I</type>
 <specific_error_msg>This shipping method is not available. To use this shipping method, please contact us.</specific_error_msg>
 </easyship>
 </carriers>
 </default>
</config>

The shipping method code should be child of default > carriers. And this code should be exactly same with $_code in app/code/PHPCodez/Easyship/Model/Carrier/Shipping.php:13

Create shipping model

File : app/code/PHPCodez/Easyship/Model/Carrier/Shipping.php

<?php
namespace PHPCodez\Easyship\Model\Carrier;

use Magento\Quote\Model\Quote\Address\RateRequest;
use Magento\Shipping\Model\Rate\Result;

class Shipping extends \Magento\Shipping\Model\Carrier\AbstractCarrier implements
 \Magento\Shipping\Model\Carrier\CarrierInterface
{
 /**
 * @var string
 */
 protected $_code = 'easyship';

/**
 * Shipping constructor.
 *
 * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
 * @param \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory
 * @param \Psr\Log\LoggerInterface $logger
 * @param \Magento\Shipping\Model\Rate\ResultFactory $rateResultFactory
 * @param \Magento\Quote\Model\Quote\Address\RateResult\MethodFactory $rateMethodFactory
 * @param array $data
 */
 public function __construct(
 \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
 \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory,
 \Psr\Log\LoggerInterface $logger,
 \Magento\Shipping\Model\Rate\ResultFactory $rateResultFactory,
 \Magento\Quote\Model\Quote\Address\RateResult\MethodFactory $rateMethodFactory,
 array $data = []
 ) {
 $this->_rateResultFactory = $rateResultFactory;
 $this->_rateMethodFactory = $rateMethodFactory;
 parent::__construct($scopeConfig, $rateErrorFactory, $logger, $data);
 }

/**
 * get allowed methods
 * @return array
 */
 public function getAllowedMethods()
 {
 return [$this->_code => $this->getConfigData('name')];
 }

/**
 * @param RateRequest $request
 * @return bool|Result
 */
 public function collectRates(RateRequest $request)
 {
 if (!$this->getConfigFlag('active')) {
 return false;
 }

/** @var \Magento\Shipping\Model\Rate\Result $result */
 $result = $this->_rateResultFactory->create();

/** @var \Magento\Quote\Model\Quote\Address\RateResult\Method $method */
 $method = $this->_rateMethodFactory->create();

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

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

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

$method->setPrice($amount);
 $method->setCost($amount);

$result->append($method);

return $result;
 }
}

Create system configuration file

File : app/code/PHPCode/Easyship/etc/adminhtml/system.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
 <system>
 <section id="carriers" translate="label" type="text" sortOrder="320" showInDefault="1" showInWebsite="1"
 showInStore="1">
 <group id="easyship" translate="label" type="text" sortOrder="0" showInDefault="1" showInWebsite="1"
 showInStore="1">
 <label>PHPCodez Easy Shipping</label>
 <field id="active" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1"
 showInStore="0">
 <label>Enabled</label>
 <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 </field>
 <field id="name" translate="label" type="text" sortOrder="3" showInDefault="1" showInWebsite="1"
 showInStore="1">
 <label>Method Name</label>
 </field>
 <field id="price" translate="label" type="text" sortOrder="5" showInDefault="1" showInWebsite="1"
 showInStore="0">
 <label>Price</label>
 <validate>validate-number validate-zero-or-greater</validate>
 </field>
 <field id="handling_type" translate="label" type="select" sortOrder="7" showInDefault="1"
 showInWebsite="1" showInStore="0">
 <label>Calculate Handling Fee</label>
 <source_model>Magento\Shipping\Model\Source\HandlingType</source_model>
 </field>
 <field id="handling_fee" translate="label" type="text" sortOrder="8" showInDefault="1" showInWebsite="1"
 showInStore="0">
 <label>Handling Fee</label>
 <validate>validate-number validate-zero-or-greater</validate>
 </field>
 <field id="sort_order" translate="label" type="text" sortOrder="100" showInDefault="1" showInWebsite="1"
 showInStore="0">
 <label>Sort Order</label>
 </field>
 <field id="title" translate="label" type="text" sortOrder="2" showInDefault="1" showInWebsite="1"
 showInStore="1">
 <label>Title</label>
 </field>
 <field id="sallowspecific" translate="label" type="select" sortOrder="90" showInDefault="1"
 showInWebsite="1" showInStore="0">
 <label>Ship to Applicable Countries</label>
 <frontend_class>shipping-applicable-country</frontend_class>
 <source_model>Magento\Shipping\Model\Config\Source\Allspecificcountries</source_model>
 </field>
 <field id="specific_country" translate="label" type="multiselect" sortOrder="91" showInDefault="1"
 showInWebsite="1" showInStore="0">
 <label>Ship to Specific Countries</label>
 <source_model>Magento\Directory\Model\Config\Source\Country</source_model>
 <can_be_empty>1</can_be_empty>
 </field>
 <field id="show_method" translate="label" type="select" sortOrder="92" showInDefault="1"
 showInWebsite="1" showInStore="0">
 <label>Show Method if Not Applicable</label>
 <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 </field>
 <field id="specific_error_msg" translate="label" type="textarea" sortOrder="80" showInDefault="1"
 showInWebsite="1" showInStore="1">
 <label>Displayed Error Message</label>
 </field>
 </group>
 </section>
 </system>
</config>

Issue the following commands and you will be able to see shipping method ‘PHPCodez Easy Shipping’ on checkout page.

php bin/magento setup:upgrade
 php bin/magento setup:static-content:deploy -f
 php bin/magento cache:clean
Share

Leave a Reply

Your email address will not be published. Required fields are marked *