DIY Developer Guide: Building Custom Integrations for Brightpearl

Developer guide for building custom Brightpearl integrations. Covers REST API patterns, authentication, order and inventory sync, and automation strategies for retail operations.

Overview

Brightpearl (by Sage) is a retail operations platform covering orders, inventory, purchasing, accounting, and warehouse management. Its REST API enables deep integrations with ecommerce platforms, marketplaces, and fulfillment systems.

Authentication

Brightpearl uses a custom authentication scheme:

1. Register as a Brightpearl developer
2. Create a private app in the target account
3. Obtain your app reference and account token
4. Include authentication headers in all API requests

Key API Resources

• Orders: GET/POST /order — sales orders, purchase orders, and credits
• Products: GET/POST /product — catalog management
• Inventory: GET /warehouse-service/product-availability — stock levels
• Contacts: GET/POST /contact — customers and suppliers
• Accounting: GET /accounting — journals, invoices, payments

Common Integration Patterns

Ecommerce Order Sync

1. Receive new orders from Shopify, BigCommerce, or WooCommerce
2. Map customer data to Brightpearl contacts
3. Create sales orders with correct product SKU mappings
4. Allocate inventory and trigger fulfillment workflows
5. Post back tracking information to the sales channel

Inventory Availability Sync

1. Poll Brightpearl's product availability endpoint
2. Aggregate across warehouses if multi-location
3. Push available quantities to all connected sales channels
4. Run on a 5-15 minute schedule for near-real-time accuracy

Purchase Order Automation

1. Monitor inventory levels against reorder points
2. Generate purchase order payloads for suppliers
3. Create POs in Brightpearl via the orders API
4. Track receipts and update inventory on goods-in

Webhook and Event Handling

Brightpearl supports event-based triggers:

• Subscribe to order, product, and inventory change events
• Process events in a queue to handle volume spikes
• Implement deduplication to handle repeated notifications

Rate Limits and Best Practices

• Brightpearl enforces request rate limits per account
• Use batch endpoints where available
• Cache reference data (products, warehouses) to reduce API calls
• Implement exponential backoff for throttled requests

When to Use a Managed Platform

Brightpearl's API is powerful but complex — especially for multi-channel retailers managing orders, inventory, and accounting across multiple systems. APIWORX provides pre-built Brightpearl connectors with battle-tested error handling, field mapping, and monitoring built in.

Don't want to build it yourself? We'll do it for you.

This guide shows how to build it manually. APIWORX automates all of this in 2–4 weeks with zero developer time required.

Book a Free Assessment