BigCommerce connection

Introduction

A BigCommerce connection, created using the BigCommerce connector, establishes access to BigCommerce. Once a connection is configured, you can create instances of BigCommerce activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit a BigCommerce connection

A new BigCommerce connection is created using the BigCommerce connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Connections page (see Create a global endpoint in Global Connections).

An existing BigCommerce connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Connections page (see Edit a global endpoint in Global Connections).

Configure a BigCommerce connection

Each user interface element of the BigCommerce connection configuration screen is described below.

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each BigCommerce connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the BigCommerce endpoint, which refers to both a specific connection and its activities.

• Store Hash: Enter the store hash. This value is obtained from the API account's API path, as described in BigCommerce API account creation.

• Client ID: Enter the client ID (optional). This value is obtained as described in BigCommerce API account creation. The client ID is not required for a successful connection, and testing a connection may succeed with an invalid client ID. BigCommerce uses the client ID to track usage and analytics and may request it for troubleshooting.

• Access Token: Enter access token for the BigCommerce instance. For more information on obtaining the access token, see BigCommerce API account creation.

• Enable Keep-alive Strategy: Select to keep the connection from closing between signals for the amount of seconds specified in the Enter the Time in Seconds Between Signals to Keep the Connection Alive field.

• Enter the Time in Seconds Between Signals to Keep the Connection Alive: Enter the time in seconds between signals to keep the connection alive. Only numerical characters are allowed.

• Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.

• Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a BigCommerce connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

• 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.