Skip to Content

Mirakl Connector

Summary

The Mirakl connector establishes access to Mirakl.

The Mirakl connector provides an interface for creating a Mirakl connection, the foundation used for generating instances of Mirakl activities. These activities, once configured, interact with Mirakl through the connection.

The Mirakl connector is accessed from the design component palette's Project endpoints and connectors tab (see Design Component Palette).

Connector Overview

This connector is used to first configure a Mirakl connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Mirakl connection and its activities are referred to as a Mirakl endpoint:

Mirakl activity types

  • Read: Retrieves object data from Mirakl and is intended to be used as a source in an operation.

  • Create: Creates object data in Mirakl and is intended to be used as a target in an operation.

  • Update: Updates object data in Mirakl and is intended to be used as a target in an operation.

  • Delete: Deletes object data from Mirakl and is intended to be used as a target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The Mirakl connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The Mirakl connector uses the Mirakl REST API, accessible at your instance's custom URL in the format of https://marketplace.{environment}.{customerName}.com.br. Refer to the API documentation for information on the schema nodes and fields.

Limitations

Mirakl API Limitations

The Mirakl connector has these issues due to limitations present in the Mirakl REST API:

  • The Mirakl Read activity is unable to retrieve object records when the paginate field is set to false in the request schema. To successfully retrieve object records, paginate must be set to true in the request schema.

  • The Mirakl Create activity does not retain the value field for the shop_additional_fields node in its request schema. When value is set to false in the request schema, the output returns the value as set to true.

Mirakl Connector Limitations

The Mirakl connector currently supports most objects and API operations in the Mirakl REST API. Several exceptions are listed below. These API operations are supported through the Harmony HTTP Connector:

Object API Operation
Business Intelligence
  • BI01: Retrieve business intelligence.
Messages
  • M12: Reply to a thread.
  • OR43: Create a message on an order.
Orders
  • OR74: Upload documents to attach to an order.
Products
  • CA01: Synchronize Marketplace categories from the operator information system with Mirakl.
  • H01: Import a file to add the operator's Catalog categories to Mirakl.
  • P21: Synchronize products from the operator information system with Mirakl.
  • P41: Import products to the operator information system.
  • P43: Upload product integration and error reports from the operator information system.
  • VL01: Send a file to create, update, or delete value lists.
Quotes
  • Q01: Create one or multiple quote requests.
  • Q05: Add a message to a shop quote request.
  • S32: Upload business documents to associate with a shop.

Troubleshooting

If you experience issues with the Mirakl connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.mirakl" level="DEBUG"/>
    
  5. If using Private Agents, you can check the agent logs for more information.