Brightpearl

How to add a Brightpearl account to ShipStation, what features are available, and other need-to-know details.

Brightpearl is a multi-channel, retail-management system that brings orders, inventory, customer data, accounting, and reporting together in one place. These features all integrate seamlessly with ShipStation.

Brightpearl Requirements

Connection Requirements:

  • An active account with Brightpearl. You can arrange a Brightpearl demo here on their website.

  • Brightpearl user name, password, and Integration URL

  • Account Code, Channel IDs, and Data Center Code

  • Determine the Brightpearl action when orders ship.

Order Import Requirements:

  • Orders must have a Goods-out note created before they will import to ShipStation.

Connect a Brightpearl account to ShipStation

To connect your Brightpearl account to ShipStation:

  1. Select the Brightpearl tile.

    Brightpearl logo
  2. Fill out the form that appears in the connection window.

    Brightpearl connection form fields.
  3. Click Connect.

If you're unsure what to put in any of those fields, check out this article from Brightpearl which describes how to find each field.

After you've completed the connection steps, your store will be connected to ShipStation. You'll be taken to the store's Settings page to adjust the store-specific settings like branding, notification preferences, and product handling.

Available Features for Brightpearl Integration

ShipStation's integration with Brightpearl supports the following standard features:

Common ShipStation Features

Default Status Mappings

Status

Brightpearl Status

Awaiting Payment

Not Supported

Awaiting Shipment

ReadyToShip

Shipped

Shipped

Cancelled

Cancelled

On Hold

Not Supported

Sent with Shipment Update

Field

Supported?

Status Update

Green checkmark. Supported feature. Yes.

Tracking Number

Green checkmark. Supported feature. Yes.

Carrier

Green checkmark. Supported feature. Yes.

Service

Green checkmark. Supported feature. Yes.

Carrier Fee

Green checkmark. Supported feature. Yes.

Note to Buyer

Green checkmark. Supported feature. Yes.

Item Information

Green checkmark. Supported feature. Yes.

This integration allows you to define the Status Mappings for the store connection.

ShipStation will import the customer email address and can send customer shipment notification and delivery emails.

ShipStation will import the customer phone number.

ShipStation will import the shipping method chosen by the customer at time of checkout.

ShipStation will import the payment method used to pay for the order.

ShipStation will import discount and coupon information for the order.

ShipStation is able to determine if an order was placed as a gift.

ShipStation will import internal notes or order activity from the selling channel.

ShipStation will import notes left by the customer at time of checkout. Displayed as Customer notes in ShipStation's Legacy Layout.

ShipStation will import the total order weight from the selling channel.

ShipStation will import the weight for each line item in the order.

ShipStation will import an image URL for each line item in the order.

ShipStation will import item options (such as color or size) for each line item in the order.

ShipStation will import a product stock location for each line item in the order.

Status UpdateTracking NumberCarrierServiceCarrier Fee

The shipment update ShipStation sends to the selling channel will include any Notes to Buyer set on the order in ShipStation.

Item Information

Additional Details about the Brightpearl Integration

  • A Goods-out note is required before an order will be exposed to ShipStation. If you're missing a Brightpearl order in ShipStation, be sure to check that the Goods-out note was created.

This integration allows you to define the Status Mappings for the store connection.

ShipStation will import the customer email address and can send customer shipment notification and delivery emails.

ShipStation will import the customer phone number.

ShipStation will import the shipping method chosen by the customer at time of checkout.

ShipStation will import the payment method used to pay for the order.

ShipStation will import discount and coupon information for the order.

ShipStation is able to determine if an order was placed as a gift.

ShipStation will import internal notes or order activity from the selling channel.

ShipStation will import notes left by the customer at time of checkout. Displayed as Customer notes in ShipStation's Legacy Layout.

ShipStation will import the total order weight from the selling channel.

ShipStation will import the weight for each line item in the order.

ShipStation will import an image URL for each line item in the order.

ShipStation will import item options (such as color or size) for each line item in the order.

ShipStation will import a product stock location for each line item in the order.

Status UpdateTracking NumberCarrierServiceCarrier Fee

The shipment update ShipStation sends to the selling channel will include any Notes to Buyer set on the order in ShipStation.

Item Information