WooCommerce Remote Sync Balance
Documentation for the Plug and Pay WooCommerce Remote Sync Balance plugin.
Requirements
Technical Requirements
- PHP: 8.1, 8.2, or 8.3
- ionCube Loader: Required. For version requirements and installation details, check the IonCube Loader documentation.
- WooCommerce: 3.5 or higher
- WP-CLI: Recommended for scheduled product sync.
Store Setup Prerequisites
- Balance API Credentials: API Host (Endpoint), API Username, and API Password provided by Balance.
Integrations
Sync Products periodically pulls product data (price, stock) from Balance into WooCommerce. It supports simple and variable products, warehouse-level stock, selected warehouses, dynamic price types, forced sync, and manual product mapping.
Sync Order pushes new WooCommerce orders to Balance automatically. It creates or looks up the customer in Balance by their personal ID, then submits the order with line items, shipping, and the configured receivables account.
Technical Specification & Feature Support
| Feature | Supported |
|---|---|
| HPOS | Yes |
| Product Sync | Yes |
| Product Mapping | Yes |
| Product Import | No |
| Order Sync | Yes |
| WP-CLI Product Sync | Yes |
| WP-CLI Product Import | No |
When Stock in warehouse sync is enabled, warehouse-level quantities are stored in WooCommerce product meta under stock_in_warehouse while the total stock quantity continues to sync to WooCommerce stock.
WP-CLI Commands
Sync Products
# Pull latest price and stock from Balance into WooCommerce wp balance sync # Download the remote product list into the local mapping table wp balance download-list
Cron Scheduling
Product sync is lightweight and can run frequently. A typical setup runs sync every 15 minutes via a system cron:
# /etc/cron.d/remote-sync-balance # Sync price & stock every 15 minutes */15 * * * * www-data cd /var/www/html && /usr/local/bin/wp balance sync