# mageplaza/magento-2-free-gifts-graphql

> Magento 2 Free Gifts GraphQl Extension

`composer require mageplaza/magento-2-free-gifts-graphql`

Canonical URL: https://packagento.com/mageplaza/magento-2-free-gifts-graphql

## At a glance

- **Vendor**: mageplaza (https://packagento.com/mageplaza.md)
- **Latest version**: 1.0.1 — released 2021-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/magento-2-free-gifts-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/magento-2-free-gifts-graphql:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Magento 2 Free Gifts GraphQl Extension

## README


Magento 2 Free Gifts will add to your customers' shopping journey a surprise and delight moment. Notably, **Magento Free Gifts GraphQL is a part of the Mageplaza Free Gift extension that adds GraphQL features; this supports PWA studio.**

[Mageplaza Free Gifts for Magento 2](https://www.mageplaza.com/magento-2-free-gifts/) is a handy tool that simplifies the process of giving away free gifts to customers on the online store. 

The biggest advantage of offering free gifts is to improve customer experience and boost sales. Depending on the store owners' purposes or strategies, they can provide customers with free gift when they purchase a specific product. Usually, free gifts can be used to gather customers' attention to a new product or a sale program. Free gifts are an incentive that stimulates customers' purchasing decisions and builds their retention. 

The free gifts are designed to display on the Product page and Shopping Cart page, which is good for store owners to avoid customers from abandoning their carts right before the checkout. In case the free gifts are offered as discount coupons, customers can get the gifts and apply them to their order right away. The extension also enables customers to freely select free gifts and change the gift they choose from the list to get the most like ones. 

The store admin can set the rules to reward gifts to customers based on product attributes and cart attributes. For example, if the cart's subtotal is more than $100, they will be given free gifts. 

Another method is setting the conditions based on the order value of customers to apply the free gifts. In other words, it's determining the prices of gifts, which can be set in three ways: free, discount by percent, and fixed prices. For example, if one's order reaches $1000, he will get one more item free or 20% off for two items. Free shipping is another appealing gift that many customers look for when shopping online, and you can add this offer to your store's gift list on the fly.  

### 1. How to install
Run the following command in Magento 2 root folder:

```
composer require mageplaza/module-free-gifts-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
```
**Note:** Magento 2 Free Gifts GraphQL requires installing [Mageplaza Free Gifts](https://www.mageplaza.com/magento-2-free-gifts/) in your Magento installation. 

### 2. How to use

 To start using **Freegifts GraphQL** in your Magento 2 store, you need to:
 
- Use Magento 2.3.x or higher. Return your site to developer mode
- Set **GraphQL endpoint** as `http://<magento2-3-server>/graphql` in url box, click **Set endpoint**. (e.g. http://develop.mageplaza.com/graphql/ce232/graphql)
- Perform a query in the left cell then click the **Run** button or **Ctrl + Enter** to see the result in the right cell
- Currently, Mageplaza Free Gifts extension support the following queries and mutations:
  - Query `mpFreeGiftsByProductSku`: Help to get the free gift by product SKU
  
  ![](https://imgur.com/z84Dsu4.png)
  - Query `mpFreeGiftsByQuoteItem`: Help to get the free gift by quote item Id
  
  ![](https://imgur.com/1UaIjPY.png)
  - Mutation `mpFreeGiftsAddByGiftId`: Help to add free gift by gift Id
  
  ![](https://imgur.com/eoshg4U.png)
  - Mutations `mpFreeGiftsDeleteByQuoteItem`: Help to delete free gift by quote item Id
  
  ![](https://imgur.com/MnJUP2v.png)
  
### 3. Devdocs
- [Magento 2 Free Gifts API & examples](https://documenter.getpostman.com/view/10589000/SzRyzpwv?version=latest)
- [Magento 2 Free Gifts GraphQL & examples](https://documenter.getpostman.com/view/10589000/SzRyzpwr?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. Documentation

- Installation guide: https://www.mageplaza.com/install-magento-2-extension/#solution-1-ready-to-paste
- User guide: https://docs.mageplaza.com/free-gifts/
- Report a security issue to security@mageplaza.com

### 5. Contribute to this module
Feel free to **Fork** and contribute to this module. 
You can also create a pull request, so we will merge your changes in the main branch. 

### 6. Get Support
- Feel free to contact us if you have any further questions. 
- If you find this project helpful, please give us a **Star** ![star](https://i.imgur.com/S8e0ctO.png)

## Changelog

CHANGELOG: https://www.mageplaza.com/releases/free-gifts/

## Recent Versions

| Version | Released |
|---|---|
| 1.0.1 | 2021-02-22 |
| 1.0.0 | 2020-02-28 |

## Quality

Latest release (1.0.1) 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 | 19 | 19 warnings (ruleset: Magento2) — 18 auto-fixable with phpcbf |
| PHPMD | Warning | 1 | 1 rule violation (IfStatementAssignment: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 | 84 | 84 | – | – |
| 2.4.8 | – | 84 | 100 | – |
| 2.4.9 | – | – | 100 | 100 |


### 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/magento-2-free-gifts-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.