Transitioning to the new BigCommerce app

We recommend moving to the new and improved Brightpearl BigCommerce App to take advantage of new features and enhanced performance and resilience.

The latest BigCommerce App is built on the same architecture as the latest Shopify and Magento Apps. The benefits of doing so are primarily enabling greater throughput of transactions (API calls), increased resilience and supportability. The app itself is modular and components can be turned on and configured in isolation of each other.

The Brightpearl BigCommerce app is made up of the following modules:

  • Inventory, prices, channel, orders, fulfillment, payments, and refunds

When installing the app ALL settings must be completed - Failure to complete the settings will often result in orders not being downloaded for and inventory not being updated. The connector does have validation for the settings, ensuring that everything is complete before exiting the app.

Prepare your Brightpearl account for the transition

To avoid overlap or skipping of order imports, we recommend the transition is managed as follows, further details on each step can be found below:

  1. Make a note of the last order that's pulled into Brightpearl from BigCommerce
  2. Deactivate the original BigCommerce app in the Brightpearl connector
  3. Install the 2017 BigCommerce app in Brightpearl
  4. Install the Brightpearl app in BigCommerce

How to deactivate the original BigCommerce app

  1. In Brightpearl, go to App store > installed apps and locate the BigCommerce app.
  2. Click the Setup button and log into the App connector using your Brightpearl login details.
  3. Click on the actions button next to the BigCommerce store and click Delete.


  4. Deactivate each separate BigCommerce account listed in the connector.

To connect Brightpearl to BigCommerce an app must be installed in Brightpearl and in BigCommerce.

BigCommerce app in Brightpearl

To allow Brightpearl to connect to BigCommerce, the app must be installed in Brightpearl. This will then allow a BigCommerce channel to be created against which all new orders will be created.

How to install the BigCommerce app in Brightpearl

  1. In Brightpearl, go to the App store and install the latest BigCommerce app from Brightpearl.


  2. Go to Settings > Company > Channels and add a new BigCommerce channel for every store that will be connected. 

Brightpearl app in BigCommerce

The Brightpearl BigCommerce app is made up of the following tabs:

  • Inventory, prices, channel, orders, fulfillment, payments, and refunds

    When installing the app, all settings must be completed. Failure to complete the settings will often result in orders not being exported to Brightpearl and inventory not being updated.

How to install the Brightpearl BigCommerce app on a BC account

  1. Navigate to the BigCommerce Apps > Marketplace and search for the word "Brightpearl" to locate the most recent app version. Click App to install. 


  2. Confirm the installation.
  3. Enter the Brightpearl account ID to connect to.
  4. Accept the terms and conditions.
  5. Name the connector (must be unique).

You are now ready to configure the Brightpearl BigCommerce app.

General configuration

Store name in Brightpearl: Record the store name used in Brightpearl.

Go live date: Use this to specify a date for the integration to go live on (allows for future dating a go live or catching old orders in transition). The BC app has redundancy checks to avoid downloading a duplicate order.

Inventory import configuration


Enable inventory updates: Check the box to activate the inventory management interaction. The app has two inventory update functions:

  • Real time update: Any time a product’s on-hand inventory level is changed (e.g. allocated to an order, transferred, received on a PO) in Brightpearl, it will push an update for that specific product in BigCommerce.
  • Nightly bulk sync: There is also a nightly bulk sync where all products’ inventory is updated nightly to ensure nothing is missed.

Stock availability warehouses: Select one or more warehouses to use for updating the availability in BigCommerce. 

Prices import configuration


Enable prices updates: Check this option to enable Brightpearl to update and manage the store prices, this will need to be enabled to make use of the rest of the price settings. This synchronization is run nightly.

Product price list: Select the Brightpearl price list for the standard pricing of products.

Retail price list: Select the Brightpearl price list to be mapped to the BigCommerce retail price of products.

Sale price list: Select the Brightpearl price list to be mapped to the BigCommerce sale price of products.

Channel configuration

BigCommerce Channel: Select the Brightpearl channel to map to orders from this BigCommerce store.

Default Price List Id: Mapped to Brightpearl price lists. All Brightpearl price lists are available, select the price list that you want to use for orders through the BigCommerce store. This is strictly to report and filter by price list in Brightpearl. Brightpearl will respect the pricing from BigCommerce on each order.

Default Shipping Method Id: Mapped to Brightpearl Shipping Methods, select the default method to be associated to orders being downloaded against the store. Note: the app will match shipping methods from BigCommerce to those in Brightpearl if their text matches.

Contact Email for Anonymous Orders: For orders that don’t have any contact information the system can use a default email address for the store (note, the email entered here should correspond to a contact in Brightpearl). Do not use the email of a user in Brightpearl.

Allocation Warehouse: Mapped from Brightpearl, select the default warehouse that you want to use for the allocation of stock against BigCommerce orders.

Keep Existing Contact Data: Checking this box will prevent updates to be made to existing account data in Brightpearl except for 1st time purchasing customers. The order will show the correct addresses but they will not be written back to a client’s CRM record. When this setting is deselected, the customer contact record will be updated to the name on the newest order and new addresses will be added to the account.

Order export configuration


Enable Order Downloads: Enables Bigcommerce orders to be downloaded into Brightpearl.

Download Pending Orders: Toggle to enable BigCommerce ‘Pending’ orders to be downloaded into Brightpearl. Pending orders can then be updated using the ‘order status mapping’ functionality.

Default Order Status: Select a default status for any unmatched statuses for new orders from BigCommerce.

Default Deleted Order status: Select a default status for any orders that are deleted in BigCommerce

Order Status Mapping: Use the mapping options to match statuses between BigCommerce and Brightpearl. The direction of the mapping can be specified either from BigCommerce, from Brightpearl or bidirectional.

Fulfillment configuration

Enable Fulfillments: Enables fulfillment updates of orders from Brightpearl to BigCommerce. This sends a shipping update and any tracking information included. Fulfillment supports partial fulfillments from Brightpearl to BigCommerce.

Payments configuration

Enable Payment sync: Enable payments to be synced between the platforms.

Default Payment Method for Payments: Select a default status for any unmatched statuses for payments from BigCommerce. Should be the text of one of the payment methods from the Brightpearl Payment Method drop-down.

Payment Method Mappings: Select the BigCommerce payment and the corresponding payment method in Brightpearl.

Refunds configuration

Create Sales Credits from Returns: Check this to enable sales credits to be created for orders via this store.

Create Payments for Sales Credits: Check this to enable payments for sales credits from the store.

New Sales Credit Status: Mapped to Brightpearl statuses, select the status that new sales credits are to be created as.

Receive items back in stock from returns: Check this to enable that returns are to be added into stock.

Learn how to install the new BigCommerce app

Learn how to configure the new BigCommerce app


Have more questions? Submit a request