Search products
brightpearl_search_productsSearch the product catalogue. Every filter is optional and they combine (AND); each result row has productId, productName, SKU, barcode, EAN, UPC, ISBN, MPN, stockTracked, createdOn, updatedOn, brightpearlCategoryCode, productGroupId, brandId, productTypeId, productStatus, primarySupplierId. Use brightpearl_get_products for full details. GET /product-service/product-search.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ean | No | EAN. | |
| mpn | No | MPN. | |
| sku | No | Exact SKU. | |
| upc | No | UPC. | |
| isbn | No | ISBN. | |
| name | No | Product name (case-insensitive match). | |
| barcode | No | Barcode. | |
| brand_id | No | Only these brands (one or more ids). | |
| page_size | No | Rows per page, 1-500 (default 25). | |
| 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. | |
| category_id | No | Only these Brightpearl categories (one or more ids). | |
| product_ids | No | Only these products (one or more ids). | |
| created_from | No | Created: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone. | |
| 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. | |
| stock_tracked | No | Only stock-tracked (true) or non-stock (false) products. | |
| product_status | No | Lifecycle status code, for example LIVE. | |
| product_type_id | No | Only these product types (one or more ids). | |
| product_group_id | No | Only products of this product group (variations); 0 = products that are not in a group. | |
| primary_supplier_id | No | Only products with these primary suppliers (one or more ids). |