- Version
- Download 3
- File Size 326.40 KB
- File Count 1
- Create Date 24/05/2025
- Last Updated 27/05/2025
PrestaBuy MinSync - PrestaShop module designed to provide essential synchronization
PrestaShop to BigBuy Minimal Synchronization Module (PrestaBuy MinSync)
**Version:** 1.0.0 (MVP)
**Author:** Deniss Piunoff
**Compatibility:** PrestaShop 1.7.x - 8.x.x (Tested on PrestaShop 1.8.2)
**License:** OSL-3.0 (Open Software License)
Description
PrestaBuy MinSync is a PrestaShop module designed to provide essential synchronization functionalities with the BigBuy dropshipping supplier. This MVP (Minimum Viable Product) version focuses on:
* Connecting to the BigBuy API (Sandbox and Production environments).
* Synchronizing selected BigBuy categories to your PrestaShop store, maintaining their hierarchy.
* Importing products from chosen BigBuy categories into the corresponding PrestaShop categories.
* Handling multilingual product data (names, descriptions).
* Attempting to download product images (with error handling for missing images on CDN).
* Updating product stock levels.
* Sending new orders from PrestaShop to BigBuy for fulfillment.
* Providing CRON URLs for automated background synchronization.
* Logging API interactions and synchronization processes for debugging.
This module aims to provide a foundational, yet functional, integration for PrestaShop store owners wishing to dropship with BigBuy.
Core Features
* **API Configuration:** Securely store your BigBuy API key, select the environment (Sandbox/Production), and choose the default language for data retrieval.
* **Category Synchronization (`Category Settings` Tab):**
* Browse and select BigBuy categories for import.
* The module automatically creates the selected BigBuy categories and their parent structure within your PrestaShop catalog.
* Maintains a mapping between BigBuy category IDs and PrestaShop category IDs.
* **Product Synchronization (`Products Management & Filters` Tab):**
* Select which of your PrestaShop categories (previously synced from BigBuy) you want to populate with products.
* Choose which product fields to synchronize (name, descriptions, price, quantity, reference, images, manufacturer, EAN13, weight, dimensions).
* Products are fetched from the first-level parent BigBuy category and then all products from this parent are imported into the user-selected PrestaShop category.
* Creates new products or updates existing ones based on SKU matching.
* Handles multilingual names and descriptions.
* Downloads product images, gracefully skipping images that return a 404 error from BigBuy's CDN.
* Updates stock quantities based on BigBuy's data.
* **Order Synchronization (`Module Settings` & Automated):**
* Configure a PrestaShop order status that triggers the sending of the order to BigBuy.
* Automatically sends new orders (customer details, products, shipping information) to the BigBuy API for fulfillment when the specified order status is reached.
* **CRON Tasks (`Actions and Logs` Tab):**
* Provides URLs for setting up CRON jobs to automate:
* Category synchronization.
* Product synchronization (including stock and price updates).
* **Logging (`Actions and Logs` Tab & `/modules/bbminsync/logs/`):**
* Detailed logging for API requests/responses (`api.log`).
* Logs for category, product, and order synchronization processes (`sync.log`, `order.log`).
* Logs for CRON job executions (`cron.log`).
* Ability to clear logs from the admin interface.
Installation
Please refer to `INSTALL.md` for detailed installation instructions.
Usage Guide
After successfully installing and configuring the module:
1. **Module Settings:**
* Enter your BigBuy API Key.
* Select the BigBuy Environment (start with "Sandbox").
* Choose the "Default Language for BigBuy Data".
* Set the "Default Parent PS Category ID for Categories" (usually your "Home" category ID, e.g., 2).
* Select the "Order Status for Sending to BigBuy" (e.g., "Payment accepted").
* Save settings.
* Test the API connection via the "Actions and Logs" tab.
2. **Category Synchronization:**
* Navigate to the "Category Settings" tab.
* The category tree from BigBuy will be displayed. Select the categories you wish to create in your PrestaShop store.
***Important:** If you select a child category, its parent categories (up to the BigBuy root) will also be automatically created in PrestaShop to maintain the correct hierarchy.
* Click "Sync Categories Now".
3. **Product Synchronization Configuration:**
* Navigate to the "Products Management & Filters" tab.
***Category selection for product import:** From the "Mapped & Ready BigBuy Categories" dropdown, select the PrestaShop categories (which correspond to BigBuy categories synced in the previous step) into which you want to import products. You can select multiple categories.
***Products filter:** Check the boxes for the product fields you wish to synchronize.
* Click "Save Product Import Config".
4. **Product Synchronization Execution:**
* On the "Products Management & Filters" tab, click "Sync Products Now".
* The module will fetch products from the first-level parent category of each selected BigBuy category and import/update them into the corresponding PrestaShop category you chose.
5. **Order Synchronization:**
* This process is automatic. When an order in PrestaShop reaches the status you configured in "Module Settings", the module will attempt to send it to BigBuy. Check `order.log` and `api.log` for details.
6. **CRON Job Setup:**
* Go to the "Actions and Logs" tab -> "CRON Tasks" section.
* Copy the provided URLs.
* Configure CRON jobs on your server to call these URLs at your desired frequency (e.g., daily for categories/products, more frequently for stock/price if needed).
Known Limitations & Issues (MVP)
* **Product Image Availability:** In sandbox mode some product images provided by BigBuy via their API may not be available on their CDN (resulting in 404 errors). The module logs these errors and skips the missing images.
* **Product Categorization in PS:** All products fetched from a BigBuy first-level parent category (determined by the user-selected category) are currently placed into the single PrestaShop category chosen by the user for that import branch. More granular assignment to sub-categories based on the product's actual BigBuy category ID is a potential future improvement.
* **Product Variations/Combinations:** Not supported in this MVP. Only base products are handled.
* **Attribute Mapping:** Not implemented.
* **Manufacturer Handling:** Manufacturers are created with a generic name like "BigBuy Manufacturer ID: X" if not found by a (currently not implemented) name lookup.
* **Tax Handling:** Products are imported with a default tax rule group (typically "No Tax").
* **Carrier Mapping:** Not implemented for outgoing orders.
* **Order Status Sync (BigBuy to PS):** Not implemented.
Future Development Ideas
* Advanced mapping options for categories, attributes, features, manufacturers, taxes, and carriers.
* Support for product combinations/variations.
* More precise product categorization options during import.
* Synchronization of order statuses and tracking information from BigBuy back to PrestaShop.
* Advanced pricing rules and margin calculations.
* Performance optimizations for very large-scale operations.
Demo
Support
Your questions, issues and tests results are more than welcome to be sent to:
deniss@piunoff.eu
www.piunoff.tech
---