What we do
Tools
Industries
Department
How we workLet's talk →
Home/Brightpearl
Brightpearl by Sage

Brightpearl API Integrations for a Channel With No App

A marketplace order lands in the inbox, and someone keys it into Brightpearl as a sales order before the warehouse can pick it. The marketplace isn't in Brightpearl's app store, so nothing else will. Brightpearl, now part of Sage, runs orders, inventory, warehouse work and its own accounting for multichannel retailers, and its REST API is how a channel without an app gets the same treatment as Shopify or Amazon. Brightpearl now steers new integrations toward instance apps authorized over OAuth, and treats the older private-app tokens as the legacy route.

Where Brightpearl stops

Native channel connections cover retail, but anything outside the app list needs custom logic so orders, stock and cash reconcile.

Stuck on Brightpearl? Let's solve it →

Native channel, app store app, or the Brightpearl API

Each kind of data has a natural way in. Code only starts where the listed options run out.

What needs to reach Brightpearl Route to use Watch for
Shopify, Amazon, eBay or another channel Brightpearl lists Brightpearl's native channel integration, or an app from its app store Configure it before writing anything. The listed connectors already map orders, stock and payments.
A marketplace, B2B portal or custom storefront with no app An instance app on the Brightpearl API: orders in as sales orders, stock back out Send the channel what Brightpearl's Product Availability reports, not a figure worked out somewhere else.
Order rules that need outside facts (3PL status, credit terms held in a CRM, a fraud score) Brightpearl's own automation for what it can see, plus an API app that writes the outside result onto the order Write the result to a field or status your team and rules can read, where your Brightpearl setup allows it.
Numbers for a parent company's books, a tax tool or leadership's BI A scheduled read through the API into that system Brightpearl keeps its own ledger. Agree which system is the source for each figure before the feed starts.

A Brightpearl instance app, piece by piece

The order a developer usually meets these parts in. Field and endpoint names come from Brightpearl's API reference.

  1. 1

    Register as a developer and create the app

    The Developer Area in Brightpearl's help center covers registering and setting up an app. Choose an instance app. Brightpearl still documents private apps with account and staff tokens, but labels that method legacy.

  2. 2

    Swap the authorization code for tokens

    POST to oauth.brightpearlapp.com/token/ followed by the account code, with the authorization_code grant. Later, renew with the refresh_token grant. Brightpearl's docs warn that values which aren't URL-encoded cause intermittent failures.

    Watch for: the api_domain in each token response. It's the domain for your API calls, and it can change when the token refreshes.

  3. 3

    Subscribe to the events you care about

    Create a webhook with subscribeTo (for example product for every product message), the URL Brightpearl should call in uriTemplate, and a bodyTemplate and contentType for the request body. Set idSetAccepted to true, as the docs recommend.

    Watch for: what arrives. The body you template carries the account code, resource type and resource ID, so the app fetches the record itself.

  4. 4

    Fetch, then write back

    Read the order or product the event points to, create a sales order (order type SO, assigned to that channel) for an incoming marketplace order, and send the channel the stock Brightpearl says is available. Check status.sage.com when calls fail across the board, since Brightpearl posts API status there.

A specialty retailer and a marketplace with no Brightpearl app

Specialty retailer · Brightpearl, plus a marketplace Brightpearl doesn't connect to natively

Before

Every order from the marketplace was copied into Brightpearl by hand.

Stock on that marketplace was updated a day behind the warehouse.

After

Orders and stock now move between the marketplace and Brightpearl the way they would for a built-in channel.

The copy-and-paste step is gone.

Brightpearl API habits that cause quiet failures

Calls start failing after a token refresh

How you'll know: Authentication works for days, then requests go to a domain that no longer answers for the account.

Fix: Read api_domain from every token response and store it next to the token. Never hard-code it.

Token requests fail some of the time

How you'll know: The same refresh works on one run and not the next.

Fix: URL-encode every parameter value in the token request, including the redirect URI and the code.

Polling for new orders every few minutes

How you'll know: Most calls return records that haven't changed, and the integration slows when it's busy.

Fix: Subscribe to webhooks for the resources you need and fetch only what an event names.

A flood of single-record events

How you'll know: A bulk price update sends one webhook per product.

Fix: Set idSetAccepted to true so related IDs can arrive together.

The same marketplace order created twice

How you'll know: A channel resends an order after a timeout, and Brightpearl ends up with two sales orders.

Fix: Put the channel's order number in the sales order's reference field, and look it up before creating a new one.

Brightpearl jobs with a page of their own

Two integrations around Brightpearl that need more room than this page has.

Brightpearl questions from retailers and developers

What is Brightpearl?

A retail operations platform for multichannel and wholesale sellers, now owned by Sage. It covers order management, inventory, warehouse operations and its own accounting, with native connections to channels such as Shopify, Amazon and eBay.

Does Brightpearl do accounting, or is it just inventory?

It does accounting too. Invoicing, purchasing and financial reporting are built in alongside inventory and orders, which is one reason retailers pick it over a pure stock system. Some still send figures on to a parent company's books, which is a job for the API.

How much does Brightpearl cost?

Brightpearl doesn't publish a flat price. It depends on order volume, the channels you connect and the modules you need, so ask Brightpearl or Sage for a current quote.

Does Brightpearl integrate with Shopify?

Yes, natively. Shopify is one of the channels Brightpearl connects to out of the box, along with Amazon and eBay, so a Shopify store doesn't need API work just to sync orders and stock.

Does Brightpearl have an API?

Yes. It's a REST API over JSON, documented at api-docs.brightpearl.com, covering orders, products, warehouse availability, webhooks and more. New integrations are built as instance apps that authorize over OAuth.

Who builds a Brightpearl API integration for a channel with no app?

That's work n-frames takes on: the instance app, the webhook subscriptions, the sales orders created from the channel and the stock sent back to it, built so a resent order doesn't land twice.

Let's talk

Tell us the one thing your team does manually that eats up time. We read every message and reply within a day.