Brightpearl Product Search

This action searches for products in Brightpearl based on a search query. This action requires a module connection to be set up.

Uses the following Brightpearl API Endpoint: https://api-docs.brightpearl.com/product/product/search.html

Search Query Instructions: https://help.brightpearl.com/s/article/212644983

Inputs

In order to use the action in your flow you need to provide it the following inputs:

InputTypeDescription
Search QueryStringThe search query parameters. Example: "productName=Lamp" - use this article for further guidance https://help.brightpearl.com/s/article/212644983
Page Size LimitStringThe maximum number of results to return. You should ideally set to a single digit number if possible to avoid max character limit errors.

Outputs

OutputTypeDecription
SuccessBooleanWhether the API call was successful.
Raw DataObjectRaw Data returned by Brightpearl
Formatted Products DataListFormatted Products Data
Products Found?BooleanWhether or not products were found based on the search query
Total Products FoundNumberTotal products found
Total Products ReturnedNumberTotal products returned by the API call (this should equal the Page Size Limit)