kalicr/yo-voy (1.0.0)
Installation
{
"repositories": [{
"type": "composer",
"url": "composer require kalicr/yo-voy:1.0.0About this package
Module Kalicr_YoVoy
YoVoy shipping method integration for Magento 2 checkout. The module manages shipping rules, calculates delivery rates through the configured YoVoy API, and persists the selected rate data for downstream order processing.
This module is developed by Kal-i CR Development Team.
Features
- Shipping rule administration: manage category, weight, dimension, and stackability rules from Magento Admin.
- Checkout rate calculation: send controlled cart and destination data to YoVoy and expose the returned shipping method when a valid rate is available.
- Order payload persistence: preserve the
yovoy_jsonorder field used by downstream fulfillment integrations.
Installation
Via Composer
The package is published in the KaliCR Forgejo Composer registry.
composer require kalicr/yo-voy:1.0.0
bin/magento module:enable Kalicr_YoVoy
bin/magento setup:upgrade
bin/magento cache:clean
For local development in the magento-packages workbench, clone the
repository under extensions/kalicr-yo-voy and require kalicr/yo-voy:@dev
to use the Composer path repository symlink.
Configuration
- Open Magento Admin.
- Configure the YoVoy shipping method under Stores -> Configuration -> Sales -> Shipping Methods.
- Configure the YoVoy API endpoint, API key, company ID, and rounding rules under the KaliCR YoVoy configuration section.
- Create the shipping rules required by the catalog.
API credentials must be supplied through the Magento configuration and must never be committed to this repository.
Dependencies
- Magento Open Source / Adobe Commerce:
2.4.8 - PHP:
^8.2 || ^8.3 - Magento modules: Backend, Catalog, Checkout, Config, Customer, Quote, Sales, Shipping, Store, and UI
- Composer packages:
kalicr/core
Compatibility
- Adobe Commerce / Magento Open Source:
2.4.8-p4baseline - PHP:
^8.2 || ^8.3 - YoVoy API: requires a configured endpoint and credentials
Functional usage
Administrators define the shipping rules that map catalog categories to package dimensions, weight, and stackability. During checkout, the carrier reads the active quote and destination attributes, requests a rate from YoVoy, and exposes the returned method when the response contains a valid positive cost.
When a YoVoy method is selected, the module stores the request and price data
in the checkout session and writes the resulting payload to
sales_order.yovoy_json before order placement completes.
Technical notes
- Carrier code:
yovoy_yovoy - Rule table:
kalicr_yovoy_shipping_rules - Order field:
sales_order.yovoy_json - API configuration paths:
yovoy/api/* - Rounding configuration paths:
yovoy/rounded/* - The package does not authorize production reactivation; enablement and consumer migration remain separate operational changes.
Changelog
Release notes are maintained in CHANGELOG.md.
Support
For questions or incidents, contact Kal-i CR Development Team:
- Email:
contacto@kalicr.com
License
This package is proprietary and distributed under the KaliCR commercial license. See LICENSE.md.
Release workflow
This repository publishes the package through the Forgejo Composer Registry.
The CI workflow uses the shared actions-magento-package action pinned to the
approved commit SHA. Releases are created by CI after the approved merge to
production.
Dependencies
Dependencies
| ID | Version |
|---|---|
| kalicr/core | >=0.1.0 <0.3.0 |
| magento/framework | ^103.0 |
| magento/module-backend | ^102.0 |
| magento/module-catalog | ^104.0 |
| magento/module-checkout | ^100.0 |
| magento/module-config | ^101.0 |
| magento/module-customer | ^103.0 |
| magento/module-quote | ^101.0 |
| magento/module-sales | ^103.0 |
| magento/module-shipping | ^100.0 |
| magento/module-store | ^101.0 |
| magento/module-ui | ^101.0 |
| php | ^8.2 || ^8.3 |
Development dependencies
| ID | Version |
|---|---|
| phpunit/phpunit | ^10.5 |