list_shelves
GET /list_shelves
To get a list of shelves.
/list_shelves?token=XXXXX
| field |
description |
| token |
Credentials provided by Powersoft that allow access to the API |
Returns
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"list_shelves": [
{
"shelf_code_365": "S001",
"shelf_name": "SHELF 1"
},
{
"shelf_code_365": "S002",
"shelf_name": "SHELF 2"
},
{
"shelf_code_365": "S003",
"shelf_name": "SHELF 3"
},
{
"shelf_code_365": "S004",
"shelf_name": "SHELF 4"
},
{
"shelf_code_365": "S005",
"shelf_name": "SHELF 5"
},
{
"shelf_code_365": "S006",
"shelf_name": "SHELF 6"
}
]
}
POST /list_shelves
To get the TOTAL COUNT of list of shelves 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",
"shelf_code_365_selection": "",
"store_code_365_selection": "",
"item_code_365_selection": "",
"only_on_stock": false
}
}
To get a list of shelves for multiple search criteria.
{
"api_credentials": {
"token": "XXX"
},
"filter_define": {
"page_number": 1,
"page_size": 100,
"only_counted": "N",
"shelf_code_365_selection": "",
"store_code_365_selection": "",
"item_code_365_selection": "",
"only_on_stock": 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 of shelves found based on user filter criteria. 'N' = brings the list of the shelves 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 |
| shelf_code_365_selection |
string |
A comma separated list of 365 shelves codes (eg 'S001,S002,...'). If the value is empty then no search criteria by 365 shelf code is applied. |
| store_code_365_selection |
string |
A comma separated list of 365 stores codes (eg '001,002,...'). If the value is empty then no search criteria by 365 store code is applied. |
| item_code_365_selection |
string |
A comma separated list of 365 items codes (eg 'IT001,IT002,...'). If the value is empty then no search criteria by 365 item code is applied. |
| only_on_stock |
bool |
if value is true brings only the items per store on stock |
Returns
TOTAL COUNT of list of shelves for multiple search criteria (only_counted='Y').
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_shelves": 6,
"list_shelves": null
}
List of shelves for multiple search criteria (only_counted='N').
{
"api_response": {
"response_code": "1",
"response_msg": "OK",
"response_id": ""
},
"total_count_list_shelves": 6,
"list_shelves": [
{
"shelf_code_365": "S001",
"shelf_name": "SHELF 1",
"list_items": [
{
"store_code_365": "100",
"store_name": "POWERSOFT365",
"item_code_365": "P01803",
"item_name": "* 11RD/0.11 NB93",
"stock": -14.0000,
"stock_on_transfer": 20.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000,
"mininum_stock": 3.0000,
"required_stock": 0.0000
},
{
"store_code_365": "100",
"store_name": "POWERSOFT365",
"item_code_365": "R04949A",
"item_name": "* 100RD/0.67 4RD/0.35 NB775",
"stock": 245.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 1.0000,
"stock_ordered": 0.0000,
"mininum_stock": 3.0000,
"required_stock": 1.0000
},
{
"store_code_365": "001",
"store_name": "STORE 001",
"item_code_365": "R04949A",
"item_name": "* 100RD/0.67 4RD/0.35 NB775",
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000,
"mininum_stock": 0.0000,
"required_stock": 1.0000
}
]
},
{
"shelf_code_365": "S002",
"shelf_name": "SHELF 2",
"list_items": [
{
"store_code_365": "002",
"store_name": "SHOP1",
"item_code_365": "P01803",
"item_name": "* 11RD/0.11 NB93",
"stock": -20.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000,
"mininum_stock": 2.0000,
"required_stock": 0.0000
},
{
"store_code_365": "002",
"store_name": "SHOP1",
"item_code_365": "R04949A",
"item_name": "* 100RD/0.67 4RD/0.35 NB775",
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000,
"mininum_stock": 2.0000,
"required_stock": 1.0000
},
{
"store_code_365": "003",
"store_name": "SHOP2",
"item_code_365": "P01803",
"item_name": "* 11RD/0.11 NB93",
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000,
"mininum_stock": 0.0000,
"required_stock": 0.0000
}
]
},
{
"shelf_code_365": "S003",
"shelf_name": "SHELF 3",
"list_items": [
{
"store_code_365": "003",
"store_name": "SHOP2",
"item_code_365": "R04949A",
"item_name": "* 100RD/0.67 4RD/0.35 NB775",
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000,
"mininum_stock": 0.0000,
"required_stock": 1.0000
}
]
},
{
"shelf_code_365": "S004",
"shelf_name": "SHELF 4",
"list_items": [
{
"store_code_365": "004",
"store_name": "SHOP3",
"item_code_365": "P01803",
"item_name": "* 11RD/0.11 NB93",
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000,
"mininum_stock": 0.0000,
"required_stock": 0.0000
},
{
"store_code_365": "004",
"store_name": "SHOP3",
"item_code_365": "R04949A",
"item_name": "* 100RD/0.67 4RD/0.35 NB775",
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000,
"mininum_stock": 2.0000,
"required_stock": 1.0000
}
]
},
{
"shelf_code_365": "S005",
"shelf_name": "SHELF 5",
"list_items": [
{
"store_code_365": "005",
"store_name": "SHOP4",
"item_code_365": "P01803",
"item_name": "* 11RD/0.11 NB93",
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000,
"mininum_stock": 0.0000,
"required_stock": 0.0000
},
{
"store_code_365": "005",
"store_name": "SHOP4",
"item_code_365": "R04949A",
"item_name": "* 100RD/0.67 4RD/0.35 NB775",
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000,
"mininum_stock": 2.0000,
"required_stock": 1.0000
},
{
"store_code_365": "007",
"store_name": "SHOP5",
"item_code_365": "R04949A",
"item_name": "* 100RD/0.67 4RD/0.35 NB775",
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000,
"mininum_stock": 2.0000,
"required_stock": 1.0000
}
]
},
{
"shelf_code_365": "S006",
"shelf_name": "SHELF 6",
"list_items": [
{
"store_code_365": "008",
"store_name": "SHOP6",
"item_code_365": "R04949A",
"item_name": "* 100RD/0.67 4RD/0.35 NB775",
"stock": 0.0000,
"stock_on_transfer": 0.0000,
"stock_reserved": 0.0000,
"stock_ordered": 0.0000,
"mininum_stock": 5.0000,
"required_stock": 1.0000
}
]
}
]
}