Skip to Content

VTEX Connector

Summary

The Jitterbit Harmony 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 Connectivity tab (see Connectors in 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

Verbose logging can be enabled for this connector when it is used with a Private Agent. See Verbose Logging for Connectors for details.

Invoke verbose logging for this connector using this configuration entry:

<logger name="org.jitterbit.connector.verbose.logging.vtex" level="DEBUG"/>

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.

  • The VTEX Create activity is unable to create new price table rules in the Pricing Table 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 Jitterbit Harmony HTTP Connector.