list_customer_item_range
POST /list_customer_item_range
Get top N items per customer based on sales history.
Returns one row per customer with a comma-separated list of their most frequently and recently purchased item codes, ranked by last sale date (most recent first), limited to the top N items per customer. Supports date range filtering and pagination.
To get the TOTAL COUNT of list of N items per customer based on sales history for multiple 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.
Returns
TOTAL COUNT of records for multiple search criteria (only_counted='Y').
To get a detailed list of customer item range for multiple search criteria.
Returns
Detailed list of customer item range for 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 of records found based on user filter criteria. 'N' = brings the list of the records found 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. 100 rows. Maximum allowed per page is 500 records. |
| from_date |
string |
From date. The date must be provided in format yyyy-mm-dd. Required. |
| to_date |
string |
To date. The date must be provided in format yyyy-mm-dd. Required. |
| top_items_count |
integer |
Top n items to be counted. Default value is 100. |
| items_code_365_selection |
string |
Comma separated list of 365 items codes ('COKE,SALAD, ...'). Optional. |
| customers_code_365_selection |
string |
Comma separated list of 365 customer codes ('10000004,10000377, ...'). Optional. |