Skip to Content

Magento Connector

Summary

The Harmony Magento Connector establishes access to Magento.

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

The Magento connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Connector Overview

This connector is used to first configure a Magento 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 Magento connection and its activities are referred to as a Magento endpoint:

Magento activity types

  • Search: Searches for items and retrieves them from Magento and is intended to be used as a source in an operation.

  • Put Bulk: Puts items in bulk into Magento and is intended to be used as a target in an operation.

  • Post: Posts an item into Magento and is intended to be used as a target in an operation.

  • Post Bulk: Posts items in bulk into Magento and is intended to be used as a target in an operation.

  • Get: Retrieves an item from Magento and is intended to be used as a source in an operation.

  • Delete Bulk: Deletes items in bulk from Magento and is intended to be used as a target in an operation.

  • Get Bulk Status: Retrieves the status of a bulk operation from Magento and is intended to be used as a source in an operation.

  • Delete: Deletes an item from Magento and is intended to be used as a target in an operation.

  • Put: Puts an item into Magento 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 Magento 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 Magento connector uses the Magento 2 REST API. Refer to the API documentation for the version of Magento 2 that you are using for information on the schema nodes and fields.

Note

The available APIs depend on the user type (specified in the Magento connection) and the Magento version that you are using. Refer to the appropriate API documentation for details.

Troubleshooting

If you experience issues with the Magento 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.magento" level="DEBUG"/>

  5. If using Private Agents, you can check the agent logs for more information.

Additional Resources

A Jitterbit Microlearning Tutorial for Magento to FTP is available through our Jitterbit Basics video series, created by Jitterbit University.