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. [Utility & Helpers](/categories/utility) 4. / 5. carriyo/module-shipment ActiveMagento2-module[Utility & Helpers](/categories/utility) carriyo/module-shipment ======================= This module integrates your e-commerce with Carriyo platform. 2.0.1(3w ago)12.4k1[1 issues](https://github.com/Carriyo/magento2/issues)Apache-2.0PHP Since Mar 8Pushed 4d 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 1w ago READMEChangelog (10)DependenciesVersions (36)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:"^2.0.0"`. - 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` - General - Enable toggle, debug logging, integration mode (`Orders` or `Shipments`) - Default location code and shipping method mapping - Connection - API Base URL, Tenant ID, Merchant ID, API Key, Client ID, Client Secret - Sync Triggers - Magento order statuses that send orders to Carriyo (COD vs other payment methods) - Order Mode Settings (shown when integration mode is `Orders`) - Order status mapping, optional order reference prefix, default sales channel, delivery schedule field mappings - Shipment Mode Settings (shown when integration mode is `Shipments`) - Shipment status mapping, auto-book toggle, optional shipment reference prefix Upgrading from 1.3.x to 2.0.0 ----------------------------- [](#upgrading-from-13x-to-200) Version 2.0.0 turns the connector from a shipment-only plugin into a dual-mode integration. ### What's new [](#whats-new) - **Integration modes** — a new `Integration Mode` setting selects how Magento integrates with Carriyo: - `Shipments` (equivalent to the 1.3.x behaviour): Magento remains the fulfillment system and each order is sent to Carriyo as a shipment. - `Orders`: Magento sends orders to Carriyo and Carriyo manages fulfillment; shipments created in Carriyo are synced back to Magento, including Magento-native tracking links. - **Order mode settings** — order status mapping, optional order reference prefix, default sales channel, and delivery schedule field mappings (map Magento order attributes to `delivery_schedule.scheduled_from`/`scheduled_to`). - **Restructured admin configuration** — settings are grouped into General, Connection, Sync Triggers, and per-mode groups that only appear for the selected integration mode. - **Item weights** are now included on synced line items. - **Automatic sync dedupe** — outbound syncs are hashed so unchanged orders are not re-sent on every save. ### Behaviour changes [](#behaviour-changes) - Carriyo shipment webhooks with a status that is not in the Shipment Status Mapping are now acknowledged and ignored, instead of failing with HTTP 400 and being retried by Carriyo. - Default status mappings are trimmed to the transitions that change the Magento order state; statuses not mapped are ignored. Existing saved mappings are not modified. - Skipped status updates no longer add noisy comments to the order status history. ### Upgrade steps [](#upgrade-steps) 1. Update the module (`composer require carriyo/module-shipment:"^2.0.0"` or replace `app/code/Carriyo/Shipment`). 2. Run `php bin/magento setup:upgrade` — a data migration renames the old sync-flow values to the new integration modes (`shipment_only` → `shipments`, `order_and_shipment` → `orders`) and defaults to `shipments` when unset, so 1.3.x installs keep their current behaviour. 3. Run `php bin/magento setup:di:compile` and `php bin/magento cache:flush`. 4. Review `Stores -> Configuration -> Carriyo -> Settings`: confirm the Integration Mode and the status mappings for your mode. ### 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 48 — FairBetter than 94% of packages Maintenance77 Regular maintenance activity Popularity21 Limited adoption so far Community14 Small or concentrated contributor base Maturity69 Established project with proven stability Bus Factor1 Top contributor holds 70.4% 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 ~105 days Recently: every ~22 days Total 23 Last Release 27d ago Major Versions 1.3.1 → v2.0.0-beta12026-04-23 ### 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 (107 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 (17 commits)")[![emfaizan59](https://avatars.githubusercontent.com/u/51472875?v=4)](https://github.com/emfaizan59 "emfaizan59 (1 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) ``` ### Alternatives [svnwa/inertiavuepaginator :package\_description 3115.9k](/packages/svnwa-inertiavuepaginator) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)