GET api/ItemAvailability

Retrieve the item availability. Provide either the wanted item's code or a last sync date to retrieve any item whose availability was modified since the given date

Request Information

URI Parameters

None.

Body Parameters

ItemAvailReq
NameDescriptionTypeAdditional information
ItemCode

The item code. Optional: return all items if not given

string

None.

LastSyncDate

Retrieve items that were modified since LastSyncDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "ItemCode": "1250024303093",
  "LastSyncDate": "2020-01-01T13:30:05"
}

Response Information

Resource Description

ItemAvailRes
NameDescriptionTypeAdditional information
msgControl

Contains information about the response

MsgControl

None.

AvailabilityList

List of the availability of requested items

Collection of ItemAvail

None.

Response Formats

application/json, text/json

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