# reach-digital/magento2-inventory-source-reservations

`composer require reach-digital/magento2-inventory-source-reservations`

Canonical URL: https://packagento.com/reach-digital/magento2-inventory-source-reservations

## At a glance

- **Vendor**: reach-digital (https://packagento.com/reach-digital.md)
- **Latest version**: 1.4.3 — released 2021-07-14
- **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/reach-digital/magento2-inventory-source-reservations 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 reach-digital/magento2-inventory-source-reservations:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## README

Ability to register reservations on sources. Allows us to defer the actual
source deduction further by allowing us to reserve qty's on the source.

This allows us to create other functionalities on top:

- [https://github.com/ho-nl/magento2-ReachDigital_InventoryOrderSourceReservations](ReachDigital_InventoryOrderSourceReservations) Introduce source reservation for all orders placed.
- [https://github.com/ho-nl/magento2-ReachDigital_ShConnector](ReachDigital_ShConnector) Specific warehouse integration.
- [https://github.com/ho-nl/magento2-ReachDigital-TransferOrdersES] Reserve incoming inventory

### API

- [AppendReservations](https://github.com/ho-nl/magento2-ReachDigital_InventorySourceReservations/blob/master/ISReservationsApi/Model/AppendReservationsInterface.php):
  Allows us to append new reservations for a given SKU.
- [GetSourceReservationsQuantity](https://github.com/ho-nl/magento2-ReachDigital_InventorySourceReservations/blob/master/ISReservationsApi/Model/GetSourceReservationsQuantityInterface.php)
  Allows us to get the reservations for a certain source.

### Indexer

First we create an inventory*source_reservation table where source reservations
can be appended to. When the `inventory_stock*\*` is indexed it will also add
the source reservation sums. This updates the aggregated stock ('salable qty')
with all the source reservations.

We now have an accurate stock index with all the source reservations included.
There are other parts that don't use the indexed amount, and we need to append the
source reservation to the stock reservation:
[GetSourceReservationsQuantityInterface](https://github.com/ho-nl/magento2-ReachDigital_InventorySourceReservations/blob/master/ISReservationsApi/Model/GetSourceReservationsQuantityInterface.php)

### Commits

A commit is validated with https://github.com/conventional-changelog/commitlint

Gittower: Gittower doesn't properly read your PATH variable and thus commit
validation doesn't work. Use `gittower .` to open this repo.

## Recent Versions

| Version | Released |
|---|---|
| 1.4.3 | 2021-07-14 |
| 1.4.3-canary.1 | 2020-10-08 |
| 1.4.2 | 2020-10-08 |
| 1.4.1 | 2020-08-04 |
| 1.4.0 | 2020-08-04 |
| 1.3.0 | 2020-06-23 |
| 1.2.0 | 2020-06-19 |
| 1.1.0 | 2020-06-19 |
| 1.0.1 | 2020-01-20 |
| 1.0.0 | 2019-10-11 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | * |
| php | ~7.1.3\|\|~7.2.0\|\|~7.3.0\|\|~7.4.0 |

## Quality

Latest release (1.4.3) 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 | not tested | not tested | – | – |
| 2.4.8 | – | not tested | not tested | – |
| 2.4.9 | – | – | 1 | 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 | 9 | 9 warnings (ruleset: Magento2) — 1 auto-fixable with phpcbf |
| PHPMD | Warning | 8 | 8 rule violations (UnusedFormalParameter:8) |
| Cpd | Warning | 1 | 1 duplicated chunk spanning 18 total lines (min-lines=5, min-tokens=70) |
| 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 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### 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 | not tested | – |
| 2.4.9 | – | – | N/A | not tested |


### 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=["reach-digital/magento2-inventory-source-reservations"],
  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

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