README

Burton Ai WMS is a Magento 2 extension for connecting Adobe Commerce / Magento Open Source stores with Burton Ai WMS.

The extension supports order synchronization, order cancellation synchronization, refund event capture, connection testing, sync event logging, retry handling, and manual order resync from the Magento Admin panel.

Requirements

Magento 2.4.x or Adobe Commerce 2.4.x
PHP 8.1 or PHP 8.2
Composer 2.x
Access to the public Composer package repository
Burton Ai WMS API Base URL, Client ID, and Client Secret

Package Information

Composer Package: burtonsoftware-ai/wms-magento2
Magento Module: BurtonAi_Wms
Version: 0.1.0

One-Click Installation

Run the installation script from your Magento project root directory.

Linux / macOS

chmod +x install.sh
./install.sh

Or:

bash install.sh

Windows PowerShell

powershell -ExecutionPolicy Bypass -File .\install.ps1

The one-click installation script will run Composer installation, enable the Magento module, run setup upgrade, clean and flush cache, and check the module status.

If Magento is running in production mode, the script will also run dependency injection compilation and static content deployment.

Manual Installation

Run the following commands from your Magento project root directory:

composer require burtonsoftware-ai/wms-magento2
php bin/magento module:enable BurtonAi_Wms
php bin/magento setup:upgrade
php bin/magento cache:flush

For production mode, also run:

php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f

Check the module status:

php bin/magento module:status BurtonAi_Wms

Admin Configuration

After installation, log in to the Magento Admin panel and go to:

Stores > Configuration > Services > Burton Ai WMS

Configure the following fields:

Enable Burton Ai WMS: Yes
API Base URL: API endpoint provided by Burton Ai WMS
Client ID: client identifier provided by Burton Ai WMS
Client Secret: client secret provided by Burton Ai WMS

Save the configuration, then click Test Connection to verify the WMS API connection.

Order Synchronization

When enabled, the extension writes supported order events into the local sync queue table:

burton_ai_wms_sync_event

Magento cron processes queued events and sends them to Burton Ai WMS asynchronously.

Supported events in version 0.1.0:

New order synchronization
Order cancellation synchronization
Refund and credit memo event capture
Sync event logging and retry
Manual order resync
Connection testing from Magento Admin

Only orders in the default processing status are sent to WMS. Offline-payment orders that remain pending are not sent until Magento changes them to processing.

Sync Event Admin Page

You can view sync records in the Magento Admin panel:

Burton Ai WMS > Sync Events

The page shows queued, successful, failed, and dead sync events with payloads, WMS responses, retry counts, and latest error messages.

Failed or dead events can be queued for retry from the Actions column.

Manual Order Resync

When Burton Ai WMS is enabled, Magento Admin order detail pages include a Resync to WMS button.

Clicking this button adds the order back to the sync queue. The queued event is processed asynchronously by Magento cron.

Detailed Deployment Guides

For detailed deployment steps, see:

Troubleshooting

If composer require reports that the package cannot be found, please check whether the package has been published to the public Composer repository and whether the server can access the configured Composer source.

If module:enable reports that the module does not exist, please confirm that Composer installation completed successfully and the module name is correct:

php bin/magento module:enable BurtonAi_Wms

If Test Connection fails, please check the API Base URL, Client ID, Client Secret, outbound network access, firewall, and proxy settings.

If the storefront or Admin page loses styles after installation, run the static content repair script from your Magento project root directory.

Linux / macOS:

bash fix-static-content.sh

Windows PowerShell:

powershell -ExecutionPolicy Bypass -File .\fix-static-content.ps1

The repair script cleans generated static view files, redeploys Magento static content, and flushes cache.

Support

For technical support, contact:

support@burtonsoftware.ai

Website:

https://www.burtonsoftware.ai/

burtonsoftware-ai / wms-magento2

Package info

Security

Statistics