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

apimagento2restsearch-criteria

How to use V1/search to get the names and SKU's of the magento products?

I need a text based search to get the names and SKU's of the magento products. While using V1/products API, the response is too much. I just need the name and the SKU, just like google suggestions come up when you type something.

I tried wit the V1/search api but no luck:http://192.168.1.180/magento/index.php/rest/V1/search?searchCriteria[filter_groups][0][filters][0][field]=name&searchCriteria[filter_groups][0][filters][0][value]=%nike%&searchCriteria[filter_groups][0][filters][0][condition_type]=like

Best Answer

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.

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 – Using searchCriteria while searching attributes in magento 2.0

Here is the fix for the "in" problem, this will probably be fixed in next release: https://github.com/magento/magento2/commit/65819d2f61a63e4fa9fc978220f8662ee5472791

Best Answer

Related Solutions

Magento 2 – Filtering Data in REST API

Magento – Using searchCriteria while searching attributes in magento 2.0

Related Topic