Powersoft 365 API Documentation

list_items


Changelog

April 22, 2026
  • All methods includes in the response the property sort_positions which is a list indicating the sort position of an item within attributes such as category, department, and additional attributes. If the value is null, it should be treated as 9999 for all attributes.
April 06, 2026
  • All methods added in the response the property list_vat_groups
December 02, 2025
  • All methods added in the response the property last_purchase_qty
October 01, 2025
  • POST method new parameter option display_fields
December 16, 2024
  • In the response of the items list added new properties last_modified_date and creation_date.
  • Option to filter the list based on the creation date time. New properties for filter object: creation_date_from and creation_date_to.

GET /list_items

To get the TOTAL COUNT of list of items for search criteria.

Use this method FIRST to determine how many total records there are for the given criteria.

After you call this method, then call the method below, and pass the required paging parameters.

/list_items?token=XXXX&active_type=active

field description
token Credentials provided by Powersoft that allow access to the API
active_type 'active' = Only the active items. 'inactive' = Only the inactive items. 'all' = All the items(active and inactive)

Returns


GET /list_items

To get a list of items.

/list_items?token=XXXXX&active_type=active&page_number=1&page_size=100

field description
token Credentials provided by Powersoft that allow access to the API
active_type 'active' = Only the active items. 'inactive' = Only the inactive items. 'all' = All the items(active and inactive)
page_number The page number in the entire list. eg Page 1
page_size The number of rows to return. Maximum allowed is 100 rows.

Returns


GET /list_items

To get a list of items with stock per stores included.

/list_items?token=XXXX&active_type=active&include_stock_per_stores=yes&page_number=1&page_size=100

field description
token Credentials provided by Powersoft that allow access to the API
active_type 'active' = Only the active items. 'inactive' = Only the inactive items. 'all' = All the items(active and inactive)
include_stock_per_stores 'yes' = Includes the stock per stores for each item. 'no' = Does not include the stock per stores for each item.
page_number The page number in the entire list. eg Page 1
page_size The number of rows to return. Maximum allowed is 100 rows.

Returns


POST /list_items

To get the TOTAL COUNT of list of items 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.

