To import seller stores from the channel to Mirakl Connect, sellers can follow two methods supported by Mirakl Connect Channel APIs:
- Mirakl Connect method: The store import is initiated from the seller account in Mirakl Connect.
- Channel method: The store import is initiated from the channel (for example, App Store).
The next sections will detail these methods and the related APIs. The connector must use these APIs to implement the method that works for the channel.
When the channel store configuration is complete, the seller can start configuring the catalog.
In this method, the seller imports the stores from their Mirakl Seller Account.
Follow these steps:
- Step 1: The seller signs in to Mirakl Connect and selects Channels > My Channels in the menu.
- Step 2: The seller clicks the “Link stores” button.
- Step 3: The seller selects the channel from which to import the stores and will be redirected to the connector consent URL.
| Connector URL | Query params |
|---|---|
/consent | - token: Used later to import stores. This token is available only once during the consent process- callback: Mirakl Connect callback URL |
- Step 4: The connector initiates the channel authorization process and saves the credentials to access the channel data. This process may vary depending on the channel authorization process.
- Step 5: At this step, the connector has the required authorizations to access Mirakl Connect Channel APIs and the channel APIs. The connector can then fetch the seller stores from the channel and create them in Mirakl Connect by calling the sellerAccountShopCreate API.
Important note: Pass the token given at the start of the process in the token query parameter of the API call. This token is valid only once during the consent process. - Step 6: The connector redirects the seller to the Mirakl Connect stores page by loading the callback URL given at the start of the process.
To update the store's information, the connector calls the sellerAccountShopUpdate API.
For more information, refer to the REST APIs reference.
In this method, the seller initiates the channel store import from the channel.
Follow these steps:
- Step 1: The seller authorizes Mirakl Connect from the channel (for example, an authorize button on the app available in the channel App Store). The seller is redirected to the login URL in the connector.
| Connector URL | Query params |
|---|---|
/login |
- Step 2: The connector redirects the seller to the Mirakl Connect organizations URL to allow the seller to choose an organization.
| Mirakl Connect URL | Query params |
|---|---|
/organizations/connectors | - connector: channelId (the channel ID provided by the Mirakl partner team)- state: Maintains a state during the process |
- Step 3: The seller chooses the organization and is redirected to the connector consent URL.
| Connector URL | Query params |
|---|---|
/consent | - token: Used later to import stores. This token is available only once during the consent process- callback: Mirakl Connect callback URL. |
- Step 4: The connector initiates the channel authorization process and saves the credentials to access the channel data. This process may vary depending on the channel authorization process.
- Step 5: At this step, the connector has the required authorizations to access Mirakl Connect Channel APIs and the channel APIs. The connector can then fetch the seller stores from the channel and create them in Mirakl Connect by calling the sellerAccountShopCreate API.
Important note: Pass the token given at the start of the process in the token query parameter of the API call. This token is valid only once during the consent process. - Step 6: The connector redirects the seller to the Mirakl Connect stores page by loading the callback URL given at the start of the process.
To update the store's information, the connector calls the sellerAccountShopUpdate API.
For more information, refer to the REST APIs reference.
Once the channel configuration is completed and the stores are imported from the channel into Mirakl Connect, the seller can link a store and activate product and order flows. The connector must implement the following workflow to link the selected store.
Follow these steps:
- Step 1: The seller selects a channel store in Mirakl Connect.
- Step 2: An event is triggered and sent to the connector containing the basic information of the store. The connector will consume this event. For more information refer to the Event APIs reference.
- Step 3: Once the event is consumed, the connector checks the field status in the event payload. If the value is “enabled”, the connector fetches the detailed store information from the channel and upsert it in Mirakl Connect by calling the upsertBusinessInformation API. For more information, refer to the REST APIs reference.
A store can be unlinked in Mirakl Connect. In this case the connector must implement the following workflow to deactivate the store synchronization flows:
- Step 1: The seller unlink a channel store in Mirakl Connect
- Step 2: An event is triggered and sent to the connector containing the basic information of the store. The connector will consume this event. For more information refer to the Event APIs reference.
- Step 3: Once the event is consumed, the connector checks the field status in the event payload. If the value is “disabled”, the connector deactivates the store synchronization flows in the connector.
In some channels, the authorization to access the channel APIs expires and needs renewal by the seller. In this case, the connector must provide an endpoint to allow the seller to renew the channel authorization for a store.
- Step 1: The seller selects the store that requires an authorization renewal in Mirakl Connect and clicks on the renew button, the seller is then redirected to the connector renew URL.
| Connector URL | Query params |
|---|---|
/renew | - token: Used later to import stores. This token is available only once during the consent process- callback: Mirakl Connect callback URL |
- Step 2: The connector initiates the channel authorization process and saves the new credentials to access the channel data. This process may vary depending on the channel authorization process.
- Step 3: At this step, the connector has the required authorizations to access Mirakl Connect Channel APIs and the channel APIs. The connector can then fetch the seller new stores from the channel and create them in Mirakl Connect by calling the sellerAccountShopCreate API.
Important note: Pass the token given at the start of the process in the token query parameter of the API call. This token is valid only once during the consent process. - Step 4: The connector redirects the seller to the Mirakl Connect stores page by loading the callback URL given at the start of the process.
To update the store's information, the connector calls the sellerAccountShopUpdate API.
For more information, refer to the REST APIs reference.