# mageplaza/module-shop-by-brand-graphql

> Magento 2 Shop By Brand GraphQl Extension

`composer require mageplaza/module-shop-by-brand-graphql`

Canonical URL: https://packagento.com/mageplaza/module-shop-by-brand-graphql

## At a glance

- **Vendor**: mageplaza (https://packagento.com/mageplaza.md)
- **Latest version**: 1.0.4 — released 2022-02-22
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/mageplaza/module-shop-by-brand-graphql and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require mageplaza/module-shop-by-brand-graphql:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Magento 2 Shop By Brand GraphQl Extension

## README


**Magento 2 Shop By Brand GraphQL is now a part of Mageplaza Shop By Brand extension that supports GraphQL features.** This supports PWA compatibility with a lot of advantages and convenience. The extension supports getting and pushing data on the website with GraphQl, this support for PWA Studio.

[Mageplaza Shop By Brand for Magento 2](https://www.mageplaza.com/magento-2-shop-by-brand/) enables you to create a separate page to display brands that have products available in your store. 

With this kind of showcasing brands, customers who prefer shopping by brand will quickly find the brands they are looking for. When customers type in some first character of their favorite brand in the instant search box, the suggested brands will appear at the drop-down, so you can swiftly pick up your favorite and go to more details of the brand. 

With each brand page, there will be essential information included, such as brand description, product description, price, rating, and other attributes. Brand logos can be displayed on the product page as well so that it’s easier for customers to identify their favorite brands. Shop By Brand is integrated with Mageplaza Layered Navigation. Customers can use brand as a product attribute to filter the products they want to buy from a specific brand. 

Based on your store’ scale and customers’ demand, you can add as many brands as you want to your store's brand page at once without manual processing one by one. You only need one click to bulk import various brands via a CSV file. The brands will be updated automatically to the brand page with complete information and brand images. 

The extension supports you in creating brand listing and brand pages with SEO-friendly URL and custom meta tags. Your pages will be more likely to rank higher on the search engine results page and let more customers know about this exciting feature of your store. 

### 1. How to install

Run the following command in Magento 2 root folder:

```
composer require mageplaza/module-shop-by-brand-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
```

**Note:**
Mageplaza Shop By Brand GraphQL requires installing [Mageplaza Shop By Brand](https://www.mageplaza.com/magento-2-shop-by-brand/) in your Magento installation.

### 2. How to use

To perform GraphQL queries in Magento, please do the following requirements:

- Use Magento 2.3.x or higher. Set your site to [developer mode](https://www.mageplaza.com/devdocs/enable-disable-developer-mode-magento-2.html).
- Set GraphQL endpoint as `http://<magento2-server>/graphql` in url box, click **Set endpoint**. 
(e.g. `http://dev.site.com/graphql`)
- To view the queries that the **Mageplaza Shop By Brand GraphQL** extension supports, you can look in `Docs > Query` in the right corner

### 3. Devdocs

- [Shop By Brand API & examples](https://documenter.getpostman.com/view/10589000/SzRxXr2x?version=latest)
- [Shop By Brand GraphQL & examples](https://documenter.getpostman.com/view/10589000/SzRxXr2y?version=latest)

Click on Run in Postman to add these collections to your workspace quickly.

![Magento 2 blog graphql pwa](https://i.imgur.com/lhsXlUR.gif)

### 4. Contribute to this module

Feel free to **Fork** and contribute to this module and create a pull request so we will merge your changes main branch.

### 5. Get Support

- Feel free to [contact us](https://www.mageplaza.com/contact.html) if you have any further questions.
- Like this project, Give us a **Star** ![star](https://i.imgur.com/S8e0ctO.png)

## Changelog

CHANGELOG: https://www.mageplaza.com/releases/shop-by-brand

## Recent Versions

| Version | Released |
|---|---|
| 1.0.4 | 2022-02-22 |
| 1.0.3 | 2021-12-10 |
| 1.0.2 | 2020-10-30 |
| 1.0.1 | 2020-10-26 |
| 1.0.0 | 2020-02-27 |

## Quality

Latest release (1.0.4) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 1 | 1 | – | – |
| 2.4.8 | – | 1 | 1 | – |
| 2.4.9 | – | – | 1 | 1 |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 21 | 21 warnings (ruleset: Magento2) — 20 auto-fixable with phpcbf |
| PHPMD | Warning | 4 | 4 rule violations (CyclomaticComplexity:1, NPathComplexity:1, UnusedLocalVariable:1, UnusedFormalParameter:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 63 | 63 | – | – |
| 2.4.8 | – | 63 | 77 | – |
| 2.4.9 | – | – | 77 | 77 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["mageplaza/module-shop-by-brand-graphql"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

mageplaza is a Magento 2 vendor on Packagento. See https://packagento.com/mageplaza.md for their full catalogue.