Brightpearl icon

Brightpearl

Work with orders, products, and price lists in Brightpearl

Actions35

Order → Search Orders (Order Endpoint)

AI-generated

Summary

Searches Brightpearl orders using optional filters, selected return columns, and sorting. Returns either all matching results or a page starting at the configured first result, with optional pacing between page requests when fetching all results.

Inputs

  • Authentication (required) — Choose OAuth2 or Private App credentials.
  • Return All — When enabled, fetches all matching orders; otherwise uses Limit and First Result for a page.
  • Columns to Return — Select order-search columns to return. Leaving this empty uses Brightpearl's defaults.
  • Filters — Filter by contact, creator, created/delivery/tax/updated date ranges, customer or external reference, department, order ID, payment/shipping/order/stock status, order type, parent order, staff owner, or warehouse. Order ID accepts a single ID, range, or comma-separated IDs; order type, parent order, and warehouse support ID-set syntax.
  • Sort — Optionally choose an order-search column and ascending or descending direction. The declared default is createdOn descending; the description notes Brightpearl's default order is orderId ascending.
  • Limit — Maximum number of results when Return All is disabled; defaults to 50.
  • First Result — 1-indexed starting position when Return All is disabled; defaults to 1. Use with Limit to page through results.
  • Batching — When Return All is enabled, optionally set page size (default 200, maximum 200) and delay between page requests in milliseconds (default 0).

Output shape

A list of matching order records.

When fetching a limited page, returned items include _pagination metadata indicating the total result count. The precise order record fields depend on the selected columns and Brightpearl defaults.

Examples

Example 1: Retrieve a page of orders created in a date range, sorted by creation time

Set Return All to false, choose a Limit and First Result, set Created On (From) and Created On (To), and sort by Created On in ascending order.

Example 2: Fetch all orders for a customer with pacing

Set Return All to true, filter by Contact ID, optionally select Columns to Return, and configure Batching with a page size and delay between pages.

Links

Discussion