Dolivroo Unified Algerian Delivery for Botble CMS

Connect a Botble CMS store to the Dolivroo unified delivery API and manage Algerian shipping from one integration. The plugin brings live delivery rates, multi-carrier parcel operations, tracking, labels, and Stop Desk delivery into Botble Ecommerce.

Features

• Live checkout rates for home delivery and Stop Desk / pickup-point delivery
• Support for Yalidine, ZR Express, Ecotrack, and Maystro
• Optional smart routing that compares available carrier prices and selects the lowest returned rate
• Rate caching with an optional recent-rate fallback when the API is temporarily unavailable
• Free-shipping threshold configuration
• Parcel creation, updates, cancellation, tracking, and label retrieval from the shipment workflow
• Automatic Botble shipment-status mapping for delivered, shipping, returned, alert, and cancelled states
• Hourly tracking synchronization through the Laravel scheduler
• Monthly wilaya and commune synchronization with local mapping generation
• Stop Desk center lookup by wilaya and carrier
• Exchange-order option and multi-account connection labels
• Admin API-key validation and server connectivity diagnostics
• Optional Dolivroo request/response logging for troubleshooting

Supported carriers

• Yalidine
• ZR Express
• Ecotrack
• Maystro

The carrier capabilities available for parcel creation, updates, labels, and cancellation depend on the carrier account and the Dolivroo API response.

Requirements

• Botble CMS 7.6 or later
• Botble Ecommerce and Location plugins enabled
• PHP version supported by your Botble CMS release (the Dolivroo SDK requires PHP 8.1 or later)
• Composer access to install dolivroo/sdk
• An active Dolivroo API key
• A Laravel scheduler entry for automatic shipment and city synchronization

Installation

1. Copy the plugin to platform/plugins/dolivroo/.

2. Install dependencies from the Botble CMS root with Composer:

   composer install --no-dev --optimize-autoloader

3. Activate Dolivroo from Admin Panel Plugins.

4. Open Admin Panel Ecommerce Shipping and configure the integration.

5. Run the city mapping command before using checkout rates:

   php artisan sync:dolivroo-cities

6. Add the scheduler to the server cron so Laravel runs every minute:

   * * * * * cd /path/to/your/botble-installation && php artisan schedule:run /dev/null 2&1

Configuration

Configure the API key, default carrier, delivery type, default parcel weight, free-shipping threshold, smart routing, exchange option, cache duration, outage fallback, logging, and automatic cancellation on return from the Dolivroo shipping settings panel.

The plugin uses Dolivroo's unified API endpoint and keeps checkout requests bounded with configurable request and lookup time limits. Store the API key securely and use HTTPS in production.

Shipment synchronization

The scheduler runs these commands automatically:

php artisan sync:dolivroo-cities php artisan dolivroo:sync-shipments

You can also run the shipment synchronization manually with a limit:

php artisan dolivroo:sync-shipments --limit=100

License

This plugin is intended for release under the MIT License. Add the license file required by your marketplace publisher account before submission.

Dolivroo, Yalidine, ZR Express, Ecotrack, and Maystro are trademarks of their respective owners. This plugin is an independent integration and is not endorsed by those organizations.

Changelog

1.0.0

• Initial unified Algerian delivery integration for Botble CMS.