Skip to content
  • There are no suggestions because the search field is empty.

Connecting Brightpearl as a Site

Connect your Brightpearl account so Spark Shipping can pull orders, send them to vendors, and update stock and tracking.

1. Create a private app in Brightpearl

  1. Log in to your Brightpearl account.
  2. Go to the App Store and click Private Apps.
  3. Click Add Private App and fill in:
    • Type: System app
    • Name: Spark Shipping
    • Identifier: your account code followed by an underscore and a number, for example youraccount_1234
  4. Click Install.
  5. Copy the App Reference and Token the app shows.

Your Account ID is shown at the bottom right of the Brightpearl admin screen.

2. Create the site in Spark Shipping

  1. Go to Sites, click New Site, then click Brightpearl. The site's Credentials page opens.
  2. Fill in:
    • API Domain: pick the one that matches your Brightpearl account's region: ws-eu1 (GMT, CET), ws-use (EST, CST) or ws-usw (PST, MST).
    • Brightpearl Account ID
    • Brightpearl App Reference
    • Brightpearl App Token
    • Brighthpearl Contact ID (for API): optional. The ID of the Brightpearl contact recorded as the owner of the Shipped event Spark Shipping adds to the goods-out note when it sends tracking. If you leave it blank, tracking is still sent but no Shipped event is added.
  3. Click Test Connection.

What the test loads

A successful test saves a copy of these Brightpearl settings in Spark Shipping:

  • Base Currency id and Base Currency Code
  • Product Weight Unit and Product Length Unit
  • Cached Shipping Methods
  • Your order statuses

Spark Shipping keeps these so it doesn't have to ask Brightpearl every time. If you change any of them in Brightpearl, click Test Connection again to refresh them.

3. Choose which orders to fulfill

Open Custom Settings:

  • Order statuses to be fulfilled: Spark Shipping sends orders in these statuses to your vendors. If you don't pick any, it uses Invoiced and Preparing Order. The list fills in after the first connection test.
  • Update Product Cost in Brightpearl: also send each product's cost to Brightpearl. (When MAP updates apply to your account, the label reads Update Product Cost and MAP in Brightpearl.)

Brightpearl warehouses are loaded within 3 hours of connecting and appear on the site's Setup Vendor Locations page (under Multi Location Configuration). To load them right away, open the site's Maintenance page and click Update Locations.

See What Each Site Type Supports for what a Brightpearl site can and can't do.