Mirakl Integration
Order Desk can connect to your Mirakl account and automatically download orders. As orders are fulfilled, shipment details can automatically be sent back to update Mirakl.
Setup
To connect your Mirakl account to Order Desk, click on Manage Integrations under the Integrations menu in the left sidebar. Under the Shopping Carts tab, find and enable the Mirakl integration:
Alternatively, search for Mirakl from the available integration search.
Click Enable to get started with connecting the integration.
On the next screen, you'll be asked to enter your Instance Name and API Key.
💡 FINDING YOUR INSTANCE NAME
Your Instance Name is the part that comes before .mirakl.net in your Mirakl URL. For example, if your Mirakl dashboard is https://bestbuyca.mirakl.net, your instance name is bestbuyca—just the word before .mirakl.net.
Once you've entered both values, click Connect to complete the setup.
💡 TIP
Order Desk isn’t able to help find or help reset your API credentials, as they can only be provided by Mirakl.
Settings
Once enabled, you can set your preferences in the Mirakl integration settings.
Check for New Orders
Choose how often you want Order Desk to check for new orders from Mirakl. Options are: Never, Every Day, Every Twelve Hours, Every Six Hours, Every Two Hours, Every Hour.
Folder for New orders
Select the folder where newly imported orders from Mirakl should be placed. If you would like to work with your own custom folders, please read this guide for how to create them.
Order Status Download
Select which Mirakl order statuses you want Order Desk to import. Orders that don’t match the selected status will be skipped.
Payment Terms to Download
Choose the payment terms of the orders to be imported from Mirakl. Orders that don’t match the selected payment terms will be skipped.
Sync Tracking Numbers
If you want Order Desk to notify Mirakl when orders are fulfilled, enable the Sync Tracking Numbers setting. If tracking details are added to the order, it will be passed back to Mirakl as well.
Order Prefix
If you’d like to add a prefix to your Mirakl order numbers as they import to Order Desk, set that value here. This will be added to the beginning of the order number.
Country Filter
Select countries from a dropdown menu, or toggle "select all".
Choose Standard to import only from selected countries. Choose Inverted to import all orders except from the selected countries.
First Import Date
Any orders created before the date set here will not be imported into Order Desk.
Check for Order Returns
Enable this setting if you want Order Desk to check Mirakl for returned orders. When a return is found, a note will be added to the Order History section on the order page.
💡 TIP
You can also take automatic action on returned orders by using the Order Returned at Mirakl rule event. To learn how to work with rules, check out this guide: How to Work with Rules.
Manual Imports
Manually Import Orders
To manually import orders, enter the date from which the download should start and click the Import Now button. Order Desk will look through orders from the date and time set when this button is clicked and try importing any that meet the conditions selected in your settings.
If you have lots of orders in Mirakl from that date range, you might need to click on the Import button a few more times to bring them all in.