Name | Description | Type | Additional information |
---|---|---|---|
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 |