Installation

Install the addon via «Administration» → «Add-ons» → «Manage add-ons». Find «MS: Extended RetailCRM Integration» and click «Install». After installation, the addon will appear in the sync data list.

Where settings are located

All addon settings are in «Administration» → «Sync data» → «MS: Extended RetailCRM Integration». The interface is organized in tabs: General, Orders, Warehouses, Import statuses, Export statuses, Payment methods, Shipping methods, User fields, Callback and one-click purchase, Cron.

Configuration — «General» tab

RetailCRM URL — enter the full URL of your RetailCRM account (e.g. https://your-store.retailcrm.ru/). You can copy it from the browser address bar when logged into RetailCRM.

API key — get the key in RetailCRM: «Settings» → «Integrations» → «API keys» → «Add key». Create a key with read and write permissions. Copy the key and paste it into the field.

Enable sync — check this to activate synchronization. Without it, no exchange occurs.

Export product external_id — enable if you need to export product external ID to RetailCRM.

Default currency — select the currency for amounts sent to RetailCRM.

Default site and Default warehouse — select from the list loaded from RetailCRM after entering URL and API key. These values are used when creating orders and products.

Configuration — «Orders» tab

Export orders from CS-Cart to RetailCRM — mode: disabled, create only, update only, full sync. When enabled, set the export mode: all orders, today only, from date, last N days.

Import orders from RetailCRM to CS-Cart — similar modes. When importing, new orders are created on the site; when updating, changes are synchronized.

In the «Order general settings» subsection configure: order type, method, URL field for order, add to comment (coupon, delivery address, shipping method), import notes and details, export changes.

Incomplete purchases — enable to export carts to RetailCRM. Specify the order method and status for such orders, and whether to add cart items to the comment.

In the «Individual» and «Legal entity» sections, map RetailCRM fields to CS-Cart profile fields (name, phone, email, address, etc.). In «Custom fields» map additional order fields.

Configuration — mapping tabs

Warehouses — map CS-Cart warehouses/PVZ to RetailCRM stores/warehouses.

Import statuses and Export statuses — map CS-Cart order statuses to RetailCRM statuses. Without mapping, orders may not sync correctly.

Payment methods and Shipping methods — map payment and shipping methods between systems.

User fields — map additional profile fields to RetailCRM fields.

Configuration — Callback and one-click purchase

Requires the «Callback» addon. Enable integration, choose the action on callback (create no order, create order, create order with products). Configure field mapping and, if needed, add products to comment on one-click purchase.

Configuration — «Cron» tab

Cron password — set a secret key (default ms_retailcrm). It is used to authorize cron requests.

After saving settings, cron links will appear for: import of order and customer history, export users, import users, import orders, export orders. Copy the required command and add it to crontab on the server (e.g. every 10 minutes: 10 * * * *).

Using the addon

After enabling sync and saving settings, synchronization runs automatically when orders are created or updated on the site, when customers register, and on payment. For bulk export or import, use cron tasks.

On the order edit page in CS-Cart admin, the RetailCRM order ID is shown (if the order was exported). Buttons are available to export product data to RetailCRM and import from RetailCRM to the site.

Verifying operation

1. Create a test order on the site — it should appear in RetailCRM under «Orders».

2. Create an order in RetailCRM — with import enabled, it should appear in CS-Cart.

3. Check logs: sync settings show the last export info (updated and skipped count). If there are errors, verify URL, API key, and status, payment, and shipping method mapping.

Common issues

Orders not exporting — ensure «Enable sync» is checked, order export is not disabled, and statuses and payment/shipping methods are mapped.

API error — ensure the URL has no extra characters, the API key is valid and has the required permissions.

Customer duplication — the addon searches customers by email and phone; with mismatched data, duplicates may be created. Check field mapping.