Brightpearl is a Retail Operating System (ROS) for retailers and wholesalers.
API documentation for Brightpearl (used to build this connector) can be found via the link below:
When adding connector instances for Brightpearl, the following authentication methods are supported:
When a user chooses to add a connector instance using OAuth 2 (authorisation code) authentication, the credentials below are prompted:
| Credential | Required? | Notes |
|---|---|---|
Data center
The data centre associated with your Brightpearl account. Typically this forms the first element of the URL that you use to access your Brightpearl account - for example: https://euw1.brightpearlapp.com/admin_login.php
Here, euw1 is the data center value.
Account
The Brightpearl account that Patchworks needs to access.
State length
If you have been given a state length, enter it here. This is a numeric value which determines the length of a random string generated (behind the scenes) during the OAuth process, for verification purposes.
Scope
Enter the required scope to define what access permissions should be given to Patchworks.
Client ID
The reference given when the Patchworks app was created in Brightpearl.
Secret
The client secret which was issued when the Patchworks app was created in Brightpearl.
Response authentication token key
Set to access_token.
Grant type
Set to authorization_code.
Response type key
Set to code.
Dashboard OAuth callback URL
For our production environment set to: https://app.wearepatchworks.com/oauth/authenticate
For our staging environment set to: https://stage.app.wearepatchworks.com/oauth/authenticate
Client type
Set to confidential
OAuth authorised code (advanced)
This is an advanced setting that's used internally - under normal circumstances it should not need to be updated.