Skip to Content

VTEX connector for Jitterbit Integration Studio

Summary

The VTEX connector establishes access to VTEX.

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

The VTEX 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 VTEX 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 VTEX connection and its activities are referred to as a VTEX endpoint:

VTEX activity types

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

  • Upsert: Updates existing object data or creates new object data in VTEX and is intended to be used as a target in an operation.

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

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

  • Delete: Deletes object data from VTEX 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 VTEX 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 VTEX connector uses the VTEX REST API. Refer to the API documentation for information on the schema nodes and fields.

Limitations

VTEX API limitations

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

  • The VTEX Read activity is unable to retrieve custom prices from the Price Simulation object.

VTEX connector limitations

The VTEX Offer Management object does not currently support the Close interaction and create log API operations. these API operations are supported through the Harmony HTTP connector.

Troubleshooting

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

  5. If using private agents, you can check the agent logs for more information.

  6. For additional troubleshooting considerations, see Operation troubleshooting.