How can we get stock data in product listing via afterGetList plugin in Magento 2.2.3

Question

Since magento 2.2.3 is displaying out of stock items in product listing, I would like to get the qty attribute in the listing using rest API. I'm using afterGetList plugin.

di.xml

<type name="Magento\Catalog\Api\ProductRepositoryInterface">
    <plugin name="get_product_metrics" type="Custom\Module\Plugin\ProductGet"/>
</type>

Custom/Module/etc/extension_attributes.xml

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
    <extension_attributes for="Magento\Catalog\Api\Data\ProductInterface">
        <attribute code="qty" type="string"/>
    </extension_attributes>
</config>

ProductGet.php

 <?php

namespace Custom\Module\Plugin;

use Magento\Catalog\Api\Data\ProductInterface;

class ProductGet{
protected $productExtensionFactory;
protected $productFactory;

public function __construct(
    \Magento\Catalog\Api\Data\ProductExtensionFactory $productExtensionFactory,
    \Magento\Catalog\Model\ProductFactory $productFactory,
    \Magento\CatalogInventory\Api\StockStateInterface $stockItem,
    \Psr\Log\LoggerInterface $logger,
    \Magento\Store\Model\StoreManagerInterface $storeManager,
    \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryInterface $mediaGallery,
    \Magento\Eav\Model\Config $eavConfig
)
{
    $this->productFactory = $productFactory;
    $this->storeManager = $storeManager;
    $this->logger = $logger;
    $this->stockItem = $stockItem;
    $this->productExtensionFactory = $productExtensionFactory;
    $this->eavConfig = $eavConfig;
    $this->mediaGallery = $mediaGallery;
}

public function afterGet(
    \Magento\Catalog\Api\ProductRepositoryInterface $subject,
    \Magento\Catalog\Api\Data\ProductInterface $product){

    $this->logger->info("Inside AfterGet ");

    $imageUrl = $this->storeManager->getStore()->getBaseUrl(\Magento\Framework\UrlInterface::URL_TYPE_MEDIA);

    if($product->getImage()){
        $product->setCustomAttribute("image", $imageUrl.'catalog/product'.$product->getImage());
    }

    return $product;
}


/**
 * @param \Magento\Catalog\Api\ProductRepositoryInterface $subject
 * @param \Magento\Catalog\Model\ResourceModel\Product\Collection $products
 * @return \Magento\Catalog\Model\ResourceModel\Product\Collection
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
    public function afterGetList(
    \Magento\Catalog\Api\ProductRepositoryInterface $subject,
    $products
    )
    {
        $this->logger->info("list: ".json_encode($products->getItems()));
        /** @var  $product */
        foreach ($products->getItems() as $key => $product) {
            $qty = $this->stockItem->getStockQty($product->getId(), $product->getStore()->getWebsiteId());
            $extensionattributes = $product->getExtensionAttributes();
            $extensionattributes->setQty($qty);
            $product->setExtensionAttributes($extensionattributes);
        }
        return $products;
    }
}

Can anyone help on this? Thanks in advance!

Answer 1

you can add qty attribute using extension_attributes.xml. Here is the code for that

create extension_attributes.xml in etc/ folder of your module.

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">

<extension_attributes for="Magento\Catalog\Api\Data\ProductInterface">
    <attribute code="qty" type="string"/>
</extension_attributes>

and add this code in your afterGetList()

public function afterGetList(
    \Magento\Catalog\Api\ProductRepositoryInterface $subject,
    $products
) {
    foreach ($products->getItems() as $key => $product) {
        $qty = $this->stockItem->getStockQty($product->getId(), $product->getStore()->getWebsiteId());
        $extensionattributes = $product->getExtensionAttributes();
        $extensionattributes->setQty($qty);
        $product->setExtensionAttributes($extensionattributes);
    }
    return $products;
}

You can get more idea from here https://devdocs.magento.com/guides/v2.2/extension-dev-guide/extension_attributes/adding-attributes.html

Hope it will help you.

Answer 2

Instead of using plugin, you can directly copy list.phtml from vendor/magento/module-catalog/view/frontend/templates/product/list.phtml

to

app/design/frontend/vendor/theme/Magento_Catalog/templates/product/list.phtml

and add following code

$_product->getExtensionAttributes()->getStockItem()->getQty();

I am using the same and its perfectly working fine.

Answer 3

You can get each product's qty by using this below code :

foreach ($products->getItems() as $key => $product) {
    $stockItem = $product->getExtensionAttributes()->getStockItem();
    print_r($stockItem->getQty());
}

---

EDIT :

You can set it by this below code :

$product->setStockData(['qty' => $stockItem, 'is_in_stock' => (bool)$stockItem]);
$product->setQuantityAndStockStatus(['qty' => $stockItem, 'is_in_stock' => (bool)$stockItem]);
$product->save();

Hope, It will helpful for you.