Mirakl
  • 07 Aug 2023
  • 3 Minutes to read
  • Dark
    Light
  • PDF

Mirakl

  • Dark
    Light
  • PDF

Article Summary

Required Permissions

An employee must be assigned to the shop with a Shop Owner Admin role to perform actions referred to in this article.

Mirakl integration connector allows you to import and accept orders, update Mirakl with shipment information, and synchronize your stock levels.
Export of stock levels is performed automatically in the background, with scheduled requests. After the change in available product stock is registered, the corresponding Mirakl product offer is updated with a new value.

Products in ShopCtrl are mapped to Mirakl product by Offer SKU, which is the product code in ShopCtrl.
This way, a product offer in Mirakl with SKU "S2081", is mapped to a product in ShopCtrl with the same product code "S2081".

Setting up integration with Mirakl

To set up the integration, you first need to create an API key for your production environment. To do this, please follow the steps in this Mirakl support article: Generating or retrieving your API key.

Setting up Mirakl synchronization in ShopCtrl

Before start

Before enabling synchronization with Mirakl, please set up the corresponding shop currency, VAT tariffs, and payment types for your ShopCtrl shop.

mirakl-shop-settings

To set up synchronization with pre-prod Mirakl environment in ShopCtrl:

  1. Log in to your ShopCtrl account as a user with the Shop Owner Admin role.
  2. In the navigation menu, select Configuration > Shops to open the list of shops created.
  3. Select a shop for which you would like to set up Mirakl synchronization and click Edit to open shop settings.
  4. Within the topic menu, select Shop synchronization > Mirakl Synchronization.
  5. First, within Connection settings > Test (highlighted green) enter the API key test generated for the pre-prod environment. The url link is already pre-filled.
  6. Click the Connect button to test the connection. If all credentials were provided correctly, a pop-up window would open informing that the connection was successful. Otherwise, please check if the credentials provided are valid and belong to the pre-prod environment.
  7. (Optional) You can determine in ms the custom interval between API calls. Or leave the field blank to set API call timeout to default 5 minutes.
  8. (Optional) Enable API logging to check the detailed logs on each API call performed.
  9. Move back to the top of the pane to the Functional settings - Order features section. Check the features you would like to use:
    • Orders synchronization - new orders will be imported to ShopCtrl.
    • Order integration - a setting required for accepting orders and sending T&T info to Mirakl
  10. On the Product features pane:
    • Product integration - to enable the stock/price export feature
    • Product stock management - enables stock export to Mirakl
  11. On the Orders section decide on the moment ShopCtrl will indicate to Mirakl the order has been accepted. Currently there are several options available:
    • Order Import - the moment an order gets into ShopCtrl,
    • Order Allocated - the moment stock is allocated to ship the order. In case there is not enough stock, the sync request won't be created till order is fully allocated.
    • Order Shipped - the order is accepted at Mirakl the moment the shipment in ShopCtrl is marked as shipped.
  12. Track&Trace shipments - once the order is marked as shipped in Shopctrl, an automatic request to update tracking info is created. The Mirakl shipment will be automatically updated with the tracking code and Url, and order will be marked as shipped.
  13. Carrier account mapping. Here you can map the Mirakl carrier codes to the ShopCtrl carriers. This mapping is used for auto-updating tracking information to Mirakl. Please click Show Carriers to load the list of Mirakl carrier identifiers. Add the mapping to ShopCtrl Carriers to provide the correct tracking information to Mirakl.
  14. Enable the synchronization at the top of the Functional Settings pane.
  15. Click Save or Save and Close to apply changes to the shop.

What's Next