Get Product Collection Using GraphQL Magento

In this blog, you can see how to get all the product collections using GraphQL in Magento 2.

Contents hide

5 Now, execute the following commands:

6 Thank You!

Step 1:

First of all, we need to create a registration.php file in app/code/Webi/GraphQL/ directory to register our module by adding the following code.

<?php
\Magento\Framework\Component\ComponentRegistrar::register(
   \Magento\Framework\Component\ComponentRegistrar::MODULE,
   'Webi_GraphQL',
   __DIR__
);

<?php

\Magento\Framework\Component\ComponentRegistrar::register(

\Magento\Framework\Component\ComponentRegistrar::MODULE,

'Webi_GraphQL',

__DIR__

);

Step 2:

Now, we need to create a module.xml file in app/code/Webi/GraphQL/etc/ directory and add the following code.

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
   <module name="Webi_GraphQL">
       <sequence>
           <module name="Magento_Sales"/>
           <module name="Magento_GraphQl"/>
       </sequence>
   </module>
</config>

<?xml version="1.0"?>

</sequence>

</module>

</config>

Step 3:

In this step is now to create schema.graphqls file in app/code/Webi/GraphQL/etc/ directory and add the following code.

app/code/Webi/GraphQL/etc/ directory and add the following code.

type Query {
    productCollection: ProductCollection @resolver(class:   "Webi\\GraphQL\\Model\\Resolver\\ProductsResolver")      @doc(description: "Get Product collection of a store")
}

type ProductCollection @doc(description: "product collection") {
    allProducts: [ProductRecord] @doc(description: "Product records with sku,name and price")
}
type ProductRecord {
    id: Int @doc(description: "To get Product Id")
    sku: String @doc(description: "To get Product sku")
    name: String @doc(description: "To get Product name")
    price: Float @doc(description: "To get Product price")
}

type Query {

productCollection: ProductCollection @resolver(class: "Webi\\GraphQL\\Model\\Resolver\\ProductsResolver") @doc(description: "Get Product collection of a store")

}

type ProductCollection @doc(description: "product collection") {

allProducts: [ProductRecord] @doc(description: "Product records with sku,name and price")

}

type ProductRecord {

id: Int @doc(description: "To get Product Id")

sku: String @doc(description: "To get Product sku")

name: String @doc(description: "To get Product name")

price: Float @doc(description: "To get Product price")

}

Step 4:

Lastly, we need to create ProductsResolver.php as a resolver file in app/code/Webi/GraphQL/Model/Resolver/ and add the following code.

<?php
namespace Webi\GraphQL\Model\Resolver;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Framework\GraphQl\Config\Element\Field;
use Magento\Framework\GraphQl\Exception\GraphQlInputException;
use Magento\Framework\GraphQl\Exception\GraphQlNoSuchEntityException;
use Magento\Framework\GraphQl\Query\ResolverInterface;
use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;

class ProductsResolver implements ResolverInterface
{
    public function __construct(
        \Magento\Catalog\Api\ProductRepositoryInterface $productRepository,
        \Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder
    ) {
        $this->productRepository = $productRepository;
        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
    }


    public function resolve(
        Field $field,
        $context,
        ResolveInfo $info,
        array $value = null,
        array $args = null
    ) {
        $productsData = $this->getProductsData();
        return $productsData;
    }

    private function getProductsData()
    {
        try {
            /* filter for all the pages */
            $searchCriteria = $this->searchCriteriaBuilder->addFilter('entity_id', 1,'gteq')->create();
            $products = $this->productRepository->getList($searchCriteria)->getItems();
            $productRecord['allProducts'] = [];
            foreach($products as $product) {
                $productId = $product->getId();
                $productRecord['allProducts'][$productId]['id'] = $product->getId();
                $productRecord['allProducts'][$productId]['sku'] = $product->getSku();
                $productRecord['allProducts'][$productId]['name'] = $product->getName();
                $productRecord['allProducts'][$productId]['price'] = $product->getPrice();
            }
        } catch (NoSuchEntityException $e) {
            throw new GraphQlNoSuchEntityException(__($e->getMessage()), $e);
        }
        return $productRecord;
    }
}

<?php

namespace Webi\GraphQL\Model\Resolver;

use Magento\Framework\Exception\NoSuchEntityException;

use Magento\Framework\GraphQl\Config\Element\Field;

use Magento\Framework\GraphQl\Exception\GraphQlInputException;

use Magento\Framework\GraphQl\Exception\GraphQlNoSuchEntityException;

use Magento\Framework\GraphQl\Query\ResolverInterface;

use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;

class ProductsResolver implements ResolverInterface

{

public function __construct(

\Magento\Catalog\Api\ProductRepositoryInterface $productRepository,

\Magento\Framework\Api\SearchCriteriaBuilder $searchCriteriaBuilder

) {

$this->productRepository = $productRepository;

$this->searchCriteriaBuilder = $searchCriteriaBuilder;

}

public function resolve(

Field $field,

$context,

ResolveInfo $info,

array $value = null,

array $args = null

) {

$productsData = $this->getProductsData();

return $productsData;

}

private function getProductsData()

{

try {

/* filter for all the pages */

$searchCriteria = $this->searchCriteriaBuilder->addFilter('entity_id', 1,'gteq')->create();

$products = $this->productRepository->getList($searchCriteria)->getItems();

$productRecord['allProducts'] = [];

foreach($products as $product) {

$productId = $product->getId();

$productRecord['allProducts'][$productId]['id'] = $product->getId();

$productRecord['allProducts'][$productId]['sku'] = $product->getSku();

$productRecord['allProducts'][$productId]['name'] = $product->getName();

$productRecord['allProducts'][$productId]['price'] = $product->getPrice();

}

} catch (NoSuchEntityException $e) {

throw new GraphQlNoSuchEntityException(__($e->getMessage()), $e);

}

return $productRecord;

}

Now, execute the following commands:

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f en_US
php bin/magento cache:flush
php bin/magento cache:clean
php bin/magento indexer:reindex

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy -f en_US

php bin/magento cache:flush

php bin/magento cache:clean

php bin/magento indexer:reindex

Now, you need to pass the query required data in the Request Body.

{
  productCollection{
    allProducts{
      id
      name
      price
      sku
    }
  }
}

{

productCollection{

allProducts{

name

price

sku

}

We hope this post is very helpful to you.

Thank You!

Hit 5 Stars if you find this post helpful

0 (based on 0 Reviews)