Brightpearl + Shopware

Integration documentation and guides

Getting Started · 2

Getting Started

Start with credentials, setup steps, and the key guides for this pair.

oauth2 · The client credentials stay valid until rotated or revoked. OAuth access tokens are short-lived and generated from these credentials.

10-15 minutes

1
Confirm the Brightpearl account context
Identify the correct Brightpearl account code and environment before starting authorization.
2
Use the agreed Brightpearl app setup
Have Junipeer or the app owner confirm the Brightpearl app/client that should be used for the integration.
3
Authorize the integration
Complete the Brightpearl authorization flow for the correct merchant account and environment.
4
Save the account-specific identifiers
Keep any Brightpearl account code, app reference, or related identifiers required by the integration.
5
Finish the setup in Junipeer
Enter the agreed Brightpearl values in Junipeer and verify the connection.

api_key · Until the integration credentials are regenerated or the integration is deleted

5 minutes

1
Open Integrations
In Shopware Admin, go to Settings → System → Integrations.
2
Create a new integration
Click Create integration and give the integration a clear name such as Junipeer.
3
Choose permissions
Decide whether the integration should use administrator permissions or a dedicated role with the required access.
4
Save the generated credentials
After creation, copy the Access ID and Security key. Shopware only shows the security key at creation time.
5
Paste the credentials into Junipeer
Enter the Access ID and Security key in the Shopware connection settings inside Junipeer.