Magento Integration Features
Order sync
Stock and Product sync
Despatch Updates (Status and Tracking info)
Prerequisite - Adding and authorising Magento connection
Customers using v2.4.6 and above on Magento, integrate with Mintsoft using the Oauth method. Ensure you're logged in via om.mintsoft.co.uk.
Please ensure the connection you want to set up isn't Authorised already on Mintsoft or else you will get an error when connecting. If the connection is already Authorised, you will see a Deauthorise button this will remove the authorisation with Magento and allow you to reauthoise it. Please also delete the integration from Magento before continuing with the steps below to set up from scratch.
If you encounter empty data fields or other issues during integration, this may indicate authorization problems or the need to generate new API keys. Refer to the troubleshooting section at the end of this document for further guidance.
Setting up a connection - v2.4.6
To set up a connection with Magento please do the following:
Log into Mintsoft using https://om.mintsoft.co.uk.
Click Connect, then Order Integrations.
Next, click Magento then Create Account.
Leave the URL Placeholder in the URL field, Mintsoft will autofill this once activated.
This is auto populated when authorising.
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.
Turn the connection to Active.
Click Add then, log in to your Magento store.
Click System then Integrations.
Go to Add New Integration.
In the Name field, Type Mintsoft.
For the Call back URL, enter https://om.mintsoft.co.uk/Magento/Callback.
For the Identity Callback URL, enter https://om.mintsoft.co.uk/Magento.
Enter your Password.
Next, click the API tab and select ALL for the Resource Access.
Unauthorised error messages may show on Mintsoft if Resource Access is not selected as ALL.
Then click Save.
Clicking Save and Activate will still keep the integration inactive.
Next, click Activate against the new connection, and a small pop-up window of Mintsoft will appear.
Within the popup window scroll across to the right and click Authorise.
You will be brought back 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, additionally if upgrading from v2.4.4+, any Magento Integration App (Except Mintsoft) will need to be re-created. To set up a connection with Magento please do the following:
Log into Magento.
Click System then Integrations.
Go to Add New Integration.
In the Name field, Type Mintsoft.
On the Resource Access drop-down click ALL.
Then click Save.
Clicking Save and Activate will still keep the integration inactive.
Next, click Activate against the new connection and copy the contents of the Access Token field.
Then, log into Mintsoft.
Click Connect, then Order Integrations.
Next, click Magento.
Then 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.
Turn the connection to Active.
Click Save.
Adding a Store Code
Please keep in mind that when using the Store Code feature on the advanced tab of the connection it only supports Order Filtering (Orders only coming in from the requested store) and not Stock Sync. 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 then you would need to set up a connection for each store code in Mintsoft.
Locating the Store ID
To locate the Store ID please follow the steps below:
Within Magento, click Stores then Settings.
Next, click All Stores.
Click the hyperlink for the required store within the Store View column.
Within the Web address URL there will be a store_id followed by the code.
Take note of this as you will require this for the connection in Mintsoft.
URL Example -
Adding the Store Code to Mintsoft
If you want to add a Store Code to your Magento connection within Mintsoft, please do the following:
Within Mintsoft, click Connect, then Order Integrations.
Next, 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 Magentos' Store View URL.
Finally, click Update.
Use Magento Order Number instead of Magento Order ID from Order Import
Users 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 API Connectivity Issues
Common Causes of API Connectivity Issues
API connectivity problems typically arise due to the following reasons:
Incorrect or expired API keys.
Authorization problems on the third-party platform.
Improper configuration settings during integration.
By addressing these causes, you can restore connectivity and ensure a smooth integration experience.
Best Practices for Dealing with API Issues
Always verify the validity of your API keys and update expired ones immediately.
Ensure proper permissions are granted when setting up API integrations (e.g., Resource Access set to "ALL" for Magento).
Double-check configuration settings to avoid simple errors.
Reach out to platform-specific support teams when issues arise beyond your control.