How to add a custom column in Shipment grid in Magento 2

Before following the below steps, you can create the order attribute and store it into the value.

Step 1: Create module.xml file under app/code/Vendor/Modulename/etc directory and registration.php file under app/code/Vendor/Modulename directory.

Step 2: Create sales_order_shipment_grid.xml file under app/code/Vendor/Modulename/view/adminhtml/ui_component directory with below code

<?xml version="1.0" encoding="UTF-8"?>
<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_shipment_columns">
        <column name="custcolumn" class="Vendor\Modulename\Ui\Component\Listing\Column\Custcolumn">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="filter" xsi:type="string">text</item>
                    <item name="label" xsi:type="string" translate="true">Custom Column</item>
                </item>
            </argument>
        </column>
    </columns>
</listing>

<?xml version="1.0" encoding="UTF-8"?>

<item name="label" xsi:type="string" translate="true">Custom Column</item>

</item>

</argument>

</column>

</columns>

</listing>

Step 3: Create Custcolumn.php ui component class file under app/code/Vendor/Modulename/Ui/Component/Listing/Column directory with below code

<?php
namespace Vendor\Modulename\Ui\Component\Listing\Column;
 
use \Magento\Sales\Api\OrderRepositoryInterface;
use \Magento\Framework\View\Element\UiComponent\ContextInterface;
use \Magento\Framework\View\Element\UiComponentFactory;
use \Magento\Ui\Component\Listing\Columns\Column;
use \Magento\Framework\Api\SearchCriteriaBuilder;
 
class Custcolumn extends Column
{
 
    protected $_orderRepository;
    protected $_searchCriteria;
    protected $_customfactory;
 
    public function __construct(
        ContextInterface $context,
        UiComponentFactory $uiComponentFactory,
        OrderRepositoryInterface $orderRepository,
        SearchCriteriaBuilder $criteria,
        \Magento\Framework\App\ResourceConnection $resource,
        \Magento\Sales\Model\OrderFactory $orderFactory,
        array $components = [], array $data = [])
    {
        $this->_orderRepository = $orderRepository;
        $this->_searchCriteria  = $criteria;
        $this->resource = $resource;
        $this->orderFactory = $orderFactory;
        parent::__construct($context, $uiComponentFactory, $components, $data);
    }
 
    public function prepareDataSource(array $dataSource)
    {
        if (isset($dataSource['data']['items'])) {
            $connection  = $this->resource->getConnection();
            $tableName = $connection->getTableName('sales_shipment_grid'); 
            foreach ($dataSource['data']['items'] as & $item) {
                $order = $this->orderFactory->create()->loadByIncrementId($item["order_increment_id"]);
                if($order->getCustcolumn()){
                    $item['custcolumn'] = $order->getCustcolumn();
                }
            }
        }
        return $dataSource;
    }
}

<?php

namespace Vendor\Modulename\Ui\Component\Listing\Column;

use \Magento\Sales\Api\OrderRepositoryInterface;

use \Magento\Framework\View\Element\UiComponent\ContextInterface;

use \Magento\Framework\View\Element\UiComponentFactory;

use \Magento\Ui\Component\Listing\Columns\Column;

use \Magento\Framework\Api\SearchCriteriaBuilder;

class Custcolumn extends Column

{

protected $_orderRepository;

protected $_searchCriteria;

protected $_customfactory;

public function __construct(

ContextInterface $context,

UiComponentFactory $uiComponentFactory,

OrderRepositoryInterface $orderRepository,

SearchCriteriaBuilder $criteria,

\Magento\Framework\App\ResourceConnection $resource,

\Magento\Sales\Model\OrderFactory $orderFactory,

array $components = [], array $data = [])

{

$this->_orderRepository = $orderRepository;

$this->_searchCriteria = $criteria;

$this->resource = $resource;

$this->orderFactory = $orderFactory;

parent::__construct($context, $uiComponentFactory, $components, $data);

}

public function prepareDataSource(array $dataSource)

{

if (isset($dataSource['data']['items'])) {

$connection = $this->resource->getConnection();

$tableName = $connection->getTableName('sales_shipment_grid');

foreach ($dataSource['data']['items'] as & $item) {

$order = $this->orderFactory->create()->loadByIncrementId($item["order_increment_id"]);

if($order->getCustcolumn()){

$item['custcolumn'] = $order->getCustcolumn();

}

return $dataSource;

}

Fill the below form if you have any Magento programming need.

Add an image programmatically from any url in Magento 2
[crayon-6387b9e59af5c677119150/] Using above fucntion Images can be imported directly from...
Magento 2 : Override the Category view block file
Override view block using di.xml and add the below code...
How to check list of Layout XML called for a specific page in Magento 2?
You can check a list of called layout XML for...
Magento 2 : Setup PWA from Scratch
Follow the below steps to install and set up PWA...
How to remove leading zero’s from the order, invoice and shipment number in Magento 2?
If you want to remove all leading zero's from order,...

Author Info

Hire s. dutt

Let’s have a call

Fill the form & Get Installation Support