GET api/StockAvailability

Retrieve the availability of items for specific store

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Company	The company name	string	Required
ItemCode	The item code. Optional: return all items if not given	string	None.
Store	The store where the item is stored. Optional: return item from all stores if not given	string	None.
ExcludeZeroQuantities	Exclude zero quantities	boolean	None.
PageSize	Optional paging parameter. Return x records per page	integer	None.
PageNumber	Optional paging parameter. Number of page to return	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Company": "DEMO",
  "ItemCode": "1250024303093",
  "Store": "",
  "ExcludeZeroQuantities": false,
  "PageSize": 2,
  "PageNumber": 1
}

Response Information

Resource Description

ItemAvailStockRes

Name	Description	Type	Additional information
msgControl	Contains information about the response	MsgControl	None.
ItemAvailStockList	List of the availability of requested items	Collection of ItemAvailStock	None.

Response Formats

application/json, text/json

Sample:

{
  "msgControl": {
    "result": 0,
    "Message": "Corresponding success and error message",
    "MethodName": "api/StockAvailability GET",
    "AppName": "EsoftWebApi",
    "EsoftUser": "ESOFT",
    "User": "Username",
    "Password": "Password",
    "SystemDate": "2025-01-06T22:32:15.2189577+02:00",
    "GenList": [],
    "GenMsg1": "",
    "GenMsg2": "",
    "GenMsg3": ""
  },
  "ItemAvailStockList": [
    {
      "ItemCode": "1250024303093",
      "Store": "001",
      "AvailQty": 10
    },
    {
      "ItemCode": "1250024303093",
      "Store": "002",
      "AvailQty": 50
    }
  ]
}