Magento 2 : How to add a column in Order Grid and Order

Following steps explain how to add new column in order and grid tables

1) Add the columns in order, quote and grid tables using declarative schema

2) Add arguments to Magento\Sales\Model\ResourceModel\Order\Grid virtual class that already defined in Magento_Sales di.xml

<virtualType name="Magento\Sales\Model\ResourceModel\Order\Grid">
        <arguments>
            <argument name="columns" xsi:type="array">
                <item name="channel" xsi:type="string">sales_order.channel</item>
            </argument>
        </arguments>
    </virtualType>

3) Create event.xml and Observer class to save the data to quote and order

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="sales_model_service_quote_submit_before">
        <observer name="CheckoutSubmitQuote" instance="Vasan\Order\Observer\SubmitQuote" />
    </event>
</config>

use Magento\Framework\Event\Observer;
use Magento\Framework\Event\ObserverInterface;
use Psr\Log\LoggerInterface;

class SubmitQuote implements ObserverInterface
{
    protected $logger;

    public function __construct(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    public function execute(Observer $observer)
    {
        $this->logger->info('Observer executed for order creation');
        $quote = $observer->getData('quote');
        $order = $observer->getData('order');

        $channel = $quote->getData('channel');
        $this->logger->info('The value of channel before save :' . $channel);

        if ($channel) {
            $order->setData('channel', $channel);
        }
    }
}

4) Add the column in sales_order_grid.xml in ui_component

<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    
    <columns name="sales_order_columns">
        <column name="channel">
            <settings>
                <filter>text</filter>
                <label translate="true">Channel</label>
            </settings>
        </column>
    </columns>
</listing>

vasan

Say thanks2

Last edit

Over 2 years ago

vasan

Keywords

Order, Grid, Order, attribute

Magento 2 : Admin Module Part 2

5.Create Model and Resource model

Address model class extends the AddressInterface and it contains the data object getters setter methods.

<?php
/**
 * Address
 *
 * @copyright Copyright © 2021 Va...

Magento 2 : Admin Module Part 1

1. Create required folders and files for a module

Vasan
--KpsAddress
  --Api
    --Data
      --AddressInterface.php
      --AddressSearchResultsInterface.php
    --AddressRepositoryIn...

How to add a column in magento grid joining other table example shipment grid

Following steps explain how to add additional column in shipment grid by joining tables

1) Add a plugin

<type name="Magento\Framework\View\Element\UiComponent\DataProvider\CollectionFactory">
        <plugin name="antyra_extended_shippi...

Magento2 : Admin Module Part 3

This section contains the edit UI components and layout xml files

Stesps :

Form ui components

create a file kpsaddress_index_lising.xml for grid under ui_component

<?xml version="1.0" encoding="UTF-8"?>
<listing xmlns:xsi="http...

Magento 2 : Data cleaning and import

Following example shows how to clean customer and order records and import customer data from another database

## Following query to identify the name of the attribute and attribute id
select * from  live.eav_attribute where entity_type_i...

Magento 2 : Customer attribute creation

CustomerSetupFactory and Attribute SetFactory classes should be used to create the customer attribute using setup script

<?php


namespace ExamNotes\Chapter10\Setup;

use Magento\Customer\Setup\CustomerSetupFactory;
use Magento\Eav\Setup\Eav...

Magento 2 Notes

1) Non Auto Increment Primary key

The $_isPkAutoIncrement should be assigned as false in resource model, when a primary key of a table is used as non auto increment.

protected $_isPkAutoIncrement = false;

2) Custom Cron Job

F...

Posted by vasan to vasan's deck (2020-12-25 18:04)

Magento 2 : How to add a column in Order Grid and Order

Related cards:

5.Create Model and Resource model

1. Create required folders and files for a module