BrightPearl by Sage: Add a Store in the ShipWorks Hub

Background

Brightpearl is a multi-channel, retail-management system that brings orders, inventory, customer data, accounting, and reporting together in one place.

ShipWorks connects directly to your Brightpearl account. With one click, or on an automated schedule, your orders are downloaded from Brightpearl. As soon as you process a shipment, ShipWorks communicates the updated order status, shipping method and tracking information back to Brightpearl. This article will guide you through how to connect your BrightPearl account to ShipWorks.

This article will guide you through how to connect your BrightPearl account to ShipWorks in the ShipWorks Hub.

First Things First

In order to connect BrightPearl to ShipWorks there are a few things you will need:

Brightpearl username: The email address you use to log into your Brightpearl account.
Brightpearl password: The password you use to log into your Brightpearl account.
Account code: The company ID you use to access your Brightpearl login screen.
Channel IDs: Sales channels are sent to ShipWorks with each order. Brightpearl channel ID's can be found by using your browser's inspect tool. You can also contact support@brightpearl.com and our technicians will find them for you.

The Process

Connect Brightpearl in the ShipWorks Hub

Navigate to hub.shipworks.com and log in.
Click Settings.
Click the Connect Order Source button in the Order Sources section.
Click Brightpearl.
Enter a name for the order source. This is the name that will display for the store connection in the ShipWorks client.
Enter the following Connection Details then click the Next button.
- Brightpearl Username: The email address you use to log into your Brightpearl account.
- Brightpearl Password: The password you use to log into your Brightpearl account.
- Account Code: The company ID you use to access your Brightpearl login screen.
- Weight Units: Ensure this matches the weight unit type in your Brightpearl account, found under Settings > Products/Inventory > Inventory Settings.
- Channel IDs: Sales channels are sent to ShipWorks with each order. Brightpearl channel ID's can be found by using your browser's inspect tool. You can also contact support@brightpearl.com and our technicians will find them for you.
- Data Center Code: You can see which data center you are on from your Brightpearl admin URL:
  - http://use1.brightpearl.com is on USE
  - http://euw1.brightpearl.com is on EU1
- Determine the Brightpearl action when an order ships: Choose what to do with the goods note in Brightpearl when the shipment is shipped in ShipWorks.
- Download orders when the Brightpearl Goods-out note is: This is the status your goods-out notes will be in in order to download into ShipWorks.
Enter the contact info and address of your Brightpearl store. This will be downloaded into the ShipWorks software as the store address and contact information. Then, click the Next button.
Verify that you wish for ShipWorks to upload the shipment details to Brightpearl when a shipment is processed. The default is to Upload the tracking number. Then, click the Finish button.

Your Brightpear store will be added and will display in the Order Sources section of the Settings screen.

Edit the Brightpearl Connection in the ShipWorks Hub

Modify the connection to Brightpearl and/or the store configuration in the ShipWorks Hub. Here's how:

Click on the Edit button to the right of Brightpearl in the Order Sources section of the Settings screen.
Select to edit either the store Connection or store Settings.
- Connection: This option allows you to update or change how ShipWorks connects to Brightpearl.
- Settings: This option allows you to update
  - Address: The address associated to your Brightpearl store in ShipWorks
  - Desktop Settings: The name associated to the Brightpearl store in ShipWorks, how orders manually entered in ShipWorks are handled, and Address Validation settings for this store.

Brightpearl in the ShipWorks Software

Sync Brightpearl with the ShipWorks Software

After successfully adding Brightpearl as an order source in the ShipWorks Hub it is recommended that you exit the ShipWorks client software and relaunch it. This will force the ShipWorks software to resync with the Hub so that it can configure the Brightpearl connection and download orders.

After syncing with the Brightpearl order source in the Hub:

A new Brightpearl store will be added in Manage > Stores.

Note that when editing the store in the ShipWorks client software, the store address, manual store settings, and store connection are grayed out and must be edited in the ShipWorks Hub.
A new Filter will be created for orders downloaded from Brightpearl.
The available Brightpearl orders will be downloaded.

Still Need Help?

Please feel free to reach out to one of our awesome Technical Support Representatives in St. Louis. We are happy to help.

Attachments

Menu