> For the complete documentation index, see [llms.txt](https://help.orderdesk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.orderdesk.com/integration-setup-guides/sales-channels/mirakl-integration.md).

# Mirakl Integration

> New to Order Desk? Order Desk collects all your orders from all your sales channels in one place and sends them to your chosen fulfillment services automatically.
>
> <i class="fa-computer" style="color:$primary;">:computer:</i> [See all integrations](https://www.orderdesk.com/integrations/) . <i class="fa-wallet" style="color:$primary;">:wallet:</i> [Pricing](https://www.orderdesk.com/pricing/) . <i class="fa-arrow-right" style="color:$primary;">:arrow-right:</i> [Start free trial](https://app.orderdesk.me/account-setup)

Order Desk can connect to your [**Mirakl**](https://www.mirakl.com/) 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:

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/686e9ff99522340fd1a3fa28/file-WQ25sUFmfl.png)

Alternatively, search for *Mirakl* from the available integration search.

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/686ea00c9522340fd1a3fa29/file-CsLHblyBsp.png)

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

{% hint style="info" %}

#### 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`.
{% endhint %}

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/686ea2d051300c606b6aff20/file-G4gaD5ZfpQ.png)

Once you’ve entered both values, click **Connect** to complete the setup.

{% hint style="info" %}
Order Desk isn’t able to help find or help reset your API credentials, as they can only be provided by Mirakl.
{% endhint %}

### Settings

Once enabled, you can set your preferences in the Mirakl integration settings.

<figure><img src="https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FoF0Pijf67qo3mY1HZpaK%2FCleanShot%202026-11-19%20at%2022.33.01%402x.png?alt=media&amp;token=54266973-8862-43c3-a62b-f8c8327f421d" alt="" width="563"><figcaption></figcaption></figure>

#### 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**](https://help.orderdesk.com/start-here/getting-started-series/quick-start-overview.md#working-with-folders) 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.

#### Auto Accept Orders

Enable this if you want Order Desk to automatically send an order acceptance notice to Mirakl as soon as the order is imported.

#### Sync Inventory

Enable this setting if you want Order Desk to regularly send inventory updates to Mirakl. When enabled, Order Desk will keep your Mirakl stock quantities in sync with the inventory levels in Order Desk.

By default, Order Desk matches items using their SKUs, so the SKUs in Order Desk and Mirakl need to be the same.

If your SKUs are different, you can add a metadata field called `mirakl_shop_sku` to your inventory items and set its value to the corresponding SKU in Mirakl. Order Desk will then use this value to find and update the matching item in Mirakl instead.

For more information on adding metadata to your inventory items, [see this guide](https://help.orderdesk.com/guided-walkthroughs/products-and-inventory/how-to-work-with-inventory-details.md#store-extra-item-details-in-order-desk).

#### SKU Type

Choose the Mirakl field you’d like to use as the Item Code in Order Desk. You can choose whether to use the **Offer SKU** or **Shop SKU**.

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

#### Shop ID

Enter the ID of the Mirakl shop you’d like Order Desk to download orders from. If this is left blank, Order Desk will pull orders from your default shop.

{% hint style="info" %}
Only one **Shop ID** can be entered in this field. If your Mirakl account has access to multiple shops and you’d like to pull orders from each one, you’ll need [a separate Order Desk store](https://help.orderdesk.com/guided-walkthroughs/using-order-desk/how-to-manage-multiple-stores-on-one-account.md) for each **Shop ID**.
{% endhint %}

#### Inventory Location Filter

If you only want to download specific orders, you can use the Inventory Location Filter field to specify which ones you want. Enter multiple locations separated by a comma.

The inventory location name must match exactly as it is on your inventory items in Order Desk. When importing new orders from Mirakl, Order Desk will look at the SKUs on the items and compare to the SKUs in your inventory here. Any orders with items for a location that isn’t listed in this field will not be imported.

For this to work, your inventory must be added to Order Desk. The inventory Location should be set on each item. For details, please see [How to Add Inventory](https://help.orderdesk.com/start-here/getting-started-series/quick-start-orders-and-inventory.md#working-with-inventory) and [How to Store Extra Item Details](https://help.orderdesk.com/guided-walkthroughs/products-and-inventory/how-to-work-with-inventory-details.md#store-extra-item-details-in-order-desk).

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

{% hint style="info" %}
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**](https://help.orderdesk.com/guided-walkthroughs/rules-and-automations/how-to-work-with-rules.md).
{% endhint %}

### Manual Imports

#### Manually Import Orders

You can manually import orders from Mirakl at any time. You can import orders by **Date** if you need to bring in multiple orders, or by a specific **Order ID** if you only need to import one order.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FenlqwVDATuR4Pq7ilFIk%2Flegacy-2c6d2f04acde1052cc6f.png?alt=media)

{% hint style="info" %}
**Tip: Importing Orders by Date**

If Mirakl has a large number of orders in the selected date range, you may need to click the **Import** button a few times to bring them all in.
{% endhint %}

#### Manually Import Inventory Items

Click the **Download Inventory Items** button to download your Mirakl products into Order Desk.

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/6915eeb348468c2871136685/file-9EMcwjPBwd.png)

### Order Import Log

If an order from your cart hasn't come into Order Desk, the **Order Import Log** is a good place to start. It shows recent import attempts, including which orders were imported or skipped and any skip reasons.

Learn how to use the log in the [How to Troubleshoot Missing Shopping Cart Orders](https://help.orderdesk.com/guided-walkthroughs/integration-specific-walkthroughs/how-to-troubleshoot-missing-shopping-cart-orders.md) guide.

#### Mirakl Rules Reference

In addition to the [**general set of rule events and actions**](https://help.orderdesk.com/resources/rules-reference-events-filters-and-actions.md) in Order Desk, Mirakl includes a number of rule events and actions that are specific to the integration. These aren’t found directly on the integration page. Instead, you’ll need to use the **Rule Builder** to access them.

If you’re new to using rules in Order Desk, we recommend starting with our [**How to Work With Rules**](https://help.orderdesk.com/guided-walkthroughs/rules-and-automations/how-to-work-with-rules.md) guide.

#### Rule Events

In addition to the general rule events available for all orders, the following events are specific to Mirakl. To find them, type *mirakl* in the **Event** dropdown menu in the **Rule Builder**:

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FvoYQEIudwXTS0ZeseygH%2Flegacy-dc62129a8f48421c284a.png?alt=media)

| Event                    | Description                                                 |
| ------------------------ | ----------------------------------------------------------- |
| Order Returned at Mirakl | Triggered when an order gets returned at Mirakl.            |
| Order Accepted at Mirakl | Triggered when an order is successfully accepted at Mirakl. |
| Order Canceled at Mirakl | Triggered when an order is canceled at Mirakl.              |

#### Rule Actions

Mirakl also supports specific rule actions that you can apply to your orders. These can be found in the **Actions** dropdown by searching for *mirakl*:

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/695e71a89c5b087efa234c20/file-Au1EypcPw6.png)

| Action                 | Description                                        |
| ---------------------- | -------------------------------------------------- |
| Accept Order at Mirakl | Sends an acceptance notice to Mirakl for an order. |
| Cancel Order at Mirakl | Tries to cancel an order at Mirakl.                |

### Related Articles

* [Mirakl integration overview](https://www.orderdesk.com/integrations/mirakl/)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.orderdesk.com/integration-setup-guides/sales-channels/mirakl-integration.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
