search_item
POST /search_item
To get the TOTAL COUNT of list of items 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 items 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 items found based on user search criteria. 'N' = brings the list of the items 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 'ItemCode','ItemBarcode','VariantCode','ImportedCode' 'ItemName', 'WebSite', 'Specifications', 'Other', 'ExtraTextFields'. |
| active_type |
string |
'active' = Only the active items. 'inactive' = Only the inactive items. 'all' = All the items(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. |