Release notes and new features in the Brightpearl API

This is where you can read about all the features we've introduced in our API. We will be continuously updating this page with any new features added. You can also learn about all our new features in the release notes updates that we regularly email.

October 2022 | All Transaction Statement SEARCH improvements

The dueAmount field returned by All Transaction Statement Search was previously NULL when the full balance of an invoice or credit was outstanding, i.e. when no payment is allocated. It will now return the outstanding amount.

Additionally the this field now provides the correct response for partially paid sales credits.

July 2021 | Payment DELETE endpoints now cancel the linked journal

The Customer Payment DELETE and Supplier Payment DELETE endpoints previously removed order payments but left the underlying journals in place. We've made an improvement to these endpoints such that they now also cancel the linked SR or PP journal, ensuring that the contact's account balance is correct.

October 2020 | Order updated date now more reliable

Sales and purchase orders have a last updated date which is returned in Order GETs and Sales Order GETs as the 'updatedOn' date. We've added a few additional operations that will update this field with the current timestamp to ensure the field is reliable. Actions such as updating the order's status via the API or amending an order row will now update the updatedOn date.

March 2020 | Product Availability GET - option to include on-order

You can now find the on-order inventory level of a product when requesting its availability via Product Availability GET. On order is a useful figure as it tells you how many items are expected to be received against your open purchase orders into each warehouse.

If you include this option, the response will include both the total quantity across all purchase orders in Brightpearl and the shipped quantity (in other words, the quantity that has already been received). To find the number of items that have not yet been received, i.e. the on-order quantity, simply subtract the shipped quantity from the total.

January 2020 | Warehouse SEARCH - new

With this new endpoint, you can now search all warehouses with the option to filter by warehouse ID, name, type or address ID.

July 2019 | Product PUT - new

This new endpoint allows you to update existing products. When using this API call please be aware of concurrency protection; a version number is now provided in the Product GET response and it is recommended to pass this value in the "If-Match" header field when calling the Product PUT. This ensures the state of the product is the same as when you loaded the information, i.e. no concurrent change has taken place.

June 2019 | Product POST - include reporting categories and reporting season

It is now possible to include reporting category, reporting subcategory and reporting season when creating a new product via the API.

May 2019 | Product POST - include product nominal codes

When creating a new product using Product POST, it is now possible to specify the product's sales, purchases and stock nominal code. These codes are used for posting accounting when the product is purchased and sold. If these codes are not provided, the default codes specified in the account's settings will be used.

May 2019 | Product POST - create product bundles

New products can now be created as bundles using Product POST.  Within the request body, simply state that the product is a bundle and specify the product IDs and quantities of the components that make up the bundle.

May 2019 | Resource event for goods out note modified

Previously, Brightpearl webhooks activated on the creation or destruction of a goods out note, or when any of the print/pick/pack/ship events occur. We've added a resource event that triggers on changes to a goods out note's shipping method, priority, number of boxes, tracking reference or weight, which is handy for integrations with shipping aggregators or third-party logistics companies.

March 2019 | Pick POST - use for transfers

We've updated our Pick POST to now work with goods-out notes associated with transfers as well as those for orders. This means that should you want to use our WMS or the API to mark transfers as picked from an alternative location, you can do so. 

March 2019 | External Transfer POST - location now optional

We've updated the API for creating external transfers (warehouse to warehouse) to now treat locations as an optional part of the request. If you don't send through specific locations then FIFO will be used to select the inventory items for the transfer.

January 2019 | Goods-out note SEARCH - transfers now included

This enables you to search for goods-out notes which relate to a transfer rather than a sale.

December 2018 | Order row DELETE - new

With this new API call you will be able to delete order rows. This means order amendments can be made. It has a few controls to ensure orders are managed effectively:

Sales and purchases

  • Invoiced items can't be deleted
  • When deleting a bundle parent it will also remove all components of the bundle
  • It is not possible to delete only the component of a bundle

Sales orders/credits

  • If a row with allocated stock is removed the items will be released back into on hand stock
  • A row with any items fulfilled to goods-out notes cannot be deleted
  • A row with any items fulfilled to drop-ship purchase orders cannot be deleted

Purchase orders/credits

  • No rows can be deleted on drop-ship purchase orders
  • A row with any items received into stock cannot be deleted

December 2018 | Contact Search - search by telephone number

The contact SEARCH will now accept telephone number as a search term further expanding the options you can build into your apps.

Have more questions? Submit a request