To get started, you need to download the archive with the module (retailcrm-module_version.zip), which is available at the link GitHub.
Loading the integration module
The downloaded module must be loaded into PrestaShop. To do this, in the “Modules” section, go to “Module Manager” and click on the “Load module” button. Select the recently downloaded module on your computer and load it into PrestaShop. After successful loading, a message will be displayed: Module installed. Next, click “Set up”, a window with module settings will open.
You can also go to this page using the menu: in the “Improvements” - “Modules” - “Module Manager” block enter “Simla.com” in the search bar. Once the module is found, click “Set up”.
Connecting an account to the integration module
If you have not yet registered a CRM account, click “Get Simla.com for free” and a site for registering a new account will open in the adjacent tab.
If you already have a CRM account, click “I have an account in Simla.com” to proceed to setting up the module. In the “FAQ” tab you can find a description of the module and frequently asked questions.
The first step in setting up the module is to enter the data of the system being connected. In the first field specify the full URL of the system (for example, https://demo.simla.com ). In the second, the previously created API key. Click "Save".
Module settings
Note
If multisite is enabled in PrestaShop, then do not forget to set up the correspondence of stores in the system to PrestaShop sites.
After saving, a window with the main module settings will open. The “Connection” block will display the data of the connected system.
Next, you need to specify the correspondence between the values of the directories of the online store and the system.
Delivery types
In the “Delivery types” block, you need to associate the delivery service on the website with the delivery type in the system. Values for selecting matches are loaded from the directory [“Delivery Types”] (/Users/Administration/Dictionaries/SettingTypeOfDelivery) in the system. Please note that all types of deliveries, including inactive ones, are downloaded from the directory. After setting matches of all delivery methods, save the changes.
Note
If you later connect a new delivery service on the PrestaShop side, do not forget to add mapping to it in the module settings for correct operation. When placing an order with a delivery type that does not match, the order will be uploaded to the system, but the delivery type will not be selected in the order card.
Payment types
In the “Payment Types” block you need to establish correspondence of payment types between the system being connected and PrestaShop. All listed payment types are available, including inactive ones.
Note
After setting up the module, check the availability of payment methods for the available delivery types. To do this, go to the administrative panel of the PrestaShop website - “Improvements” - “Payment” - “Settings”, at the bottom find the “Carrier restrictions” block. Please also note that if payment for the order is made in “Cash”, then the amount of payment must be equal to the cost of the order.
Order statuses
In the “Order Statuses” block you need to set the correspondence of statuses between the system being connected and PrestaShop. If during the working process a new status is added on the PrestaShop side, you need to match it with the status in the system in the module settings for correct operation.
Note
It is necessary that the values in the mappings are not repeated, otherwise the correct operation of the module will not be guaranteed. Also, if an order in PrestaShop changes to a status for which a match is not selected in the module settings, then no further status updates for this order will occur in the system.
Additionally
Advanced module settings
Option ”Upload services to ICML”. When the option is enabled, all the products with the “virtual” type and for which no files have been added for downloading, will be considered as services and uploaded to the System as services.
Note
Uploading services via ICML file is available from version 3.6.4.
To enable the functionality of corporate customers, activate the "Corporate customers support" checkbox.
Find more about corporate customers in the corresponding section.
When the option "Sending order number to Simla.com " is activated, the order number will match the Reference field in the PrestaShop order. If the option is deactivated, then when uploading an order from PrestaShop to CRM, the order number will match the template of order number generation created via the API.
If you activate the option "Receiving order number from Simla.com", then when downloading an order from CRM to PrestaShop, the order number (the Reference field) will match the order number in CRM. If this option is deactivated, the order number will not be transmitted from CRM to PrestaShop.
Note
If you need to transfer the order ID as the order number to CRM, then specify the value
{external_id}in the “Template for generating order number from API” field in the CRM settings (Settings → System settings → General).
After entering all the required data, click Save.
Two-way synchronization
In order for the data to be updated on the PrestaShop side when order or customer data changes on the system side, you need to enable the “Synchronize orders from CRM” option.
After activating the option, you need to fill in the default parameters for delivery type and payment type, if payment or delivery type is not specified when placing an order in the system. Parameters are mandatory to be filled in.
PrestaShop triggers an order change event in three cases:
- When adding a product to an order;
- When changing an existing product in an 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 discount changes to the system, an additional change from the above listed must occur.
Work with balances
To receive up-to-date information on balances from CRM, you need to activate the checkbox "Receive balances from Simla.com".
In the field "If the order is paid" you need to specify the order status, which will be automatically entered if some product is out of stock and the order is paid.
In the field "If the order is not paid" you need to specify the order status, which will be automatically entered if some product is out of stock and the order is not paid.
In PrestaShop, the setting for allowing a purchase of a product when it is out of stock is set either in the product card itself (section “Availability Settings”), or in the store parameters (“Product Settings” - “Product stock” - “Allow ordering of products with zero stock balance").
Abandoned carts
To upload abandoned carts to CRM, you should activate the option “Upload abandoned carts”. The time after which the abandoned cart will be uploaded to the system is 15 minutes for the correct operation of the module.
Next, set the time after which the cart will be considered “abandoned”.
Data collection service
In this block you need to specify the site key to monitor the online status of users. Monitoring is performed using the internal service Daemon collector.
The key can be found in the system settings following the way Settings → Integration → Collector.
Online Consultant
If you need to use the “Online Consultant” widget on the website, insert the script from consultant module settings into this block and save the changes.
Work with orders
Uploading orders
In the “Uploading orders” block it is possible to upload several orders at a time - in this case, order identifiers are specified either separated by commas (1,2,3,4,5) or by a range (1-5). You can upload up to 10 orders at a time.
Non-uploaded orders
In this tab you can restart the uploading of non-uploaded orders.
Below you can find the table “Work with orders”. With its help you can check the result of synchronizing orders from PrestaShop to the system. It specifies the date and time of uploading, the order number in PrestaShop and the corresponding order number on the system side, as well as the status - “Uploaded” or “Error” if the order contains incorrect data.
Product catalog
This block contains the following information: whether the catalog is connected in the system, how much time has passed since the last generation of the ICML file and the number of Products and Trade offers in the generated catalog. When you click on the “Generate now” button, the command to generate the ICML catalog file will be launched.
In order to upload a catalog to the system you need to specify the option “Upload catalog from ICML now” in the store settings, in the system, or the catalog will be uploaded automatically according to a schedule (~ 4 hours).
Note
Please note that by default the module transmits weight in grams and dimensions in centimeters.
If the product has attributes (product with combinations) in the catalog on the PrestaShop side, then the versions of this product will be uploaded to the CRM as trade offers.
