To get started, you need to download the archive with the RetailCRM module, which is available in the PrestaShop marketplace.
Upoading the integration module
The downloaded module must be uploaded to PrestaShop. To do this, in the "Modules" section, go to the "Module Manager" and click on the "Load module" button. Select the recently downloaded module on your computer and upload it to PrestaShop. After a successful upload, the following message will be displayed: “The module is installed”. Next, click "Configure", and a window with the module settings will open.
You can also go to this page using the menu via the following path: "Improvements" - "Modules" - "Module Manager", enter "RetailCRM" in the search bar. After you've found the module, click on "Configure".
Connecting an account to the integration module
If a RetailCRM account has not been registered yet, click "Get RetailCRM for free", and a site for registering a new account will open in the next tab.
If you already have a RetailCRM account, click "I have an account in RetailCRM" to proceed to configure the module. In the "FAQ" tab, you can familiarise yourself with the description of the module and with frequently asked questions.
The first step in configuring the module is to enter the data for the system to be connected. In the first field, enter the full URL of the system (for example, https://demo.retailcrm.pro). In the second, enter the previously created API key. Click "Save".
Main module settings
After saving, a window with the main module settings will open. The "Connection" block will display the data of the connected system. In order to update the data on the PrestaShop side when changing order or customer data on the RetailCRM side, you need to enable the "Enable history upload" option.
PrestaShop triggers an order change event in three cases:
- When adding a product to the order;
- When changing the product existing in the order (for example, changing its quantity);
- When deleting a product from an order.
In all other cases, the event is not triggered. Thus, due to the specifics of the PrestaShop platform, we cannot transfer a change if only discounts in the order have been added or changed. To transfer changes of discounts to the system, an additional change from the above-mentioned list must be made.
To receive up-to-date information on stock balances from RetailCRM, you need to activate the "Receive stock balances from RetailCRM" checkbox.
To enable the corporate customers functionality, activate the "Enable support for corporate customers" checkbox.
Read more about corporate customers in the corresponding section.
The corporate customers functionality will only work correctly if the fuction has been activated in the connected system. If the system contains customers with the "Legal entity" contractor type, then it is necessary that the migration of legal entities to corporate customers has been carried out.
After entering all the necessary data, click "Save".
Next, you need to specify the correspondence of the values between the online store and system's data books.
"Delivery types" tab
In the "Delivery types" block, it is necessary to match the delivery service on the site with the type of delivery in the RetailCRM. The values for the selection of matches are uploaded from the "Delivery types" data book in the system. Please note that all types of deliveries are uploaded from the data book, including inactive ones. After matching all delivery types, save your changes.
If in the future you connect a new delivery service on the PrestaShop side, don't forget to add a map for it in the module settings. When placing an order with a delivery type that does not have any matches, the order will be uploaded to the system, but the delivery type will not be selected in the order card.
"Order statuses" tab
In the "Order statuses" block, it is necessary to set correspondences to statuses] between RetailCRM and PrestaShop. If a new status is added whilst working on the PrestaShop side, it must be matched with the status in RetailCRM in the module settings for correct operation.
It is necessary that the values in the mappings are not repeated, otherwise the module may not work correctly. Also, if an order on PrestaShop is transferred to a status that has not been matched in the module settings, then RetailCRM will not update the status for this order any further.
"Payment types" tab
In the "Payment types" block, it is necessary to set correspondences of types of payments between the connected system and PrestaShop. All the listed types of payments are available in the selection, including inactive ones.
After configuring the module, check the availability of payment types for the available delivery types. To do this, go to the administrative panel via the path: "PrestaShop" - "Improvements" - "Payment" - "Settings", "Carrier restrictions". Also note that if payment for an order is to be made in "Cash", then the payment amount must be equal to the value of the order.
Tab "By default"
In the "By default" tab, you must specify the correspondences to the payment and delivery types that will be applied if the type of payment or delivery is not specified in the system when placing an order in the system. Please note that these parameters are required.
"Uploading orders" tab
In the "Uploading orders" tab, it is possible to upload several orders at a time. In this case, order IDs are specified either with a comma (1,2,3,4,5), or by a range (1-5). Up to 10 orders can be uploaded at a time.
"Abandoned carts" tab
If you want abandoned shopping carts to be uploaded to the system, check the “Create orders for abandoned shopping carts” box in the “Abandoned carts” block. These orders will be uploaded to the system with the status set in the "Order status for abandoned shopping carts of buyers" field. The time after which the abandoned cart will be uploaded to the system is recommended to be set at least 15 minutes.
It is also possible to export all orders and customers from PrestaShop to the system by clicking on the “Export” button.
Please note that the tab should remain open while exporting orders.
You can check the result of synchronization of orders from PrestaShop to the system in the "Uploaded orders" table. Specify the export date and time, the order number in PrestaShop and the corresponding order number on the system side, as well as the status - "Uploaded" or "Error" (if incorrect data was specified in the order).
“ICML catalogue” tab
This section contains the following information: whether the catalogue is enabled in the system, how much time has passed since the last generation of an ICML file, and the number of products and SKUs in the generated catalogue. When you click on the "Generate now" button, the command for generating the ICML catalog file will be launched.
In order to upload the catalogue to the system, you need to specify the “Upload catalogue from ICML now” option in the store settings in the system. Otherwise, the catalogue will be uploaded automatically every 4 hours.
Please note that, by default, the module transfers weight in grams and dimensions in centimeters.
If in the catalogue (on the PrestaShop side) a product has attributes (a product with combinations), then in RetailCRM the variants of this product will be uploaded as SKUs.
"Daemon collector" tab
In the "Daemon collector" tab, you can is specify the site key for tracking the online status of users.
"Live Chat" tab
If you need to use the "Live Chat" on the website, insert the script from the settings of the Live Chat module into this block and save the changes.