URI syntax

All Brightpearl API URIs, with the exception of the authenticate message, follow the same syntax:

https://ws-{datacentre}.brightpearl.com/{api-version}/{account-id}/{service}-service/{resource-path}

Variable Value
datacentre The datacentre your account is located in (see table below)
api-version The version of the API that you want to use. At the time of writing the latest version is 2.0.0
account-id Your account ID (e.g. mycompanyapitest)
service A name for a logical grouping of functionality (e.g. warehouse for stock control and warehouse management)
resource-path The resource (in the RESTful sense of the word) you want to manipulate

Example: Get contact with ID 500 from my brightpearlapiaccountid

https://ws-eu1.brightpearl.com/2.0.0/brightpearlapiaccountid/contact-service/contact/500

Broken down that is:

  • datacentre = eu1
  • api-version = 2.0.0
  • account-id = brightpearlapiaccountid
  • service = contact
  • resource-path = /contact/500

Your URI Prefix

The first portion of the URI, up to, but not including the service name, is referred to as your URI prefix. Most of the API documentation will specify URIs relative to this prefix.

Datacentre codes

The datacentre code you will need to use is dependent on the timezone you chose when you created your Brightpearl account.

Datacentre Code Timezones
eu1 GMT, CET
eu2 Use if your Brightpearl admin domain (visible at Settings > Company > Other options) is https://secure2.thisispearl.com
usw PST, MST
use EST, CST

Resource Searches

For learning on how to construct Search queries please checkout the document here for more information.

 
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.