Brightpearl API Beta

Welcome to the documentation for the Brightpearl API. Using the Brightpearl API, you can access the data held in your Brightpearl account and make use of Brightpearl's powerful functionality from within your own applications.

We are dedicated to building a modern, fast and lightweight API based on proven technologies (HTTP, JSON) and design principles (REST). We hope that our choices will enable you to build innovative applications for any device, using whichever programming language you prefer.

What should I do first?

The first thing you should do is follow our Getting Started tutorial, which will show you how to enable access to your account, setup a simple test environment and start experimenting with some of the features offered by the Brightpearl API. After that, you should look at the articles in the Concepts section of the documentation, which will introduce you to the technologies and patterns used in the API.

You should also have a look at the tutorials, which include instructions on how to access the Brightpearl API from some common programming languages and platforms.

We recommend following BrightpearlHelp on Twitter for service and API updates.

Where is the technical documentation?

The icons at the top of every page link to documentation for an individual 'service', each of which provides access to a group of messages related to areas of related functionality (accounting, order management, etc).

Why is this a 'beta' release?

The Brightpearl API is ready for developing against, and we encourage you to start building your applications and integrations, but there are a few caveats. These are described in detail here, but can be summarised as:

  • Core messages related to contact, product and order management are not yet available for public use
  • Permission and role management does not match the equivalent functionality in the Brightpearl application