Channel Integrations Through Mirakl

Created April 24, 2020
Updated date March 25, 2023
Author Sophie H.
Category Channels
Views: 4296
0

Table of Contents

Overview

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, and Catch.

See the full list of Mirakl integrations here

BestBuy Canada
Catch
Express
Weight Watchers
Kroger
HudsonsBayUS
The Knot
OrientalTrading US
Verishop US
Belk
BedBathAndBeyond CA
BedBathAndBeyond US
Ahold
PeaPod Digital

Mirakl offers numerous channel integrations and a straightforward implementation, achieved by specifying the integration name and getting a unique API key per channel.

The company settings and relevant scheduled tasks should be set for a company designated for this integration. If you want to integrate several marketplaces through Mirakl, you need a designated company for each of them. The only exception is that you can have Best Buy and one more marketplace set up under one company.

Integration Workflow

The Mirakl integration workflow has five 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.

Create Custom Company Settings

Note that the Client Setting Enable Custom Company Settings must be enabled.

To create the custom company settings:

Go to Settings > Companies > Manage Companies > Open a company.
Go to Toolbox > Custom Settings.
Click the + sign to Add a New Custom Setting > Add the Setting Name and Setting Value from the table below.
Click Save.

CUSTOM COMPANY SETTING	VALUE
Mirakl_Integration_Name	Mirakl channels, such as BestBuyCA, Catch, etc.
Mirakl_API_Key	Mirakl authentication key.
Mirakl_API_URL	URL for the Mirakl channels, such as: BestBuy Canada: https://bby-dev.mirakl.net (test environment) https://marketplace.bestbuy.ca (production environment) Catch: https://catch-dev.mirakl.net (test environment) https://marketplace.catch.com.au (production environment)
Mirakl_Always_Accept_Orders	Optional. 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.
Mirakl_Shop_IDs	Optional. 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. Note that you can only have one Mirakl integration per company in Sellercloud. The only exception is that you can have Best Buy and one more marketplace under the same company. This setting should not exceed two IDs.
Mirakl_Order_Statuses	Optional. Only orders with comma-separated order statuses will be imported; e.g., WAITING_ACCEPTANCE,CLOSED,SHIPPING, etc. If missing, orders with a status of WAITING_ACCEPTANCE, PAYMENT_COLLECTED, SHIPPING, SHIPPED, RECEIVED, and CLOSED will be imported.
Mirakl_Import_orders_with_source_BestBuy_instead_of_Website	Optional. Can be True or False. Determines if orders will be imported as Website or BestBuy orders.

Create Custom Order Columns

The following custom order columns are created by your System Administrator or by contacting Sellercloud Support. For instructions, see the Custom Columns for Orders topic.

CUSTOM ORDER COLUMN

DATA TYPE

DESCRIPTION

MIRAKL_CHANNEL

String

Used by the Mirakl Order Import plugin to save the relevant order channel (BestBuy Canada, or other Mirakl channels).

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.

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

MIRAKL_AVAILABLE_STARTED and MIRAKL_AVAILABLE_ENDED can be in the past as long as the start date is before the end date; otherwise, Mirakl will reject the inventory and price update for the relevant product.

Add Plugins to the Server

This section is for Sellercloud Support reference only.

Add the following plugins to the relevant server:

PLUGIN NAME	ID
Mirakl Order Import	3623
Mirakl Order Tracking Export	3624
Mirakl Inventory Export Plugin	3625
Mirakl RMA Import	3775

Create Scheduled Tasks

The Mirakl plugin integration can be set up to run automatically using scheduled tasks.

Set up the tasks in the table below for the relevant company that will use the integration, not for the default company.

For instructions, see the Channel Plug-in Integrations through Scheduled Tasks topic.

SCHEDULED TASK	DESCRIPTION
Import Orders	This task will: Download orders from Mirakl and create them in Sellercloud. Send an order acceptance to Mirakl if all the ordered items have enough inventory to fulfill the order; or, set it as canceled on Sellercloud and Mirakl if inventory of one of the items is insufficient. 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: BestBuy Canada UPS FedEx DHL Canada Post ATS Purolator Loomis Canpar Tracking information for any other carrier will be sent with an empty carrier code. Catch Australia Post Allied Express Toll Ipec Toll Priority Star Track Express Couriers Please Fastway Couriers TNT Express FedEx Hunter Express Direct Freight Express Effective Freight Management Air Road StarTrack – ONLINE ORDERS Main Freight Blue Star Fastway Couriers Temando XL Express PPX Track Nexday StarTrack Border Express Cope – Sensitive Freight Temando VICTAS Freight Express Xpress Transport Services M3 Logistics NORTHLINE peptransport Dynamic Express TOLL NQX
Export Products	This task sends available inventory, price, and offer start and end date: Price is set in the custom product column MIRAKL_PRICE. The offer start and end dates are in MIRAKL_AVAILABLE_STARTED and MIRAKL_AVAILABLE_ENDED. Product UPC must be the same as when the Mirakl offer was created; otherwise, Mirakl will reject the offer(product) update (for BestBuy Canada only; Catch inventory updates will be matched by product ID and custom column MIRAKL_SKU). Do not update more than 60,000 products per hour since the limit of 60 calls per hour will be reached. 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.”

You can use Sellercloud with any Mirakl integration, such as BestBuy Canada, and Catch.

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.

Create custom company settings

Note that the Client Setting Enable Custom Company Settings must be enabled.

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, etc.
Mirakl_API_Key	Mirakl authentication key.
Mirakl_API_URL	URL for the Mirakl channels, such as: BestBuy Canada: https://bby-dev.mirakl.net (test environment) https://marketplace.bestbuy.ca (production environment) Catch: https://catch-dev.mirakl.net (test environment) https://marketplace.catch.com.au (production environment)
Mirakl_Always_Accept_Orders	Optional. 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.
Mirakl_Shop_IDs	Optional. 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. Note that you can only have one Mirakl integration per company. The only exception is that you can have Best Buy and one more marketplace set up under the same company. This means that the values for this setting cannot exceed 2 IDs.
Mirakl_Order_Statuses	Optional. Only orders with comma-separated order statuses will be imported; e.g., WAITING_ACCEPTANCE,CLOSED,SHIPPING, etc. If missing, orders with a status of WAITING_ACCEPTANCE, PAYMENT_COLLECTED, SHIPPING, SHIPPED, RECEIVED, and CLOSED will be imported.
Mirakl_Import_orders_with_source_BestBuy_instead_of_Website	Optional. Can be True or False. Determines if orders will be imported as Website or BestBuy orders.

Create custom order columns

The following custom order columns are created by your System Administrator or by a Sellercloud Support representative. For instructions, see the Custom Columns for Orders topic.