To get a list of items 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 items found based on user filter criteria. 'N' = brings the list of the items 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 10 rows
active_type string 'active' = Only the active items. 'inactive' = Only the inactive items. 'all' = All the items(active and inactive)
ecommerce_type string 'eCommerceOnly' = Only items flagged as eCommerce. 'NoteCommerce' = Only the items which are not flagged as eCommerce. 'all' = All the items(flagged or not as eCommerce)
categories_selection string A comma separated list of 365 items categories codes (eg 'DRINK,FOOD,CLOTHES,...'). If the value is empty then no search criteria by item category is applied.
departments_selection string A comma separated list of 365 items departments codes (eg 'MEN,WOMEN,CHILDREN,...'). If the value is empty then no search criteria by item department is applied.
items_supplier_selection string A comma separated list of 365 items suppliers codes (eg '10000001,10000004,10000009,...'). If the value is empty then no search criteria by item supplier is applied.
brands_selection string A comma separated list of 365 brands codes (eg 'GUCCI,LEVINTZA,...'). If the value is empty then no search criteria by brands is applied.
seasons_selection string A comma separated list of 365 seasons codes (eg '2015S,2016W,...'). If the value is empty then no search criteria by season is applied.
models_selection string A comma separated list of 365 models codes (eg 'ARTICLE01,DRESS,...'). If the value is empty then no search criteria by model is applied.
items_selection string A comma separated list of 365 items codes (eg 'MILKSHST,MILKSHSTTA,MILKVAN,MILKVANTA,MILKCHOCA,MILKCHOTA,...'). If the value is empty then no search criteria by item is applied.
colours_selection string A comma separated list of 365 colours codes (eg 'RED,BLACK,...'). If the value is empty then no search criteria by colour is applied.
sizes_selection string A comma separated list of 365 sizes codes (eg 'XL,XXL,L,...'). If the value is empty then no search criteria by size is applied.
sizes_group_selection string A comma separated list of 365 sizes groups codes (eg 'SML,10-20,...'). If the value is empty then no search criteria by size group is applied.
attributes_1_selection string A comma separated list of 365 attributes 1 codes (eg 'A,B,C,...'). If the value is empty then no search criteria by attribute 1 is applied.
attributes_2_selection string A comma separated list of 365 attributes 2 codes (eg 'A,B,C,...'). If the value is empty then no search criteria by attribute 2 is applied.
attributes_3_selection string A comma separated list of 365 attributes 3 codes (eg 'A,B,C,...'). If the value is empty then no search criteria by attribute 3 is applied.
attributes_4_selection string A comma separated list of 365 attributes 4 codes (eg 'A,B,C,...'). If the value is empty then no search criteria by attribute 4 is applied.
attributes_5_selection string A comma separated list of 365 attributes 5 codes (eg 'A,B,C,...'). If the value is empty then no search criteria by attribute 5 is applied.
attributes_6_selection string A comma separated list of 365 attributes 6 codes (eg 'A,B,C,...'). If the value is empty then no search criteria by attribute 6 is applied.
text_field_value_1_selection string A comma separated list of values to be searched in extra field text value 1 (eg 'filter,panel,...'). If the value is empty then no search criteria by text field 1 is applied.
text_field_value_2_selection string A comma separated list of values to be searched in extra field text value 2 (eg 'filter,panel,...'). If the value is empty then no search criteria by text field 2 is applied.
text_field_value_3_selection string A comma separated list of values to be searched in extra field text value 3 (eg 'filter,panel,...'). If the value is empty then no search criteria by text field 3 is applied.
text_field_value_4_selection string A comma separated list of values to be searched in extra field text value 4 (eg 'filter,panel,...'). If the value is empty then no search criteria by text field 4 is applied.
text_field_value_5_selection string A comma separated list of values to be searched in extra field text value 5 (eg 'filter,panel,...'). If the value is empty then no search criteria by text field 5 is applied.
number_field_value_1_selection string A comma separated list of values to be searched in extra field number value 1 (eg '102,125.35,...'). If the value is empty then no search criteria by number field 1 is applied.
number_field_value_2_selection string A comma separated list of values to be searched in extra field number value 2 (eg '102,125.35,...'). If the value is empty then no search criteria by number field 2 is applied.
number_field_value_3_selection string A comma separated list of values to be searched in extra field number value 3 (eg '102,125.35,...'). If the value is empty then no search criteria by number field 3 is applied.
number_field_value_4_selection string A comma separated list of values to be searched in extra field number value 4 (eg '102,125.35,...'). If the value is empty then no search criteria by number field 4 is applied.
number_field_value_5_selection string A comma separated list of values to be searched in extra field number value 5 (eg '102,125.35,...'). If the value is empty then no search criteria by number field 5 is applied.
date_field_value_1_selection string A comma separated list of values to be searched in extra field date value 1 (eg '2020-01-15,2021-10-25,...'). If the value is empty then no search criteria by date field 1 is applied.
date_field_value_2_selection string A comma separated list of values to be searched in extra field date value 2 (eg '2020-01-15,2021-10-25,...'). If the value is empty then no search criteria by date field 2 is applied.
date_field_value_3_selection string A comma separated list of values to be searched in extra field date value 3 (eg '2020-01-15,2021-10-25,...'). If the value is empty then no search criteria by date field 3 is applied.
date_field_value_4_selection string A comma separated list of values to be searched in extra field date value 4 (eg '2020-01-15,2021-10-25,...'). If the value is empty then no search criteria by date field 4 is applied.
date_field_value_5_selection string A comma separated list of values to be searched in extra field date value 5 (eg '2020-01-15,2021-10-25,...'). If the value is empty then no search criteria by date field 5 is applied.
boolean_field_value_1 string Allowed values 0, 1 or empty. If the value is empty then no search criteria by boolean_field_value_1 is applied.
boolean_field_value_2 string Allowed values 0, 1 or empty. If the value is empty then no search criteria by boolean_field_value_2 is applied.
boolean_field_value_3 string Allowed values 0, 1 or empty. If the value is empty then no search criteria by boolean_field_value_3 is applied.
boolean_field_value_4 string Allowed values 0, 1 or empty. If the value is empty then no search criteria by boolean_field_value_4 is applied.
boolean_field_value_5 string Allowed values 0, 1 or empty. If the value is empty then no search criteria by boolean_field_value_5 is applied.
keyword_search_item_code_365 string The keyword search in 365 item code. The system looks for all items codes that contain the word provided
keyword_search_item_name string The keyword search in item first description, name. The system looks for all items first descriptions that contain the word provided
request_password_365 string Request password as registered in 365 BASE64 encoded - optionally. The password is necessary if the user needs to have the item cost. Password is provided by Powersoft.
date_field_1_value_from string Date field 1 from. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 1. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value.
date_field_1_value_to string Date field 1 to. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 1. If the from date is empty and to date has a value the system applies the criteria less or equal than to value.
date_field_2_value_from string Date field 2 from. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 2. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value.
date_field_2_value_to string Date field 2 to. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 2. If the from date is empty and to date has a value the system applies the criteria less or equal than to value.
date_field_3_value_from string Date field 3 from. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 3. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value.
date_field_3_value_to string Date field 3 to. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 3. If the from date is empty and to date has a value the system applies the criteria less or equal than to value.
date_field_4_value_from string Date field 4 from. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 4. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value.
date_field_4_value_to string Date field 4 to. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 4. If the from date is empty and to date has a value the system applies the criteria less or equal than to value.
date_field_5_value_from string Date field 5 from. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 5. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value.
date_field_5_value_to string Date field 5 to. The date must be provided in format yyyy-mm-dd. Pass "" if you don't want selection by date field 5. If the from date is empty and to date has a value the system applies the criteria less or equal than to value.
last_modified_from string Last modified date from (UTC). The date must be provided in format yyyy-mm-dd HH:mm:ss. Pass "" if you don't want selection by last modified date. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value.
last_modified_to string Last modified date to (UTC). The date must be provided in format yyyy-mm-dd HH:mm:ss. Pass "" if you don't want selection by last modified date. If the from date is empty and to date has a value the system applies the criteria less or equal than to value.
creation_date_from string Creation date from (UTC). The date must be provided in format yyyy-mm-dd HH:mm:ss. Pass "" if you don't want selection by creation date. If the from date has a value and to date is empty the system applies the criteria greater or equal than from value.
creattion_date_to string Creation date to (UTC). The date must be provided in format yyyy-mm-dd HH:mm:ss. Pass "" if you don't want selection by creation date. If the from date is empty and to date has a value the system applies the criteria less or equal than to value.
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.

Returns

TOTAL COUNT of list of items for multiple search criteria (only_counted='Y').

List of items for multiple search criteria (only_counted='N').

Note

The method with including stock per store should be used against all items only to get the stock for the first time. To synchronize the items stock please have a looks at the section Synchronization Overview. The continously usage of the method to get all items stock especially for a large data will end it up with the disconnection of the token provided.