BigCommerce Store Management

BigCommerce Store Management API provides comprehensive access to store operations, enabling developers to manage products, orders, customers, and store settings through RESTful endpoints for seamless e-commerce platform integration.

Power end-to-end data operations for your BigCommerce Store Management API with Nexla. Our bi-directional BigCommerce Store Management connector is purpose-built for BigCommerce Store Management, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to BigCommerce Store Management or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your BigCommerce Store Management workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a BigCommerce Store Management credential in Nexla, you need to create a Store API Credential in your BigCommerce store and obtain your store hash and API key. BigCommerce Store Management API uses API key authentication with the X-Auth-Token header for secure API access.

BigCommerce Store Management API requires Store API credentials for authentication. These credentials are used to authenticate requests to the BigCommerce Store Management REST API.

1. Access BigCommerce Control Panel: Sign in to your BigCommerce Control Panel.

2. Navigate to API Settings: Go to Advanced Settings → API Accounts (or Settings → API Accounts depending on your BigCommerce version).

3. Create Store API Credential: Click Create API Account or Create V2/V3 API Token to create a new Store API credential. This will generate:

   • API Key: A unique identifier for your API credential
   • Store Hash: A unique identifier for your store (found in the API URL or credential details)

4. Configure API Scopes: Ensure your Store API credential has the necessary scopes to access the data you need. The credential needs appropriate permissions for the Store Management API endpoints you plan to use (e.g., read access for products, orders, customers).

5. Copy Credentials: Copy your API Key and Store Hash immediately after creation. Keep these credentials secure, as they provide access to your BigCommerce store data.

   BigCommerce Store API credentials provide programmatic access to your BigCommerce store. Keep your API Key and Store Hash secure and do not share them publicly or commit them to version control systems. The API key is sent in the X-Auth-Token header for all API requests. For detailed information about creating Store API credentials, see the BigCommerce API documentation.

For additional information about BigCommerce Store Management API authentication and credential management, see the BigCommerce API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Store Hash	Yes	No	The store hash generated by BigCommerce when you generated a Store API Credential. Check out the BigCommerce API documentation link for instructions
API Key	Yes	Yes	The api key generated by BigCommerce when you generated a Store API Credential. Check out the BigCommerce API documentation link for instructions

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – BigCommerce Store Management

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your BigCommerce store hash in the Store Hash field. This should be the store hash generated by BigCommerce when you created your Store API Credential. The store hash is a unique identifier for your store and is used to construct the API endpoint URL. You can find your store hash in the API credential details or in the API URL format https://api.bigcommerce.com/stores/{store_hash}/....

4. Enter your BigCommerce API key in the API Key field. This should be the API key generated by BigCommerce when you created your Store API Credential. The API key is used to authenticate requests to the BigCommerce Store Management API.

   The Store Hash and API Key are used to authenticate requests to the BigCommerce Store Management API. The API key is sent in the X-Auth-Token header for all API requests. Keep your API key secure and do not share it publicly or commit it to version control systems. For detailed information about BigCommerce API authentication, see the BigCommerce API documentation.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the BigCommerce Store Management connector tile, then select the credential that will be used to connect to the BigCommerce Store Management instance, and click Next; or, create a new BigCommerce Store Management credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common BigCommerce Store Management endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

View Store Information

This endpoint retrieves metadata and information about your BigCommerce store. Use this endpoint when you need to access store settings, configuration, or general store information.

• This endpoint automatically retrieves store information. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses GET requests to the BigCommerce Store Management API endpoint (https://api.bigcommerce.com/stores/{store_hash}/v2/store). The endpoint URL is automatically constructed based on your credential's store hash configuration.
• The endpoint will return store metadata and information. The response data is returned at the root level of the JSON response ($), containing store details, settings, and configuration information.
• The endpoint does not use pagination and returns store information in a single request.

This endpoint retrieves store metadata in a single request. The endpoint does not use pagination and returns all available store information. The endpoint requires API key authentication with the X-Auth-Token header, which is handled automatically by your credential configuration. For detailed information about the Store Information API, including available fields and response formats, see the BigCommerce API documentation.

Fetch Resources of a Type

This endpoint retrieves all store resources of a specified type from your BigCommerce store. Use this endpoint when you need to access products, categories, orders, customers, or other store resources. This endpoint fetches a maximum of 1000 responses based on the selected filter criteria and pagination settings.

• Enter the resource path in the Resource Path field. This should be the resource category and resource name in the format resourceCategory/resourceName. For example:

  • catalog/brands - For fetching brands
  • catalog/categories - For fetching categories (default)
  • catalog/products - For fetching products
  • orders - For fetching orders
  • customers - For fetching customers

  The default value is catalog/categories if not specified.

• Select the API version from the API Version dropdown menu. Available options are:

  • v3: BigCommerce API v3 (default, recommended)
  • v2: BigCommerce API v2 (legacy)

  The default value is v3 if not specified.

• Enter the maximum number of items to fetch per page in the Items per page field. This determines how many items will be retrieved in each API request. The default value is 50 if not specified. The endpoint will fetch a maximum of 1000 total responses based on the selected filter criteria.

• The endpoint uses GET requests to the BigCommerce Store Management API endpoint (https://api.bigcommerce.com/stores/{store_hash}/{api_version}/{resource_type}). The endpoint URL is automatically constructed based on your credential's store hash configuration and the selected API version and resource type.
• The endpoint uses incrementing page-based pagination, automatically fetching additional pages as needed using the page and limit query parameters. The endpoint starts from page 1 and continues fetching pages until all available resources have been retrieved (up to the maximum of 1000 responses).
• The endpoint will return all resources of the specified type. The response data is extracted from the data array in the API response ($.data[*]), with each resource record processed individually.

This endpoint requires a valid resource path in the format resourceCategory/resourceName. The endpoint uses incrementing page-based pagination (iteration.type: paging.incrementing) through the page and limit query parameters. The endpoint starts from page 1 and uses the specified page limit to fetch resources. The endpoint will fetch a maximum of 1000 total responses. The endpoint requires API key authentication with the X-Auth-Token header, which is handled automatically by your credential configuration. For detailed information about available resource types, API versions, and response formats, see the BigCommerce API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

BigCommerce Store Management data sources can also be manually configured to ingest data from any valid BigCommerce Store Management API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or sources that require custom authentication headers or request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

BigCommerce Store Management API endpoints follow the pattern https://api.bigcommerce.com/stores/{store_hash}/{api_version}/{resource_path}, where {store_hash} is your store hash, {api_version} is the API version (e.g., v2, v3), and {resource_path} is the specific resource path (e.g., catalog/products, orders, customers). API requests require API key authentication with the X-Auth-Token header, which is handled automatically by your credential configuration.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new BigCommerce Store Management data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.