GET api/Items

Retrieve items from ESOFT that were modified after the given date

Request Information

URI Parameters

None.

Body Parameters

ItemsReq
NameDescriptionTypeAdditional information
Company

The company name

string

Required

LastSyncDate

Retrieve items that were modified since LastSyncDate

date

Required

Code

Optional filter: The item code

string

String length: inclusive between 0 and 30

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",
  "LastSyncDate": "2019-01-01T14:30:00",
  "Code": null,
  "PageSize": 2,
  "PageNumber": 1
}

Response Information

Resource Description

stkItemsDM
NameDescriptionTypeAdditional information
msgControl

Message control - Will contain information about the response. If paging is enabled Gen1 equals the total pages

MsgControl

None.

stkItemsList

List of items

Collection of stkItem

None.

Response Formats

application/json, text/json

Sample:
{
  "msgControl": {
    "result": 0,
    "Message": "Corresponding success and error message",
    "MethodName": "api/Items GET",
    "AppName": "EsoftWebApi",
    "EsoftUser": "ESOFT",
    "User": "Username",
    "Password": "Password",
    "SystemDate": "2025-01-06T22:32:15.2189577+02:00",
    "GenList": [],
    "GenMsg1": "",
    "GenMsg2": "",
    "GenMsg3": ""
  },
  "stkItemsList": [
    {
      "Company": "DEMO",
      "Code": "10010552",
      "ShortCode": "1_52",
      "Desc1": "Demo item 1",
      "Desc2": null,
      "Subunits": 1,
      "UOM": null,
      "NonStock": true,
      "Stopped": false,
      "VatCode": "3",
      "VatRate": 19,
      "ElectronicVatCode": "0",
      "Price1": 10.75,
      "Price2": 10.25,
      "Price3": 9.5,
      "Price4": 0.0,
      "Price5": 0.0,
      "Price6": 0.0,
      "Price7": 0.0,
      "Price8": 0.0,
      "Price9": 0.0,
      "Level1": "01",
      "Level2": "100",
      "Level3": "1010",
      "Level4": null,
      "Level5": null,
      "Level6": null,
      "Level7": null,
      "Level8": null,
      "Level9": null,
      "Level10": null,
      "Level11": null,
      "Level12": null,
      "Level13": null,
      "Level14": null,
      "Level15": null,
      "Level16": null,
      "Level17": null,
      "Level18": null,
      "Level19": "A",
      "Level20": null,
      "Notes": "Demo notes",
      "ItemGroupDisc": null,
      "Barcode": null,
      "Text1": "use defined data",
      "Text2": "use defined data",
      "Text3": "use defined data",
      "Text4": "use defined data",
      "Text5": "use defined data",
      "Text6": "use defined data",
      "Text7": "use defined data",
      "Text8": "use defined data",
      "Text9": "use defined data",
      "Text10": "use defined data",
      "Date1": "2025-01-06T22:32:15.2189577+02:00",
      "Date2": null,
      "Date3": null,
      "Date4": null,
      "Date5": null,
      "Numeric1": 10.0,
      "Numeric2": 5.0,
      "Numeric3": null,
      "Numeric4": null,
      "Numeric5": null,
      "PointPerPound": 0.0,
      "PointPerQty": 10,
      "Weight": 10.0,
      "Length": 3.0,
      "Width": 1.85,
      "Height": 1.6,
      "Volume": 8.88,
      "NetWeight": 5.6,
      "Notes2": "Demo notes2",
      "Notes3": "Demo notes3",
      "Notes4": "Demo notes4",
      "LastSalesDate": "2025-01-06T22:32:15.2189577+02:00",
      "LastPurchaseDate": null,
      "RecyclingCost": 2.3,
      "RecyclingItem": "100100100",
      "QuantityFactor": 4.0,
      "Assembly": false
    },
    {
      "Company": "DEMO",
      "Code": "1250024302270",
      "ShortCode": null,
      "Desc1": "Demo item 2",
      "Desc2": "",
      "Subunits": 1,
      "UOM": "",
      "NonStock": true,
      "Stopped": false,
      "VatCode": "5",
      "VatRate": 5,
      "ElectronicVatCode": null,
      "Price1": 1.25,
      "Price2": 1.5,
      "Price3": 2.0,
      "Price4": 0.0,
      "Price5": 0.0,
      "Price6": 0.0,
      "Price7": 0.0,
      "Price8": 0.0,
      "Price9": 0.0,
      "Level1": "01",
      "Level2": "200",
      "Level3": "2020",
      "Level4": "",
      "Level5": "",
      "Level6": "",
      "Level7": "",
      "Level8": "",
      "Level9": "",
      "Level10": null,
      "Level11": null,
      "Level12": null,
      "Level13": null,
      "Level14": null,
      "Level15": null,
      "Level16": null,
      "Level17": null,
      "Level18": null,
      "Level19": null,
      "Level20": null,
      "Notes": "Demo notes",
      "ItemGroupDisc": "A01",
      "Barcode": "",
      "Text1": null,
      "Text2": null,
      "Text3": null,
      "Text4": null,
      "Text5": null,
      "Text6": null,
      "Text7": null,
      "Text8": null,
      "Text9": null,
      "Text10": null,
      "Date1": null,
      "Date2": null,
      "Date3": null,
      "Date4": null,
      "Date5": null,
      "Numeric1": null,
      "Numeric2": null,
      "Numeric3": null,
      "Numeric4": null,
      "Numeric5": null,
      "PointPerPound": null,
      "PointPerQty": null,
      "Weight": null,
      "Length": null,
      "Width": null,
      "Height": null,
      "Volume": null,
      "NetWeight": null,
      "Notes2": null,
      "Notes3": null,
      "Notes4": null,
      "LastSalesDate": null,
      "LastPurchaseDate": null,
      "RecyclingCost": null,
      "RecyclingItem": null,
      "QuantityFactor": null,
      "Assembly": true
    }
  ]
}