Duplicate entry error When getting an order using REST API in Magento

Duplicate entry error When getting an order using REST API in Magento


Suppose you encounter a "duplicate entry" error while trying to retrieve an order using the REST API in Magento. In that case, it means that there is already an entry with the same identifier in the system. This can occur if you're trying to create a new order with an already-used identifier by an existing order. You must ensure each order has a unique identifier to resolve this issue. You can provide a different identifier for the new order or update the existing one with a unique identifier. You will prevent the "duplicate entry" error and allow you to retrieve orders successfully using the REST API.

We will learn in this topic how to solve the REST API bug of Magento 1 while getting the order with Order REST API.

This bug is inside the "Mage_Sales_Model_Api2_Order_Rest" class, and this is an abstract class, so we can't override this via the Magento module override feature in config.xml

We can do this using the "local" code pool of Magento.

We must copy the "Mage_Sales_Model_Api2_Order_Rest" class into Magento's app/code/local/ folder.

Add the following line to the file.


Here is the complete source of the file



abstract class Mage_Sales_Model_Api2_Order_Rest extends Mage_Sales_Model_Api2_Order
    * Retrieve information about specified order item
    * @throws Mage_Api2_Exception
    * @return array
   protected function _retrieve()
       $orderId    = $this->getRequest()->getParam('id');
       $collection = $this->_getCollectionForSingleRetrieve($orderId);

       if ($this->_isPaymentMethodAllowed()) {
       if ($this->_isGiftMessageAllowed()) {
      //Add this line


       $order = $collection->getItemById($orderId);

       if (!$order) {
       $orderData = $order->getData();
       $addresses = $this->_getAddresses(array($orderId));
       $items     = $this->_getItems(array($orderId));
       $comments  = $this->_getComments(array($orderId));

       if ($addresses) {
           $orderData['addresses'] = $addresses[$orderId];
       if ($items) {
           $orderData['order_items'] = $items[$orderId];
       if ($comments) {
           $orderData['order_comments'] = $comments[$orderId];
       return $orderData;

Contact us:+91 8128405131

Email send us at hello@elightwalk.com

Jayram Prajapati
Full Stack Developer

Jayram Prajapati brings expertise and innovation to every project he takes on. His collaborative communication style, coupled with a receptiveness to new ideas, consistently leads to successful project outcomes.

Most Visited Blog

How to add customer last logged in column customer grid in Magento 2?

Easily improve client insights with Magento 2! Learn how to add a 'Last Logged In' column to the customer grid with ease. To optimize client management and personalized experience, follow our step-by-step tutorial.

Read More
How to create a module in Magento 2: Sample Module A Step-by-Step Guide

Embark on Magento 2 journey with confidence! Our step-by-step tutorial module development. Learn how to create a Module to harness the potential of Magento 2 customization for personalized and efficient e-commerce experience.

Blog Info
How to display a child product’s attribute value at a configurable product’s grid panel?

Improve the setup of your Magento! Learn how to dynamically Show a child product's value in a customizable grid panel. Follow our step-by-step instructions for customization and increased product visibility.

Read More