Magento 2 Integration Setup Guide

This guide outlines how to connect your Magento 2 store to Helm using either your admin credentials or a secure Access Token. Follow the steps below to create your Magento API integration and enable order and inventory sync.

Last updated 3 months ago

Prerequisites

Before you begin, ensure the following:

  • You have administrative access to your Magento 2 Admin Panel.

  • You know your Magento store URL.

  • You can either:

    • Use your Magento admin login credentials, or

    • Generate an Access Token from the Magento 2 Integrations page.

Note:

If you use Access Token, you don't need to enter API Key and Password.

Option 1: Use Magento Admin Credentials

  1. In Helm, go to Settings → Sales Channels and select Magento 2.

  2. Fill in the required fields:

    • Active – Toggle on to activate the channel.

    • Name – Choose a clear reference (e.g. Magento 2 UK Store).

    • Magento 2 Domain URL – Your full store URL (e.g. https://yourstore.com/).

    • API Username – Your Magento admin email.

    • API Key – Your Magento admin password.

  3. Click Submit to finalise the connection.

✅ If the credentials are valid, Helm will confirm the connection and begin syncing data.

Option 2: Use a Magento 2 Access Token

If you prefer a more secure method, you can connect using an Access Token. Follow the steps below to generate one in your Magento admin panel.

Step 1: Create a New Integration in Magento

  1. Log in to your Magento 2 Admin Panel.

  2. From the left-hand menu, go to:

    image-1645703911865.png

    • System → Extensions → Integrations.

  3. Click Add New Integration.

    image-1645703923178.png

  4. Provide a meaningful name for the integration (e.g. Helm Connector) and enter your current admin password.

    image-1645704000138.png

  5. Navigate to the API tab and set Resource Access to All.

    image-1645704019219.png

  6. In the top-right corner, click the Save dropdown and select Save & Activate.

    image-1645704033656.png

  7. Click Allow when prompted.

    image-1645704047831.png

  8. Copy the Access Token provided and store it somewhere safe.

    image-1645704259079.png

Step 2: Connect Magento 2 to Helm with Access Token

  1. In Helm, return to Settings → Sales Channels → Magento 2.

  2. Fill in the following fields:

    • Active – Toggle on to activate the channel.

    • Name – Choose a recognisable name for your channel.

    • Magento 2 Domain URL – Your store URL.

    • Enable the Use Access Token option.

    • Paste your Access Token into the field provided.

    • Explore the additional and optional settings and adjust these according to your business requirements.

  3. Optional configuration tabs include:

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

    • Stock Control – Set up Auto Sync Stock.

    • Brand – Setup your Company Information for this sales channel below. By default your Company Information as set in General Settings will be used.

    • Commercial Invoice – Setup your Commercial Invoice Information for this sales channel below. By default your Commercial Invoice Information as set in General Settings will be used.

    • Despatch Emails – Do you want Helm to send out an order despatched email with carrier tracking information (if applicable)? If you do setup your Despatch Email for this sales channel below.

    • Feedback Emails – Do you want Helm to send out an order feedback email? If you do, setup your Despatch Email for this sales channel below.

      Adjust these according to your business requirements.

  4. Once all fields are complete, click Submit to finalise the setup.

  5. A confirmation message will appear once your Magento 2 channel has been successfully connected.

Optional: Configure Custom Fulfilment Status

  1. If desired, enable Custom Fulfilment Status to control how order statuses appear in Magento.

  2. Enter the preferred status (e.g. Awaiting Courier, Dispatched, or Fulfilled) that Helm should use when marking orders as complete.

Completion

You have now successfully integrated your Magento 2 store with Helm. Orders and stock levels will begin syncing automatically, ensuring a seamless multichannel retail experience.