Brightpearl API
Brightpearl by Sage is a cloud retail operating system that runs order management, inventory, fulfillment, CRM, and accounting for multichannel ecommerce and wholesale merchants. An unofficial API lets you programmatically pull orders, inventory, contacts, products, and accounting records—and push updates like new orders, stock movements, shipments, and invoices back into Brightpearl.
What is Brightpearl?
Brightpearl is a cloud-based retail operating system, now part of Sage, that helps multichannel ecommerce merchants and wholesalers streamline operations across order management, inventory, fulfillment, CRM, and accounting. Retailers use Brightpearl to centralize orders and stock from channels like Shopify, Magento, BigCommerce, Amazon, eBay, and Walmart; automate repetitive workflows; forecast demand and purchasing; and keep financials in sync—reported across 5,000+ brands.
Core product areas include:
- Inventory & Order Management (centralized orders and stock across channels)
- Inventory Planning (demand forecasting and purchasing recommendations)
- Shipping & Fulfillment and Warehouse Management System
- Automation Engine (workflow automation for repetitive tasks)
- Retail CRM and Retail Analytics
- Retail Accounting (financial management and ledger integration)
Common data entities:
- Sales Orders, Purchase Orders, Order Rows, Acknowledgments, Shipping Status
- Products, Brands, Categories, Bundles, Suppliers, Price Lists
- Inventory, Stock Transfers, Goods Movement, Fulfillment
- Contacts, Companies, Groups, Addresses, Custom Fields
- Invoices, Payments, Journals, Tax Codes, Currencies (Accounting)
- Warehouses, Locations, Webhooks, Integration Instances
The Brightpearl Integration Challenge
Merchants run order-to-cash, inventory, and accounting on Brightpearl daily, but turning its account-scoped REST API into resilient, production automation is non-trivial:
- Account-scoped endpoints: Every request must supply your account code and target the correct datacenter, so generic clients break across tenants and regions
- OAuth 2.0 app registration: Public and private apps require staff/developer approval, client credentials, and token refresh before any data flows
- Mixed encoding quirks: Token requests use x-www-form-urlencoded input while responses are JSON with underscore-cased keys, complicating naive HTTP clients
- Rate limits and throttling: API request quotas vary by plan and must be respected to avoid being throttled during high-volume order syncs
- Resource sprawl: Orders, Products, Warehouse, Contact, Pricing, and Accounting each have distinct object models, IDs, and lifecycle states
- Event consistency: Webhooks and the integration message bus need careful idempotency and ordering when syncing stock and order status downstream
How Supergood Creates Brightpearl APIs
Supergood handles Brightpearl's OAuth 2.0 flow, account-code and datacenter routing, and its REST resource catalogue to deliver a resilient API layer for your Brightpearl account—across order, inventory, contact, and accounting data.
- Manages OAuth 2.0 token grant, refresh, and account-code/datacenter resolution securely
- Normalizes underscore-cased responses and quirky encodings into consistent JSON objects
- Normalizes responses across Orders, Products, Warehouse, Contact, and Accounting so you integrate once and rely on stable objects
- Respects plan-based rate limits with adaptive throttling, retries, and webhook-driven freshness
Use Brightpearl with AI agents: Brightpearl MCP Server →
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your Brightpearl account, modules, channels, and authentication model.
- Supergood Generates and Validates Your API
We deliver a production-ready Brightpearl adapter tailored to your account, datacenter, and resource scopes.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as Brightpearl evolves.
API Endpoints
Authentication
/authenticateObtain an OAuth 2.0 access token for a Brightpearl account, resolving the account code and datacenter for downstream calls.
Orders
/ordersList sales and purchase orders with filters for status, channel, customer, and date range, including order rows and shipping status.
Orders
/create_orderCreate a new sales or purchase order with line items, customer reference, pricing, and fulfillment details.
Products
/productsRetrieve products, brands, categories, bundles, suppliers, and price lists from the product catalogue.
Warehouse
/inventoryPull stock levels, goods movements, transfers, and fulfillment status across warehouses and locations.
Contacts
/contactsList contacts, companies, groups, and addresses with custom fields for CRM and downstream syncs.
Use Cases
Sync orders and inventory across sales channels
- Pull sales and purchase orders, rows, and shipping status into a single warehouse - Stream stock levels and goods movements to downstream BI and replenishment tools - Reconcile multichannel orders from Shopify, Amazon, and eBay against Brightpearl inventory
Automate order-to-cash and fulfillment
- Create sales orders and trigger shipments without portal clicks - Push fulfillment and tracking updates back to ecommerce storefronts - Surface backorders and stock-out events to retention and purchasing workflows
Reconcile accounting and invoices
- Sync invoices, payments, and journals from Retail Accounting into the general ledger - Match tax codes and multi-currency transactions for finance reporting - Flag unpaid invoices and overdue accounts to AR systems
Keep product and contact data in sync
- Push product, bundle, and price-list updates into Brightpearl from a PIM - Pull contacts, companies, and custom fields into CRM and marketing tools - Trigger automation-engine workflows when catalogue or customer data changes
Technical Specifications
Authentication
OAuth 2.0 token grant with account code and client credentials, handled in a managed session
Connectivity
Brightpearl's account-scoped REST API across Order, Product, Warehouse, Contact, Pricing, and Accounting resources
Response format
Normalized JSON across orders, products, inventory, contacts, and accounting objects (underscore-cased keys re-mapped)
Rate limits
Adaptive throttling tuned to your plan's API request quota to avoid Brightpearl-side limits
Session management
Automatic OAuth token refresh, account-code/datacenter routing, and credential rotation
Data freshness
Near real-time pulls for orders, stock, and invoices with optional scheduled batch syncs
Security
Encrypted credential vault, scoped access tokens, SOC 2-aligned controls, and audit logging
Webhooks
Event-style callbacks for order status, stock changes, shipments, and invoice events via Brightpearl webhooks
Latency
Sub-second reads on cached entities; multi-second writes when posting orders and accounting transactions
Throughput
Horizontally scaled workers sized to multichannel order and inventory volume
Reliability
Retry, backoff, and idempotency keys for order creation, stock movements, and invoice posting
Adaptation
Continuous monitoring of Brightpearl API releases, datacenter changes, and account configuration drift
Frequently asked questions
Yes. Supergood manages the full OAuth 2.0 grant and refresh flow, supplies your account code, and resolves the correct datacenter automatically, so you never handle token plumbing yourself.
Yes. Brightpearl centralizes multichannel orders and inventory, and Supergood exposes those orders, rows, and stock levels through a normalized API so you can reconcile and sync them downstream.
Yes. Invoices, payments, journals, tax codes, and multi-currency transactions from Retail Accounting are exposed through the same normalized surface, alongside order and inventory data.
Supergood applies adaptive throttling, retries, and backoff tuned to your plan's API request quota, so high-volume order and inventory syncs stay within Brightpearl's limits.
No. Supergood handles app registration, client credentials, and token management on your behalf, working within your existing Brightpearl entitlements rather than requiring you to build and maintain an integration app.