Integrating your Magento store with Mintsoft enables automated order management, real-time stock synchronisation, and automatic despatch notifications. This guide covers the complete setup process for both OAuth (v2.4.6+) and API Key (v2.4.4 and below) authentication methods, including essential order status configuration.
Magento Integration Features
The Magento integration provides:
Order sync: Imports orders matching your configured Ready Status from Magento.
Stock and product sync: Keeps inventory levels synchronised between Mintsoft and Magento.
Despatch updates: Automatically sends status updates and tracking information back to Magento when orders are shipped.
Prerequisites
Before setting up your Magento connection, ensure:
You're logged into Mintsoft via om.mintsoft.co.uk.
The connection you want to set up isn't already authorised in Mintsoft. If you see a Deauthorise button, click it to remove the existing authorisation with Magento.
If re-authorising, delete the integration from Magento before continuing with the setup steps.
Important: If you encounter empty data fields or other issues during integration, this may indicate authorisation problems or the need to generate new API keys. Refer to the Troubleshooting section for further guidance.
Setting Up a Connection – v2.4.6 and Above
Customers using v2.4.6 and above on Magento integrate with Mintsoft using the OAuth method.
Creating the Connection in Mintsoft
Log into Mintsoft using https://om.mintsoft.co.uk.
Click Connect, then Order Integrations.
Click Magento, then Create Account.
Leave the URL placeholder in the URL field. Mintsoft will autofill this once activated.
Use the Version drop-down and select the version that appears at the bottom of your Magento store. For example, V2.4.6 = MAG_2_4_6.
Configure the connection to your specification, including:
Ready Status: Set which Magento order status triggers import (default: processing).
Picking Status: (Optional) Status to update orders to after import.
Despatched Status: (Optional) Status to update orders to when shipped.
Turn the connection to Active.
Click Add.
Authorising the Connection in Magento
Important: Unauthorised error messages may appear in Mintsoft if Resource Access isn't set to ALL.
Log into your Magento store.
Click System, then Integrations.
Click Add New Integration.
In the Name field, type Mintsoft.
For the Callback URL, enter https://om.mintsoft.co.uk/Magento/Callback.
For the Identity Callback URL, enter https://om.mintsoft.co.uk/Magento.
Enter your password.
Click the API tab and select ALL for the Resource Access.
Click Save.
Important: Clicking Save and Activate will still keep the integration inactive.
Click Activate against the new connection. A small pop-up window from Mintsoft will appear.
Within the pop-up window, scroll across to the right and click Authorise.
You'll be returned to Magento and the integration should show as Active.
Setting Up a Connection – v2.4.4 and Below
Customers using v2.4.4 and below on Magento integrate with Mintsoft using the API Key method.
Important: If you're upgrading from v2.4.4+, any Magento Integration App (except Mintsoft) will need to be re-created.
Creating the Integration in Magento
Log into Magento.
Click System, then Integrations.
Click Add New Integration.
In the Name field, type Mintsoft.
On the Resource Access drop-down, click ALL.
Click Save.
Click Activate against the new connection and copy the contents of the Access Token field.
Creating the Connection in Mintsoft
Log into Mintsoft.
Click Connect, then Order Integrations.
Click Magento.
Click Add New Account.
In the URL field, type the Store URL.
In the ApiKey field, paste the Access Token from Magento.
Use the Version drop-down and select the version that appears at the bottom of your Magento store.
Configure the connection to your specification, including:
Ready Status: Set which Magento order status triggers import (default: processing).
Picking Status: (Optional) Status to update orders to after import.
Despatched Status: (Optional) Status to update orders to when shipped.
Turn the connection to Active.
Click Save.
Configuring Which Orders to Import
After setting up your Magento connection, you need to configure which orders Mintsoft should import based on their status in Magento.
When editing your Magento connection in Mintsoft, you'll find the following status configuration fields:
Ready Status (Required)
This determines which orders are imported from Magento into Mintsoft.
Only orders with this status will be synced.
Default value: "processing".
You can use any Magento order status name, including custom statuses you've created.
Example: If you set this to "ready_to_ship", only Magento orders with that status will import.
Picking Status (Optional)
After Mintsoft imports an order, it can automatically update the order status in Magento.
Set this to indicate the order is now being processed in your warehouse.
Example: You might set this to "processing_in_warehouse".
Leave blank if you don't want Mintsoft to update the status after import.
Despatched Status (Optional)
When an order is despatched from Mintsoft, it can update the order status in Magento.
This typically indicates the order has shipped.
Example: Common values are "complete" or "shipped".
Leave blank if you don't want status updates on despatch.
Adding a Store Code
Important: The Store Code feature on the Advanced tab only affects Order Filtering, limiting which store's orders are imported. It doesn't affect Stock Sync, which synchronises inventory across all stores in your Magento instance.
Currently, it's not possible to add multiple store codes within the Store Code field in Mintsoft. If you have multiple stores and want to import from more than one store, you'll need to set up a connection for each store code in Mintsoft.
Locating the Store ID
Within Magento, click Stores, then Settings.
Click All Stores.
Click the hyperlink for the required store within the Store View column.
Within the web address URL, there'll be a store_id followed by the code.
Take note of this as you'll require it for the connection in Mintsoft.
URL Example
Adding the Store Code to Mintsoft
Within Mintsoft, click Connect, then Order Integrations.
Click Magento.
Find the connection you want to amend.
Click Edit, then click the Advanced tab.
Add a value to the Store ID field. This is the Store ID found in Magento's Store View URL.
Click Update.
Use Magento Order Number Instead of Magento Order ID from Order Import
You can select whether to use Magento's Order ID (current functionality) or Order Number. Enabling this toggle will swap the order number and external order number fields for orders imported.
Property Mappings
To set up Property Mappings please review the Magento - Meta Mapping / Property Mapping article.
Troubleshooting and Best Practices
For information on troubleshooting Magento issues, please review our Troubleshooting help guide.