1. ShipStation Help U.S.
  2. Integrations Help Guide
  3. Stores A-C

Brightpearl by Sage

Avatar

ShipStation Content Team

Updated

Brightpearl is a multi-channel, retail-management system that brings orders, inventory, customer data, accounting, and reporting together in one place. Brightpearl integrates directly with ShipStation to automatically import your orders so you can start shipping quickly. ShipStation will automatically notify your Brightpearl account with each order's shipment details as soon as you create each label.

You can arrange a Brightpearl demo here on their website.

Brightpearl Requirements

Connection Requirements:

  • An active account with Brightpearl.

  • 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 in the Printed status before they will import to ShipStation.

Connect a Brightpearl account to ShipStation

To connect your Brightpearl account to ShipStation:

  1. Go to Account Settings.

    sssettings.png

  2. Select Selling Channels from the sidebar, then choose Store Setup.

    Settings page selections, with outline marking the Selling Channels Store Setup option.

  3. Click Connect a Store or Marketplace.

    Store Setup Settings, box highlights Connect a Store or Marketplace button.

  4. Select the Brightpearl tile.

    Brightpearl logo on square tile button

  5. Fill out the form that appears in the connection window.

    Brightpearl connection form fields in ShipStation settings

  6. Click Connect.

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

After you've completed the connection steps, the store's Settings page will open. You can adjust your store-specific settings like branding and customer notifications, if you wish. Or click Save to close.

Available Features for Brightpearl

The ShipStation integration with Brightpearl supports the following standard features:

Key: Green checkmark. Supported feature. Yes. = Supported; Red X mark. Unsupported feature. No. = Not Supported; Grey dash icon. Not applicable. = Does Not Apply

Feature

Supported?

Custom Statuses

Red X mark. Unsupported feature. No.

Customer Emails

Green checkmark. Supported feature. Yes.

Customer Phone Numbers

Green checkmark. Supported feature. Yes.

Requested Service

Green checkmark. Supported feature. Yes.

Payment Method

Red X mark. Unsupported feature. No.

Discounts

Red X mark. Unsupported feature. No.

Identifies Gift Orders

Green checkmark. Supported feature. Yes.

Internal Notes

Green checkmark. Supported feature. Yes.

Notes from Buyer

Green checkmark. Supported feature. Yes.

Order Weight

Green checkmark. Supported feature. Yes.

Item Weight

Green checkmark. Supported feature. Yes.

Item Images

Red X mark. Unsupported feature. No.

Item Options

Green checkmark. Supported feature. Yes.

Item Warehouse Location

Green checkmark. Supported feature. Yes.

Order Status Mapping

ShipStation Status

Brightpearl Status

Awaiting Payment

Not Supported

Awaiting Shipment

ReadyToShip

Shipped

Shipped

Cancelled

Cancelled

On Hold

Not Supported

Data Sent with Shipment Notification

This table indicates which data ShipStation sends to Brightpearl with the marketplace shipment notification:

Field

Sent to Marketplace?

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

Red X mark. Unsupported feature. No.

Note to Buyer

Green checkmark. Supported feature. Yes.

Item Information

Green checkmark. Supported feature. Yes.
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

If a store allows custom statuses, this means you define that statuses your orders use in your selling channel. In most cases, if you have custom statuses you'll need to define which ShipStation statuses each custom order status corresponds to.

ShipStation will import the customer's email address with the order data and can send shipment confirmation and delivery emails to that email address (configured in your Store settings).

ShipStation will import the customer phone number with the order data.

ShipStation will import the shipping method chosen by the customer during their store checkout.

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

ShipStation will import discount and coupon information for the order.

ShipStation can determine if an order is a gift from the order data sent by the store.

ShipStation will import internal notes or order activity from the store into the ShipStation Internal Notes field.

ShipStation will import notes provided by the customer when they made their purchase.

ShipStation will import the total order weight from the store.

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. These images will appear as thumbnails in your Order Details and can be included in email notifications and packing slips.

ShipStation will import item options (such as color or size) for each line item in the order. This data will appear in your Order Details and can be included in customer emails and packing slips.

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

Troubleshooting Tips for Brightpearl

Here are some common issues experienced by users, potential causes, and available troubleshooting tips.

Issue

How to troubleshoot or resolve

Orders do not import into ShipStation.

Ensure that the Order has a Goods-out note in the Printed status so it will import to ShipStation.

Historic orders that were shipped on Brightpearl do not appear on our Shipped list.

If a store allows custom statuses, this means you define that statuses your orders use in your selling channel. In most cases, if you have custom statuses you'll need to define which ShipStation statuses each custom order status corresponds to.

ShipStation will import the customer's email address with the order data and can send shipment confirmation and delivery emails to that email address (configured in your Store settings).

ShipStation will import the customer phone number with the order data.

ShipStation will import the shipping method chosen by the customer during their store checkout.

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

ShipStation will import discount and coupon information for the order.

ShipStation can determine if an order is a gift from the order data sent by the store.

ShipStation will import internal notes or order activity from the store into the ShipStation Internal Notes field.

ShipStation will import notes provided by the customer when they made their purchase.

ShipStation will import the total order weight from the store.

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. These images will appear as thumbnails in your Order Details and can be included in email notifications and packing slips.

ShipStation will import item options (such as color or size) for each line item in the order. This data will appear in your Order Details and can be included in customer emails and packing slips.

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

Didn't find what you were looking for?