search_customer
Changelog
September 3, 2025
- In the post method for filtering added a new options display_fields and display_b2b_fields.
|
POST /search_customer
To get the TOTAL COUNT of list of customers for the search criteria.
Use this method with only_counted = 'Y' FIRST to determine how many total records there are for the given criteria.
After you call this method with only_counted = 'Y', then call again this method with only_counted = 'N', and pass the required paging parameters.
To get a list of customers for the search criteria.
| field |
type |
description |
|
api_credentials
|
| token |
string |
Credentials provided by Powersoft that allow access to the API |
|
search_option
|
| only_counted |
string |
'Y' = brings only the total of customers found based on user search criteria. 'N' = brings the list of the customers found based on user search criteria |
| page_number |
integer |
The page number in the entire list. eg Page 1. |
| page_size |
integer |
The number of rows to return. eg 10 rows |
| expression_searched |
string |
Expression searched. Required. Minimum 4 characters needs to be provided. |
| search_operator_type |
string |
Search operator type. Required. Allowed values are 'StartsWith', 'Contains', 'Equals', 'EndsWith'. |
| search_in_fields |
string |
A comma separated list of fields to be searched for the expression. Required. For each element in the list allowed values are 'CustomerCode', 'CustomerName', 'ContactName', 'ShortName', 'StoreCode', 'Phones', 'Email', 'WebSite', 'CustomerID', 'CustomerVatRegistrationNo', 'CustomerAddress', 'Remarks', 'ExtraTextFields'. |
| active_type |
string |
'active' = Only the active customers. 'inactive' = Only the inactive customers. 'all' = All the customers(active and inactive) |
| display_fields |
string |
Comma separated list of the fields to be displayed in the response. If the value is empty or not passed all the fields will be included in the response. |
| display_b2b_fields |
boolean |
Indicates if the customer b2b fields are displayed. When set to true, the b2b_fields object is always shown for customers flagged as B2B, regardless of the display_fields selection. When set to false, the b2b_fields object is shown only if b2b_fields is explicitly included in display_fields. |
Returns
TOTAL COUNT of list of customers for multiple search criteria (only_counted='Y').
List of customers for multiple search criteria (only_counted='N').
List of customers for multiple search criteria (only_counted='N') with b2b fields.