The MIRAKL MP connector links your seller shop on a marketplace that runs on the Mirakl Marketplace Platform to Pipe17, using your shop API key. It brings marketplace orders into the app and sends order acceptance, fulfillments, offers, product catalog data, and inventory back to the marketplace.
Which Mirakl connector? The app has three Mirakl tiles:
- MIRAKL MP connects one seller shop on a marketplace that runs on Mirakl, with the shop API key and the marketplace's Mirakl URL. This article covers this connector.
- MIRAKL Connect connects your Mirakl Connect seller account. You sign in to Mirakl Connect and authorize Pipe17 (OAuth). See Connect Mirakl Connect to Pipe17.
- MIRAKL the older connector that also signs in to Mirakl Connect (OAuth), with an environment selector. See Getting Started with Mirakl.
If you aren't sure which one your account uses, contact Pipe17 support.
With this connector, you can:
- Bring orders from your marketplace shop into the app every 5 minutes, filtered by status, fulfillment center, channel, or shop.
- Accept orders in Mirakl automatically, or accept or refuse them as they move forward or are canceled in the app.
- Send fulfillments with tracking details to Mirakl, or pull shipments for orders that Mirakl fulfills.
- Send offers (price and quantity) and, optionally, product catalog data to Mirakl, or pull your Mirakl offers into the app.
- Keep Mirakl stock levels up to date from your inventory in the app.
Setup
Before you begin
- An approved seller shop on a marketplace that runs on Mirakl, and access to that marketplace's Mirakl seller back office.
- A Mirakl user with shop administrator rights, so you can view or generate the shop API key.
- The marketplace's Mirakl URL. This is the address you use to sign in to the seller back office, for example
https://yourmarketplace.mirakl.net. - One MIRAKL MP integration for each marketplace you sell on. Each marketplace has its own URL and API key.
- If you plan to send offers or inventory, SKUs in the app that match your shop SKUs in Mirakl, or channel SKUs mapped to them.
Note: The Connect MIRAKL MP pop-up shows a Limited availability badge. If you have questions about using it for your account, contact Pipe17 support.
Get your credentials from Mirakl
- Sign in to your marketplace's Mirakl seller back office.
- Copy the address from your browser up to the domain, for example
https://yourmarketplace.mirakl.net. This is your MIRAKL MP URL. Don't include a path or a trailing slash. - Open your user account settings and find your shop API key. If no key is shown, generate one. Copy the key.
Menu names can differ between marketplaces. If you can't find the API key, ask the marketplace's seller support where to generate a shop API key for API integrations.
Note: Keep the API key private. If you generate a new key in Mirakl, update MIRAKL MP API Key in the app. Mirakl sends API calls to your marketplace's own URL and identifies your shop by this key. To learn more, see the Mirakl Marketplace seller API reference.
Connect in the app
- Navigate to Integrations and click Add integration.
- Search for MIRAKL MP and select it. The Connect MIRAKL MP pop-up opens.
- In MIRAKL MP URL, enter your marketplace's Mirakl URL.
- In MIRAKL MP API Key, paste your shop API key.
- Click Connect. The app checks the credentials directly. You aren't redirected to Mirakl.
- Open the integration's Settings tab and turn on the flows you want to use: Pull locations from MIRAKL MP, Pull orders from MIRAKL MP, Process fulfillments, Process product catalog information, and Push inventory updates to MIRAKL MP. Save your changes.
Note: If you don't have your credentials yet, click Add without credentials. The integration is added but doesn't sync until you enter them on its Connection Details tab and click Save.
Confirm the connection
- On Integrations, check that the integration shows Connected and that its switch is on. If it shows Error or Not Configured, check MIRAKL MP URL and MIRAKL MP API Key on the Connection Details tab and save again.
- Turn on Pull locations from MIRAKL MP and save. Within a few minutes, a location named after your Mirakl shop appears under Locations.
- Pick one test order in Mirakl. Its status must be selected in Pull only orders with one of following statuses (by default, WAITING_ACCEPTANCE), and it must be created after Exclude orders created before this date.
- Enter the order's commercial order ID in Pull only orders with specific order IDs. Then turn on Pull orders from MIRAKL MP and save.
- Wait about 5 minutes. The app checks Mirakl for orders every 5 minutes.
- Navigate to Orders and search for the commercial order ID. If the order doesn't appear, run Pull orders from Mirakl MP by external order IDs from the integration's Integration Actions tab.
- Remove the order ID from Pull only orders with specific order IDs and save, so the app brings in all orders.
Settings
You find these on the integration's Settings tab.
Flows
| Setting | Description | Options/Default |
|---|---|---|
| Pull locations from MIRAKL MP | Creates one location in the app for your Mirakl shop. | On/Off. Default: Off |
| Pull orders from MIRAKL MP | Brings Mirakl orders into the app. | On/Off. Default: Off |
| Process fulfillments | Sends fulfillments to Mirakl, pulls shipments from Mirakl for orders that Mirakl fulfills, or both. | Disabled (default), Pull fulfillments from MIRAKL MP, Push fulfillments to MIRAKL MP, Process fulfillments in both directions |
| Process product catalog information | Pulls your Mirakl offers into the app, or sends offers (and optionally catalog data) to Mirakl. | Disabled (default), Pull product catalog from MIRAKL MP, Push product catalog to MIRAKL MP |
| Push inventory updates to MIRAKL MP | Sends stock levels to your Mirakl offers. | On/Off. Default: Off |
Orders
| Setting | Description | Options/Default |
|---|---|---|
| Exclude orders created before this date | Skips orders created before this date. If you move the date into the past after the sync has started, older orders come into the app only after they're updated in Mirakl. | Optional. Default: integration creation date |
| Pull only orders with specific order IDs | Brings in only the orders with the Mirakl commercial order IDs you list. Use this while testing. | Optional. Empty pulls all |
| Pull only orders with one of following statuses | Brings in orders with one of the selected Mirakl statuses. REFUSED and CANCELED orders never create new orders. They cancel the matching order in the app. | STAGING, WAITING_ACCEPTANCE, WAITING_DEBIT, WAITING_DEBIT_PAYMENT, SHIPPING, SHIPPED, TO_COLLECT, RECEIVED, CLOSED, REFUSED, CANCELED. Default: WAITING_ACCEPTANCE, REFUSED, CANCELED |
| Pull only orders with one of fulfillment center codes assigned | Brings in only orders assigned to the Mirakl fulfillment center codes you list. | Optional. Empty pulls all |
| Pull only orders with one of channel codes assigned | Brings in only orders from the Mirakl sales channel codes you list. | Optional. Empty pulls all |
| Pull only orders assigned to specific shop Id | Brings in only orders for this Mirakl shop ID. Use it when your Mirakl user can access more than one shop. | Optional. Empty uses the default shop for your API key |
| Treat orders assigned following fulfillment center codes as fulfillable at MIRAKL MP | Orders assigned to these fulfillment center codes are fulfilled by Mirakl. They come into the app for reference only: they aren't routed, and the app doesn't accept or ship them. With Process fulfillments set to pull, the app pulls their shipments. | Optional. Default: - (no fulfillment center) |
| Accept or reject order lines in MIRAKL MP based on order status update (only for regular orders) | For orders still awaiting acceptance in Mirakl, accepts the lines when the order is Sent to Fulfillment, partially fulfilled, or fulfilled in the app, and refuses them when you cancel the order in the app. | On/Off. Default: Off |
| Automatically accept MIRAKL MP orders ingested to Pipe17 | Accepts all lines of an order awaiting acceptance as soon as it comes into the app. | On/Off. Default: Off |
Products
| Setting | Description | Options/Default |
|---|---|---|
| Process only products with specific SKUs | Sends only the products with the SKUs you list. | Optional. Empty sends all |
| Product push scope | Sends offers only, or offers plus a product catalog import file. Applies when Process product catalog information is set to push. | Sync product offers only (default), Sync both product offers and catalog |
| Product catalog export mode | With catalog sync, sends changed products every 15 minutes to 4 hours, or a full catalog file once a day at 4 AM UTC. | Incremental updates (default), Daily snapshots |
| Force product catalog resync | Sends all products to Mirakl again on the next run. | On/Off. Default: Off |
Inventory
| Setting | Description | Options/Default |
|---|---|---|
| Report inventory updates only for products with specific SKUs | Sends inventory only for the SKUs you list. Matching isn't case-sensitive. To use a regular expression, wrap it in slashes, for example /^ABC-/. |
Optional. Empty sends all |
| Do not process inventory information for products with specific SKUs | Never sends inventory for the SKUs you list. Same matching rules as above. Applies only when Use inventory import API (STO01) is off. | Optional |
| Use inventory import API (STO01) | Sends inventory to Mirakl as import files in batches instead of updating offers one batch at a time. A full pass runs at most once an hour. | On/Off. Default: Off |
| Force inventory resync | Sends inventory for all products to Mirakl again on the next run. | On/Off. Default: Off |
Flows
| Flow | Direction | Notes |
|---|---|---|
| Locations | Mirakl → Pipe17 | Creates one location for the default shop of your API key, named after the shop, with the shop's contact address. |
| Orders | Mirakl → Pipe17 | Runs every 5 minutes. The channel order ID is the Mirakl commercial order ID, and the order source shows MIRAKL MP and the sales channel. Each order links to the order in your Mirakl back office. Updates stop once an order in the app moves past Ready for Fulfillment. |
| Order cancellations | Mirakl → Pipe17 | When an order is REFUSED or CANCELED in Mirakl, the app cancels the matching order, as long as that status is selected in the status filter. |
| Order acceptance | Pipe17 → Mirakl | Accepts or refuses order lines in Mirakl, depending on your settings. |
| Fulfillments | Pipe17 → Mirakl | Sends each fulfillment as a Mirakl shipment with tracking number, tracking URL, carrier, and shipped lines. Bundle components are reported on the original order line. If a bundle is split across fulfillments, the app waits until all its components ship. |
| Fulfillments | Mirakl → Pipe17 | For orders that Mirakl fulfills (see Treat orders assigned following fulfillment center codes as fulfillable at MIRAKL MP), pulls orders that are shipped, ready to collect, or received, and creates the shipment and fulfillment in the app. |
| Products | Mirakl → Pipe17 | Pulls your Mirakl offers once a day after 4 AM UTC: SKU, title, description, UPC, brand, prices, and status. |
| Products | Pipe17 → Mirakl | Sends published simple and child products as offers: SKU, UPC as the product ID, description, and price. New offers are created with a quantity of 0 until inventory is sent. With Sync both product offers and catalog, the app also sends a catalog import file and waits until Mirakl finishes the latest import before it sends offers. |
| Inventory | Pipe17 → Mirakl | Updates the quantity of offers that already exist in Mirakl, when the offer's shop SKU matches a SKU or mapped channel SKU in the app. Only changed quantities are sent. |
| Shipping methods | Mirakl → Pipe17 | Each order carries its Mirakl shipping type label as the shipping code, so you can map it to your shipping methods. |
Note: The catalog import file uses the column codes your marketplace expects. Contact Pipe17 support to set up the catalog mapping for your marketplace before you choose Sync both product offers and catalog.
To send inventory from a warehouse to Mirakl, merge the Mirakl location into the warehouse location you fulfill from. To learn more, see Merging Locations and Using Locations. To connect MIRAKL MP with TikTok Shop, see Connect TikTok Shop to Mirakl.
Integration actions
On the integration's Integration Actions tab, you can run these one-time pulls from the Actions menu. To learn more, see Integration Actions.
- Pull orders from Mirakl MP by external order IDs: enter the Mirakl order IDs in Pull orders with specified external order IDs.
- Pull orders from Mirakl MP by date: pulls orders created in a time window. Enter the start in Pull orders for shipments created after and pick a Time interval from 1h (default) to 48h.
- Pull fulfillments from Mirakl MP by external order IDs and Pull fulfillments from Mirakl MP by date: same fields, for orders that Mirakl fulfills. Process fulfillments must be set to pull or both directions.
- Pull products from Mirakl MP by SKUs: enter SKUs in Pull products with specified SKUs. Process product catalog information must be set to pull.
The order and fulfillment actions have Ignore filters defined for integration. Turn it on to skip the order ID filter.
Troubleshooting
- The integration disconnects right after you connect, or on the first sync
Mirakl rejected the API key (HTTP 401 or 403). The key may be wrong, replaced by a newer key, or from another marketplace or a user without shop administrator rights. Copy the current key from the Mirakl seller back office, enter it on the Connection Details tab, and save. - The integration connects, but nothing syncs and errors mention the address or "not found"
Check MIRAKL MP URL. It must be your marketplace's Mirakl address, for examplehttps://yourmarketplace.mirakl.net, with no path or trailing slash. - An order from Mirakl doesn't appear in the app
Check that its status is selected in Pull only orders with one of following statuses, that it was created after Exclude orders created before this date, and that it matches your fulfillment center, channel, and shop filters. Check that Pull only orders with specific order IDs is empty unless you're testing. To bring in a missed order, run Pull orders from Mirakl MP by external order IDs. - Orders stay in WAITING_ACCEPTANCE in Mirakl
Turn on Automatically accept MIRAKL MP orders ingested to Pipe17, or Accept or reject order lines in MIRAKL MP based on order status update (only for regular orders), or accept the orders in Mirakl. - An order has the error "Failed to retrieve order from MIRAKL"
The app couldn't find the order in Mirakl when it tried to accept or refuse it. Check that the order still exists in Mirakl and that the integration uses the right marketplace URL. - A fulfillment has the error "Failed to resolve order"
The app couldn't find the Mirakl order for the fulfillment. This happens when the order didn't come from this integration. Only fulfillments for Mirakl orders can be sent. - A fulfillment says the bundle is split across fulfillments and not yet fully shipped
The app waits until all components of a bundle ship, then reports the bundle line to Mirakl. No action is needed unless components never ship. - A product has an error that says "Full errors and the uploaded file are on the Mirakl portal under Product imports"
Mirakl rejected rows in the catalog import file. Open Product imports in the Mirakl seller back office, review the error report, fix the product data in the app, and resync. - Inventory doesn't update for some SKUs
The app updates only offers that already exist in Mirakl and whose shop SKU matches a SKU or mapped channel SKU in the app. Check your SKU include and exclude lists. To send everything again, turn on Force inventory resync. - No location appears for the integration
Turn on Pull locations from MIRAKL MP and wait a few minutes.
Need Help?
If you need additional assistance:
- Use Ask Pippen, our AI agent, located at the top of the platform page.
- Submit a support request with as much relevant detail as possible. Learn how to submit a request.
We’re here to help you succeed with your operations.
Comments
0 comments