BigCommerce Installation Instructions

Log in to your BigCommerce account.

Navigate to Settings, and then select Store-Level API Accounts.
​

Create a new API account. In the API path, find the text stores/ and the version number. Copy the path and save it to a safe location.
​

Select the OAuth scopes your app or integration:

Click Save.

Note: The BigCommerce store owner or user with Create Store-level API accounts permissions must ensure the access token used for iPaaS.com contains the B2B Edition permission under Settings API Store-level API accounts:
​

If the B2B Edition permission is not present, new tokens must be generated with

all previous permissions in addition to B2B.BigCommerce displays the BigCommerce API credentials dialog box and starts to download a file with these credentials to your system.
​

Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
​

Click the BigCommerce integration tile.
​

On the Subscription Detail page, click the Subscribe button.

Enter the name of the subscription and select a version. It can be set to any relevant and unique subscription name within the company where this subscription is created.

Select a Version.

Select Create Default Mappings (recommended).
If you don’t want to create default mappings and want to create all mappings from scratch by yourself, then uncheck this box.
​

Provide the API endpoint for your BigCommerce B2B instance.
​Environment URLs:

Enter the BC API Store Hash and the BC API Client ID that you saved or downloaded.

Enter the BC API Token. This is the Access Token you copied in the Before You Begin section, above.

Enter the following:

Enter the B2B Email address of the B2B instance.

Set the B2B Enabled setting. This configuration flag controls whether the B2B (Business-to-Business) functionality in the system is enabled or disabled. Set to True to enable B2B mode. If False or if the value is empty, the system runs in retail (B2C) mode with no B2B communication or features enabled.

Enter the B2B Enabled value. Set to True or False to enable or disable BigCommerce B2B.

Enter the B2B Tokenname, the authentication token for the BigCommerce B2B edition.

Enter the B2B Password, the password for a B2B buyer logging into the B2B Buyer portal on the storefront.

Enter the B2B API URL. The API Base URL is https://api-b2b.BigCommerce.com

Enter the Price List Record Delimiter. This separates multiple pricing records within a single data field. A product can have several price entries, such as different prices for bulk quantities. The record delimiter, comma (,) or pipe(|), indicates where one complete pricing record ends, and the next begins. This allows the integration to correctly split and process each pricing record individually when creating or updating price lists. Without this delimiter, the system would not be able to distinguish between separate price entries, leading to incorrect or incomplete pricing data.

Enter the Price List Field Separator, which is used to separate individual values or fields within a single pricing record. A price record can contain price amount, quantity, discount type, or currency. The field separator, such as a comma (,) or pipe (|) defines how these values are separated in the record. This allows the system to correctly read and extract each field from the pricing data. Without the field separator, the integration would not be able to distinguish between different values within a single record, leading to parsing errors or incorrect price assignments.

Set the value for Do Not Delete Price List Record. Set to True to not delete these records. Set to False to allow BigCommerce to delete price-related custom fields with no values.

Set Allow iPaaS.com To Delete Company Hierarchy to True to allow a call to the B2B API to delete a parent-child relationship. If set to False or empty, the existing hierarchy is unchanged.

Set Processing Company Creation in Prerequisite to True to have the system check that the company exists before adding a user or order. Set to False to skip this check.

Enter the Group Order Shipments By value, which defines how multiple shipments for the same order are grouped based on a specific field (like tracking number or shipping method). It merges shipments that share the same field value into one record and helps prevent duplicate shipment entries.

Set Ignore Price List Errors to True or False.

Set the value for Namespace For Product (Metafields), which is used to organize and group meta fields in BigCommerce. Its primary purpose is to logically separate different types of meta fields so they don’t conflict with each other. For example, you might have meta fields for Warehouse Locations, Shipping Info, or Product Specifications. By assigning each group its own namespace, developers can manage and identify related meta fields. The namespace acts like a folder or category name for meta fields. It helps keep custom data structured, avoids naming conflicts, and makes data retrieval more efficient and organized.

Enter the Permission Set For Product (Metafields) setting defines the access level or visibility of a meta field in BigCommerce. It determines the visibility and writeability of the field by other API consumers. Values can include permission_set:app_only.

Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.

Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.

Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that Akeneo can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.

Click Apply to save the settings.

Initiate a sample data pull. (To iPaaS.com)

Initiate a sample data push. (From iPaaS.com)

Run an end-to-end business process.

Validate key features like field mappings, workflow triggers, and logging.

Review integration logs in iPaaS.com.