POST api/StockTaking/IncrementCounts

Increments the counted figure for a collection of products

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Counts	A collection of products that have been counted	Collection of EskimoClassLibraries.clsCountedProduct	None.
StockTakeID		integer	None.
StockTakeStore		string	String length: inclusive between 3 and 3

Request Formats

application/json, text/json

Sample:

{
  "Counts": [
    {
      "DateScanned": "2025-01-18T03:39:24.7048292+00:00",
      "ScanID": "sample string 2",
      "PLU": "sample string 3",
      "SecondaryPLU": "sample string 4",
      "CountAmount": 5,
      "Location": 6,
      "ShelfLocation": "sample string 7",
      "OperatorID": "sample string 8",
      "AdditionalInfo": "sample string 9",
      "Area": "sample string 10",
      "DeviceID": "sample string 11",
      "CurrentLevel": 12,
      "StockTakeID": 1,
      "StockTakeStore": "sample string 13"
    },
    {
      "DateScanned": "2025-01-18T03:39:24.7048292+00:00",
      "ScanID": "sample string 2",
      "PLU": "sample string 3",
      "SecondaryPLU": "sample string 4",
      "CountAmount": 5,
      "Location": 6,
      "ShelfLocation": "sample string 7",
      "OperatorID": "sample string 8",
      "AdditionalInfo": "sample string 9",
      "Area": "sample string 10",
      "DeviceID": "sample string 11",
      "CurrentLevel": 12,
      "StockTakeID": 1,
      "StockTakeStore": "sample string 13"
    }
  ],
  "StockTakeID": 1,
  "StockTakeStore": "sample string 1"
}

application/xml, text/xml

Sample:

<clsCountedProducts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <Counts>
    <clsCountedProduct>
      <AdditionalInfo>sample string 9</AdditionalInfo>
      <Area>sample string 10</Area>
      <CountAmount>5</CountAmount>
      <CurrentLevel>12</CurrentLevel>
      <DateScanned>2025-01-18T03:39:24.7048292+00:00</DateScanned>
      <DeviceID>sample string 11</DeviceID>
      <Location>6</Location>
      <OperatorID>sample string 8</OperatorID>
      <PLU>sample string 3</PLU>
      <ScanID>sample string 2</ScanID>
      <SecondaryPLU>sample string 4</SecondaryPLU>
      <ShelfLocation>sample string 7</ShelfLocation>
      <StockTakeID>1</StockTakeID>
      <StockTakeStore>sample string 13</StockTakeStore>
    </clsCountedProduct>
    <clsCountedProduct>
      <AdditionalInfo>sample string 9</AdditionalInfo>
      <Area>sample string 10</Area>
      <CountAmount>5</CountAmount>
      <CurrentLevel>12</CurrentLevel>
      <DateScanned>2025-01-18T03:39:24.7048292+00:00</DateScanned>
      <DeviceID>sample string 11</DeviceID>
      <Location>6</Location>
      <OperatorID>sample string 8</OperatorID>
      <PLU>sample string 3</PLU>
      <ScanID>sample string 2</ScanID>
      <SecondaryPLU>sample string 4</SecondaryPLU>
      <ShelfLocation>sample string 7</ShelfLocation>
      <StockTakeID>1</StockTakeID>
      <StockTakeStore>sample string 13</StockTakeStore>
    </clsCountedProduct>
  </Counts>
  <StockTakeID>1</StockTakeID>
  <StockTakeStore>sample string 1</StockTakeStore>
</clsCountedProducts>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EskimoClassLibraries.clsCountedProduct

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

Response Formats

application/json, text/json

Sample:

[
  {
    "DateScanned": "2025-01-18T03:39:24.7048292+00:00",
    "ScanID": "sample string 2",
    "PLU": "sample string 3",
    "SecondaryPLU": "sample string 4",
    "CountAmount": 5,
    "Location": 6,
    "ShelfLocation": "sample string 7",
    "OperatorID": "sample string 8",
    "AdditionalInfo": "sample string 9",
    "Area": "sample string 10",
    "DeviceID": "sample string 11",
    "CurrentLevel": 12,
    "StockTakeID": 1,
    "StockTakeStore": "sample string 13"
  },
  {
    "DateScanned": "2025-01-18T03:39:24.7048292+00:00",
    "ScanID": "sample string 2",
    "PLU": "sample string 3",
    "SecondaryPLU": "sample string 4",
    "CountAmount": 5,
    "Location": 6,
    "ShelfLocation": "sample string 7",
    "OperatorID": "sample string 8",
    "AdditionalInfo": "sample string 9",
    "Area": "sample string 10",
    "DeviceID": "sample string 11",
    "CurrentLevel": 12,
    "StockTakeID": 1,
    "StockTakeStore": "sample string 13"
  }
]

application/xml, text/xml

Sample:

<ArrayOfclsCountedProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries">
  <clsCountedProduct>
    <AdditionalInfo>sample string 9</AdditionalInfo>
    <Area>sample string 10</Area>
    <CountAmount>5</CountAmount>
    <CurrentLevel>12</CurrentLevel>
    <DateScanned>2025-01-18T03:39:24.7048292+00:00</DateScanned>
    <DeviceID>sample string 11</DeviceID>
    <Location>6</Location>
    <OperatorID>sample string 8</OperatorID>
    <PLU>sample string 3</PLU>
    <ScanID>sample string 2</ScanID>
    <SecondaryPLU>sample string 4</SecondaryPLU>
    <ShelfLocation>sample string 7</ShelfLocation>
    <StockTakeID>1</StockTakeID>
    <StockTakeStore>sample string 13</StockTakeStore>
  </clsCountedProduct>
  <clsCountedProduct>
    <AdditionalInfo>sample string 9</AdditionalInfo>
    <Area>sample string 10</Area>
    <CountAmount>5</CountAmount>
    <CurrentLevel>12</CurrentLevel>
    <DateScanned>2025-01-18T03:39:24.7048292+00:00</DateScanned>
    <DeviceID>sample string 11</DeviceID>
    <Location>6</Location>
    <OperatorID>sample string 8</OperatorID>
    <PLU>sample string 3</PLU>
    <ScanID>sample string 2</ScanID>
    <SecondaryPLU>sample string 4</SecondaryPLU>
    <ShelfLocation>sample string 7</ShelfLocation>
    <StockTakeID>1</StockTakeID>
    <StockTakeStore>sample string 13</StockTakeStore>
  </clsCountedProduct>
</ArrayOfclsCountedProduct>