OpenCart AliExpress Retail Plugin User Guide By Lim Tee Chert 30 April 2015 (last updated on: 15 Oct 2015) http://www.aliwebstore.com
Purpose: The purpose of this Opencart AliExpress Retail Plugin is to provide 1-way data transmission from AliExpress into Opencart covers module for Categories, Manufacturer/Brand, Products, Product Attribute, Product Option, Product Images, Special Price and CSV Bulk Upload. Compatible: No 1. Software Version Opencart 2.0.3.1 2.1.0.1 DISCLAIMER: USE AT YOUR OWN RISK. WE DO NOT ISSUED ANY WARRANTY FOR THIS PLUGIN. THE LICENSE IS GRANTED FOR SINGLE DOMAIN ONLY. IF YOU NEED TO DEPLOYED IN SECOND DOMAIN, YOU NEED TO BUY ANOTHER LICENSE FROM US.
Table of Contents Pre-requisite... 4 How To Install OpenCart AliExpress Retail Module...5 How To Configure Opencart AliExpress Retail Module... 6 How To Configure Opencart Default Length and Weight Class...15 How To Apply AliExpress Tracking ID, App Key and Secret Key... 16 How To Bulk Upload Product using CSV File Into OpenCart Store...17 How To Manually Add/Update Products Into OpenCart Store...20 How To Setup Cron Jobs...24 Auto Load Categories Into OpenCart Store... 26 Auto Load Manufacturer/Brand Into OpenCart Store... 27 Auto Load Products Into OpenCart Store... 28 Support... 32
Pre-requisite Software Requirements: Software Website Opencart http://www.opencart.com Compatible: Opencart 2.0.3.1 2.1.0.1 Server Requirements: Web Server (Preferable Apache Web Server) PHP (Supported Version 5.3.x / 5.4.x / 5.5.x) MySQL Database PHP Curl & PHP Mbstring ioncube PHP Loader (At least version 4.4.1 and above) 1) Please follow the step to installed Opencart VQMod (At least version 2.5.1 and above) https://github.com/vqmod/vqmod/releases/download/v2.5.1-opencart.zip/vqmod-2.5.1-opencart.zip How to install VQmod on Opencart (Video Tutorial) https://www.youtube.com/watch?feature=player_embedded&v=ezs1jwommjc 1. Download the latest version that has "opencart" in the title from http://code.google.com/p/vqmod 2. Using FTP, upload the "vqmod" folder from the zip to the root of your opencart store. 3. Be sure the vqmod folder and the vqmod/vqcache folders are writable (either 755 or 777). Also be sure index.php and admin/index.php are writable. If not sure which you need, first try 755. If you get errors about permissions, then try 777. 4. Goto http://www.yoursite.com/vqmod/install 5. You should get a success message. If not, check permissions above and try again 6. Load your store homepage and verify it works. 7. Using FTP, verify that there are new "vq" files in the "vqmod/vqcache" folder. 8. If yes, then you are ready to start downloading or creating VQmod scripts, otherwise ask for assistance. You're done. If you do not have any web hosting, we recommend 1) VPS Server www.digitalocean.com
How To Install OpenCart AliExpress Retail Module Installation Notes: 1. 2. 3. 4. Please make a FULL BACKUP before executing this step. I am using opencart version 2.1.0.1 for our documentation. No files will be overwritten. Go to opencart_v2.0.x/new_install There are 4 folder need to be deploy into Opencart folder. admin - is a back-end module for opencart aliretailsync AliExpress WebService API catalog - is a front-end module for opencart vqmod - is an xml file support for opencart 5. Use FTP program (FileZilla) to transferred the files into your Opencart ROOT folder. Drag n drop admin, aliretailsync, catalog and vqmod folder into opencart folder
How To Configure Opencart AliExpress Retail Module 1) Login to OpenCart using admin 2) Click the Home -> Modules 3) Click Install to setup AliWebStore AliExpress Retail Plugin 4) Click Edit to configure AliWebStore AliExpress Retail Plugin General Settings Value Description Status 1 = Enabled Sync Process 0 = Disabled Sync Process (Turn Off) Always set to 1 to enabled the sync process Version 2.0.2.x Opencart Version Is Debugging Mode 1 = Yes 0 = No (default) set to 1 for Debugging Mode set to 0 for Production Mode I am running on VPS / Cloud / Dedicated Server 256MB Set to VPS / Cloud / Dedicated Server. Choose your available Memory Limit in Opencart php.ini Data Sync URL http://www.yourdomain.com/aliretailsync Data Sync URL.
AliExpress Settings Value Description AliExpress Website Main Site AliExpress.com (default) Choose your AliExpress default to English AliExpress.com Default Language English (default) Choose your Default Language for your store Tracking ID / Affiliate ID tracking_id Your Tracking ID App Key app_key Your App Key (Public Key) Secret Key Private secure key Your Secret Key (Private Key) Criteria Settings Value Description Page Number 1 = (default) Page Number start from 1-10 only. For Cronjob Add Products Only. Minimum Price (USD) From: 10.00 Minimum product price to be added into your store. Maximum Price (USD) To: 9999.00 Maximum product price to be added into your store. Commission Rate (%) From: 0.03 Commission Rate From must be start from 0.01 0.09 Commission Rate (%) To: 0.05 Commission Rate To must be start from 0.01 0.09 Seller Credit Score From: 3 Minimum limit of the credit score of the seller Seller Credit Score To: 5 Maximum limit of the credit score of the seller Sort By: orignalpriceup, orignalpricedown, sellerratedown, commissionrateup, commissionratedown, volumedown, validtimeup, validtimedown Sort by price from high to low and from low to high, credit score from high to low and from low to high, the commission rate from high to low and from low to high, volume from high to low, the valid time from high to low and from low to high. Categories Choose the categories that you wish to add the products into your store running with Cronjob. Products Settings Value Description Default Product Quantity 5 (Default) Minimum Quantity = 5 Default Tax Class None (Default) Default to None Default Stock Status In Stock Default to In Stock Update Product Information Yes (Default) No Note: Price vary depending on AliExpress Update Product Information like Model, Quantity, Stock Status, Dimension (L x W x H), Weight, Manufacturer Update Product Specification Yes (Default) No Update Product Attribute Update Product Option like Size, Color Yes (Default) No Update Product Option like Size, Color Update Product Price Yes (Default) No Note: Price vary depending on AliExpress Update Product Price whenever the product change to latest price. Update Product Special Price Yes (Default) No Note: Special Price vary depending on AliExpress Update Product Special Price whenever the product update their discounted price.
Update Product Title Yes No (Default) Update Product Title. If you do not wish to update product title, please set to No. You can manually edit your Product Title without overwritten Update Product Description Yes No (Default) Update Product Description. If you do not wish to update product description, please set to No. You can manually edit your Product Description without overwritten Update Product Image Yes (Default) No Update Product Image to refresh any new images available in AliExpress Update Product To Category Yes (Default) No link the Product to Main Category Disabled Product Yes (Default) No Set Products Status = Disabled when the product have been removed from AliExpress or product is no longer available.
Price Markup Settings Value Description Default Product Markup Price 10 Value (Numeric Only) Type Markup Price in Percentage / Amount. Default to Percentage. - Percentage (default) - Amount Higher / Lowest Markup Price Lowest Price is Better (default) Override Default Product Markup Price based on Category Category Markup Price Category / Sub-categories Price in value Markup Price using - Lowest Price is Better - Higher Price is Better Status Enabled / Disabled
SEO Settings Value Description Product Title Length 150 characters long Suggested to be 150 character long Product Image Length 200 characters long Suggested to be 200 character long
Misc Settings Value Description Is Enabled API Yes = (default) No Enabled API for CSV Bulk Upload and REST API Remote Access My API Key Random Key. Must be in numeric format You can auto generate new API or enter your own preferences number. CSV Header Delimited By ; = (default) Default to semi-column (;) to separate the Header Column by semi-column. Valid value can be ; or Remove CSV File After Processing Yes = (default) No Delete the CSV file after processing.
How To Configure Opencart Default Length and Weight Class By using our AliExpress, you need to configure your setting under Home Settings Edit your store, Under the Local tab
How To Apply AliExpress Tracking ID, App Key and Secret Key 1) Visit to AliExpress Portal and Click on New User Guide http://portals.aliexpress.com/help/help_center.html 2 3 Copy the API KEY and Digital Signature into Opencart Extensions Modules AliWebStore AliExpress Retail Plugin Tracking ID/Affiliate ID: tracking_id App Key: 12345 Secret Key: ABCDEFG 1
How To Bulk Upload Product using CSV File Into OpenCart Store 1.1 Goto Home Extensions -> Modules AliWebStore AliExpress Retail Plugin 1.2 Under the Misc Settings, enable API and fill in the API Key and CSV Header Delimiter 1.3 Goto Home Systems User Group Choose the Top Administrator grant the Access Permissions for catalog/aliwebstore_csv_import. Click Save button 1.4 Goto Catalog Products 1.5 Click Switch To AliExpress button
1 2 Click Browse to attached the CSV file Click CSV Bulk Upload to process the CSV file Sample CSV File Format 1 API_KEY is the Unique API that define under AliExpress Retail Plugin Misc Settings CATEGORY_ID refer to Opencart category_id. Products will add into Opencart Category If APPEND_CATEGORY=1. It will Auto Append the products to the targeted Category If APPEND_CATEGORY=0. It will re-organize all products into targeted Category Only CSV Header File delimiter by semi-column (;) API_KEY=1383117719038 APPEND_CATEGORY=1 CATEGORY_ID=60,61 AliExpress Product ID Sample CSV File Format 2 (CATEGORY_ID is optional. It will auto create Category based on AliExpress Category)
How to lookup for Opencart category_id from Opencart Admin Store. Goto Catalog Categories, click Edit link to choose the category. For example: Apparel & Accessories API_KEY=1383117719038;APPEND_CATEGORY=1;CATEGORY_ID=60,61 Default to semi-column (;). Separate the Header by column by semi-column. Valid value can be ; or API_KEY = {My API KEY} CATEGORY_ID={Opencart Category ID} You can add the products into many categories separate the category_id by comma (,)
How To Manually Add/Update Products Into OpenCart Store 1.1 Goto Home Catalog Products 1.2 Click Switch To AliExpress button 1.3 You are now entering AliExpress Products page 1.4 Click Switch To Product button to switch back to the Opencart Product page
AliExpress Products Settings Value Description Search By Search By Keywords or Product ID 1 = Keywords (default) 2 = Product ID Search Text 1) Search by Keywords Enter your keywords in the text-box. For example: tablets 2) Search by Product ID If you know exactly your product ID, you can enter your Product ID as below: 2.1 Single Product Product ID 32298038687 2.2 Multiple Product Product ID 32298038687,32254114654 Notes: Up to Maximum of 10 Product ID. Separate each Product ID by comma (,) and no spacing in between AliExpress Category All A list of available AliExpress Categories available in the marketplace. Choose the category and search for your products Price (USD) From: 10.00 Minimum product price to be search Price (USD) To: 9999.00 Maximum product price to be search Commission Rate (%) From: 0.03 Commission Rate From to be search Commission Rate (%) To: 0.05 Commission Rate To to be search Seller Credit Score From: 3 Minimum Limit of the credit score to be search Seller Credit Score To: 5 Maximum Limit of the credit score to be search Sort By: orignalpriceup, orignalpricedown, sellerratedown, commissionrateup, commissionratedown, volumedown, validtimeup, validtimedown Sort by price from high to low and from low to high, credit score from high to low and from low to high, the commission rate from high to low and from low to high, volume from high to low, the valid time from high to low and from low to high.
2 1 Enter your categories 4 5 3 Example Search By Product ID 1.4.1 Search By: Product ID 1.4.2 Search Text: 32254114654,32259740275 1.4.3 All others field will be Disabled (Grey-out) 1.4.4 Click Search By AliExpress button 1.4.5 A list of AliExpress result will be automatically show on the product page 1.4.6 To Add/Update the products, please ticked the checkbox 1.4.7 Enter your target category (Auto Complete), it will automatically added into your selected target categories 1.4.8 To Add/Update the products, please ticked the checkbox and then click on Import/Update AliExpress Product button.
Example Search By Keywords 1.4.1 Search By: Keywords 1.4.2 Search Text: tablets 1.4.3 Choose the AliExpress Category. 1.4.4 Enter the Price (USD) From 1.4.5 Enter the Price (USD) To 1.4.6 Enter the Commission Rate (%) From 1.4.7 Enter the Commission Rate (%) To 1.4.8 Enter the Seller Credit Score From 1.4.9 Enter the Seller Credit Score To 1.4.10 Choose the Sort By 1.4.11 Click Search By AliExpress button 1.4.12 A list of AliExpress result will be automatically show on the product page 1.4.13 To Add/Update the products, please ticked the checkbox and then click on Import/Update AliExpress Product button.
How To Setup Cron Jobs There are 2 important step to setup and configure cronjob. (SKIPPED to Step 2 if you are not using Bluehost/JustHost) 1) How to install ioncube in Bluehost / JustHost BlueHost - https://my.bluehost.com/cgi/help/149 JustHost - https://my.justhost.com/cgi/help/149 You need to copy public_html/php.ini into aliretailsync folder: copy the public_html/php.ini into aliretailsync/api/php.ini copy the public_html/php.ini into aliretailsync/opencart/aliwebstore/php.ini 2) Cronjob Setting Auto Update AliExpress Data into Opencart for daily cronjob running at every 15 minutes started from 1am - 6am Using cpanel Scroll down until you see the Cron jobs Cronjob Setting for Daily Update Products at 1am - 6am ------------------------------------------------------------------------------------------------curl "http://www.yourdomain.com/aliretailsync/opencart/aliwebstore/sync-opencart-aliwebstore-sync-item.php" >/dev/null 2>&1 ------------------------------------------------------------------------------------------------NOTES: Please change the yourdomain.com to your own domain name
01-06 opencart/aliwebstore/sync-opencart-aliwebstore-sync-item.php OPTIONAL Notes: If you wish to add products at 4am. Add the Cronjob below. ------------------------------------------------------------------------------------------------curl "http://www.yourdomain.com/aliretailsync/opencart/aliwebstore/sync-opencart-aliwebstore.php" >/dev/null 2>&1 ------------------------------------------------------------------------------------------------NOTES: Please change the yourdomain.com to your own domain name opencart/aliwebstore/sync-opencart-aliwebstore.php
Auto Load Categories Into OpenCart Store All Categories will be automatically loaded into opencart store.
Auto Load Manufacturer/Brand Into OpenCart Store All Manufacturer/Brand will be automatically loaded into opencart store.
Auto Load Products Into OpenCart Store All Products will be automatically loaded into opencart store.
Product Attribute will be automatically created.
In Main Store Product Specification Page
Product Option will be automatically created. In Main Store Product Page
Product Special Price will be automatically created. Product Images will be automatically created. Support Support for installation and troubleshooting is available via support email at support@aliwebstore.com