How to create Custom Shipping Method in Bagisto ?

Shivendra Gupta

15 May 2023

Shipping Method

It becomes very easy to create custom Shipping Methods in bagisto for both (i.e. Novice developer as well as Professional Developers). As the diversity of shipping methods provide the options to customer for various shipments when they proceed to checkout. On another perspective, multiple shipping methods are a great strategy to reach out to the global marketplace.

There are basically two ways to create Custom Shipping Methods in bagisto.

Package Generator
Manual old school way

Package Generator

If you are using bagisto 1.2.0 or above, what you can do is, You can simply run the command below which will make appropriate directory structure for you which will be used further.

1	php artisan package:make-shipping-method ACME/FedEx

If, in case your Package Name already exist at the same directory, you can also use –force with the above command which goes like this:

1	php artisan package:make-shipping-method ACME/FedEx --force

Manual Way

You have to create the directory structure of your own. Follow and create the directory structure mentioned below.

Create this directory structure to create your payment method.

FedEx/
- src/
  - config/
    - carriers.php

The user needs to create a file named carriers.php at the src/config path in the package (say FedEx). Here, we are going to specify what to include in your carriers.php file.

<?php

return [

'DemoShipping' => [

'code' => 'demoshipping',

'title' => 'DemoShipping',

'description' => 'Demo Shipping',

'active' => true,

'type' => 'per_unit',

'class' => 'ACME\FedEx\Carriers\FedEx',

]

];

Step 1: Add your Shipping method in Admin panel

Go to Config folder present inside your package -> src.
Now you have to add some keys and there values which helps you adding you shipping Method at the admin end Configuration.
You can use the keys below and edit at your own end according to the need of yours.

<?php
         return [
            [
                'key'    => 'sales.carriers.demoshipping',
                'name'   => 'Demo Shipping',
                'sort'   => 1,
                'fields' => [
                    [
                        'name'          => 'title',
                        'title'         => 'admin::app.admin.system.title',
                        'type'          => 'text',
                        'validation'    => 'required',
                        'channel_based' => false,
                        'locale_based'  => true,
                    ], [
                        'name'          => 'description',
                        'title'         => 'admin::app.admin.system.description',
                        'type'          => 'textarea',
                        'channel_based' => false,
                        'locale_based'  => true,
                    ], [
                        'name'          => 'active',
                        'title'         => 'admin::app.admin.system.status',
                        'type'          => 'boolean',
                        'validation'    => 'required',
                        'channel_based' => false,
                        'locale_based'  => true,
                    ]
                ]
            ]
         ];

<?php

return [

[

'key' => 'sales.carriers.demoshipping',

'name' => 'Demo Shipping',

'sort' => 1,

'fields' => [

[

'name' => 'title',

'title' => 'admin::app.admin.system.title',

'type' => 'text',

'validation' => 'required',

'channel_based' => false,

'locale_based' => true,

], [

'name' => 'description',

'title' => 'admin::app.admin.system.description',

'type' => 'textarea',

'channel_based' => false,

'locale_based' => true,

], [

'name' => 'active',

'title' => 'admin::app.admin.system.status',

'type' => 'boolean',

'validation' => 'required',

'channel_based' => false,

'locale_based' => true,

]

];

What this will do is, It will create the fields in the admin end where you can configure your settings. It will look like this:

Step 2: Render Shipping Method at checkout

In order to render your custom shipping method at the checkout process, you just need to define ‘calculate()’ within your DemoShipping.php and return shipping rate, shipping title, shipping description within an object.

You can refer to the code below.

<?php

namespace Webkul\DemoPayment\Carriers;

use Config;
use Webkul\Checkout\Models\CartShippingRate;
use Webkul\Shipping\Facades\Shipping;
use Webkul\Checkout\Facades\Cart;

/**
 * Class Rate.
 *
 */
class DemoShipping extends AbstractShipping
{
    /**
     * Payment method code
     *
     * @var string
     */
    protected $code  = 'demoshipping';

/**
     * Returns rate for flatrate
     *
     * @return CartShippingRate|false
     */
    public function calculate()
    {
        if (! $this->isAvailable()) {
            return false;
        }

$cart = Cart::getCart();

$object = new CartShippingRate;

$object->carrier = 'flatrate';
        $object->carrier_title = $this->getConfigData('title');
        $object->method = 'flatrate_flatrate';
        $object->method_title = $this->getConfigData('title');
        $object->method_description = $this->getConfigData('description');
        $object->price = 0;
        $object->base_price = 0;

if ($this->getConfigData('type') == 'per_unit') {
            foreach ($cart->items as $item) {
                if ($item->product->getTypeInstance()->isStockable()) {
                    $object->price += core()->convertPrice($this->getConfigData('default_rate')) * $item->quantity;
                    $object->base_price += $this->getConfigData('default_rate') * $item->quantity;
                }
            }
        } else {
            $object->price = core()->convertPrice($this->getConfigData('default_rate'));
            $object->base_price = $this->getConfigData('default_rate');
        }

return $object;
    }
}

<?php

namespace Webkul\DemoPayment\Carriers;

use Config;

use Webkul\Checkout\Models\CartShippingRate;

use Webkul\Shipping\Facades\Shipping;

use Webkul\Checkout\Facades\Cart;

/**

* Class Rate.

class DemoShipping extends AbstractShipping

{

/**

* Payment method code

* @var string

protected $code = 'demoshipping';

/**

* Returns rate for flatrate

* @return CartShippingRate|false

public function calculate()

{

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

return false;

}

$cart = Cart::getCart();

$object = new CartShippingRate;

$object->carrier = 'flatrate';

$object->carrier_title = $this->getConfigData('title');

$object->method = 'flatrate_flatrate';

$object->method_title = $this->getConfigData('title');

$object->method_description = $this->getConfigData('description');

$object->price = 0;

$object->base_price = 0;

if ($this->getConfigData('type') == 'per_unit') {

foreach ($cart->items as $item) {

if ($item->product->getTypeInstance()->isStockable()) {

$object->price += core()->convertPrice($this->getConfigData('default_rate')) * $item->quantity;

$object->base_price += $this->getConfigData('default_rate') * $item->quantity;

}

} else {

$object->price = core()->convertPrice($this->getConfigData('default_rate'));

$object->base_price = $this->getConfigData('default_rate');

}

return $object;

}

After doing all these things and enabling payment method from the admin end, you’ll be able to see the shipping method at the front end at the time of checkout.

Rest Important folders

Within Database folder, the migration and seeder(if needed) files are stored.
Within Resources folder your views as well as your raw, un-compiled assets such as SASS, or JavaScript. This directory also houses all of your language files.
Within Providers folder all of the service providers for your application. Service providers bootstrap your application by binding services in the service container, registering events, or performing any other tasks to prepare your application for incoming requests.Here, in our case, we have created two providers files i.e.,
1. EventServiceProvider : In this file, events included with your application provides a convenient place to register all of your application’s event listeners.
2. PaymentServiceProvider : In this file, you may register all your configuration, language, and routes within register and boot methods.
Within Models folder, the models are stored for the application.
Within Payment folder, write the code needed to operate your payment method
Within Repositories folder, create a file as HelloWorldRepository.php which must extend repository class
Within Http folder, define your routes and controller application.
Within Listeners folder, this folder includes listener files to listen to respective events.