findProductForStocktaking

Retrieves product information by code or name and it's data related to stocktaking sheet. Call is used for quick search of all data required for update of quantities on stocktaking act, see saveStocktakingReadings (to make bulk updates) or incrementStocktakingReading (to increment quantities atomically). Call will return products with exact match, or up to 100 products matching with search filters, products are ordered by last modification date - newest first. If no products matching with filters were found call will return empty response without any error codes.

Input parameters

Parameter name Description Possible value Required
code Code or product name for search. string yes
stocktakingID Stocktaking sheet ID, must be ID of non-confirmed stocktaking sheet integer yes
lang Retrieve item names in a specific language. If omitted, API will return item names in the default language of your Erply account.
Possible values:
  • 'eng' - English
  • 'spa' - Spanish
  • 'ger' - German
  • 'swe' - Swedish
  • 'fin' - Finnish
  • 'rus' - Russian
  • 'est' - Estonian
  • 'lat' - Latvian
  • 'lit' - Lithuanian
  • 'gre' - Greek
 string

Response

Field name Type Description
productID integer ID of a matching product.
productCode string Code of a matching product.
productCode2 string UPC/EAN of a matching product.
productName string Name of the product, in the language specified by the API client, or in default language otherwise.
existsOnStocktaking integer 0 or 1. 1 if the product already exists on the stocktaking sheet, 0 if it does not.
recordedQuantity number The amount that Erply thinks is supposed to be in stock. The value is written down and fixed when stocktaking starts. It is either the total quantity in stock, or the available quantity in stock (total minus reservations) — depending on what choice was made when the stocktaking was started. For products not on the stocktaking sheet, 0 will be returned.
alreadyCountedQuantity number Quantity already counted during the stocktaking. For products not on the stocktaking sheet, 0 will be returned.
lastModified integer Unix timestamp. Last modification time.

This API call returns error 1181 if provided stocktaking sheet is confirmed.