{"id":376751,"date":"2023-04-14T10:03:03","date_gmt":"2023-04-14T10:03:03","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=376751"},"modified":"2023-04-20T06:48:15","modified_gmt":"2023-04-20T06:48:15","slug":"how-to-create-a-simple-shipping-method-in-opencart","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/how-to-create-a-simple-shipping-method-in-opencart\/","title":{"rendered":"How to Create a Simple Shipping Method in Opencart?"},"content":{"rendered":"\n

In our previous blog, we learned to create a module<\/a> in Opencart. Now, we learn to build a simple module in Opencart. Shipping is one of the major parts of an e-commerce website. So, we must learn this part for the Opencart.<\/p>\n\n\n\n

Create A Language File For The Shipping Method <\/strong><\/h2>\n\n\n\n

In Order To Proceed, you will need to create a new Language file for your module. Subsequently, a file called “my_shipping.php” will be located in the “\/admin\/language\/en-gb\/extension\/shipping\/” directory.<\/p>\n\n\n\n

<?php\n\/**\n * Webkul Software\n * \n * @category Webkul\n * @package Opencart Module Tutorial\n * @author [Webkul] <[<http:\/\/webkul.com\/>]>\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\n\/\/ Heading\n$_['heading_title']    = 'My Shipping';\n\n\/\/ Text\n$_['text_extension']   = 'Extensions';\n$_['text_success']     = 'Success: You have modified My shipping!';\n$_['text_edit']        = 'Edit My Shipping';\n\n\/\/ Entry\n$_['entry_cost']       = 'Cost';\n$_['entry_tax_class']  = 'Tax Class';\n$_['entry_status']     = 'Status';\n$_['entry_sort_order'] = 'Sort Order';\n\n\/\/ Error\n$_['error_permission'] = 'Warning: You do not have permission to modify My shipping!';<\/pre>\n\n\n\n
Create A Controller File For The Shipping Method <\/strong><\/h2>\n\n\n\n
In Order To Proceed, you will need to create a new PHP Controller file. As a result, you can create a file called “my_shipping.php” in the “\/admin\/controller\/extension\/shipping\/” directory.<\/p>\n\n\n\n
<?php\n\/**\n * Webkul Software\n * \n * @category Webkul\n * @package Opencart Module Tutorial\n * @author [Webkul] <[<http:\/\/webkul.com\/>]>\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n *\/\nclass ControllerExtensionShippingMyShipping extends Controller\n{\n    private $error = array();\n\n    public function index()\n    {\n        $this->load->language('extension\/shipping\/my_shipping');\n\n        $this->document->setTitle($this->language->get('heading_title'));\n\n        $this->load->model('setting\/setting');\n\n        if (($this->request->server['REQUEST_METHOD'] == 'POST') && $this->validate()) {\n            $this->model_setting_setting->editSetting('shipping_my_shipping', $this->request->post);\n\n            $this->session->data['success'] = $this->language->get('text_success');\n\n            $this->response->redirect($this->url->link('marketplace\/extension', 'user_token=' . $this->session->data['user_token'] . '&type=shipping', true));\n        }\n\n        if (isset($this->error['warning'])) {\n            $data['error_warning'] = $this->error['warning'];\n        } else {\n            $data['error_warning'] = '';\n        }\n\n        $data['breadcrumbs'] = array();\n\n        $data['breadcrumbs'][] = array(\n            'text' => $this->language->get('text_home'),\n            'href' => $this->url->link('common\/dashboard', 'user_token=' . $this->session->data['user_token'], true)\n        );\n\n        $data['breadcrumbs'][] = array(\n            'text' => $this->language->get('text_extension'),\n            'href' => $this->url->link('marketplace\/extension', 'user_token=' . $this->session->data['user_token'] . '&type=shipping', true)\n        );\n\n        $data['breadcrumbs'][] = array(\n            'text' => $this->language->get('heading_title'),\n            'href' => $this->url->link('extension\/shipping\/my_shipping', 'user_token=' . $this->session->data['user_token'], true)\n        );\n\n        $data['action'] = $this->url->link('extension\/shipping\/my_shipping', 'user_token=' . $this->session->data['user_token'], true);\n\n        $data['cancel'] = $this->url->link('marketplace\/extension', 'user_token=' . $this->session->data['user_token'] . '&type=shipping', true);\n\n        if (isset($this->request->post['shipping_my_shipping_cost'])) {\n            $data['shipping_my_shipping_cost'] = $this->request->post['shipping_my_shipping_cost'];\n        } else {\n            $data['shipping_my_shipping_cost'] = $this->config->get('shipping_my_shipping_cost');\n        }\n\n        if (isset($this->request->post['shipping_my_shipping_tax_class_id'])) {\n\t\t\t$data['shipping_my_shipping_tax_class_id'] = $this->request->post['shipping_my_shipping_tax_class_id'];\n\t\t} else {\n\t\t\t$data['shipping_my_shipping_tax_class_id'] = $this->config->get('shipping_my_shipping_tax_class_id');\n\t\t}\n\n\t\t$this->load->model('localisation\/tax_class');\n\n\t\t$data['tax_classes'] = $this->model_localisation_tax_class->getTaxClasses();\n\n        if (isset($this->request->post['shipping_my_shipping_status'])) {\n            $data['shipping_my_shipping_status'] = $this->request->post['shipping_my_shipping_status'];\n        } else {\n            $data['shipping_my_shipping_status'] = $this->config->get('shipping_my_shipping_status');\n        }\n\n        if (isset($this->request->post['shipping_my_shipping_sort_order'])) {\n            $data['shipping_my_shipping_sort_order'] = $this->request->post['shipping_my_shipping_sort_order'];\n        } else {\n            $data['shipping_my_shipping_sort_order'] = $this->config->get('shipping_my_shipping_sort_order');\n        }\n\n        $data['header'] = $this->load->controller('common\/header');\n        $data['column_left'] = $this->load->controller('common\/column_left');\n        $data['footer'] = $this->load->controller('common\/footer');\n\n        $this->response->setOutput($this->load->view('extension\/shipping\/my_shipping', $data));\n    }\n\n    protected function validate()\n    {\n        if (!$this->user->hasPermission('modify', 'extension\/shipping\/my_shipping')) {\n            $this->error['warning'] = $this->language->get('error_permission');\n        }\n\n        return !$this->error;\n    }\n}<\/pre>\n\n\n\n
Create A View File For The Shipping Method <\/strong><\/h2>\n\n\n\n
In Order To Proceed, you will need to create a new PHP Twig file. As a consequence, you can create a file called “my_shipping.php” in the “\/admin\/view\/template\/extension\/shipping\/” directory.<\/p>\n\n\n\n
{#\n * Webkul Software\n * \n * @category Webkul\n * @package Opencart Module Tutorial\n * @author [Webkul] <[<http:\/\/webkul.com\/>]>\n * @copyright Copyright (c) Webkul Software Private Limited (https:\/\/webkul.com)\n * @license https:\/\/store.webkul.com\/license.html\n#}\n{{ header }}{{ column_left }}\n<div id="content">\n  <div class="page-header">\n    <div class="container-fluid">\n      <div class="pull-right">\n        <button type="submit" form="form-shipping" data-toggle="tooltip" title="{{ button_save }}" class="btn btn-primary"><i class="fa fa-save"><\/i><\/button>\n        <a href="{{ cancel }}" data-toggle="tooltip" title="{{ button_cancel }}" class="btn btn-default"><i class="fa fa-reply"><\/i><\/a><\/div>\n      <h1>{{ heading_title }}<\/h1>\n      <ul class="breadcrumb">\n        {% for breadcrumb in breadcrumbs %}\n        <li><a href="{{ breadcrumb.href }}">{{ breadcrumb.text }}<\/a><\/li>\n        {% endfor %}\n      <\/ul>\n    <\/div>\n  <\/div>\n  <div class="container-fluid">\n    {% if error_warning %}\n    <div class="alert alert-danger alert-dismissible"><i class="fa fa-exclamation-circle"><\/i> {{ error_warning }}\n      <button type="button" class="close" data-dismiss="alert">&times;<\/button>\n    <\/div>\n    {% endif %}\n    <div class="panel panel-default">\n      <div class="panel-heading">\n        <h3 class="panel-title"><i class="fa fa-pencil"><\/i> {{ text_edit }}<\/h3>\n      <\/div>\n      <div class="panel-body">\n        <form action="{{ action }}" method="post" enctype="multipart\/form-data" id="form-shipping" class="form-horizontal">\n          <div class="form-group">\n            <label class="col-sm-2 control-label" for="input-cost">{{ entry_cost }}<\/label>\n            <div class="col-sm-10">\n              <input type="text" name="shipping_my_shipping_cost" value="{{ shipping_my_shipping_cost }}" placeholder="{{ entry_cost }}" id="input-cost" class="form-control" \/>\n            <\/div>\n          <\/div>\n          <div class="form-group">\n            <label class="col-sm-2 control-label" for="input-tax-class">{{ entry_tax_class }}<\/label>\n            <div class="col-sm-10">\n              <select name="shipping_my_shipping_tax_class_id" id="input-tax-class" class="form-control">\n                <option value="0">{{ text_none }}<\/option>\n                {% for tax_class in tax_classes %}\n                {% if tax_class.tax_class_id == shipping_my_shipping_tax_class_id %}\n                <option value="{{ tax_class.tax_class_id }}" selected="selected">{{ tax_class.title }}<\/option>\n                {% else %}\n                <option value="{{ tax_class.tax_class_id }}">{{ tax_class.title }}<\/option>\n                {% endif %}\n                {% endfor %}\n              <\/select>\n            <\/div>\n          <\/div> \n          <div class="form-group">\n            <label class="col-sm-2 control-label" for="input-status">{{ entry_status }}<\/label>\n            <div class="col-sm-10">\n              <select name="shipping_my_shipping_status" id="input-status" class="form-control">\n                {% if shipping_my_shipping_status %}\n                <option value="1" selected="selected">{{ text_enabled }}<\/option>\n                <option value="0">{{ text_disabled }}<\/option>\n                {% else %}\n                <option value="1">{{ text_enabled }}<\/option>\n                <option value="0" selected="selected">{{ text_disabled }}<\/option>\n                {% endif %}\n              <\/select>\n            <\/div>\n          <\/div>\n          <div class="form-group">\n            <label class="col-sm-2 control-label" for="input-sort-order">{{ entry_sort_order }}<\/label>\n            <div class="col-sm-10">\n              <input type="text" name="shipping_my_shipping_sort_order" value="{{ shipping_my_shipping_sort_order }}" placeholder="{{ entry_sort_order }}" id="input-sort-order" class="form-control" \/>\n            <\/div>\n          <\/div>\n        <\/form>\n      <\/div>\n    <\/div>\n  <\/div>\n<\/div>\n{{ footer }}<\/pre>\n\n\n\n
So, we have completed building our simple shipping module. now, we will install the shipping by heading to Extensions-> Extensions-> Shipping-> My Shipping<\/strong> from the admin panel, and after installing you can configure the shipping by enabling it.<\/p>\n\n\n\n
\"Installed<\/figure>\n\n\n\n
Configuration<\/strong><\/h2>\n\n\n\n
Therefore, the admin can easily set the module as per the business requirement by navigating via “Extensions-> Extensions-> Shipping-> My Shipping<\/strong>“.<\/p>\n\n\n\n
Once you have installed the My Shipping Module, you can then edit the module and add the Shipping Cost.<\/p>\n\n\n\n
\"My<\/figure>\n\n\n\n