Beta limitations and restrictions

The Brightpearl API is ready for developers to start building applications, integrations and websites against, but there are some things to be aware of.

Version control

Because of the high rate of change (we are adding to the API and its documentation every day) during the beta period, our normal version control policy is suspended and the version number will not change from 2.0.0

This means that resources, messages, URIs and JSON object structures may be changed or removed without notice - although we will try our hardest to prevent this.

Role management

The Brightpearl application places strict limits on which of your users can view or modify particular data. These restrictions are not in place for API users, so do not grant API access to a user that does not have unrestricted access to your Brightpearl account.

As soon as the Brightpearl API moves out of beta, role restrictions will be put in place.

Incomplete messages

As mentioned above, not all of the messages required to fully manage every Brightpearl resource are in place. Each week we add new messages and the rough order of priority is order management, product management, contact management and accounting.

Stock control/warehouse management is functionally complete.