This article walks you through installing and configuring the BigCommerce integration on iPaaS.com — creating a BigCommerce API account, subscribing to the integration, entering your credentials and settings, and verifying that the connection works. For an ongoing reference to every credential and setting, see BigCommerce Connections and Settings.
Before You Begin
Before you set up the subscription in iPaaS.com, create a store-level API account in BigCommerce and save the credentials it generates. The integration connects to BigCommerce using this API account's access token.
Log in to your BigCommerce admin account with a user that has admin permissions.
Navigate to Settings, then select Store-level API accounts.
Click Create API Account and set Token type to V2/V3 API token. Name the account iPaaS.com (or a similar recognizable name).
In the API path, locate the segment that begins with
stores/followed by your store identifier and the version number. Copy the full API path and save it to a safe location.
Grant the following OAuth scopes. Any scope not listed should be set to None.
Orders: Modify
Order Transactions: Modify
Fulfillment Methods: Modify
Order Fulfillment: Modify
Create Payments: Create
Get Payment Methods: Get
Stored Payment Instruments: Modify
Products: Modify
Store Inventory: Modify
Store Locations: Modify
Customers: Modify
Content: Modify
Marketing: Modify
Channel Settings: Modify
Channel Listings: Modify
Click Save. BigCommerce displays the API credentials dialog and downloads a credentials file to your computer. This file contains the API path, Client ID, and Access Token you will enter on the iPaaS.com subscription settings page. Store it securely — the access token is shown only once.
Important Notes:
Only the BigCommerce store owner, or a user with permission to create store-level API accounts, can generate these credentials. See BigCommerce User Permissions for details.
The access token is tied to the scopes you grant. If a data transfer later fails with a permission error, review the API account's scopes in BigCommerce and regenerate the token if needed.
B2B Edition (optional): If you plan to use B2B functionality, install and configure the BigCommerce B2B Edition app (additional fees may apply). B2B uses the same store-level access token — there is no separate B2B login. For what the integration covers, see BigCommerce B2B Edition Support.
With these credentials in hand, you can install the BigCommerce subscription.
Installation Instructions for Integration Setup
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the BigCommerce integration tile in the marketplace.
On the Subscription Detail page, click Subscribe.
Enter a Name for the subscription. It can be any name that is relevant and unique within your company.
Format: [Product Name] - [Environment/Purpose]
Example: BigCommerce - Three Rivers Equipment
Select a Version.
Select Create Default Mappings (recommended). This pre-builds the standard mapping collections for you. If you prefer to build all mappings yourself from scratch, leave this box unchecked.
Click Apply to create the subscription. You will then configure the connection credentials and settings, described in the next section.
Authentication Configuration
On the BigCommerce subscription settings page, enter the four credential fields below. These are what connect the integration to your store — the integration authenticates with the store-level API account access token you created, scoped to the store identified by the store hash. This is not an OAuth login flow, and there is no separate B2B email or password.
Credential | Location | Description |
BC Api Url | The first part of the API path from your credentials file. | The BigCommerce API path through the top-level domain, with no trailing slash. Example: |
BC Api Store Hash | The | Your store identifier. If the API path is |
BC Api Client Id | The Client ID in your downloaded credentials file. | Identifies the API account. |
BC Api Token | The Access Token in your downloaded credentials file. | The store-level access token used to authenticate every request. |
Important Notes:
The access token is shown only once, in the credentials file downloaded when you created the API account. If you lose it, create a new API account (or regenerate the token) in BigCommerce and update the BC Api Client Id and BC Api Token fields.
Because the token carries the scopes you granted, the connection can only perform the operations those scopes allow. Permission errors during a transfer usually mean a scope is missing.
When B2B is enabled (see the next section), the integration connects to the BigCommerce B2B Edition API using this same access token together with the store hash.
For the full credential and authentication reference, see BigCommerce Connections and Settings.
Operational Configuration
Beyond the four credential fields, the BigCommerce subscription has optional settings that control specific behaviors. All of them are optional — leave a setting empty unless you use the feature it controls. Each setting is documented in full in BigCommerce Connections and Settings; the summary below covers what to set at installation.
B2B settings
B2B Enabled: Set to True to turn on BigCommerce B2B Edition support (company, customer, and quote handling). Leave empty or False to run in standard retail (B2C) mode.
B2B Api Url: The BigCommerce B2B Edition API base URL, used only when B2B is enabled. Example:
https://api-b2b.bigcommerce.comAllow iPaaS.com to delete company hierarchy: Set to True only if you want the integration to be able to delete a B2B company parent-child relationship. If left empty or False, the existing hierarchy is left unchanged.
Price list settings
These apply only when you synchronize BigCommerce price lists.
Price List Record Delimiter: The character (for example a comma
,or a pipe|) that separates one complete price-list record from the next within a single field.Price List Field Separator: The character that separates the individual values within a single price-list record.
Do Not Delete Price List Record: Set to True to keep existing price-list records. Set to False to allow the integration to delete price-list records that have no values.
Ignore Price List Errors: Set to True to suppress price-list errors instead of failing the transfer. Defaults to False.
Product metafield settings
These apply only when the integration writes product metafields.
Namespace For Product(MetaFields): The namespace applied to product metafields the integration writes. Namespaces group metafields so different types of custom data do not conflict.
Permission Set For Product(MetaFields): The permission set that controls the visibility and writeability of product metafields the integration writes (for example,
app_only).
Other settings
Group Order Shipments By: Controls how multiple shipments for the same order are grouped when an order is transferred. Shipments that share the same value for the chosen field are merged into one record, which helps prevent duplicate shipment entries.
Disable Gift Card Auto-Creation During Order To iPaaS Preprocessing: Set to True to stop the integration from automatically creating gift cards for gift-certificate line items while an order is being prepared for transfer. Defaults to False.
Note: The Rectangle Grid Tags, Swatch Grid Tags, and Swatch Color Values settings are no longer supported. Leave them empty.
Throttling
The subscription also includes throttle and concurrency settings that keep the integration from overwhelming BigCommerce's API during heavy transfers. These fields are required, but their values are pre-populated by the integration and do not normally need to be changed. For details, see Subscription Configuration – Edit.
Post-Installation Verification
After completing the installation, run these checks to confirm the connection works.
Data Sync Test:
Trigger a sample data pull from BigCommerce into iPaaS.com (for example, a product or order transfer).
Trigger a sample data push from iPaaS.com to BigCommerce.
Functionality Test:
Run an end-to-end business process that exercises the integration.
Confirm that field mappings and workflow triggers behave as expected.
Review the integration logs in iPaaS.com for errors. If you see a permission error, verify the API account scopes in BigCommerce. For common messages and their fixes, see BigCommerce Errors.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or search the documentation.
Documentation: iPaaS.com API Introduction
Support Portal: support.ipaas.com
Contact Information: Contact iPaaS.com