POST api/StockTaking/ValidateStockTake

Retrieves a list of all counts. This can be used to match up with local data

Request Information

URI Parameters

None.

Body Parameters

The unique device ID to filter the results on.

EskimoClassLibraries.StockTakingValidateOptions
NameDescriptionTypeAdditional information
DeviceID

Each Stock Taking Device will have it's own unique hardware ID. This is passed when incrementing the stock take count figures. Passing a value here will filter the results to just those of that device.

 string

None.
Area

Optional property which when passed, will filter the results for that area. The area is a field passed to the IncrementCounts action.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "DeviceID": "sample string 1",
  "Area": "sample string 2"
}

application/xml, text/xml

Sample: 
<StockTakingValidateOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <Area>sample string 2</Area>
  <DeviceID>sample string 1</DeviceID>
</StockTakingValidateOptions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsCountedProductExt
NameDescriptionTypeAdditional information
ShortDescription

The 30 character till description of the product

 string

None.
DateScanned

The date/time the barcode was scanned. This may be different to the time the entry is added to the database by a few minutes if the api call fails initially.

 date

None.
ScanID

A unique identifier for this row. Feel free to use your own identifier. This can aid to correlate results when the response is received.

 string

String length: inclusive between 0 and 50
PLU

Must be a valid PLU code

 string

Required

String length: inclusive between 0 and 35
SecondaryPLU

string

None.
CountAmount

The number of pieces that have been counted for this PLU. Multiple rows for the same PLU can be present.

 integer

None.
Location

The Eskimo system manages stock in up to 3 stock locations. This specifies which location has been counted for this product.

 integer

Range: inclusive between 1 and 3
ShelfLocation

Optional. The location on the shelf where this product can be found. Useful in warehouse racking etc.

 string

String length: inclusive between 0 and 50
OperatorID

Must match an existing Eskimo Operator ID. These are retieved by calling the StockTaking/GetProductData call

 string

Required

String length: inclusive between 0 and 12
AdditionalInfo

Pass any notes you like about this count. Some people like to pass the friendly name of the device (i.e. Scanner 5 or Bob's)

 string

String length: inclusive between 0 and 200
Area

The Stock Area (or room) that is being counted. A free-text, friendly name. For example, useful in a busines that has many different demonstration living rooms. This can filtered on when Validating the Stock Take.

 string

String length: inclusive between 0 and 100
DeviceID

The unique hardware ID of the device being to used. This can filtered on when Validating the Stock Take.

 string

None.
CurrentLevel

The count value after incrementing. This does not need to be passed in the Request. It will be returned in the response.

 integer

None.
StockTakeID

Eskimo can run multiple stock takes at once - for different product sections. This is the ID of the stock take currently selected.

 integer

None.
StockTakeStore

string

String length: inclusive between 3 and 3

Response Formats

application/json, text/json

Sample: 
[
  {
    "ShortDescription": "sample string 1",
    "DateScanned": "2024-05-03T13:43:28.9910561+01:00",
    "ScanID": "sample string 3",
    "PLU": "sample string 4",
    "SecondaryPLU": "sample string 5",
    "CountAmount": 6,
    "Location": 7,
    "ShelfLocation": "sample string 8",
    "OperatorID": "sample string 9",
    "AdditionalInfo": "sample string 10",
    "Area": "sample string 11",
    "DeviceID": "sample string 12",
    "CurrentLevel": 13,
    "StockTakeID": 1,
    "StockTakeStore": "sample string 14"
  },
  {
    "ShortDescription": "sample string 1",
    "DateScanned": "2024-05-03T13:43:28.9910561+01:00",
    "ScanID": "sample string 3",
    "PLU": "sample string 4",
    "SecondaryPLU": "sample string 5",
    "CountAmount": 6,
    "Location": 7,
    "ShelfLocation": "sample string 8",
    "OperatorID": "sample string 9",
    "AdditionalInfo": "sample string 10",
    "Area": "sample string 11",
    "DeviceID": "sample string 12",
    "CurrentLevel": 13,
    "StockTakeID": 1,
    "StockTakeStore": "sample string 14"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfclsCountedProductExt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsCountedProductExt>
    <AdditionalInfo>sample string 10</AdditionalInfo>
    <Area>sample string 11</Area>
    <CountAmount>6</CountAmount>
    <CurrentLevel>13</CurrentLevel>
    <DateScanned>2024-05-03T13:43:28.9910561+01:00</DateScanned>
    <DeviceID>sample string 12</DeviceID>
    <Location>7</Location>
    <OperatorID>sample string 9</OperatorID>
    <PLU>sample string 4</PLU>
    <ScanID>sample string 3</ScanID>
    <SecondaryPLU>sample string 5</SecondaryPLU>
    <ShelfLocation>sample string 8</ShelfLocation>
    <StockTakeID>1</StockTakeID>
    <StockTakeStore>sample string 14</StockTakeStore>
    <ShortDescription>sample string 1</ShortDescription>
  </clsCountedProductExt>
  <clsCountedProductExt>
    <AdditionalInfo>sample string 10</AdditionalInfo>
    <Area>sample string 11</Area>
    <CountAmount>6</CountAmount>
    <CurrentLevel>13</CurrentLevel>
    <DateScanned>2024-05-03T13:43:28.9910561+01:00</DateScanned>
    <DeviceID>sample string 12</DeviceID>
    <Location>7</Location>
    <OperatorID>sample string 9</OperatorID>
    <PLU>sample string 4</PLU>
    <ScanID>sample string 3</ScanID>
    <SecondaryPLU>sample string 5</SecondaryPLU>
    <ShelfLocation>sample string 8</ShelfLocation>
    <StockTakeID>1</StockTakeID>
    <StockTakeStore>sample string 14</StockTakeStore>
    <ShortDescription>sample string 1</ShortDescription>
  </clsCountedProductExt>
</ArrayOfclsCountedProductExt>