> For the complete documentation index, see [llms.txt](https://help.orderdesk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.orderdesk.com/integration-setup-guides/sales-channels/brightpearl-integration.md).

# Brightpearl Integration

If you have an online store with [Brightpearl](https://www.brightpearl.com/), use Order Desk to automatically import orders through the Brightpearl integration.

### Setup

To begin, click on **Manage Integrations** from the left sidebar in Order Desk. Under the **Shopping Carts** tab, find and click to enable Brightpearl.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FEFCqmjldei2MVJodcnEK%2Flegacy-4bb40355604d1b85a6d2.jpg?alt=media)

Alternatively, search for Brightpearl from the available integrations search.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FQqjnYoSe4Eui2faaGCHz%2Flegacy-6d3335b10f861a2d936a.jpg?alt=media)

Once enabled, you’ll need to reach out to us at **<tech+brightpearl@orderdesk.com>** with your Brightpearl Account ID, after which you will be given confirmation to head back to the connection page and click Connect To Brightpearl. Your Account ID can be found on the bottom right of your Brightpearl Dashboard.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FZ5Pj9WmxtHcmjC2j8gz6%2Flegacy-c7d83ff5d0fa68fcc9a0.png?alt=media)

Please note that Order Desk isn’t able to help find or reset your credentials, as they can only be provided by Brightpearl.

### Integration Settings

Once connected, set your preferences in the Brightpearl settings.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FK6WAOoM5OuFdo6HZEpqr%2Flegacy-9e36333d67341bb35374.png?alt=media)

#### Brightpearl Help

Click *Need Help Getting Started?* for access to helpful resources for using Brightpearl.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FwAULJJiy9ZtxdPqCuVhr%2Flegacy-a758e3e72fefd3cca7f3.gif?alt=media)

#### Check for New Orders

Select how often you want Order Desk to download orders from Brightpearl.

#### Folder for New Orders

Choose the folder where new orders should be placed as they come in from Brightpearl. You can use the default New folder, or create your own custom folder from your [Store Settings](/start-here/getting-started-series/quick-start-overview.md#working-with-folders).

#### Order Status

Select the order status of the orders to be downloaded into Order Desk.

#### Payment Status

Select the payment status of the orders to be downloaded into Order Desk.

#### Shipping Status

Select the shipping status of the orders to be downloaded into Order Desk.

#### Warehouse ID

Brightpearl Warehouse ID. Order Desk can only import orders that have a shipment note (referred to as a *Goods Out Note*) created in Brightpearl that has a Warehouse ID matching the one set here.

#### Order Number Format

Select which number should be the order ID in Order Desk. You can choose one of two options: **Goods Out Note ID** and **Sequence ID**.

#### Sync Tracking Numbers

If enabled, shipment details will be passed back to the original order in Brightpearl as they are added to Order Desk.

#### Auto Accept Orders

If enabled, order acceptance emails will be automatically sent to Brightpearl after orders are downloaded.

#### First Import Date

Any orders prior to the date set here will not import into Order Desk.

#### Order Prefix

If you’d like to add a unique order prefix to the order numbers that come in from Brightpearl, set that here.

#### Inventory Settings

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FOdfFxiXTrK4bEqdYvKSi%2Flegacy-2b8ac46f34d617b73406.png?alt=media)

#### Sync Inventory

Enable if you want Order Desk to sync your inventory counts back to Brightpearl. If enabled, inventory updates will be sent to Brightpearl throughout the day as they happen, with up to a 7 minute delay for batching purposes.

#### Warehouse ID

Select the warehouse ID where Order Desk should check for inventory.

#### Location ID

Select the location ID where Order Desk should check for inventory.

#### Currency

Select the currency your items are in.

#### Manually Import Orders

You can manually import orders from Brightpearl at any time. You can import orders by **Date** if you need to bring in multiple orders, or by a specific **Order ID** if you only need to import one order.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FenlqwVDATuR4Pq7ilFIk%2Flegacy-2c6d2f04acde1052cc6f.png?alt=media)

> **Tip: Importing Orders by Date**
>
> If Brightpearl has a large number of orders in the selected date range, you may need to click the **Import** button a few times to bring them all in.

### Sending Extra Shipment Details to Brightpearl

#### Order Level Details

The following details can be added as Checkout Data or Order Metadata and we’ll send them along to BrightPearl with your shipment updates.

| Field Name       | Field Description                         |
| ---------------- | ----------------------------------------- |
| PriorityShipping | Sets the shipping priority.               |
| ShippingLabel    | Link to the shipping label.               |
| ShippingBoxes    | Sets the number of boxes in the shipment. |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.orderdesk.com/integration-setup-guides/sales-channels/brightpearl-integration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.