Articles in this section

Set up a connection to Mirakl

Naga Sri Hari Gonaboyina
Updated

Mirakl is a leading global marketplace platform that enables businesses to launch and operate online marketplaces

Set up a connection

After you start the connection , configure it in the Create connection panel and complete all of the required * authentication settings:

Setting

Instructions

Name your connection * 

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

API type *

Choose your Mirakl API type:

  • Operator and Front: Manage marketplace operations and storefront features such as orders, offers, pricing, promotions, and front-end interactions for operator-side control and buyer-facing experiences.

  • Seller: Enable sellers to manage their offers, orders, shipments, returns, and messaging to support seller integrations with the Mirakl marketplace.

  • Connect: Synchronize data between Mirakl and external systems (ERP, PIM, OMS) using structured feeds and workflows for bulk data exchange and automation.

  • Account: Manage user accounts, roles, permissions, and authentication for access control and user management across Mirakl APIs.

  • GraphQL: Query and mutate marketplace data flexibly with a single endpoint for efficient, customized data retrieval with reduced over-fetching.

Operator and Front API type:

Subdomain * 

Enter your Mirakl subdomain. For example, if your Mirakl account URL is https://shop-dev.mirakl.net, then shop-dev is your subdomain.

Auth type *

Select your Mirakl authentication type (OAuth 2.0 or Token).

API key * 

Enter your Mirakl API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

OAuth 2.0 client *

Select the OAuth 2.0 client that stores the client ID and client secret provided to you by Mirakl partner team.

To add an OAuth 2.0 client and configure your credentials, click the plus (+) button. Click the edit (pencil.svg) button to modify a selected OAuth 2.0 client. For more information, see Create an OAuth 2.0 iClient resource.

Seller API type:

Subdomain * 

Enter your Mirakl subdomain. For example, if your Mirakl account URL is https://shop-dev.mirakl.net, then shop-dev is your subdomain.

API key * 

Enter your Mirakl API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

Connect API type:

Token *

Enter your Mirakl API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

OAuth 2.0 client *

Select the OAuth 2.0 client that stores the client ID and client secret provided to you by Mirakl partner team.

To add an OAuth 2.0 client and configure your credentials, click the plus (+) button. Click the edit (pencil.svg) button to modify a selected OAuth 2.0 client. For more information, see Create an OAuth 2.0 iClient resource.

Account API type:

Environment *

Select your Mirakl account environment:

  • Production: if your account URL is https://account.mirakl.net/

  • Test: if your account URL is https://account-test.mirakl.net/

OAuth 2.0 client *

Select the OAuth 2.0 client that stores the client ID and client secret provided to you by Mirakl partner team.

To add an OAuth 2.0 client and configure your credentials, click the plus (+) button. Click the edit (pencil.svg) button to modify a selected OAuth 2.0 client. For more information, see Create an OAuth 2.0 iClient resource.

GraphQL API type:

Subdomain * 

Enter your Mirakl subdomain. For example, if your Mirakl account URL is https://shop-dev.mirakl.net, then shop-dev is your subdomain.

API key * 

Enter your Mirakl API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see the Token and OAuth 2.0 auth universal connector documentation, respectively.

How to retrieve the API key

  1. Sign in to your Mirakl account.

  2. Click User ID (email ID).

  3. Navigate to My user settings > API key.

  4. Click Generate a new key.

  5. Copy the API key.

Mirakl.png

Additional references