Home Nodes BigCommerce REST

BigCommerce REST

Provides integration into BigCommerce via its REST Admin API.

BigCommerce is a popular cloud-based eCommerce platform that enables merchants to build and manage online stores. The BigCommerce Admin REST API provides a powerful interface for integrating with store data including products, orders, customers, categories, shipping, and more. This connector allows you to programmatically access and manipulate that data from within Flowgear.

Revision History

1.0.0.0 Initial Release
1.0.0.1 Fixed validation issue when connection not set.

Properties

Connection

Type: Connection Input
The Connection Property

Url
Type: String
The base URL of the BigCommerce Admin API. This is typically in the format https://api.bigcommerce.com/stores/{storeHash}/v3/.

AccessToken
Type: Password
The Store-level Access Token from BigCommerce. This token is required to authenticate all requests to the Admin API.

OperationId

Type: String Input
The internal ID of the selected BigCommerce operation. This is set automatically when a sample is selected.

Description

Type: String Input
A short description of the selected BigCommerce operation. Display only; this value is set automatically when a sample is selected.

Request

Type: JSON Input
The JSON body of the request, used for create/update operations. Define the data you want to send to BigCommerce here.

Response

Type: JSON Output
The JSON body returned in the response from BigCommerce. This contains the data returned by the selected operation.

Setup

To authenticate with the BigCommerce REST API, you will need to create a Store-level API account in the BigCommerce Admin UI.

Step 1: Create a Store-level API Account

  1. Log into your BigCommerce store admin
  2. Navigate to:
    Advanced Settings > API Accounts
  3. Click Create API Account
  4. Select "V2/V3 API Token"
  5. Fill in the following:
    • Name: (e.g., Flowgear Integration)
    • OAuth Scopes: Select appropriate read/write access depending on what the connector needs to do (e.g., Products, Orders, Customers)
  6. Click Save

A .txt file will be automatically downloaded. This contains your credentials.

From that file, you will need:

  • API Path → Paste this into the Url property in Flowgear
  • Access Token → Paste this into the AccessToken property in Flowgear

You do not need the Client ID or Client Secret.

Keep the credentials file secure. The Access Token is sensitive and will not be shown again.

Remarks

To use this connector, you should first select a sample. Doing so will automatically populate the following:

  • The OperationId for the selected endpoint
  • A prefilled Request body
  • Any required custom properties (parameters) for that specific operation

These can then be modified as needed for your use case.

Refer to the BigCommerce API Reference for additional information on supported parameters and expected responses.

See Also