Magento 1 Integration Setup Guide

This guide outlines the steps required to connect your Magento 1 store to Helm. You’ll create API credentials within your Magento admin panel, configure access roles, and enter the appropriate details in Helm to complete the integration

Last updated 3 months ago

Prerequisites

Before starting, please ensure:

  • You have access to your Magento 1 Admin Panel with administrative privileges.

  • You can create new API Roles and Users.

  • You have your Magento store URL ready.

Step 1: Create an API Role in Magento.

  1. Log in to your Magento 1 Admin Panel.

  2. From the navigation menu, go to:

    image-1650629569313.png

    • System → Web Services → SOAP/XML-RPC - Roles.

  3. Click Add New Role.

    image-1650629575993.png

  4. Provide a role name of your choice, and enter your current admin password to proceed.

    image-1650629584682.png

  5. Navigate to the Role Resources tab.

  6. Set Resource Access to All to ensure Helm has full API access.

    image-1650629590191.png

  7. Click Save Role to finish this step.

Step 2: Create an API User in Magento

  1. Return to:

    image-1650629595440.png

    • System → Web Services → SOAP/XML-RPC - Users

  2. Click Add New User.

    image-1650629601502.png

  3. Fill in the user details:

    image-1650629607612.png

    • User Name – Choose a unique name (e.g., helm_api_user).

    • API Key – Choose a secure key. You’ll need to use this key later in Helm.

    • Record both values somewhere safe.

  4. Scroll down to the User Role section.

  5. Assign the user to the API Role you created in Step 1.

    image-1650629613590.png

  6. Click Save User to complete this step.

Step 3: Connect Magento 1 to Helm

  1. Log in to Helm and navigate to Settings from the bottom-left corner.

  2. Select Sales Channels and choose Magento 1 from the integration list.

  3. Fill in the following details:

    • Active - Toggle on to set as active.

    • Name – Choose a reference name for the channel (e.g. Magento UK Store).

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

    • API Username – The user name you created in Magento.

    • API Key – The secure key set for the user.

  4. (Optional) Enable Custom Fulfilment Status:

    • Tick the checkbox if you wish to use personalised fulfilment statuses such as Awaiting Courier, Awaiting Label, or Fulfilled.

    • Enter your preferred custom status which Helm should send to Magento when orders are marked as fulfilled.

  5. Explore the configuration settings to further tailor and enhance your integration.

  6. Click Settings in the top tab and choose the Helm warehouse from which goods will be despatched for this integration.

  7. Explore the configuration settings to further tailor and enhance your integration.

  8. Optional configuration tabs include:

    • 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.

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

  10. A confirmation message will appear once your Magento 1 channel has been successfully connected.

Completion

You have now linked your Magento 1 store with Helm. Orders and stock data will begin syncing automatically, streamlining your order management across platforms.