# mageworx/module-rewardpoints-graphql

`composer require mageworx/module-rewardpoints-graphql`

Canonical URL: https://packagento.com/mageworx/module-rewardpoints-graphql

## At a glance

- **Vendor**: mageworx (https://packagento.com/mageworx.md)
- **Latest version**: 1.0.1 — released 2026-02-12
- **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/mageworx/module-rewardpoints-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 mageworx/module-rewardpoints-graphql:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## README

GraphQL API module for Mageworx [Magento 2 Reward Points](https://www.mageworx.com/magento-2-reward-points.html) extension.

### Installation

**1) Installation using composer (from packagist)**
- Execute the following command: `composer require mageworx/module-rewardpoints-graphql`

**2) Copy-to-paste method**
- Download this module and upload it to the `app/code/MageWorx/RewardPointsGraphQl` directory *(create "RewardPointsGraphQl" first if missing)*

### How to use

#### Apply reward points to the shopping cart
  
The **applyMwRewardPointsToCart** mutation is used to apply reward points to the shopping cart.  
  
**Syntax**  
`applyMwRewardPointsToCart(input: ApplyMwRewardPointsToCartInput): ApplyMwRewardPointsToCartOutput`  

The ApplyMwRewardPointsToCartInput object may contain the following attributes:
```
cart_id: String! @doc(description:"The unique ID that identifies the customer's cart")
points: Float @doc(description: "Points value")
```
  
The ApplyMwRewardPointsToCartOutput object contains the Cart object.  
  
**Request:**
```
mutation {
    applyMwRewardPointsToCart(
        input: {
            cart_id: "plhjWW93b8r2zO4kpye2FfWtK2QPmvS3"
            points: 4
        }
    ) {
        cart {
            items {
                product {
                    name
                    sku
                }
                quantity
            }
            mw_applied_reward_points {
                points
                money {
                    value
                    currency
                }
            }
            mw_reward_messages {
                header_message
                minicart_message
                cart_message
                checkout_message
            }
        }
    }
}
```

**Response:**
```
{
    "data": {
        "applyMwRewardPointsToCart": {
            "cart": {
                "items": [
                    {
                        "product": {
                            "name": "Fusion Backpack",
                            "sku": "24-MB02"
                        },
                        "quantity": 1
                    }
                ],
                "mw_applied_reward_points": {
                    "points": 4,
                    "money": {
                        "value": 40,
                        "currency": "USD"
                    }
                },
                "mw_reward_messages": {
                    "header_message": "Header Message: Complete this cart and earn 5.9 points for a discount on your future purchases.",
                    "minicart_message": "Mini-cart Balance Message: Your current reward points balance is $179.60.",
                    "cart_message": "Cart Message: Complete the purchase and earn 5.9 points for a discount on your future purchases.",
                    "checkout_message": "Checkout Message: Complete the purchase and earn 5.9 points for a discount on your future purchases."
                }
            }
        }
    }
}
```
  
  
#### Remove reward points from the shopping cart
  
The **removeMwRewardPointsFromCart** mutation is used to remove reward points from the shopping cart. 
  
**Syntax**  
`removeMwRewardPointsFromCart(input: RemoveMwRewardPointsToCartInput): RemoveMwRewardPointsFromCartOutput`  

The RemoveMwRewardPointsToCartInput object may contain the following attributes:
```
cart_id: String! @doc(description:"The unique ID that identifies the customer's cart")
```
  
The RemoveMwRewardPointsFromCartOutput object contains the Cart object.  
  
**Request:**
```
mutation {
    removeMwRewardPointsFromCart(
        input: {
            cart_id: "plhjWW93b8r2zO4kpye2FfWtK2QPmvS3"
        }
    ) {
        cart {
            items {
                product {
                    name
                    sku
                }
                quantity
            }
            mw_applied_reward_points {
                points
                money {
                    value
                    currency
                }
            }
            mw_reward_messages {
                header_message
                minicart_message
                cart_message
                checkout_message
            }
        }
    }
}
```

**Response:**
```
{
    "data": {
        "removeMwRewardPointsFromCart": {
            "cart": {
                "items": [
                    {
                        "product": {
                            "name": "Fusion Backpack",
                            "sku": "24-MB02"
                        },
                        "quantity": 1
                    }
                ],
                "mw_applied_reward_points": null,
                "mw_reward_messages": {
                    "header_message": "Header Message: Complete this cart and earn 5.9 points for a discount on your future purchases.",
                    "minicart_message": "Mini-cart Balance Message: Your current reward points balance is $179.60.",
                    "cart_message": "Cart Message: Complete the purchase and earn 5.9 points for a discount on your future purchases.",
                    "checkout_message": "Checkout Message: Complete the purchase and earn 5.9 points for a discount on your future purchases."
                }
            }
        }
    }
}
```
  
  
#### Additional data in Cart object
  
The following attributes are added for Cart:  
```
mw_applied_reward_points: MwRewardPointsBalance @doc(description: "Applied reward points details")
mw_reward_messages: CartRewardMessages @doc(description: "Cart Reward Messages")
```

MwRewardPointsBalance attributes:
```
points: Float! @doc(description: "Points value")
money: Money! @doc(description: "The amount of reward points in the currency of the store")
```

_(README truncated for .md surface. Full README on https://packagento.com/mageworx/module-rewardpoints-graphql.)_

## Recent Versions

| Version | Released |
|---|---|
| 1.0.1 | 2026-02-12 |
| 1.0.0 | 2022-08-10 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/module-catalog-graph-ql | >= 100.3.1 < 100.5 |
| magento/module-customer-graph-ql | >= 100.3.1 < 100.5 |
| magento/module-quote-graph-ql | >= 100.3.1 < 100.5 |
| mageworx/module-rewardpoints | >= 1.8.11 |

## 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 | not tested | – |
| 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 | Pass | 0 |  |
| PHPMD | Warning | 22 | 22 rule violations (UnusedFormalParameter:20, MissingImport:2) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 2 | valid; 2 advisory notes (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 | Error | Error | – | – |
| 2.4.8 | – | Error | Error | – |
| 2.4.9 | – | – | Error | Error |


### 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 | N/A | 0 | no resolvable dependency tree to audit — Your requirements could not be resolved to an installable set of packages. Problem 1 |
| 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=["mageworx/module-rewardpoints-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

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