list_stock_stores_item
Overview
This method returns a list of the stock position of an item in all the stores.
GET /list_stock_stores_item
/list_stock_stores_item?token=XXXXX&item_code_365=A-B-C-AZURE-340
| field |
description |
| token |
Credentials provided by Powersoft |
| item_code_365 |
The item code of the item |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"list_stock_stores_item": [
{
"store_code_365": "100",
"store_name": "POWERSOFT365",
"store_active": true,
"item_code_365": "A-B-C-AZURE-340",
"model_code_365": "A-B-C",
"item_name": "aaa",
"stock": 20,
"stock_on_transfer": 0,
"stock_reserved": 0,
"stock_ordered": 0,
"mininum_stock": 0,
"required_stock": 0
}
]
}
GET /list_stock_stores_item
This method returns the stock position of an item for a selected store.
/list_stock_stores_item?token=XXXXX&item_code_365=AAA&store_code_365=100
| field |
description |
| token |
Credentials provided by Powersoft |
| item_code_365 |
The item code or barcode of the item |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"list_stock_stores_item": [
{
"store_code_365": "100",
"store_name": "POWERSOFT365",
"store_active": true,
"item_code_365": "AAA",
"model_code_365": "",
"item_name": "aaa",
"stock": 20,
"stock_on_transfer": 0,
"stock_reserved": 0,
"stock_ordered": 0,
"mininum_stock": 0,
"required_stock": 0
}
]
}
POST /list_stock_stores_item
To get the TOTAL COUNT of list of stock per items and stores 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": "XXXXX"
},
"filter_define": {
"only_counted": "Y",
"page_number":0,
"page_size":0,
"active_type":"all",
"ecommerce_type":"all",
"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":"",
"stores_selection":""
}
}
To get a list of stock per items and stores for multiple search criteria.
{
"api_credentials": {
"token": "XXXXX"
},
"filter_define": {
"only_counted": "N",
"page_number":1,
"page_size":10,
"active_type":"all",
"ecommerce_type":"all",
"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":"",
"stores_selection":""
}
}
| 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 rows found based on user filter criteria. 'N' = brings the list of the stock per items and stores 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 'COKE,DRESS-BLUE-XL,...'). 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. |
| stores_selection |
string |
A comma separated list of 365 stores codes (eg '001,100,401'). If the value is empty then no search criteria by stores is applied. |
Returns
TOTAL COUNT of list of stock per items and stores for multiple search criteria (only_counted='Y').
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_items": 2,
"list_stock_stores_item": null,
}
List of items for multiple search criteria (only_counted='N').
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_items": 2,
"list_stock_stores_item": [
{
"store_code_365": "100",
"store_name": "POWERSOFT365",
"store_active": true,
"item_code_365": "AAA",
"model_code_365": "",
"item_name": "aaa",
"stock": 20,
"stock_on_transfer": 0,
"stock_reserved": 0,
"stock_ordered": 0,
"mininum_stock": 0,
"required_stock": 0
}
{
"store_code_365": "001",
"store_name": "STORE LIMASSOL",
"store_active": true,
"item_code_365": "AAA",
"model_code_365": "",
"item_name": "aaa",
"stock": 10,
"stock_on_transfer": 0,
"stock_reserved": 0,
"stock_ordered": 0,
"mininum_stock": 0,
"required_stock": 0
}
]
}
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.