list_stock_items_store

Overview

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

GET /list_stock_items_store

/list_stock_items_store?token=XXXXX&store_code_365=100&available_stock_type=all&active_type=all&ecommerce_type=all

field	description
token	Credentials provided by Powersoft
store_code_365	365 Store Code. In order to get the stock position at all stores level pass the value 'all_365_stores'
available_stock_type	'withStock' = to get all items stock position with available stock > 0 for selected store.'withoutStock' = to get all items stock position with available stock <=0 for selected store.'all'=to get all items stock position for selected store.
active_type	'active' = to get all items stock position for selected store only for the active items. 'inactive' = to get all items stock position for selected store only for the inactive items. 'all' = to get all items stock position for selected store (active and inactive)
ecommerce_type	'eCommerceOnly' = to get all items stock position for selected store only for the items flagged as eCommerce. 'NoteCommerce' = to get all items stock position for selected store only for the items not flagged as eCommerce. 'all' = to get all items stock position for selected store flagged or not as eCommerce

Returns

       {
            "api_response": {
                "response_code": "1",
                "response_msg": "OK",
                "response_id": ""
            },
            "total_count_list_items": 2
        }
       

GET /list_stock_items_store

To get a list of all items stock position for search criteria.

/list_stock_items_store?token=XXXXX&store_code_365=100&available_stock_type=all&active_type=all&ecommerce_type=all&page_number=1&page_size=10

field	description
token	Credentials provided by Powersoft
store_code_365	365 Store Code. In order to get the stock position at all stores level pass the value 'all_365_stores'
available_stock_type	'withStock' = to get all items stock position with available stock > 0 for selected store.'withoutStock' = to get all items stock position with available stock <=0 for selected store.'all'=to get all items stock position for selected store.
active_type	'active' = to get all items stock position for selected store only for the active items. 'inactive' = to get all items stock position for selected store only for the inactive items. 'all' = to get all items stock position for selected store (active and inactive)
ecommerce_type	'eCommerceOnly' = to get all items stock position for selected store only for the items flagged as eCommerce. 'NoteCommerce' = to get all items stock position for selected store only for the items not flagged as eCommerce. 'all' = to get all items stock position for selected store flagged or not as eCommerce
page_number	The page number in the entire list. eg Page 1
page_size	The number of rows to return. eg 10 rows

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": "0VAT",
                    "model_code_365": "",
                    "item_name": "ITEM 0 VAT",
                    "stock": 0,
                    "stock_on_transfer": 0,
                    "stock_reserved": 0,
                    "stock_ordered": 0,
                    "mininum_stock": 0,
                    "required_stock": 0
                },
                {
                    "store_code_365": "100",
                    "store_name": "POWERSOFT365",
                    "store_active": true,
                    "item_code_365": "1",
                    "model_code_365": "",
                    "item_name": "ITEM1",
                    "stock": 8,
                    "stock_on_transfer": 6,
                    "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.

---