Learn How to Add Custom Parameter in Magento 2 Order API

Magento 2 APIs empower developers and integrators to seamlessly connect Magento 2 with external systems, including CRM, ERP, CMS, PIM, POS, shopping apps, and more. By default, Magento 2 does not include custom order attributes in the Sales Order API. And therefore, in this blog, we are going to explain you, how you can include custom parameter (external order id and channel) in Magento 2 Order API, which you can get or set in order by using Magento Order API.

As explained earlier, in Magento, we have to develop custom modules in order to add any extra feature as per your requirements. So, you have to create a module to implement this feature.

Here, I am skipping the basic Module structure.

You have to create a Registration.php and module.xml before using the codes below.

Create extension_attributes.xml in app\code\Ids\CheckOrder\etc\

In order to add external_order_id and channel in Order API, we have to create extension attributes, we will use these attributes to send parameters from Quote to Order.

<?xml version=”1.0″?>

<config xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xsi:noNamespaceSchemaLocation=

“urn:magento:framework:Api/etc/extension_attributes.xsd”>

    <extension_attributes for=”Magento\Sales\Api\Data\OrderInterface”>

        <attribute code=”external_order_id” type=”string”/>

        <attribute code=”channel” type=”string”/>

    </extension_attributes>

</config>

Create di.xml in app\code\Ids\CheckOrder\etc\

Further, we will create di.xml to create OrderRepositoryPlugin and we are creating this Plugin to inject custom parameter data to order API.

<?xml version=”1.0″ ?>

<config xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xsi:noNamespaceSchemaLocation=

“urn:magento:framework:ObjectManager/etc/config.xsd”>

                <preference for=”Ids\CheckOrder\Api\ExternalOrdersManagementInterface” type=”Ids\CheckOrder\Model\Api\ExternalOrdersManagement”/>      

    <type name=”Magento\Sales\Api\OrderRepositoryInterface”>

        <plugin name=”checkorder_add_order_extension_attribute”

                type=”Ids\CheckOrder\Plugin\OrderRepositoryPlugin” />

    </type>          

</config>

Create OrderRepositoryPlugin.php in app\code\Ids\CheckOrder\Plugin\

Here, we will inject our custom parameters in Order API by using two methods afterGet and afterGetList. afterGet is used to set custom parameters and afterGetList is used to get custom parameters.

The next step is to empty the generated folder under your Magento 2 root directory before testing.

The last step involves testing the created API and then making it live. There are certain benefits that APIs offer when used. They help with enhanced integration and helps with advanced user engagement as well. Custom API can also contribute to increase the efficiency by automating tasks and reducing the manual intervention in any task.

Added to that, custom order attributes Magento 2 also helps to add scalability in the service. It also ensures service scalability

 
<?php
namespace Ids\CheckOrder\Plugin;

use Magento\Sales\Api\Data\OrderExtensionFactory;

use Magento\Sales\Api\Data\OrderExtensionInterface;

use Magento\Sales\Api\Data\OrderInterface;

use Magento\Sales\Api\Data\OrderSearchResultInterface;

use Magento\Sales\Api\OrderRepositoryInterface;

 

/**

 * Class OrderRepositoryPlugin

 */

class OrderRepositoryPlugin

{

    /**

     * Order external order id field name

     */

    const FIELD_EXTERNAL_ORDER_ID = ‘external_order_id’;

    const FIELD_CHANNEL = ‘channel’;

 

    /**

     * Order Extension Attributes Factory

     *

     * @var OrderExtensionFactory

     */

    protected $extensionFactory;

 

    /**

     * OrderRepositoryPlugin constructor

     *

     * @param OrderExtensionFactory $extensionFactory

     */

    public function __construct(OrderExtensionFactory $extensionFactory)

    {

        $this->extensionFactory = $extensionFactory;

    }

    /**

     * Add “external_order_id” extension attribute to order data object to make it accessible in API data

     *

     * @param OrderRepositoryInterface $subject

     * @param OrderInterface $order

     *

     * @return OrderInterface

     */

    public function afterGet(OrderRepositoryInterface $subject, OrderInterface $order)

    {

        $externalOrderId = $order->getData(self::FIELD_EXTERNAL_ORDER_ID);

        $orderChannel = $order->getData(self::FIELD_CHANNEL);

        $extensionAttributes = $order->getExtensionAttributes();

        $extensionAttributes = $extensionAttributes ? $extensionAttributes : $this->extensionFactory->create();

        $extensionAttributes->setExternalOrderId($externalOrderId);

        $extensionAttributes->setChannel($orderChannel);

        $order->setExtensionAttributes($extensionAttributes);

        return $order;

    }

    /**

     * Add “external_order_id” extension attribute to order data object to make it accessible in API data

     *

     * @param OrderRepositoryInterface $subject

     * @param OrderSearchResultInterface $searchResult

     *

     * @return OrderSearchResultInterface

     */

    public function afterGetList(OrderRepositoryInterface $subject, OrderSearchResultInterface $searchResult)

    {   $orders = $searchResult->getItems();

        foreach ($orders as &$order) {

            $externalOrderId = $order->getData(self::FIELD_EXTERNAL_ORDER_ID);

                                                $orderChannel = $order->getData(self::FIELD_CHANNEL);

            $extensionAttributes = $order->getExtensionAttributes();

            $extensionAttributes = $extensionAttributes ? $extensionAttributes : $this->extensionFactory->create();

            $extensionAttributes->setExternalOrderId($externalOrderId);

                                                $extensionAttributes->setChannel($orderChannel);

            $order->setExtensionAttributes($extensionAttributes);

        }

        return $searchResult;

    }         

public function beforeSave(

        \Magento\Sales\Api\OrderRepositoryInterface $subject,

        \Magento\Sales\Api\Data\OrderInterface $resultOrder

    ) {       

                                $extensionAttributes = $resultOrder->getExtensionAttributes();

                                if (

                                                null !== $extensionAttributes &&

                                                 (null !== $extensionAttributes->getExternalOrderId() || null !== $extensionAttributes->getChannel())

                                ) {                                           

            $resultOrder->setExternalOrderId($extensionAttributes->getExternalOrderId());

                                                $resultOrder->setChannel($extensionAttributes->getChannel());                                           

                                }

        return [$resultOrder];

    }         

}

Did You Know: How to Use the Declarative Schema in Magento 2? Here is a Guide

Contributed By:

Sharika Dubey