1. APIWORX Help Center
  2. Getting Started Guide

Brightpearl and CS - Cart to ESB Integration Guide

Efficiently Integrating Brightpearl and CS-Cart with ESB: A Detailed Guide for Seamless Data Synchronization

Getting Started: Connecting Your Accounts


Configuration Setup of Brightpearl and CS-Cart to ESB App


After completing the login process, you can proceed to the final step, which is the configuration setup. This step ensures that all your data flows correctly between both platforms according to your requirements. 


Note that all data is required to start the synchronization between the two platforms.


Note: Click on "Fetch Latest Data" and then begin the process outlined below.


1. Map Unique Product Identifier: This step helps match items across both platforms. As CS-Cart uses “product code” by default, it will be auto-selected. However, you can map it with Brightpearl according to your needs. For example, you can add SKU, MPN, UPC, etc., from the dropdown menu provided.

2. Manage Sales Order Payment Mapping: This section offers dynamic mapping options. Click on the '+' icon to add more rules. It assists in mapping your payment method flow across both platforms.



3. Manage Sales Order Shipping Method Mapping: Similar to payment mapping, this section provides dynamic mapping for shipping methods. Click on the '+' icon to add rules, facilitating the mapping of your shipping method flow on both platforms.


4. Choose Default Values: Many fields are mandatory in Brightpearl for creating a product. However, when importing items from CS-Cart to Brightpearl, not all data is available. To avoid failures in product creation, this section allows you to set default values for missing information.


5. Get Sales Order Status Sync: This feature enables you to synchronize only those orders from CS-Cart that meet your specific criteria. Select the desired order status from the dropdown menu in CS-Cart, and only orders with that status will be synced to Brightpearl.


6. Default Inventory Warehouse Sync: This option controls inventory updates from Brightpearl to CS-Cart. Whenever inventory is updated in any Brightpearl warehouse, the same update will reflect in CS-Cart. Multiple selection options are available for specifying the warehouse.

7. Save Mapping: Ensure to save your configurations after completing the mapping.



8. Integration Flows: This section allows you to control which elements you wish to sync between the platforms. Only the items set to “ON” status will be synchronized, while others will remain inactive.



9. Check Logs: Once you've enabled synchronization in step 8, you can monitor the process by checking the logs. Select the log type and status from the dropdown menu. This feature also enables you to see if any item or order fails to sync, along with the specific reason for the failure.


In case of any doubts or questions, please contact us at support@apiworx.com.


Connect ESB with Brightpearl and CS-Cart


To connect Brightpearl and CS-Cart with ESB, you first need to grant permission. Follow the simple instructions mentioned below:


1. Log in to the ESB APP.

2. Once you're logged in, the “Integrations” dashboard will open.


3. Navigate to "Brightpearl + CS-Cart" or search for it in the search bar, and click on the “Activate Flow” button.



4. Enter a friendly name for this flow.



5. You will be prompted to connect your Brightpearl and CS-Cart accounts and configure the settings.



Connect Your Brightpearl Account


  1. (a): Add your Brightpearl account by clicking on “add new Brightpearl account” from the dropdown menu. A pop-up will open where you need to add your Brightpearl details to complete the authorization process:

  • (i) Add Account ID of Brightpearl


Once you add the “account ID”, it will redirect you to the Brightpearl authentication page. 


Click on “approve” to grant permission for connection. After approval, Brightpearl will be successfully connected.



Now, let's move forward to connect CS-Cart with ESB.


Connect Your CS-Cart Account


2. (b): Add your CS-Cart account by clicking on “add new CS-Cart” from the dropdown menu. A new pop-up will open for you to add your CS-Cart details and complete the authentication process.

Note: In case of any doubts, please contact APIworx Support at support@apiworx.com.


3. (c) Configuration Setup: Now, let's proceed to the Configuration setup of Brightpearl and CS-Cart in the ESB App.