Brightpearl - Enable API Access

Karl Falconer · Updated

This article is for whoever connects a Brightpearl account inside DropStream — a fulfillment provider (3PL) or a merchant who manages their own DropStream account. You’ll add the store through DropStream’s Add Connection wizard. If a fulfillment provider is setting up DropStream for you, you don’t need this page — just gather your Brightpearl API credentials and send them over.

What you’ll need

How DropStream connects to Brightpearl

Every store connects through the same Add Connection wizard. For the full walkthrough of the wizard’s four steps, see Add a Connection. This article covers only the Store Setup step, where you enter the Brightpearl-specific details.

Enter your Brightpearl details

  1. In the Add Connection wizard, work through to the Store Setup step. Choose Create new store, give the store a Name, and select Brightpearl as the Platform. The Brightpearl credential fields appear below.

  2. Enter your credentials:

    Field What it is Example
    Datacenter Code Your account’s datacenter (timezone) EST / CST Timezone
    Account ID Your Brightpearl account ID myaccount
    API User Email Email of your Brightpearl API user api@example.com
    API User Password Password of your Brightpearl API user ••••••••

    For where to find each value, see Get Your API Credentials.

  3. (Optional) Adjust the import settings:

    • Warehouse Name — integrate with this warehouse only.
    • Import orders from the selected Warehouses — if any are selected, only orders for those warehouses are imported.
    • Inventory Update Price List — use this Brightpearl price list when updating inventory.
  4. Click Add connection.

Notes

  • Create a dedicated Brightpearl staff user for API communication. On the List staff page, confirm the user shows a green check in the API column — if it shows a red X, click it once to enable API access.

Once the connection is added, confirm orders are flowing with Review Order Status.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.