Configuring the Brightpearl BigCommerce app

General configuration

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

Gift message custom field: Select a custom field to map a gift message to Brightpearl. If no custom field is selected, order notes will be used used. 

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.

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.

Primary Contact Address on Order: This option will dictate which address and contact information is used on an order's primary address in Brightpearl. 

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.

Record payments with no status as captured in Brightpearl: Some payment methods in BigCommerce do not provide a payment status (such as 'Authorized', 'Captured', 'Void', etc), for example when the method only supports successful capture. Enable this setting if you would like these payments to be recorded as 'Captured' in Brightpearl. If disabled, those orders will be shown as unpaid in Brightpearl and should be reconciled manually. This only affects a small number of BigCommerce's payment providers.

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.

Returned stock location: Specify the location for returned stock. 


Have more questions? Submit a request