API Concepts

Optional Sections Some messages allow parts of the response data to be included or excluded to improve performance.
Request throttling How and why we limit the rate of inbound requests to the Brightpearl API
HTTP status codes An explanation of how the Brightpearl API uses HTTP status codes and common status codes that you might encounter while using the API.
Webhooks Webhooks allow developers to configure Brightpearl to send a callback to a remote system when certain events occur.
HTTP PATCH The need for and usage of HTTP PATCH
API Fundamentals Technologies, concepts and principles behind the Brightpearl API
Subscribable Resource Events Some of our internal resource events are available for API users to subscribe to
ID Resources are uniquely identifed by a postive integer called an ID.
Structure of JSON responses Responses from the Brightpearl API have a consistent structure to make integration more straightforward.
Beta limitations and restrictions Things to consider while the Brightpearl API is in beta.
Data types for resource searches Data types for columns and filters in resource searches
Multi-message Advanced API message for sending multiple messages in a single HTTP request
Empty list response code We use 404 to indicate a request for multiple resources has returned no results.
URI Syntax The format of URIs used to access the Brightpearl API
ID Sets Resources can be manipulated en masse by using an ID Set to specify a group of resources to operate on
Resource Search The Brightpearl mechanism for finding resources differs from many other RESTful APIs.