KeyCRM Sync — CRM for OpenCart 2.3, 3.x & 4.x

KeyCRM Sync for OpenCart 2.3, 3.x and 4.x is a module that keeps your store in two-way sync with KeyCRM. In the forward direction, every OpenCart order is automatically created in the CRM — with the customer, products, shipping and payment method. In the reverse direction (optional), the module pulls order statuses, waybill numbers and even stock levels from KeyCRM back into OpenCart. Managers run sales from a single CRM window, and the store stays up to date with no manual work.

The module is completely free. The code is open on GitHub: github.com/catcodestudio/opencart-keycrm-sync. All you need is an API key from your KeyCRM account — no subscriptions and no extra services.

How it works, step by step

1. The customer places an order in the OpenCart store.
2. The module builds the data for the CRM: contacts, products, shipping and payment. The phone number is normalised into the +380 format, and zero-price line items are skipped.
3. The order is sent to KeyCRM — right at checkout or when it reaches the configured status. The order source is created in the CRM automatically on the first send.
4. Duplicate protection: a unique key, UNIQUE(order_id, target), in the log guarantees the order won’t be duplicated even if the event fires again.
5. Failed sends go into a retry queue — a separate cron task keeps retrying them, up to a limited number of attempts.
6. Reverse sync (if enabled): a second cron task periodically pulls updated statuses from KeyCRM (according to your “KeyCRM status → OpenCart status” mapping), adds a comment with the waybill to the order history, and, with a separate checkbox, updates product stock by SKU.

Under the hood

• Database-level idempotency — UNIQUE(order_id, target) in the log table: a duplicate is impossible even if an OpenCart event fires twice.
• The API key is encrypted in the database — sodium with an HMAC fallback, never stored in plain text.
• A sync log with a per-status record for every order and fragments of the API request/response — handy for figuring out why a particular order didn’t go through.
• Reverse sync with no loops: it reads from KeyCRM only to fetch data, and while writing the order history it suppresses the forward-sync event — nothing is sent back to the CRM. Every run rescans a 10-minute overlap so no borderline update is missed; times are in UTC.
• Adapter architecture — the order mapper and the dispatcher are decoupled from any specific CRM, with KeyCRM implemented as an adapter.

How to install

1. Download cc_crm.ocmod.zip via Extensions → Installer in the OpenCart admin panel. For OpenCart 3.x, use the cc_crm-oc3.ocmod.zip build.
   For OpenCart 2.3, take the cc_crm-oc2.ocmod.zip build. The 2.3 built-in installer only copies files over FTP, so if FTP isn’t set up, unpack the archive and upload the contents of the upload/ folder to the store’s root.
2. Go to Extensions → Modules, find KeyCRM Sync and click “Install”.
3. Open the module’s settings and paste in the API key from your KeyCRM account.
4. Enable sending and choose the trigger: right at checkout, or on a status change.
5. If needed, enable reverse sync on the “Reverse sync” tab: set up the status mapping (the list of KeyCRM statuses loads right in the admin panel) and add the cron tasks.
6. OpenCart 2.3 and 3.x: these versions have no scheduler at all, so both cron URLs (retry queue and reverse sync) are simply shown in the module settings — add them to the system crontab. There’s also a “Cron token” field next to them: fill it in so no one else can trigger these URLs.