Magento 2 API filter products by Qty

Question

I am trying to get products data having qty >=5 and I tried following options in Search Criteria

/rest/default/V1/products?searchCriteria[page_size]=20&searchCriteria[filter_groups][0][filters][0][field]=stock_item[qty]&searchCriteria[filter_groups][0][filters][0][value]=5&searchCriteria[filter_groups][0][filters][0][condition_type]=gteq

/rest/default/V1/products?searchCriteria[page_size]=20&searchCriteria[filter_groups][0][filters][0][field]=qty&searchCriteria[filter_groups][0][filters][0][value]=5&searchCriteria[filter_groups][0][filters][0][condition_type]=gteq

/rest/default/V1/products?searchCriteria[page_size]=20&searchCriteria[filter_groups][0][filters][0][field]=extension_attributes[qty]&searchCriteria[filter_groups][0][filters][0][value]=5&searchCriteria[filter_groups][0][filters][0][condition_type]=gteq

/rest/default/V1/products?searchCriteria[page_size]=20&searchCriteria[filter_groups][0][filters][0][field]=extension_attributes[stock_item[qty]]&searchCriteria[filter_groups][0][filters][0][value]=5&searchCriteria[filter_groups][0][filters][0][condition_type]=gteq

/rest/default/V1/products?searchCriteria[page_size]=20&searchCriteria[filter_groups][0][filters][0][field]=extension_attributes[stock_item][qty]&searchCriteria[filter_groups][0][filters][0][value]=5&searchCriteria[filter_groups][0][filters][0][condition_type]=gteq

but none of them is working for me, I have magento version 2.3.3 , having MSI but only 1 source.

and all are giving error as:

The "%1" attribute name is invalid. Reset the name and try again.

Answer 1

You need to create a custom filter to get product collection by REST API with the QTY filter. Please make the below files in the module.

app/code/Vendor/Module/etc/di.xml

<virtualType name="Magento\Catalog\Model\Api\SearchCriteria\CollectionProcessor\ProductFilterProcessor" type="Magento\Eav\Model\Api\SearchCriteria\CollectionProcessor\FilterProcessor">
    <arguments>
        <argument name="customFilters" xsi:type="array">
            <item name="qty" xsi:type="object">Vendor\Module\Model\Api\SearchCriteria\CollectionProcessor\FilterProcessor\ProductQtyFilter</item>
        </argument>
    </arguments>
</virtualType>

app/code/Vendor/Module/Model/Api/SearchCriteria/CollectionProcessor/FilterProcessor/ProductQtyFilter.php

<?php
namespace Vendor\Module\Model\Api\SearchCriteria\CollectionProcessor\FilterProcessor;

use Magento\Catalog\Model\ResourceModel\Product\Collection;
use Magento\Framework\Api\Filter;
use Magento\Framework\Api\SearchCriteria\CollectionProcessor\FilterProcessor\CustomFilterInterface;
use Magento\Framework\Data\Collection\AbstractDb;

class ProductQtyFilter implements CustomFilterInterface
{
    /**
     * Apply QTY Filter to Product Collection
     *
     * @param Filter $filter
     * @param AbstractDb $collection
     * @return bool Whether the filter is applied
     */
    public function apply(Filter $filter, AbstractDb $collection)
    {
        $value = $filter->getValue();
        $conditionType = $filter->getConditionType() ?: 'in';

        /** @var Collection $collection */
        $collection->joinField(
            'qty', 'cataloginventory_stock_status', 'qty', 'product_id=entity_id', '{{table}}.stock_id=1', 'left'
        )->addFieldToFilter('qty', array($conditionType => $value));

        return true;
    }
}

Now you can use the REST API with the QTY filter like below.

/rest/default/V1/products?searchCriteria[page_size]=20&searchCriteria[filter_groups][0][filters][0][field]=qty&searchCriteria[filter_groups][0][filters][0][value]=5&searchCriteria[filter_groups][0][filters][0][condition_type]=gteq

I hope this will work for you.

Answer 2

There is no such API on Magento default.

You can write your own API that allows product searching according to a certain qty that you want.

Answer 3

I think that you will first have to extract the SKUs with the endpoint inventory/source-items and then do another request to get the product data.

/rest/default/V1/inventory/source-items/?searchCriteria[page_size]=20&searchCriteria[filter_groups][0][filters][0][field]=quantity&searchCriteria[filter_groups][0][filters][0][value]=5&searchCriteria[filter_groups][0][filters][0][condition_type]=gteq

Reference from ReDoc: https://magento.redoc.ly/2.3.6-admin/tag/productsproductSkustockItemsitemId#operation/inventoryApiSourceItemRepositoryV1GetListGet

I couldn't find any direct way to retrieve the data. So you ether chain 2 calls and parse the response from the first one to the second one, or you write your own custom REST method.