API documentation
Method list
Test your request
Changelog


addInventoryStocktakeItems
The method allows you to add items to an existing stocktake in draft status, or to update the quantity of an existing item by item_id. Entering a product with the same ID and matching parameters updates the previously saved position. If any parameter differs, a new item will be added.


Input parameters
stocktake_idintStocktake identifier
itemsarrayList of items to add or update. At most 1000 items with item_id can be updated at a time
| - item_idint(optional) Existing item identifier. When set, quantity is required and is the only field that can be updated
| - product_idintProduct identifier, required when item_id is not provided
| - quantityintExpected quantity. Must be a non-negative integer. Required when item_id is not provided.
| - location_namevarchar(255)(optional) Storage location name
| - expiry_datevarchar(10)(optional) Expiry date in YYYY-MM-DD format (ISO 8601)
| - batchvarchar(128)(optional) Batch number
| - serial_novarchar(128)(optional) Serial number



Output data
The method returns the data in JSON format.
statusvarchar(30)SUCCESS - request executed correctly
ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
itemsarrayList of created/updated stocktake items
| - item_idintItem identifier
| - positionintItem position in stocktake



Sample
Input data:
Output data:
A sample request in PHP: