Magento – Unable to get order details using magento 2 rest api

magento2order-gridordersrest apisales-order

I have created an order in magento 2. And magento gave me this message

"Your order number is: 000000235. We'll email you an order
confirmation with details and tracking info."

Screen shot is also attached,

Then I tried to fetch the order details using rest api endpoint rest/V1/orders/235 in salesOrderRepositoryV1 on http://devdocs.magento.com/swagger/#/

My request as shown in screenshot,

but everytime i get this,

{
"message": "Requested entity doesn't exist"
}

Just for the reference screen shot of admin panel->sales->orders is also attached that i am fetching the details against the valid order id.

I investigated this isssue, here are some of my findings,

This is not happening with all the orders.
Its due to the difference between entity_id and increment_id in sales_order table.
For most of the old orders(those i created earlier) everything is working fine but for most recent orders this issue is occuring(for which i have different entity_id and increment_id(magento gives us this id at success page)
I need to pass in increment_id in rest/V1/orders/{id} but this endpoint point to entity_id in the sales_order table

Why i have difference in my entity_id and increment_id? In sales_order table i have same entity_id and increment_id for the first 165 orders(i.e entity_id = increment_id) then form entity_id 166 my increment_id became 179. Why this difference came in suddenly.

Can anyone please explain?

Best Answer

Its not mandatory that entity_id of sales_order table and increment_id of sales_order table are same.

entity_id field should be auto incremented ,so it may be differ when you delete any specific order manually and its used as foreign key in sales_order_item table to identify how many items each order have.

Meanwhile you must need to pass increment_id with orders api , But your url should be like this http://os.mydomain.com/index.php/rest/V1/orders/000000003

here 000000003 this is my increment_id

Then pass Authorization Bearer accesstoken in headers

It will works for all orders.

Related Solutions

Magento2.3 REST API – Get Order Entity ID from Increment ID

For your requirements, you have to use order search api point

http://<magento_host>/rest/V1/orders

and use GET and perform the Search

GET <host>/rest/<store_code>/V1/orders/?
searchCriteria[filter_groups][0][filters][0][field]=increment_id&
searchCriteria[filter_groups][0][filters][0][value]={YOURFIELDVALUE}&
searchCriteria[filter_groups][0][filters][0][condition_type]=eq`

Magento – Magento 2 Rest API get order details from customer id

Please find a script that is standolone and can be placed anywhere within your magento files, on my environment it is in the folder

<magento-root>/app/code/Mbs/OrderRepositoryExtension/shell/getlistordersbycustomerid.php 



<?php
    
    $path = __DIR__ . '/../';
    
    while (!file_exists($path. '/vendor/autoload.php') && $i++ < 15) {
        $path .= '../';
    }
    require ($path. '/vendor/autoload.php');
    
    $path = __DIR__ . '/../';
    $zendLibrary = 'vendor/zendframework/zend-http/src/';
    $i = 0;
    
    while (!file_exists($path. $zendLibrary . 'Headers.php') && $i++ < 15) {
        $path .= '../';
    }
    
    require_once $zendLibrary . 'Headers.php';
    require_once $zendLibrary . 'Request.php';
    require_once $zendLibrary . 'Response.php';
    
    
    error_reporting(E_ALL);
    ini_set('display_errors', 1);
    
    // \Magento\Webapi\Model\ServiceMetadata::getServicesConfig to debug the available webapi services
    $params = ['customer_id' => null];
    foreach ($argv as $arg) {
        if (preg_match("%^--(.*?)=(.*?)$%", $arg, $m)) {
            $params[$m[1]] = $m[2];
        }
    }
    
    if (!$params['customer_id'])
        exit("Specify customer id (as --customer_id=_ID_ parameter)\n");
    
    $customer_id = $params['customer_id'];
    
    $token = 'or7ozb3e97x19nk97zylmhspul7niqi3';
    $httpHeaders = new \Zend\Http\Headers();
    $httpHeaders->addHeaders([
        'Authorization' => 'Bearer ' . $token,
        'Accept' => 'application/json',
        'Content-Type' => 'application/json'
    ]);
    
    $request = new \Zend\Http\Request();
    $request->setHeaders($httpHeaders);
    $request->setUri('http://magecertif.test/index.php/rest/V1/orders');
    $request->setMethod(\Zend\Http\Request::METHOD_GET);
    
    //searchCriteria[filterGroups][0][filters][0][field]=created_at&searchCriteria[filterGroups][0][filters][0][value]=2020-06-28&searchCriteria[filterGroups][0][filters][0][conditionType]=gt&searchCriteria[filterGroups][1][filters][0][field]=created_at&searchCriteria[filterGroups][1][filters][0][value]=2020-06-29&searchCriteria[filterGroups][1][filters][0][conditionType]=lt
    
    $params = new \Zend\Stdlib\Parameters([
        'searchCriteria' => [
            'filterGroups' => [
                0 => [
                    'filters' => [
                        0 => [
                            'field' => 'customer_id',
                            'value' => $customer_id,
                            'condition_type' => 'eq'
                        ]
                    ]
                ]
            ],
            'current_page' => 1,
            'page_size' => 10
        ],
    ]);
    
    $request->setQuery($params);
    
    $client = new \Zend\Http\Client();
    $options = [
        'adapter'   => 'Zend\Http\Client\Adapter\Curl',
        'curloptions' => [CURLOPT_FOLLOWLOCATION => true],
        'maxredirects' => 0,
        'timeout' => 30
    ];
    
    $client->setOptions($options);
    
    $response = $client->send($request);
    
    echo $response->getBody();

to call this script: open a terminal and at the root of your magento install, hit php <script_location>/getlistordersbycustomerid.php --customer_id=1

on my environment: php app/code/Mbs/OrderRepositoryExtension/shell/getlistordersbycustomerid.php --customer_id=1

Best Answer

Related Solutions

Magento2.3 REST API – Get Order Entity ID from Increment ID

Magento – Magento 2 Rest API get order details from customer id

Related Topic