Stage 2: Brightpearl setup (Shopify & Brightpearl)

Introduction

We recommend installing your Brightpearl connector via the Patchworks marketplace and then creating required instances with your Brightpearl credentials, before installing the Shopify & Brightpearl blueprint.

To add Brightpearl connector instances in Patchworks, you need to provide details for API key authentication. This page provides instructions for generating/find the required information in Brightpearl:

Creating a private app in Brightpearl

In Brightpearl, creating a private app generates a unique reference and token, which can be used for authentication in Patchworks.

1

Access Brightpearl private apps

Log in to Brightpearl and select the app store option:

Then select private apps:

2

Create a new private app

Select the add private app option:

The new private app page is displayed:

3

Provide app details

Configure the new private app page using the table below as a guide.

Field

Summary

What type of app are you creating?

Set to system app.

About the app ➤ Name

Enter a name that will be displayed for this app in Brightpearl. For example: Patchworks.

About the app ➤ Identifier

Enter a unique identifier for this app, following conventions noted on the page. This identifier will be required to authenticate your Brightpearl connector instances in Patchworks.

For example:

4

Confirm app details

Click the install option:

5

Note authentication details

You will need the reference and the token for this app to authenticate Brightpearl connector instances in Patchworks; add these to your password manager now.

Finding your Brightpearl account id

In Brightpearl, the easiest way to locate your account id is check the bottom right-hand corner of any page. For example:

Finding your Brightpearl datacenter

In Brightpearl, the easiest way to locate your datacenter is to log in to your Brightpearl dashboard and check the URL - for example:

Typically, the data centre associated with your account is the first element of the URL. Taking our example, euw1 is the data center value.