OpenCart V3 Integration Setup Guide

This page outlines the process for integrating OpenCart V3 as a sales channel within Helm. You will learn how to install the necessary module, retrieve your API credentials, and correctly configure the integration for seamless order importing and inventory synchronisation

Last updated 3 months ago

Prerequisites

Before you begin, please ensure the following:

  • Administrative access to both Helm and your OpenCart V3 Admin Panel.

  • Access to your OpenCart hosting account (FTP or file manager).

  • The Helm OpenCart V3 extension.

Step 1: Install the Helm Module in OpenCart

To enable the connection between Helm and OpenCart V3, you first need to install the extension files.

  1. Download the opencartv3.zip module package.

  2. Extract the contents using WinRAR, 7-Zip, or your preferred tool.

  3. Upload the contents of the catalog/ and admin/ folders to your OpenCart root directory via:

    • FTP (e.g. using FileZilla), or

    • Your web hosting control panel’s file manager.

  4. Once uploaded, proceed to the OpenCart Admin Panel to install the extension.

Step 2: Activate the API in OpenCart

  1. Log in to your OpenCart Admin Panel.

  2. Navigate to:
    System → Users → API

    image-1652435725152.png

  3. Click the plus (+) icon to create a new API user.

    image-1652435735825.png

  4. Enter a name for the API (e.g. Helm_API).

  5. Click Generate to create an API key.

  6. Set Status to Enabled.

    image-1652435742319.png

  7. Click the Save (floppy disk icon) to finalise.

    image-1652435749723.png

You now have your:

  • API Name

  • API Key

Note:

Keep these details secure - you’ll need them shortly when connecting the integration within Helm.

Step 3: Enable the Extension in OpenCart

  1. In your OpenCart Admin Panel, navigate to:
    Extensions → Extensions

    image-1652435760686.png

  2. From the Extension Type dropdown, choose Modules.

    image-1652435776364.png

  3. Locate Helm (Despatch Cloud) in the list.

    image-1652435783220.png

  4. Click the Install (+) icon and wait for installation to complete.

  5. Once installed, click the Edit (pencil) icon.

    image-1652435791795.png

  6. Set Status to Enabled.

    image-1652435801499.png

  7. Paste your previously generated API Key into the API Key field.

  8. Click Save.

    image-1652435808018.png

Step 4: Add OpenCart V3 as a Sales Channel in Helm

  1. Log in to your Helm Dashboard.

  2. Navigate to:
    Settings → Sales Channels

  3. From the list of integrations, select OpenCart V3.

  4. Fill in the following configuration fields:

    • Active: Toggle ON to enable the channel.

    • Name: A clear reference for your store (e.g. OpenCart - UK Store).

    • Domain: The full store URL (e.g. https://yourstore.com).

    • API Key: The key you generated in Step 2.

  5. Choose to enable any of the additional settings.

Step 5: Configure Additional Settings (Optional)

Once the basic connection is in place, Helm offers several optional configuration tabs to enhance the integration:

  • Settings - You can set up your warehouse and its unique settings.

  • Stock Control – Auto-sync your stock levels from Helm.

  • Brand – Use your default or custom branding details.

  • Commercial Invoice – Configure invoicing preferences per sales channel.

  • Despatch Emails – Send automated shipping emails with tracking.

  • Feedback Emails – Send review requests after orders are completed.

Step 6: Complete the Setup

Once all fields and settings are configured:

  1. Click Submit.

  2. A confirmation message will appear in the top-right corner of Helm.

  3. Your OpenCart V3 channel will now be listed as active.

  4. Orders and inventory will begin synchronising automatically.

Additional Notes

  • You can return to Settings → Sales Channels at any time to update or deactivate your OpenCart V3 integration.

  • Ensure your API credentials remain active and valid to avoid interruptions.

  • If managing multiple OpenCart stores, install each one using unique names and credentials.