PHPackages                             developifynet/brightpearl-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. developifynet/brightpearl-php

ActiveLibrary[API Development](/categories/api)

developifynet/brightpearl-php
=============================

Brightpearl API Wrapper for PHP

v1.0.2(7y ago)3422MITPHPPHP >=5.4.0

Since May 16Pushed 7y ago1 watchersCompare

[ Source](https://github.com/developifynet/brightpearl-php)[ Packagist](https://packagist.org/packages/developifynet/brightpearl-php)[ RSS](/packages/developifynet-brightpearl-php/feed)WikiDiscussions master Synced 4d ago

READMEChangelog (3)Dependencies (4)Versions (4)Used By (0)

Brightpearl PHP API WRAPPER
===========================

[](#brightpearl-php-api-wrapper)

[![Build Status](https://camo.githubusercontent.com/9c38c22b68c223a21b966121f4ceabd71723b09c275ba4331bb362a1464e0004/68747470733a2f2f7472617669732d63692e6f72672f646576656c6f706966796e65742f627269676874706561726c2d7068702e737667)](https://travis-ci.org/developifynet/brightpearl-php)[![Total Downloads](https://camo.githubusercontent.com/eccb101a38626a0035a1794fcf33a41c7e31dc075f69acd06f122fc7b4e2e03c/68747470733a2f2f706f7365722e707567782e6f72672f646576656c6f706966796e65742f627269676874706561726c2d7068702f646f776e6c6f6164732e737667)](https://packagist.org/packages/developifynet/brightpearl-php)[![Latest Stable Version](https://camo.githubusercontent.com/405fed68f3349086f772091d88b610c2eb181caf33579773d5dabd124f32c303/68747470733a2f2f706f7365722e707567782e6f72672f646576656c6f706966796e65742f627269676874706561726c2d7068702f762f737461626c652e737667)](https://packagist.org/packages/developifynet/brightpearl-php)[![License](https://camo.githubusercontent.com/a84d570d14eb85e4aa2f0495f4e42bd6687f12ab33e2652ec7d3fec6a6a9ce56/68747470733a2f2f706f7365722e707567782e6f72672f646576656c6f706966796e65742f627269676874706561726c2d7068702f6c6963656e73652e737667)](https://packagist.org/packages/developifynet/brightpearl-php)

This package uses arrays for the same json requests as you would send to the Brightpearl API. Please refer to the [Brightpearl API docs](http://api-docs.brightpearl.com/) for extra/optional field info.

Installation
------------

[](#installation)

Begin by pulling in the package through Composer.

```
composer require developifynet/brightpearl-php
```

Usage
-----

[](#usage)

Please note that all requests in

### Basic (any php app)

[](#basic-any-php-app)

```
use \Developifynet\Brightpearl\BrightpearlClient;

$client = new BrightpearlClient([
                'app_reference' => 'your-api-reference',
                'account_code'  => 'your-account',
                'account_token' => 'your-app-token',
                'api_domain'    => 'ws-eu1.brightpearl.com', // [optional], Provide URL or remove this line
            ]);

// or

$client = new BrightpearlClient();
$client->settings([
    'app_reference' => 'your-api-reference',
    'account_code'  => 'your-account',
    'account_token' => 'your-app-token',
    'api_domain'    => 'ws-eu1.brightpearl.com', // [optional], Provide URL or remove this line
]);

/**
 * Example Call
 * For more api calls check 'resources' folder
 */
$response = $client->getOrderStockStatus();
```

### Laravel

[](#laravel)

```
$client = Brightpearl::settings([
                'app_reference' => 'your-api-reference',
                'account_code'  => 'your-account',
                'account_token' => 'your-app-token',
                'api_domain'    => 'ws-eu1.brightpearl.com', // [optional], Provide URL or remove this line
            ]);
/**
 * Example Calls
 * For more api calls check 'resources' folder
 */
$response = Brightpearl::getOrderStockStatus();             // Optional $ids,  e.g. '1' or '1-3,4,5'
$response = Brightpearl::getOrder();                        // Optional $ids,  e.g. '1' or '1-3,4,5'
```

Services
--------

[](#services)

These are the api method calls generated by the service config files using GuzzleHttp/Guzzle-Services. For

### Contact

[](#contact)

`getContact()` - Retrieve contact info

```
// All Contacts
$contact = $client->getContact();

// Contact by idset
$contact = $client->getContact(['id' => '1-3,4,5']);

// get a specific contact by id
$contact = $client->getContact(['id' => '1']);
```

### Order

[](#order)

`getOrder()` - Retrieve order(s)

```
// All Orders
$order = $client->getOrder();

// Order by id
$order = $client->getOrder('1');

// Orders by idset
$orders = $client->getOrder('1-3,4,5');
```

### Other Available Services

[](#other-available-services)

```
// Order Types
$order_types = $client->getOrderType();             // Optional $ids,  e.g. '1' or '1-3,4,5'
// Product Prices
$product_prices = $client->getProductPrice();       // Optional $ids,  e.g. '1' or '1-3,4,5'
// Price Lists
$price_lists = $client->getPriceList();             // Optional $ids,  e.g. '1' or '1-3,4,5'
// All Price Lists Urls
$price_list_urls = $client->optionsProductPrice();  // Optional $ids,  e.g. '1' or '1-3,4,5'
// All Contacts Urls
$contact_urls = $client->optionsContact();          // Optional $ids,  e.g. '1' or '1-3,4,5'
// All Orders Urls
$order_urls = $client->optionsOrder();              // Optional $ids,  e.g. '1' or '1-3,4,5'
// All Orders Urls
$order_urls = $client->optionsOrder();              // Optional $ids,  e.g. '1' or '1-3,4,5'
// Order Statuses
$order_statuses = $client->getOrderStatus();
// Warehouses
$warehouses = $client->getWarehouse();
// Channels
$channels = $client->getChannel();
// Order Stock Statuses
$order_stock_statuses = $client->getOrderStockStatus();
// Order Shipping Statuses
$order_shipping_statuses = $client->getOrderShippingStatus();
// Order Types
$order_types = $client->getOrderType();
```

#### Contributing

[](#contributing)

Currently API coverage only represents fetching data portion of the Brightpearl API. If you want to contribute send bug fixes, additional resource/services and features in a pull request at the develop branch. Thanks!

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity13

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 83.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

3

Last Release

2556d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e8b9e51cc0eef4c8e1d28ecb9688f27c9c698b50710617b390baad1c4487e770?d=identicon)[developify](/maintainers/developify)

---

Top Contributors

[![efficientbit](https://avatars.githubusercontent.com/u/3807256?v=4)](https://github.com/efficientbit "efficientbit (5 commits)")[![DevelopifySNS](https://avatars.githubusercontent.com/u/35734664?v=4)](https://github.com/DevelopifySNS "DevelopifySNS (1 commits)")

---

Tags

phpapisdkbrightpearl

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/developifynet-brightpearl-php/health.svg)

```
[![Health](https://phpackages.com/badges/developifynet-brightpearl-php/health.svg)](https://phpackages.com/packages/developifynet-brightpearl-php)
```

###  Alternatives

[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k7.6M74](/packages/openai-php-laravel)[hubspot/api-client

Hubspot API client

23414.2M16](/packages/hubspot-api-client)[mailchimp/transactional

458.9M16](/packages/mailchimp-transactional)[resend/resend-php

Resend PHP library.

564.7M21](/packages/resend-resend-php)[checkout/checkout-sdk-php

Checkout.com SDK for PHP

553.3M7](/packages/checkout-checkout-sdk-php)[mozex/anthropic-laravel

Anthropic PHP for Laravel is a supercharged PHP API client that allows you to interact with the Anthropic API

71226.4k1](/packages/mozex-anthropic-laravel)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)