Magento 2 REST API – Get Orders with Products’ Custom Attributes

apimagento2ordersrestsearch-criteria

I would like to have the proper cURL command for getting all pending orders with the products' custom attributes in Magento 2 REST API.
I use this, but there are no custom attributes on the products in the result.

curl -X GET -H "Authorization: Bearer xxxxxxxxxxxxxxxxxxxx" -H "Cache-Control: no-cache" 'http://xxxxxx.xxx/index.php/rest/V1/orders?searchCriteria[filter_groups][0][filters][0][field]=status&searchCriteria[filter_groups][0][filters][0][value]=pending'

What am I doing wrong? I get everything but not the product attributes and the custom product attributes.

Best Answer

One order can contain multiple products, which are represented as order items in the context of order. With order APIs you cannot get order list with order items in one request. But it can be done as follows:

Get list of order IDs which you are interested in (e.g. using request provided in the question)
To get product details use \Magento\Sales\Api\OrderItemRepositoryInterface::getList($searchCriteria). Via REST it is available as GET <base_url>/V1/orders/items. Iterate through orders from the previous step and for each one get its items, in search criteria specify filter by order ID

Related Solutions

Magento 2 – Filtering Data in REST API

It is better to use search API (rest/V1/search), is faster because based on index tables, and then load full information about products returned from search using product repository (rest/V1/products).

You would have a list of product IDs returned by search API and in filter can be used when creating search criteria for rest/V1/products, this will make URL shorter. However, request URL for Search API would still be long.

There is no way to reduce URL length except for introducing alternative POST or PUT endpoing in your module (VendorName/ModuleName/etc/webapi.xml). Then you should be able to specify filters in request body.

<?xml version="1.0"?>
<routes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Webapi:etc/webapi.xsd">
    <route url="/V1/searchProducts" method="POST">
        <service class="Magento\Catalog\Api\ProductRepositoryInterface" method="getList"/>
        <resources>
            <resource ref="anonymous" />
        </resources>
    </route>
</routes>

Magento 2 API – How to Use V1/search to Get Product Names and SKUs

Use V1/products instead of V1/search and add fields=items[sku],items[name] GET parameter to the request URL. This allows to get only requested fields in the response.

Best Answer

Related Solutions

Magento 2 – Filtering Data in REST API

Magento 2 API – How to Use V1/search to Get Product Names and SKUs

Related Topic