Brightpearl icon

Brightpearl

Work with orders, products, and price lists in Brightpearl

Actions35

Order → Get Many

AI-generated

Summary

Fetches sales orders from Brightpearl using optional search filters, selected result columns, and sorting. Set Return All to fetch every matching result, or use Limit and First Result to retrieve a page; optional batching settings pace requests when fetching all results.

Inputs

  • authentication (required) — Choose OAuth2 or Private App credentials.
  • returnAll — Fetch all matching results when enabled; otherwise, fetch up to the configured Limit starting at First Result.
  • columns — Select sales-order-search columns to return. Leave empty to use Brightpearl defaults.
  • filters — Filter by channel, creator, creation or update dates, customer ID or reference, delivery or tax dates, external reference, payment/shipping/stock status, order status, sales order ID, staff owner, or warehouse. Sales Order ID accepts a single ID, range, or comma-separated IDs; Warehouse ID accepts a single ID, range, or comma-separated ID set.
  • sort — Optionally choose a sales-order-search column and ascending or descending direction. The property description states Brightpearl's default order is salesOrderId ascending; the configured sort direction defaults to DESC and sort column to createdOn.
  • limit — Maximum number of results when Return All is disabled; minimum 1.
  • firstResult — 1-indexed starting position when Return All is disabled; combine with Limit for pagination.
  • batching — When Return All is enabled, optionally set page size (1–200; default 200) and delay between page requests in milliseconds (default 0).

Output shape

A list of sales-order search result items.

With Return All disabled, Limit and First Result select a page. The First Result description says returned items include _pagination metadata indicating the total result count.

Examples

Example 1: Retrieve orders changed since a timestamp

Set Updated On (From) and optionally select columns or sort order; use Return All or page through results with First Result and Limit.

Example 2: Fetch a large matching result set

Enable Return All, optionally lower Page Size or add a Delay Between Pages to pace API requests.

Links

Discussion