# elgentos/magento2-vurbis-punchout

> This unofficial module provides an integration with the Punchout service provided by Vurbis.

`composer require elgentos/magento2-vurbis-punchout`

Canonical URL: https://packagento.com/elgentos/magento2-vurbis-punchout

## At a glance

- **Vendor**: elgentos (https://packagento.com/elgentos.md)
- **Latest version**: 1.1.2 — released 2024-04-09
- **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/elgentos/magento2-vurbis-punchout 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 elgentos/magento2-vurbis-punchout:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

This unofficial module provides an integration with the Punchout service provided by Vurbis.

## README

This is an unofficial version of the [original Magento 2 Vurbis extension](https://gitlab.com/vurbis/vurbis-interactive-magento-2.3.x-punch-out-extension).

This version contains some bugfixes, some new features and a lot of refactoring.

It:
- Is based on the original 2.1.12 version
- Uses Guzzle instead of plain cURL
- Uses Magento's query builder instead of raw SQL
- Uses PHP 8 style constructor promotion
- Declares strict types in all PHP files
- Adds a Hyvä compatibility configuration option (default disabled)
- Adds an option to control sending all your module information to Vurbis with the newly introduced Status endpoint (default disabled)
- Adds an option to use the original customer account instead of the random generated customers Vurbis' middleware creates (default disabled)
- Adds a cron to clean up the random generated Vurbis customers
- Adds a test mode for testing on local environments
- Adheres to Magento's Coding Standards (phpcs and PhpStan level 4)

### Installation

```
composer require elgentos/magento2-vurbis-punchout
bin/magento setup:upgrade
```

### How to use the test mode?

Vurbis will supply you with a login URL in this format;

```
https://your-store.com/punchout/customer/login?username=johndoe%40example.com&password=abcdefghijklmnopqrstuvwxyz&HOOK_URL=https%3A%2F%2Fioedeveloper.com%2Fapi%2Fintegrations%2Fpunchoutparser%2Foci.php
```

If you will use this format on your local installation, the callback will be done to the production URL. This callback will create a customer which you would normally be logged into. However, since you are working on a different environment, that customer account isn't created in your instance. 

To be able to test, you can add `&test=your%40emailaddress.com` to the URL. If your Magento store is in Developer mode, it will then log you in into that given customer account.

### What is the option to use the original customer account?

In some instances, we need to use the original customer account to log into instead of the newly generated one. This has to do with certain customer attributes that are set on the original customer account which won't be available on the generated one.

The main downside of enabling this setting is that the cart will be shared across multiple OCI buyers. Only use this if there is only one OCI buyer! Otherwise, carts might be 'randomly' cleared.

### What does the Hyvä / headless compatibility setting do?

This will disable setting the quote's customer ID value to null to avoid a GraphQL validation error. Hyvä and headless setups use GraphQL to update the cart. Magento has added extra validation on the GraphQL to check whether the cart that is being updated actually belongs to the currently logged in user. Setting the Customer ID field on the quote to null makes this validation fail, so we disable it when you enable this setting.

## Recent Versions

| Version | Released |
|---|---|
| 1.1.2 | 2024-04-09 |
| 1.1.1 | 2024-04-09 |
| 1.1.0 | 2024-04-09 |
| 1.0.0 | 2024-04-09 |

## Quality

Latest release (1.1.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 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | 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 | 10 | 10 warnings (ruleset: Magento2) — 4 auto-fixable with phpcbf |
| PHPMD | Warning | 7 | 7 rule violations (MissingImport:2, UnusedFormalParameter:2, CyclomaticComplexity:1, NPathComplexity:1, ExcessiveMethodLength:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Pass | 0 |  |

#### 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 | 1 | 1 | – | – |
| 2.4.8 | – | 1 | 3 | – |
| 2.4.9 | – | – | 3 | 3 |


### 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=["elgentos/magento2-vurbis-punchout"],
  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

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