How to connect KeyCRM to OpenCart

You can connect KeyCRM to OpenCart in two fundamentally different ways. The first is a regular connection for transferring new orders to CRM. The second is advanced two-way integration, where the store and KeyCRM also exchange products, categories, prices, balances, customers and statuses. The correct setting begins not with the "Set" button, but with a clear list of data and exchange directions.

First, define the scope of the integration

The official keyCRM connector for OpenCart designed primarily for receiving orders from the site. This is enough if managers need to see the buyer, order warehouse, payment and delivery in CRM, and the catalog and warehouse are further maintained in OpenCart.

If KeyCRM is to become the main accounting system, a broader scenario is needed: two-way statuses, products and options, prices, balances, categories, customers, anti-duplicate, CRON and outgoing webhook event handling. It is this scenario that closes advanced KeyCRM integration module with OpenCart by Build Zone.

What to prepare for connection

• I am making a backup copy of OpenCart files and database.
• A test copy of the store or an agreed short window for verification.
• An active KeyCRM account and administrator access to the settings section.
• KeyCRM API key; it cannot be sent in a public chat or stored in a public repository.
• A list of matching statuses, payment and delivery methods.
• Unique SKUs for each product and each option if catalog or stock exchanges are planned.
• SSL certificate and access to CRON on hosting.

Connecting KeyCRM to OpenCart step by step

1. Create a source in KeyCRM

In the KeyCRM settings, open the sources section, add OpenCart and specify the name of the store, its HTTPS address, currency and responsible manager. A separate source for each store simplifies analytics and prevents the same order numbers from being mixed up.

2. Create an API key

An API key is required for authorized requests between systems. It is transferred as a Bearer token and should only be stored in secure module settings. After rotating the key, it must be replaced in OpenCart, otherwise the API will respond with an authorization error. The key creation method and actual limits are described in keyCRM knowledge base.

3. Install the module in OpenCart

For OpenCart 3 format archive .ocmod.zip is downloaded via "Extensions → Install Extensions". After installation, update the modifiers, grant rights to the administrator group, and activate the module. If the store is heavily modified, test the process first on a test copy.

4. Specify accesses and directions of exchange

Plug in your source and API key, then enable only the operations you want. For example, orders can be sent from OpenCart to KeyCRM immediately, balances can be received from CRM on a schedule, and full import of goods can be started manually. This separation reduces the risk of accidentally overwriting the correct data.

5. Configure CRON and webhook

CRON is suitable for regular import and export of large sets: products, categories, customers and balances. KeyCRM outbound webhooks are required for quick response to order, status or inventory changes. Webhook notifies about the event, and detailed data is read by the module via API if necessary.

6. Run a test, not a full sync

Create one test product, customer and order. Check the fields in both systems and then change the status and balance. Only after successful completion of the scenario, start the bulk exchange.

Mapping of statuses, payments, deliveries and SKUs

Entity names and IDs across systems do not automatically match. The "Processing" status in OpenCart can correspond to the "New" stage in KeyCRM; "Bank card" — a specific payment method; one delivery to several services or tariffs. Mapping captures these correspondences and makes the exchange predictable.

For goods, the main key is usually SKU. Each option—for example, a particular size or color—must have its own unique article number. If two variants have the same SKU or article number is empty, the system will not be able to unambiguously determine which balance to update.

How to check that the integration is working

1. Place a test order as a regular customer.
2. Check name, phone, email, products, options, amounts, shipping and payment in KeyCRM.
3. Retry the event and make sure no duplicate is created.
4. Change the status in each system and check the given directions.
5. Update the price and balance of the test SKU.
6. Temporarily disable CRON or enter an invalid key in the test environment to see a clear log entry.
7. After regaining access, repeat the failed operation and check the recovery of the exchange.

Typical integration errors

Official or extended module

For easy transfer of new orders, start with the standard KeyCRM connector. If you need to work with catalog, two-way statuses, customers, prices, balances, options, categories, CRON and webhook events, use the advanced solution. A detailed analysis is in the material "Official KeyCRM module or advanced integration".