Integrating Mirakl

Mirakl helps B2B organizations digitally transform their business with a platform model. Mirakl helps businesses launch and grow an eCommerce marketplace that provides scale, efficiency, transaction data, and improved customer experience. Syncware connects via their open API.

The following workflows are supported:

  • Orders/Shipments
  • Products
  • Inventory

To integrate Mirakl with your Syncware account, you'll need to

  1. Add Syncware
  2. Add Mirakl
  3. Connect your Mirakl Account
  4. Map your workflows
  5. Configure your settings

Add Syncware

You must get your base URL and API key from Mirakl so that you can retrieve the required configurations to connect to Syncware.

*The API Key is generated on the API Key tab in 'My User Settings' page on the seller shop, in Mirakl. The 'My User Settings' page can be found by clicking on the user id in the top right hand corner of the seller's shop.

Add Mirakl

  1. From the navigation menu, select Integrations.
  2. On the Integrations page, click ADD INTEGRATION.
  3. On the Integrations List page, search Mirakl, and click ADD.
  4. You will be presented with the applicable fees for the integration. To proceed, click REVIEW.
  5. You will be presented with a summary of the fees that will be billed to you. If you approve, click APPROVE.

Result

Mirakl will be added to your Syncware account as an integration.


Connect your Mirkal account

  1. From the navigation menu, select Integrations.

    On the Integrations page, Mirakl will be displayed as an integration with action buttons to the right, click Connect.

    On the Connect page, enter the required information:

    1. Custom Name - this allows you to differentiate stores within Syncware.
    2. API Key
    3. Base URL
  2. Click SAVE.

Result

Your Mirakl integration will be connected to Syncware.

Map your workflows

Before you begin, ensure you've reviewed the instructional video for building your workflow with Sync Builder.

  1. From the navigation menu, select Integrations > Sync Builder.
  2. On the Sync Builder page, Mirakl will be displayed in the Integrations and Actions menu to the left. Use the arrow to display the Mirakl available actions.

While you can customize your workflow in many ways, the following Mirakl actions are available for use:

Workflow Action
Orders Import Orders
Shipments Export Shipments
Inventory Export Inventory
Products Import Products
Lists (logistical details required for processing orders) Import Lists

  1. From the menu, click and drag the actions that you would like to add to the workspace on the right.
  2. Once you have added the actions for your workflow, click SAVE.

Result

Your Mirakl actions are ready to be configured and verified.

Configure your settings

  1. From the navigation menu select Integrations.
  2. Click the Configure button to the right of your Mirakl integration.
  3. On the Configure Integration page, select the integration fields that you would like configured and input the required information.

While you can configure and customize your integration in many ways, our customers use the following fields most often:

Field Name Field Guide Suggestion
Auto Approve Orders Toggle "ON" to auto approve orders in Mirakl when they are imported into Syncware.
Display Products Toggle "ON" for all product information to be imported and displayed in Syncware.
Debug Toggle "ON" to help identify problems for troubleshooting.
Commission as a SKU or Discount Use these configuration to have commissions come in as a SKU or a Discount on the order.
Order Status Filter Use this configuration to filter orders that come into Syncware based on a given order status in Mirakl. Choose the relevant status options from the drop down.
  1. Please set any configurations that are "Default" this will make sure that if any information (ship method, price type, payment method, etc) is missing from the order a default will be set and the orders will process.
  2. Click SAVE in the top right corner of the page once complete.

Result

Your Mirakl settings have been configured.

Still need help? Contact Us Contact Us