Before configuring the Brightpearl Magento module

The Brightpearl Magento extension is configured within your Magento Admin panel.

Prior to completing the configuration, all Brightpearl resources should exist (warehouses, channels, price lists, shipping methods, order statuses, custom fields, payment methods/nominal codes).

When configuring the Brightpearl Magento extension, consider the number and frequency of interactions set to occur between Brightpearl and Magento to ensure the optimum performance of your business operations, website and Magento server.

Scope - global, website or store view?

The scope of a setting defines how broadly the setting is defined. When configuring the Brightpearl Magento extension, each setting will specify whether the scope is:

  • Global: Settings apply across the entire account - all websites, stores and store views will use the same setting.
  • Website: Settings apply to the website - all stores and store views will use the same setting. The setting can be different for other websites.
  • Store: Settings apply to the store and all the store views. The setting can be different for other stores.
  • Store view: Settings apply just to the store view. The setting can be different for other store views.

When configuring the extension, use the Magento configuration scope dropdown to specify for which level the setting is being set for.

Learn more about scope settings in the Magento user guide.

Magento 1:


Magento 2:


Summary of the Brightpearl Magento extension configuration

This table provides an overview of the Brightpearl Magento configuration screens.

A detailed explanation of each section is provided in the Configuring the Brightpearl Magento extension document.

For further reading, see Summary of Brightpearl Magento interactions.

Configuration screen Scope Summary
Brightpearl authorization Global Creates the connection between Brightpearl and Magento, and authorizes them to communicate via the extension.
  • Interaction: Import Brightpearl settings
  • SETTINGS: import
Global Pulls Brightpearl setting options into the extension so they can be used in configuration.
Shared: General settings Store view Select the Brightpearl sales channel for reporting on sales.
Shared: Stock settings Global Select the Brightpearl warehouses used for inventory sync, and specify how to handle zero stock levels, back orders and non-stock tracked items.
  • Interactions: Import stock levels (bulk)
  • INVENTORY: import / bulk
Global Activate and configure bulk inventory updates. These can be used relatively infrequently (for example, once a day) to ensure everything is in sync.
  • Interaction: Import stock levels (real-time)
  • INVENTORY: import / live
Global Activate and configure real-time inventory updates. This is the main mechanism for keeping inventory levels up to date.
Shared: Order and payment settings Store view Map order statuses and payment methods for use with the export order, import order and export order payment interactions.
  • Interaction: Export order
  • ORDER: export
Store view Map shipping methods, gift messages and customization fields.
  • Interaction: Export order status
  • ORDER: status / export
Store view Activate and configure the order status sync. Map order statuses in Shared: Order and Payment settings.
  • Interaction: Export order payment
  • ORDER: payment / export
Store view Activate and configure the payment export and transfer to Brightpearl.
  • Interaction: Reconcile orders
  • ORDER: export / reconcile
Store view

Activate and configure when an order reconciliation should occur to ensure all orders have been sent to Brightpearl.

This should be used relatively infrequently. 

Shared: Shipment settings/Goods notes and drop-ship notes settings Store view When items are shipped in Brightpearl, the shipping method mapping is used to correctly set the method in Magento and email the customer if necessary.
  • Interaction: Import shipments/Import goods notes and drop-ship notes (real-time)
  • ORDER: shipment / import / live
Store view Activate updates for shipments that are processed in Brightpearl either by a goods out note or a drop-ship note.
  • Interaction: Reconcile shipments
  • ORDER: shipment / import / bulk
Store view Activate the shipment reconciliation to do a relatively infrequent sweep across all orders to ensure any shipment updates have been captured.
  • Interaction: Import order status (real-time)
  • ORDER: status / import / live
Store view Enable updates to order statuses in Magento when a mapped order status is assigned in Brightpearl. Mapping is done under shared order settings
  • Interaction: Import order status (bulk)
  • ORDER: status / import / bulk
Store view Activate a bulk update of order statuses in Magento. Use this as a relatively infrequent sweep of Brightpearl orders to ensure the correct status has been assigned in Magento.
Shared: Price settings Website Map Brightpearl price lists to Magento websites and customer groups.
  • Interaction: Import prices
  • PRICE: import
Store view Activate price updates from Brightpearl. Map price lists in the Shared: Price settings.
  • Interaction: Register integration webhooks
  • WEBHOOKS: activate
Global Activate listening for shipping and order status updates from Brightpearl.
API Global Activate monitoring and logging of the extension activity
Core interactions    
Log cleaning    

Authorizing Brightpearl

The before you can configure your settings, you must establish the connection between your Magento instance and your Brightpearl account.

Learn more about the authorization process here.

Once the authorization has been completed, a success message will indicate that the authorization was successful.

You will now see Magento as one of the active apps in your Brightpearl app store.

Your Brightpearl and Magento accounts are now connected.

Interaction: Import Brightpearl settings

After you have authorized Brightpearl, all the settings data in Brightpearl must be imported in order to allow you to configure the extension. This includes the following details:

  • Warehouses
  • Channels
  • Price lists
  • Shipping methods
  • Custom fields
  • Payment methods/nominal codes

Note: If at any point these resources are changed in Brightpearl, the import will need to be repeated to ensure the extension is updated with the new setup.

Until this import has been performed the configuration fields in Magento will be empty and cannot be set.

How to import Brightpearl settings

  1. In the Magento admin panel, go to:

    Magento 1: Interactions > Brightpearl > Configuration

    Magento 2: Brightpearl > Brightpearl integration > Configuration

  2. In the Interactions: Import Brightpearl settings section, set the interaction as active. Magento may then indicate the cache needs refreshing. If it does, refresh the cache as instructed.


  3. To run the import of the Brightpearl settings, go to:

    Magento 1: Interactions > Brightpearl > Interactions

    Magento 2: Brightpearl > Brightpearl integration > Interactions

  4. Expand the Import Brightpearl settings section and click Execute.


    If an error is shown, ensure that the interaction is enabled under the import settings configuration as per steps 1 and 2.

    The results of the settings data import will be displayed.

  5. Review the execution results for any warnings or errors. Any errors will need to be fixed and the import re-executed.


You can now begin to configure your Brightpearl Magento extension settings.

Have more questions? Submit a request