How to cancel order Programmatically without disabling URL security key in Magento 2?

Hello Magento Friends 👋,

How are you doing? Today I am going to explain How to cancel order Programmatically without disabling URL security key in Magento 2?. In case you missed out on the previously published blog, it is right here. Magento 2: How To Display Count Of Product with Page Title on Category Page.

Whenever the admin tries to cancel an order from the controller using order ID, it is required to disable the URL security key from Magento 2 admin configuration. Thereby, I am here with the code to cancel order programmatically without disabling  URL security key in Magento 2. Let’s get started 🚀

Steps to cancel order Programmatically without disabling URL security key in Magento 2:

Step 1: Navigate to the following path:

app/code/VENDOR/EXTENSION/Controller/Adminhtml/Order/Cancel.php

And add the below code:

namespace VENDOR\EXTENSION\Controller\Adminhtml\Order;

use Magento\Framework\App\Action\HttpGetActionInterface;
use Magento\Sales\Controller\Adminhtml\Order\Cancel as CancelOrderController;

class Cancel extends CancelOrderController implements HttpGetActionInterface
{
    public function execute()
    {
        $resultRedirect = $this->resultRedirectFactory->create();

        $order = $this->_initOrder();
        if ($order)
        {
            try
            {
                $this->orderManagement->cancel($order->getEntityId());
                $this->messageManager->addSuccessMessage(__('You canceled the order.'));
            } 
            catch (\Magento\Framework\Exception\LocalizedException $e)
            {
                $this->messageManager->addErrorMessage($e->getMessage());
            }
            catch (\Exception $e)
            {
                $this->messageManager->addErrorMessage(__('You have not canceled the item.'));
                $this->_objectManager->get(\Psr\Log\LoggerInterface::class)->critical($e);
            }
        }
        return $resultRedirect->setPath('sales/order/index');
    }
}

Step 2: Now, move to the following path:

app/code/VENDOR/EXTENSION/view/adminhtml/ui_component/sales_order_grid.xml

Now, add the 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_columns">
        <actionsColumn name="actions" class="VENDOR\EXTENSION\UI\Component\Listing\Column\Actions"/>
    </columns>
</listing>

Step 3: Next, navigate to the following path:

app/code/VENDOR/EXTENSION/UI/Component/Listing/Column/Actions.php

And add the below code:

namespace VENDOR\EXTENSION\UI\Component\Listing\Column;

use Magento\Sales\Ui\Component\Listing\Column\ViewAction;

class Actions extends ViewAction
{
    public function prepareDataSource(array $dataSource)
    {
        $dataSource =  parent::prepareDataSource($dataSource);

        if (isset($dataSource['data']['items']))
        {
            foreach ($dataSource['data']['items'] as & $item)
            {
                if (isset($item['entity_id']))
                {
                    $urlEntityParamName = $this->getData('config/urlEntityParamName') ?: 'entity_id';
                    $item[$this->getData('name')]['cancel'] =
                        [
                            'href' => $this->urlBuilder->getUrl(
                                'cancel/order/cancel',
                                [
                                    $urlEntityParamName => $item['entity_id']
                                ]
                            ),
                            'label' => __('Cancel')
                        ];
                }
            }
        }
        return $dataSource;
    }
}

Step 4: Lastly, navigate to the following path:

app/code/VENDOR/EXTENSION/etc/adminhtml/routes.xml

Finally, add the below code:

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
    <router id="admin">
        <route id="cancel" frontName="cancel">
            <module name="VENDOR_EXTENSION" before="Magento_Sales" />
        </route>
    </router>
</config>

That’s it!

Conclusion:

Hence, hopefully, everyone is able to cancel order Programmatically without disabling URL security key in Magento 2. If you face any hardship while executing the code, kindly mention in the comment section below. Also, share the article with your Magento developer friends. Stay connected!

Happy Coding 😊

Subscribe to Notifications