Search orders
brightpearl_search_ordersSearch sales orders, sales credits, purchase orders and purchase credits. Every filter is optional and they combine (AND); each result row has orderId, orderTypeId, contactId, orderStatusId, orderStockStatusId, createdOn, updatedOn, customerRef, externalRef, warehouseId and more. Use brightpearl_get_orders for the full order. Order type ids: brightpearl_list_order_types; status ids: brightpearl_list_order_statuses. GET /order-service/order-search.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| is_closed | No | Whether the order is invoiced (closed). | |
| order_ids | No | Only these orders (one or more ids). | |
| page_size | No | Rows per page, 1-500 (default 25). | |
| placed_to | No | Placed: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone. | |
| contact_id | No | Only orders of this customer/supplier contact id. | |
| created_to | No | Created: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone. | |
| updated_to | No | Last updated: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone. | |
| placed_from | No | Placed: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone. | |
| created_from | No | Created: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone. | |
| customer_ref | No | Customer reference of the order. | |
| external_ref | No | External reference of the order (for example the web shop's order number). | |
| first_result | No | Position of the first row to return, from 1 (default 1). Pass the previous reply's next_first_result for the next page. | |
| newest_first | No | Newest (highest id) first. Default: oldest first. | |
| updated_from | No | Last updated: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone. | |
| warehouse_id | No | Only orders for these warehouses (one or more ids). | |
| order_type_id | No | Order type id (1 sales order, 2 purchase order, 3 sales credit, 4 purchase credit; see brightpearl_list_order_types). | |
| order_status_id | No | Order status id (brightpearl_list_order_statuses). | |
| payment_status_id | No | Order payment status id. | |
| id_or_external_ref | No | Matches an order id OR an external reference (case-insensitive match). | |
| shipping_status_id | No | Order shipping status id. |