Brightpearl Python API Docs | dltHub

Brightpearl is a cloud retail operations platform exposing a REST API to manage orders, inventory, products, warehouses and accounting. The REST API base URL is https://{datacenter}.brightpearlconnect.com/public-api/{account-id} and all requests require a Bearer token.

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv add "dlt[hub]" and start loading Brightpearl data in under 10 minutes.

---

What data can I load from Brightpearl?

Here are some of the endpoints you can load from Brightpearl:

---

How do I authenticate with the Brightpearl API?

All API requests require an OAuth2 Bearer token passed in the Authorization header. Additionally, you must include the 'brightpearl-dev-ref' and 'brightpearl-app-ref' headers in your requests.

1. Get your credentials

To obtain Brightpearl API credentials, follow these steps: 1. Log in to your developer account at https://developer.brightpearl.com/. 2. Navigate to the app management section and create a new instance app. 3. Configure the required settings (such as redirect URIs) based on your application type (Confidential for private servers, Public for other scenarios). 4. Save the app to generate your client_id and client_secret. 5. Ensure the app is added to the relevant Brightpearl accounts as an 'early access' account, and turn the app on via the app store within each target account. 6. Use the Authorization Code Grant flow to perform the approval workflow and obtain an access_token and refresh_token for authorized API calls.

2. Add them to .dlt/secrets.toml

Copy
[sources.brightpearl_source]
brightpearl_account = "your_account_id"
brightpearl_dev_ref = "your_developer_ref"
brightpearl_app_ref = "your_app_ref"
client_id = "your_client_id"
client_secret = "your_client_secret"
access_token = "your_access_token"
api_domain = "your_api_domain"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
uv run dlthub ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
uv run dlthub ai toolkit install rest-api-pipeline

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Brightpearl API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
uv run python brightpearl_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline brightpearl_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset brightpearl_data
The duckdb destination used duckdb:/brightpearl.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
uv run dlthub show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads order and contact-search from the Brightpearl API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def brightpearl_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{datacenter}.brightpearlconnect.com/public-api/{account-id}",
            "auth": {"type": "bearer", "token": access_token},
        },
        "resources": [
            {"name": "contact", "endpoint": {"path": "contact", "data_selector": "response"}},
            {"name": "order", "endpoint": {"path": "order", "data_selector": "results"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="brightpearl_pipeline",
        destination="duckdb",
        dataset_name="brightpearl_data",
    )
    load_info = pipeline.run(brightpearl_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("brightpearl_pipeline").dataset()
sessions_df = data.contact.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM brightpearl_data.contact LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("brightpearl_pipeline").dataset()
data.contact.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Brightpearl data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI harness:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-platform — Deploy, schedule, and monitor your pipeline in production.

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack