Skip to content
Azimea Docs

OpenCart

What it brings

Section titled “What it brings”
  • Customers with an account and guest buyers (taken from their orders), as contacts.
  • Orders of the last 12 months and products with price and stock.
  • Carts as they happen, anonymous ones included, with the email typed at checkout.
  • Newsletter consent with its proof.

Requirements

Section titled “Requirements”
What Why
OpenCart 4.0.2.x or 4.1.x, PHP 8.1+ The versions the extension runs on. OpenCart 3 is not supported.
The site on HTTPS Keys are never sent unencrypted.
An admin account that can use Extensions › Installer To install the extension.
Optional: a cron every 1 to 5 minutes Quicker retries; its address is on the extension’s page.

How it works

Section titled “How it works”

OpenCart has no API for customers, orders and products, so the Azimea extension does both halves of the connection:

  • Reading: it opens a read address that only Azimea can use, with signed requests and a read key and secret made in the extension. That address only reads.
  • Sending: with Send events switched on, it sends every cart change, the email typed at checkout, orders and their status changes, accounts, and newsletter consent. An order is announced when it gets its first real status (after payment or the merchant’s confirmation), not when the checkout writes it.
  • It works only through OpenCart’s event system, with no OCMOD patches: its events are registered on install and removed on uninstall. Retries go out on later visits, at most every 30 seconds, or from the cron.

Install and connect

Section titled “Install and connect”

1. Install the extension

Section titled “1. Install the extension”
  1. Download it: azimea-opencart.ocmod.zip.
  2. In the admin, upload it in Extensions › Installer.
  3. In Extensions › Extensions › Modules, install Azimea and open it.

2. Connect in Azimea

Section titled “2. Connect in Azimea”
  1. In the extension, under What Azimea reads from the shop, copy the store address, the Read key (azr_…) and the Read secret (azs_…).
  2. In Azimea, open Integrations › OpenCart › Connect your store, paste the three and press Check and connect.

3. Switch on the events

Section titled “3. Switch on the events”
  1. In Azimea, on the OpenCart page, under Store plugin, press Generate keys and copy the store key and the secret (shown only once).
  2. Back in the extension, paste both, switch on Send events, save and press Test connection.
  3. Add a product to the cart on your site: the plugin status in Azimea turns to Connected.

The store key, the secret and the events address can also be fixed in config.php / admin/config.php or the environment (AZIMEA_STORE_KEY, AZIMEA_SECRET).

Statuses

Section titled “Statuses”

The store and plugin statuses are explained in the overview; order statuses in carts and orders.

Troubleshooting

Section titled “Troubleshooting”
Symptom Likely cause Fix
stores.opencart_extension_not_found The extension did not answer at this address. Check the address, and that the extension is installed and enabled.
stores.opencart_key_format / stores.opencart_secret_format The read key or secret was not copied whole (azr_…, azs_…). Copy them again from the extension.
stores.opencart_keys_rejected The shop refused the read keys, often because new ones were made since. Copy both again: making new read keys stops the old ones.
Orders sync but no carts arrive Send events is off, or the store key and secret are missing in the extension. Paste them and switch Send events on.
Plugin status “… deliveries refused” The store key or secret in the extension is not the current one. Generate new keys in Azimea and paste them again.

All codes: error codes.

Disconnect

Section titled “Disconnect”

In Azimea, press Disconnect next to the store. In OpenCart, make new read keys in the extension (the old ones stop at once) or uninstall it; uninstalling removes its events and leaves nothing behind.

Section titled “Related”