Mirakl Integration Features
Order import sync.
Product import sync.
Stock sync.
Despatch Updates (Status and Tracking info).
Review the External Couriers / Despatch Updates section for more information.
Overview
This help guide will explain the setup of the Mirakl integration. There is a monthly fee associated with using the Mirakl integration.
Important: Please reach out to your Account Manager before setting up your Mirakl connection.
Prerequisite
Before adding your Mirakl account on Mintsoft, you will need to obtain the API key from within the Mirakl platform.
Login to the Mirakl platform.
In the top right, click your name.
On the API Key tab, copy the API key.
Setting up and connecting to Mirakl
Once you have got the API Key, the next step is to add the Mirakl account on Mintsoft:
On Mintsoft click Connect.
Next, Order Integrations then the Premium Tab.
Click Mirakl then Add Account.
(3PL Only) Choose the Client.
Select the Warehouse and Channel.
Paste in the URL.
Make sure the URL ends with a forward slash.
The URL will vary based on marketplaces. So you'll need to take that from where you log in e.g. for Feel Unique the URL is - https://feelunique-prod.mirakl.net/.
Paste in the API Key.
The Import Order Status will typically be SHIPPING.
If the status on Mirakl is Awaiting Shipment, please add the Import Order Status as SHIPPING on Mintsoft.
(Optional) Enable Only Import Accepted Orders.
If enabled, Mintsoft will only import accepted orders from Mirakl.
(Optional) Enable Auto Accept Orders If Stock Available.
Mintsoft will update Mirakl when an order is imported. If the order is not on backorder Mintsoft will accept this order and update Mirakl.
(Optional) Enable Do Not Map Email to prevent courier errors.
This controls whether customer email addresses are included when importing orders from Mirakl.
(Optional) Enable Stock Sync and set the Frequency.
Once ready, make the connection Active.
Then, click Add.
Supported marketplaces with Mirakl
Mirakl has many marketplaces that can be connected to through Mintsoft, some of these are listed below:
Debenhams
Secret Sales
Harvey Nichols
Feel Unique
Joules
B&Q
Maxeda
Tesco
Note: Please reach out to Mirakl for the full list of supported marketplaces.
External Couriers/ Despatch Updates
Mirakl requires the use of External Courier Service Names to successfully provide despatch update from Mintsoft to Mirakl.
Invalid value for field "CarrierCode"
Error: Invalid value for field 'carrierCode'. No carrier with code '[Code]' found.
This typically occurs when an incorrect code from the Get Carriers page is entered into Mintsoft. To resolve this issue please review the steps below: Carrier code errors occur because Mirakl validates codes against its internal database, which varies per connection. Using mismatched codes will cause failures. Additionally, always verify codes in the "Code" field of the "Get Carriers" results to ensure precision.
On Mintsoft click Connect.
Next, Order Integrations then the Premium Tab.
Click Mirakl then Get Carriers against the affected connection.
Next, locate the correct carrier.
Double-check that you are copying the exact Code (not the standard_code or label).
The Code used will determine the Label displayed in Mirakl if you have multiple entries for the same courier.
Paste this correct code into the Name field of an External Courier Service Name.
Important: Codes can differ from connection to connection for example FEDEX on Connection 1 but FDX on Connection 2.
Royal Mail example
Error: Invalid value for field 'carrierCode'. No carrier with code 'Royal Mail' found.
{ "code" : "RM", "label" : "Royal Mail", "standard_code" : "gb-post", "tracking_url" : "https://www.royalmail.com/track-your-item#/tracking-results/{trackingId}" }In this example, the accepted carrier code is RM with no space. In this scenario you can resolve it by using the External Courier Service Name feature to provide RM instead. Paste the Code into the Name field.
Mirakl Despatch Note
Mirakl requires that orders on Mintsoft use the despatch note provided by Mirakl. The Mirakl despatch note will override the despatch note on Mintsoft. If you want to change this please discuss it with your Mirakl account manager.
Trigger full stock sync
You can manually realign stock figures between Mintsoft and Mirakl:
Click Connect then Order Integrations.
Select Mirakl.
Locate the connection and click Trigger Full Stock Sync.
Important: Once triggered, this can take up to 30 minutes to update on the Mirakl store.