CLI Commands
Channable Connect provides several CLI commands for managing the extension from the command line. These are useful for automation, debugging, and running tasks outside of cron.
Available Commands
| Command | Description |
|---|---|
channable:selftest |
Run diagnostics to check configuration |
channable:item:update |
Push product updates to Channable |
channable:order:simulate |
Create a test order |
channable:generate:token |
Generate or refresh the API token |
channable:selftest
Runs a series of diagnostic tests to verify your configuration is correct.
bin/magento channable:selftest
Output: Shows each test with its result (success/error) and a message explaining the status.
Use this when:
- Setting up the extension for the first time
- Troubleshooting connection issues
- Verifying configuration after changes
channable:item:update
Manually pushes invalidated products to Channable. This is the same action that runs via cron.
# Update all enabled stores
bin/magento channable:item:update
# Update specific store only
bin/magento channable:item:update --store-id=1
Options:
| Option | Description |
|---|---|
--store-id |
Process only this store ID. If omitted, all enabled stores are processed. |
Output: Shows the number of products updated per store.
Use this when:
- You need immediate sync without waiting for cron
- Debugging product update issues
- After bulk catalog changes
channable:order:simulate
Creates a test order to verify your order import configuration.
# Basic test order (required: store-id)
bin/magento channable:order:simulate --store-id=1
# Test with specific product
bin/magento channable:order:simulate --store-id=1 --product-id=42
# Test with quantity
bin/magento channable:order:simulate --store-id=1 --product-id=42 --qty=3
# Test with different country
bin/magento channable:order:simulate --store-id=1 --country-code=DE
# Test FBB/LVB order
bin/magento channable:order:simulate --store-id=1 --lvb=1
Options:
| Option | Required | Description |
|---|---|---|
--store-id |
Yes | Store view ID for the order |
--product-id |
No | Specific product ID (random if omitted) |
--qty |
No | Order quantity (default: 1) |
--country-code |
No | Country code for addresses (default: NL) |
--lvb |
No | Set to 1 for FBB/LVB order simulation |
Output: Shows the created order increment ID on success, or error message on failure.
Use this when:
- Testing order import configuration
- Verifying shipping method assignment
- Testing before going live with a marketplace
channable:generate:token
Generates a new API token for Channable connections. The token is used in feed and webhook URLs.
# Generate token (fails if token already exists)
bin/magento channable:generate:token
# Force regenerate token
bin/magento channable:generate:token --force=1
Options:
| Option | Description |
|---|---|
--force |
Set to 1 to regenerate token even if one exists |
Important: After regenerating the token, you must update all connections in Channable with the new feed/webhook URLs.
Use this when:
- Initial setup (token is auto-generated, rarely needed)
- Security concerns (token may have been exposed)
- Troubleshooting authentication issues
Examples
Full deployment workflow
# After deploying code changes
bin/magento setup:upgrade
bin/magento cache:flush
# Verify configuration
bin/magento channable:selftest
# Test order import
bin/magento channable:order:simulate --store-id=1
# Push any pending product updates
bin/magento channable:item:update
Debug product sync issues
# Check configuration first
bin/magento channable:selftest
# Force push updates for specific store
bin/magento channable:item:update --store-id=1
Test international orders
# Test German order
bin/magento channable:order:simulate --store-id=1 --country-code=DE
# Test Belgian order
bin/magento channable:order:simulate --store-id=1 --country-code=BE
# Test US order (includes state)
bin/magento channable:order:simulate --store-id=1 --country-code=US
Need More Help?
- Test Orders - More details on test order parameters
- Product Updates Configuration
- Troubleshooting