# mygento/module-shipment

> Magento 2 Shipment Base

`composer require mygento/module-shipment`

Canonical URL: https://packagento.com/mygento/module-shipment

## At a glance

- **Vendor**: mygento (https://packagento.com/mygento.md)
- **Latest version**: 2.4.8 — released 2025-11-19
- **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/mygento/module-shipment 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 mygento/module-shipment:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Magento 2 Shipment Base

## README

[![Build Status](https://travis-ci.org/mygento/module-shipment.svg?branch=v2.4)](https://travis-ci.org/mygento/module-shipment)
[![Latest Stable Version](https://poser.pugx.org/mygento/module-shipment/v/stable)](https://packagist.org/packages/mygento/module-shipment)
[![Total Downloads](https://poser.pugx.org/mygento/module-shipment/downloads)](https://packagist.org/packages/mygento/module-shipment)

### Installation with composer
* Include the repository: `composer require mygento/module-shipment`

### Usage

Every extension should have three classes:

- Client inherits \Mygento\Shipment\Model\AbstractClient

  Class is used for communication with API. Exchanges with others through Service.

- Carrier inherits \Mygento\Shipment\Model\AbstractCarrier

  Class is used to work with Magento Shipping Rates

- Service inherits \Mygento\Shipment\Model\AbstractService

  Class is responsible for working with Magento and DB

### Compability

The module is tested on magento version 2.4.x

## Recent Versions

| Version | Released |
|---|---|
| 2.4.8 | 2025-11-19 |
| 2.4.7 | 2025-09-30 |
| 2.4.6 | 2025-06-11 |
| 2.4.5 | 2024-12-17 |
| 2.4.4 | 2024-08-09 |
| 2.4.3 | 2022-08-30 |
| 2.4.2 | 2022-04-27 |
| 2.4.1 | 2021-12-17 |
| 2.3.5 | 2021-11-02 |
| 2.3.4 | 2021-09-01 |

Showing 10 of 16 versions. Full release history on https://packagento.com/mygento/module-shipment.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/module-shipping | 100.* |
| mygento/module-base | ~2.4.3 |
| php | >=8.0.0 |

### Require (dev)

| Package | Constraint |
|---|---|
| mygento/coding-standard | ~2.14.0 |

## Quality

Latest release (2.4.8) 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 | 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 | Fail | 46 | 7 errors, 39 warnings (ruleset: Magento2) — 31 auto-fixable with phpcbf |
| PHPMD | Warning | 2 | 2 rule violations (MissingImport:2) |
| 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 | 23 | 23 | – | – |
| 2.4.8 | – | 23 | 23 | – |
| 2.4.9 | – | – | 21 | 21 |


### 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=["mygento/module-shipment"],
  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

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