list_sync_items_stock_summary
POST /list_sync_items_stock_summary
To obtain the total count of item stocks with quantities summarized based on multiple search criteria.
Use this method with only_counted = 'Y' to determine the total number of records matching the criteria.
Once the total count is retrieved, call this method again with only_counted = 'N', providing the necessary paging parameters to fetch the actual data.
To retrieve a list of item stocks with quantities summarized based on multiple search criteria.
| field |
type |
description |
| api_credentials
|
| token |
string |
Credentials provided by Powersoft that allow access to the API |
| filter_define
|
| only_counted |
string |
'Y' = brings only the total number of of items stock based on user filter criteria. 'N' = brings the list of the of items stock based on user filter 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 |
| stores_selection |
string |
A comma separated list of 365 stores codes INCLUDED in the summarized quantities (eg '001,002...'). Can be used when you want to show the stock only for some specific stores. If the value is empty then no search criteria by included stores is applied. |
| exclude_stores_selection |
string |
A comma separated list of 365 stores codes EXCLUDED in the summarized quantities (eg '001,002...'). Can be used when you want to show the stock for all stores except some specific stores. If the value is empty then no search criteria by excluded stores is applied. |
| date_time_order |
string |
The order of the rows in the list by change stock date time. Allowed only values 'ascending' and 'descending' |
Returns
TOTAL COUNT of list items stock with quantities summarized for multiple search criteria (only_counted='Y').
List of items stock with quantities summarized for multiple search criteria (only_counted='N').