# netresearch/module-shipping-core

> Netresearch component providing utilities and frameworks for advanced shipping features

`composer require netresearch/module-shipping-core`

Canonical URL: https://packagento.com/netresearch/module-shipping-core

## At a glance

- **Vendor**: netresearch (https://packagento.com/netresearch.md)
- **Latest version**: 4.1.1 — released 2026-06-03
- **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/netresearch/module-shipping-core 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 netresearch/module-shipping-core:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Netresearch component providing utilities and frameworks for advanced shipping features

## README

Netresearch Shipping Core Extension
===================================

The Netresearch shipping core package is the central component to offer generic functionality as required by all carriers. 

It is not intended to be used standalone.

Features
--------

- Add product attributes: Catalog Management
- Load shipping rates: Collect Rates
- Offer additional shipping options: Shipping Options
- Add surcharge for value-added services in checkout: Additional Fee
- Split recipient street into street name and street number: Street Split
- Handle availability of cash on delivery payment methods: Cash on Delivery
- Convert weight and dimensions units: Unit Conversion
- Automate shipping label retrieval: Bulk Shipment
- Display label status in orders grid: Label Status
- Offer API pipelines for rates and label retrieval: API Pipelines
- Extend REST API order endpoint: Order Export

Requirements
------------

* PHP >= 8.3

Compatibility
-------------

* Magento >= 2.4.8

License
-------

[OSL - Open Software Licence 3.0](http://opensource.org/licenses/osl-3.0.php)

Copyright
---------

(c) 2023 Netresearch DTT GmbH

## Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

### 4.1.1

#### Changed

- Use tilde version range for PHP requirement to match Magento framework convention.

### 4.1.0

Magento 2.4.9 compatibility release

#### Added

- Support for Magento 2.4.9
- Support for PHP 8.5

### 4.0.3

#### Changed

- Removed redundant `php-http/curl-client` and `nyholm/psr7` dependencies, HTTP client is provided by Magento's Guzzle integration.

### 4.0.2

#### Fixed

- Added workaround for broken Magento Email Attachment handling - [#39869](https://github.com/magento/magento2/issues/39869).  


### 4.0.1

#### Fixed

- StreetSplitter removing parts of the address during parsing, reported via [#77](https://github.com/netresearch/dhl-shipping-m2/issues/77).

### 4.0.0

Magento 2.4.8 compatibility release with breaking changes

#### Breaking Changes

- **Error Response Interface**: Changed `getErrors()` return type from `Phrase` to `string[]` for Magento 2.4.8 compatibility

#### Added

- Support for PHP 8.3 and 8.4 features
- PHPUnit 10.x compatibility and modern test patterns
- Rector and PHPStan configuration for code quality

#### Changed

- Error response interfaces now return arrays of strings instead of single Phrase objects
- Updated all Magento dependencies to 2.4.8 compatible versions
- Modernized codebase with PHP 8.3+ features and type declarations
- Migrated development toolchain to modern standards

#### Removed

- Support for PHP 8.2
- Support for Magento versions prior to 2.4.8

### 3.1.0

#### Added

- Add Validator and translated error messages for HSCode Input.

### 3.0.0 

Magento 2.4.7 compatibility release

#### Added

- Support for Magento 2.4.7

#### Changed 

- Replace Zend_Measurement with Magento Framework Measurement
- Use escaper instead of block for escaping in templates

#### Removed

- Support for PHP 7.x
- Support for PHP 8.1

### 2.9.0

#### Added

- Add composite rule for processing multiple street splitting rules per region/country.
- Provide utilities for converting ISO-3166-1 country codes from Alpha2 to Alpha3 and vice versa.
- Validate shipping option compatibility using regular expressions.

#### Fixed

- Prevent broken styling in module configuration, reported via [#50](https://github.com/netresearch/dhl-shipping-m2/issues/50).

### 2.8.2

#### Fixed

- Display tracking number in shipment confirmation emails during mass action, reported via issue [#6](https://github.com/netresearch/module-shipping-core/issues/6).

### 2.8.1

#### Fixed

- Add table alias to `item_id` column for GraphQL support, reported via issue [#49](https://github.com/netresearch/dhl-shipping-m2/issues/49).

### 2.8.0

Magento 2.4.4 compatibility release

#### Added

- Support for Magento 2.4.4
- Send shipping label to configured email address, suggested via issue [#45](https://github.com/netresearch/dhl-shipping-m2/issues/45).

#### Removed

- Support for PHP 7.1

### 2.7.1

#### Fixed

- Return documents download in customer account.

### 2.7.0

#### Added

- Carrier-agnostic framework for module configuration validation.
- Persist return shipment labels retrieved from label APIs.
- Display return shipment labels in customer account.
- Send return shipment labels to customer email address.
- Display carrier icons in _Shipping Settings_ configuration groups.

#### Changed

- Set selected delivery location as order shipping address.

#### Fixed

- Prevent comma as decimal separator in _Packages_ configuration.
- Accept full hours as cut-off time calculation input.

### 2.6.0

#### Added

- Add content type option "Commercial Goods" for dutiable shipments.

### 2.5.0

#### Added

- Expose services for interactive mass action.

### 2.4.0

#### Added

- Carrier-agnostic return shipments framework.

### 2.3.1

#### Fixed

_(Changelog truncated for .md surface. Full history on https://packagento.com/netresearch/module-shipping-core.)_

## Recent Versions

| Version | Released |
|---|---|
| 4.1.1 | 2026-06-03 |
| 4.1.0 | 2026-06-02 |
| 4.0.3 | 2025-12-03 |
| 4.0.2 | 2025-10-27 |
| 4.0.1 | 2025-09-07 |
| 4.0.0 | 2025-07-02 |
| 3.1.0 | 2025-03-18 |
| 3.0.0 | 2024-05-27 |
| 2.9.0 | 2023-04-11 |
| 2.8.2 | 2022-08-23 |

Showing 10 of 24 versions. Full release history on https://packagento.com/netresearch/module-shipping-core.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| azuyalabs/yasumi | ^2.0.0 |
| ext-dom | * |
| ext-simplexml | * |
| magento/framework | ^103.0.8 |
| magento/module-backend | ^102.0.8 |
| magento/module-bundle | ^101.0.8 |
| magento/module-catalog | ^104.0.8 |
| magento/module-config | ^101.2.8 |
| magento/module-configurable-product | ^100.4.8 |
| magento/module-cron | ^100.4.8 |
| magento/module-directory | ^100.4.8 |
| magento/module-eav | ^102.1.8 |
| magento/module-email | ^101.1.8 |
| magento/module-payment | ^100.4.8 |
| magento/module-quote | ^101.2.8 |
| magento/module-sales | ^103.0.8 |
| magento/module-shipping | ^100.4.8 |
| magento/module-store | ^101.1.8 |
| magento/module-tax | ^100.4.8 |
| magento/module-ui | ^101.2.8 |
| magento/module-webapi | ^100.4.7 |
| netresearch/config-fields-m2 | ^1.3.0 |
| php | ~8.3.0\|\|~8.4.0\|\|~8.5.0 |

### Require (dev)

| Package | Constraint |
|---|---|
| magento/module-checkout | ^100.4.8 |
| magento/module-customer | ^103.0.8 |
| phpunit/phpunit | ^10.0.0 |
| symfony/yaml | ^6.4.0 |
| tddwizard/magento2-fixtures | ^1.2.0 |

### Suggest

| Package | Constraint |
|---|---|
| magento/module-rma | * |
| magento/module-scalable-checkout | * |
| magento/module-scalable-oms | * |
| netresearch/module-shipping-inventory | ^1.2.0 |

## Quality

Latest release (4.1.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 | not tested | 1 | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### 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 | 48 | 48 warnings (ruleset: Magento2) |
| PHPMD | Warning | 86 | 86 rule violations (MissingImport:34, UnusedFormalParameter:13, UndefinedVariable:13, UnusedLocalVariable:7, CyclomaticComplexity:6) |
| 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 | 1 | 1 | – | – |
| 2.4.8 | – | 1 | 1 | – |
| 2.4.9 | – | – | 1 | 1 |


### 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 | Error | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | Error | – | – |
| 2.4.8 | – | 8 | 19 | – |
| 2.4.9 | – | – | Pass | 1 |


### 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=["netresearch/module-shipping-core"],
  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

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