Mirakl is a marketplace-platform technology, which uses an API solution to help website retailers partner with third-party sellers, in order to grow their online offerings and expand their market reach.
You can use Sellercloud with any Mirakl integration, such as BestBuy Canada, Catch, and BlueFly.
Mirakl offers numerous channel integrations and a straightforward implementation, achieved by specifying the integration name and getting a unique API key per channel.
The Mirakl integration workflow has 5 main steps:
- Create the custom company settings.
- Create custom order columns.
- Create the custom product columns.
- Request the addition of 4 server plugins.
- Create scheduled tasks to run the plugin integration.
Creating custom company settings
To create the custom company settings:
- Click your company’s Toolbox > Custom Settings.
- Add the company settings and values from the table below.
- Click Save Settings.
|CUSTOM COMPANY SETTING||VALUE|
|Mirakl_Integration_Name||Mirakl channel, such as BestBuyCA, Catch, BlueFly, etc.|
|Mirakl_API_Key||Mirakl authentication key.|
|Mirakl_API_URL||URL for the Mirakl channels, such as:
Can be True or False.
Determines if orders with a pending acceptance will be accepted, even if inventory on hand is insufficient to fulfill them.
If missing, defaults to False.
|Mirakl_Get_Only_Recent_Orders||True or False.
Determines if the plugin will only get orders that were modified in the past 10 days.
You can skip creating this setting or set it to False for the initial order import, then set it to True to speed up the plugin and avoid reaching API limits.
A comma-separated list of Mirakl shop IDs; e.g., 2000,2774 etc.
If missing, the plugin will only import orders from the first shop associated with the Mirakl user.
Only orders with comma-separated order statuses will be imported; e.g., WAITING_ACCEPTANCE,CLOSED,SHIPPING, etc. See this documentation for a list of order statuses.
If missing, orders with a status of WAITING_ACCEPTANCE, PAYMENT_COLLECTED, SHIPPING, SHIPPED, RECEIVED, and CLOSED will be imported.
Can be True or False.
Determines if orders will be imported as Website or BestBuy orders.
Creating custom order columns
|CUSTOM ORDER COLUMN||DATA TYPE||DESCRIPTION|
|MIRAKL_CHANNEL||String||Used by the Mirakl Order Import plugin to save the relevant order channel (BestBuy Canada, BlueFly, or other Mirakl channel).
Allows searching for orders from each channel.
|MIRAKL_SHOP_ID||Integer||Populates the Mirakl shop ID if the custom company setting Mirakl_Shop_IDs is not empty or missing.|
Creating custom product columns
Each of the columns in the table below are created by your System Administrator or by contacting Sellercloud Support.
For instructions, see the Custom Product Columns topic.
|CUSTOM PRODUCT COLUMN||DATA TYPE||DESCRIPTION|
|MIRAKL_SKU||String||Used to add the Mirakl product ID, if this not the same as the Sellercloud product ID.
If there are both products with such SKU and with the ID in the custom column, the second one will be exported.
|MIRAKL_PRICE||Decimal||Product price that will be sent by the Mirakl Inventory Export plugin to Mirakl.|
|MIRAKL_AVAILABLE_STARTED||DateTime||Start date of the active offer.|
|MIRAKL_AVAILABLE_ENDED||DateTime||End date of the active offer.|
|MIRAKL_SHOP_IDS||String||Only used if the company setting Mirakl_Shop_IDs is populated.
A comma-separated list of Mirakl shop IDs for which product price, inventory, and availability dates should be updated; e.g., 2000,2774.
Adding plugins to the server
Add the following plugins to the relevant server:
|Mirakl Order Import||3623|
|Mirakl Order Tracking Export||3624|
|Mirakl Inventory Export Plugin||3625|
|Mirakl RMA Import||3775|
Creating scheduled tasks
The Mirakl plugin integration can be set up to run automatically using scheduled tasks.
For instructions, see the Channel Plug-in Integrations through Scheduled Tasks topic.
|Import Orders||This task will:
Orders will be created with the email address customer_id + @ + custom company setting “Mirakl_Integration_Name” with removed empty spaces + .com (@integrationName.com).
All orders are created as paid.
Products with such SKUs or IDs in custom column MIRAKL_SKU must exist on Sellercloud. Otherwise, order items will be UNKNOWN, their inventory on hand will be considered 0, and the order will be refused on Mirakl.
|Import RMAs||This task downloads order returns from Mirakl and creates them in Sellercloud.
Returns must be processed on Mirakl. They are only imported into Sellercloud.
|Export Orders||This task exports tracking information for shipped orders and sends shipping carrier and tracking number to Mirakl.
The plugin accepts the following carriers for:
Tracking information for any other carrier will be sent with an empty carrier code.
|Export Products||This task sends available inventory, price, and offer start and end date:
This integration is connecting to Mirakl’s API; therefore, no file transfer between Sellercloud and Mirakl is required. When setting up the scheduled tasks, set “Export to/Import from” to “None.”