# mageworx/module-optiongraphql

> GraphQl support for APO

`composer require mageworx/module-optiongraphql`

Canonical URL: https://packagento.com/mageworx/module-optiongraphql

## At a glance

- **Vendor**: mageworx (https://packagento.com/mageworx.md)
- **Latest version**: 2.3.2 — released 2026-03-23
- **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-optiongraphql 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-optiongraphql:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

GraphQl support for APO

## README

This GraphQL module is the add-on for the [Advanced Product Options Suite](https://www.mageworx.com/magento-2-advanced-product-options-suite.html) module for Magento 2. It adds support for the GraphQL API to use the features provided by APO extension on PWA store fronts.

Our module extends original Magento products GraphQL request to add our attributes. You can remove the unnecessay attributes manually if they are not applicable for your configuration.

<details>
  <summary>Products request</summary>

```graphql 
{
  products(filter: {sku: {eq: "testMW"}}) {
    items {
      id
      name
      sku
      __typename
      dependency_rules
      hidden_dependents
      absolute_price
      absolute_cost
      absolute_weight
      sku_policy
      shareable_link
      hide_additional_product_price
      ... on CustomizableProductInterface {
        options {
          __typename
          title
          required
          sort_order
          option_id
          qty_input
          div_class
          one_time
          is_swatch
          is_hidden
          mageworx_option_gallery
          mageworx_option_image_mode
          description
          sku_policy
          is_all_customer_groups
          is_all_store_views
          customer_group
          store_view
          disabled
          disabled_by_values
          selection_limit_from
          selection_limit_to
          ... on CustomizableDropDownOption {
            dropdown_value: value {
              title
              option_type_id
              price
              price_type
              sku
              mageworx_option_type_price
              mageworx_title
              special_price
              tier_price
              description
              dependency
              dependency_type
              cost
              images_data
              is_default
              qty_multiplier
              weight
              weight_type
              qty
              manage_stock
              disabled
            }
          }
          ... on CustomizableRadioOption {
                radio_value: value {
              title
              option_type_id
              price
              price_type
              sku
              mageworx_option_type_price
              mageworx_title
              special_price
              tier_price
              description
              dependency
              dependency_type
              cost
              images_data
              is_default
              qty_multiplier
              weight
              weight_type
              qty
              manage_stock
              disabled
            }
          }
          ... on CustomizableMultipleOption {
            multiple_value: value {
              title
              option_type_id
              price
              price_type
              sku
              mageworx_option_type_price
              mageworx_title
              special_price
              tier_price
              description
              dependency
              dependency_type
              cost
              images_data
              is_default
              qty_multiplier
              weight
              weight_type
              qty
              manage_stock
              disabled
            }
          }
          ... on CustomizableCheckboxOption {
            checkbox_value: value {
              title
              option_type_id
              price
              price_type
              sku
              mageworx_option_type_price
              mageworx_title
              special_price
              tier_price
              description
              dependency
              dependency_type
              cost
              images_data
              is_default
              qty_multiplier
              weight
              weight_type
              qty
              manage_stock
              disabled
            }
          }
          ... on CustomizableFieldOption {
            field_value: value {
              max_characters
              price_type
              price
              sku
              mageworx_option_price
              mageworx_title
              dependency
              dependency_type
            }
          }
          ... on CustomizableAreaOption {
            area_value: value {
              max_characters
              price_type
              price
              sku
              mageworx_option_price
              mageworx_title
              dependency
              dependency_type
            }
          }
          ... on CustomizableFileOption {
            file_value: value {
              file_extension
              image_size_x
              image_size_y
              price_type
              price
              sku
              mageworx_option_price
              mageworx_title
              dependency
              dependency_type
            }
          }
          ... on CustomizableDateOption {
            date_value: value {
              price_type
              price
              sku
              mageworx_option_price
              mageworx_title
              dependency
              dependency_type
            }
          }
        }
      }
    }
  }
}
```
</details>
<details>
  <summary>Products response</summary>

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

## Recent Versions

| Version | Released |
|---|---|
| 2.3.2 | 2026-03-23 |
| 2.3.1 | 2026-01-30 |
| 2.3.0 | 2025-12-05 |
| 2.2.1 | 2025-01-23 |
| 2.2.0 | 2023-12-19 |
| 2.1.1 | 2023-01-19 |
| 2.1.0 | 2022-10-05 |
| 2.0.0 | 2020-09-11 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | >=102.0.0 <104 |
| magento/module-catalog-graph-ql | >=100.3.0 |
| mageworx/module-optionbase | >=2.17.23 |
| mageworx/module-optionfeatures | >=2.31.19 |

## Quality

Latest release (2.3.2) 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 | – | – | not tested | not tested |


### 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 | 37 | 37 warnings (ruleset: Magento2) — 6 auto-fixable with phpcbf |
| PHPMD | Warning | 29 | 29 rule violations (UnusedFormalParameter:17, UndefinedVariable:11, MissingImport:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 4 | valid; 4 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-optiongraphql"],
  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.

