Skip to Content

BigCommerce Connector

Summary

The Harmony BigCommerce Connector establishes access to BigCommerce.

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

The BigCommerce connector uses a Store Hash, Client ID (optional), and Access Token for configuring a BigCommerce connection. These values are obtained from a store API account, as described in BigCommerce API Account Creation.

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

BigCommerce activity types

  • Query: Queries data from an object in BigCommerce and is intended to be used as a source in an operation.

  • Create: Creates a new object record in BigCommerce and is intended to be used as a target in an operation.

  • Update: Updates an existing object record in BigCommerce and is intended to be used as a target in an operation.

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

Troubleshooting

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

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