list_items_stock
POST /list_items_stock
To get the TOTAL COUNT of list of items stock 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.
{
"api_credentials": {
"token": "XXX"
},
"filter_define": {
"page_number": 1,
"page_size": 100,
"only_counted": "Y",
"stores_selection": "",
"exclude_stores_selection": "",
"item_active_type": "all",
"ecommerce_type": "eCommerceOnly",
"categories_selection": "",
"departments_selection": "",
"items_supplier_selection": "",
"brands_selection": "",
"seasons_selection": "",
"models_selection": "",
"items_selection": "",
"colours_selection": "",
"sizes_selection": "",
"sizes_group_selection": "",
"attributes_1_selection": "",
"attributes_2_selection": "",
"attributes_3_selection": "",
"attributes_4_selection": "",
"attributes_5_selection": "",
"attributes_6_selection": "",
"last_modified_from": "",
"last_modified_to": "",
"creation_date_from": "",
"creation_date_to": "",
"analytical_per_store": false,
"model_level": false
}
}
To get a list of items stock for multiple search criteria.
{
"api_credentials": {
"token": "XXX"
},
"filter_define": {
"page_number": 1,
"page_size": 100,
"only_counted": "N",
"stores_selection": "",
"exclude_stores_selection": "",
"item_active_type": "all",
"ecommerce_type": "eCommerceOnly",
"categories_selection": "",
"departments_selection": "",
"items_supplier_selection": "",
"brands_selection": "",
"seasons_selection": "",
"models_selection": "",
"items_selection": "",
"colours_selection": "",
"sizes_selection": "",
"sizes_group_selection": "",
"attributes_1_selection": "",
"attributes_2_selection": "",
"attributes_3_selection": "",
"attributes_4_selection": "",
"attributes_5_selection": "",
"attributes_6_selection": "",
"last_modified_from": "",
"last_modified_to": "",
"creation_date_from": "",
"creation_date_to": "",
"analytical_per_store": false,
"model_level": false
}
}
| 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. If analytical_per_store is false maximum value allowed is 100, otherwise 50. |
| stores_selection |
string |
A comma separated list of 365 stores codes INCLUDED in the stock 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 stock 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. |
| item_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. |
| last_modified_from |
string |
Last modified date time from. The date time must be provided in format yyyy-mm-dd HH:mm:ss. If the value is empty then no search criteria by last modified date is applied. |
| last_modified_to |
string |
Last modified date time to. The date time must be provided in format yyyy-mm-dd HH:mm:ss. If the value is empty then no search criteria by last modified date is applied. |
| creation_date_from |
string |
Creation date time from. The date time must be provided in format yyyy-mm-dd HH:mm:ss. If the value is empty then no search criteria by creation date is applied. |
| creation_date_to |
string |
Creation date time to. The date time must be provided in format yyyy-mm-dd HH:mm:ss. If the value is empty then no search criteria by creation date is applied. |
| analytical_per_store |
boolean |
If includes the breakdown per stores of the item stock |
| model_level |
boolean |
If the value is false the stock value is per item, otherwise per model |
Returns
TOTAL COUNT of list items stock for multiple search criteria (only_counted='Y').
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_items": 250,
"list_items_stock": null
}
List of items stock for multiple search criteria without breakdown of the stock per stores (only_counted='N', analytical_per_store=false).
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_items": 2,
"list_items_stock": [
{
"item_code_365": "001",
"item_name": "TOYRTA BROWNIE MEG1",
"color_code_365": "",
"color_name": "",
"color_html": "",
"size_code_365": "",
"size_name": "",
"size_name_invoice": "",
"total_stock": -41.0000,
"total_stock_reserved": 1.0000,
"total_stock_ordered": 0.0000,
"list_stock_store": null
},
{
"item_code_365": "1",
"item_name": "COKE ZERO",
"color_code_365": "",
"color_name": "",
"color_html": "",
"size_code_365": "",
"size_name": "",
"size_name_invoice": "",
"total_stock": 2144.0000,
"total_stock_reserved": 5.0000,
"total_stock_ordered": 0.0000,
"list_stock_store": null
}
]
}
List of items stock for multiple search criteria with breakdown of the stock per stores (only_counted='N', analytical_per_store=true).
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_items": 2,
"list_items_stock": [
{
"item_code_365": "001",
"item_name": "TOYRTA BROWNIE MEG1",
"color_code_365": "",
"color_name": "",
"color_html": "",
"size_code_365": "",
"size_name": "",
"size_name_invoice": "",
"total_stock": -41.0000,
"total_stock_reserved": 1.0000,
"total_stock_ordered": 0.0000,
"list_stock_store": [
{
"store_code_365": "001",
"store_name": "STORE01",
"store_active": true,
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000
},
{
"store_code_365": "002",
"store_name": "STORE02",
"store_active": true,
"stock": -41.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 1.0000,
"stock_ordered": 0.0000
},
{
"store_code_365": "003",
"store_name": "BAR002",
"store_active": true,
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000
},
{
"store_code_365": "004",
"store_name": "SHOP",
"store_active": true,
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000
},
{
"store_code_365": "005",
"store_name": "BAR001",
"store_active": true,
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000
},
{
"store_code_365": "100",
"store_name": "POWERSOFT365",
"store_active": true,
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000
},
{
"store_code_365": "999",
"store_name": "ESHOP",
"store_active": true,
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000
}
]
},
{
"item_code_365": "1",
"item_name": "COKE ZERO",
"color_code_365": "",
"color_name": "",
"color_html": "",
"size_code_365": "",
"size_name": "",
"size_name_invoice": "",
"total_stock": 2144.0000,
"total_stock_reserved": 5.0000,
"total_stock_ordered": 0.0000,
"list_stock_store": [
{
"store_code_365": "001",
"store_name": "STORE01",
"store_active": true,
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000
},
{
"store_code_365": "002",
"store_name": "STORE02",
"store_active": true,
"stock": 998.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 5.0000,
"stock_ordered": 0.0000
},
{
"store_code_365": "003",
"store_name": "BAR002",
"store_active": true,
"stock": 10.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000
},
{
"store_code_365": "004",
"store_name": "SHOP",
"store_active": true,
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000
},
{
"store_code_365": "005",
"store_name": "BAR001",
"store_active": true,
"stock": 10.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000
},
{
"store_code_365": "100",
"store_name": "POWERSOFT365",
"store_active": true,
"stock": 1126.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000
},
{
"store_code_365": "999",
"store_name": "ESHOP",
"store_active": true,
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000
}
]
}
]
}
Note
The method 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.