PHPackages                             carriyo/module-shipment - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. carriyo/module-shipment

ActiveMagento2-module

carriyo/module-shipment
=======================

This module integrates your e-commerce with Carriyo platform.

1.3.1(2mo ago)12.1k1[1 issues](https://github.com/Carriyo/magento2/issues)Apache-2.0PHP

Since Mar 8Pushed 1y ago2 watchersCompare

[ Source](https://github.com/Carriyo/magento2)[ Packagist](https://packagist.org/packages/carriyo/module-shipment)[ RSS](/packages/carriyo-module-shipment/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)DependenciesVersions (24)Used By (0)

Mage2 Module Carriyo Shipment
=============================

[](#mage2-module-carriyo-shipment)

```
``carriyo/module-shipment``

```

Main Functionalities
--------------------

[](#main-functionalities)

This module integrates your ecommerce with Carriyo platform.

Installation
------------

[](#installation)

\* = in production please use the `--keep-generated` option

### Type 1: Zip file

[](#type-1-zip-file)

- Unzip the zip file in `app/code/Carriyo`
- Rename the unziped folder to `Shipment`
- By this moment you should have the following folder tree

```
  app
    |-- code
          |-- Carriyo
              |-- Shipment

```

- Enable the module by running `php bin/magento module:enable Carriyo_Shipment`
- Apply database updates by running `php bin/magento setup:upgrade`\*
- Flush the cache by running `php bin/magento cache:flush`

### Type 2: Composer

[](#type-2-composer)

- Add the composer repository to the configuration by running `composer config repositories.repo.magento.com composer https://repo.magento.com/`
- Install the module composer by running `composer require carriyo/module-shipment:"^1.3.0"`. Replace version number if you want to use a previous version of the Carriyo module.
- enable the module by running `php bin/magento module:enable Carriyo_Shipment`
- apply database updates by running `php bin/magento setup:upgrade`\*
- Flush the cache by running `php bin/magento cache:flush`

Specifications
--------------

[](#specifications)

The following settings can be found in `Stores -> Configuration -> Carriyo -> Settings`

- API Credentials
    - API Domain - (required)
    - Tenant ID - (required)
    - Merchant ID - (required)
    - API Key - (required)
    - Client ID - (required)
    - Client Secret - (required)
- Pickup Address
    - Location Code - (required)
- Carriyo Mappings
    - Shipping Methods - (required) A map between your sipping methods labels and Carriyo shipping type. Eg: `Flat Rate=STANDARD,Free Shipping=EXPRESS`
    - Allowed Order Statuses (COD): List of Magento statuses that are allowed to update Carriyo for COD orders. Eg: `pending,processing`
    - Allowed Order Statuses (Other Payment Types): List of Magento statuses that are allowed to update Carriyo for non COD orders. Eg: `processing`
    - Order Status Mapping: Map Carriyo statuses to update the Magento order status. Eg: `shipped=complete,cancelled=canceled`
    - Shipment Reference Prefix: Add an optional prefix to the Carriyo shipment reference. Use this when your Magento order numbers are not unique across merchants.

### Running in local environment

[](#running-in-local-environment)

In order to run this environment please make sure you have `docker` and `docker-compose` installed.

- Download this repo: [Clean docker Magento2](https://github.com/clean-docker/Magento2)
- After that you need to download a [Magento2 project](https://magento.com/tech-resources/download)
- Move your Magento project to be the `src` inside the docker repo.
- Now you can just `docker-compose up -d` to spin up the project normally.

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance39

Infrequent updates — may be unmaintained

Popularity21

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 75.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~128 days

Recently: every ~248 days

Total

18

Last Release

71d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/90ccb1c3aecc4e09eba39346de04f3e0c61b4dfd8e1e0ad9914b98b47a6ccb85?d=identicon)[FaiselAzeez](/maintainers/FaiselAzeez)

---

Top Contributors

[![FaiselAzeez](https://avatars.githubusercontent.com/u/1321380?v=4)](https://github.com/FaiselAzeez "FaiselAzeez (90 commits)")[![ZiruZanrgeiff](https://avatars.githubusercontent.com/u/6626840?v=4)](https://github.com/ZiruZanrgeiff "ZiruZanrgeiff (26 commits)")[![Munawwar](https://avatars.githubusercontent.com/u/734816?v=4)](https://github.com/Munawwar "Munawwar (2 commits)")[![shoebahamed](https://avatars.githubusercontent.com/u/22190216?v=4)](https://github.com/shoebahamed "shoebahamed (1 commits)")

### Embed Badge

![Health badge](/badges/carriyo-module-shipment/health.svg)

```
[![Health](https://phpackages.com/badges/carriyo-module-shipment/health.svg)](https://phpackages.com/packages/carriyo-module-shipment)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)