This call is deprecated. We recommend to use WMS API instead.
The corresponding new call is: POST /v1/bin-inventory-record.
Make a bin quantity adjustment which is not related to any sales or purchase document (eg. a discrepancy found in recounting). For quantity adjustments that are related to specific sales or purchase documents, you should use saveBinRecords instead.
Internally, this API call will also create transaction records, just like saveBinRecords does. However, in some cases this interface may be more convenient to use.
You can send multiple records with one API call; append numbers 1, 2, 3, ... to the parameter names to identify values for record 1, record 2, etc. Fore example, binID1
, productID1
, newAmount1
for the first record, binID2
, productID2
, newAmount2
for the second one and so on.
There is no hard limit to how many records you can send with one call, but it is recommended to keep it below 500. Also, more records take a longer time to process, so make sure you will not hit a timeout while waiting for API's response.
Parameter name | Description | Possible value | Required |
---|---|---|---|
binID# | Bin ID. | integer | yes |
productID# | Product ID. | integer | yes |
newAmount# | New amount. | Decimal (6 places) | yes |
timestamp# | Integer (Unix timestamp) | ||
creatorID# | Creator (employee) ID. | integer | yes |
reasonCodeID# | Reason Code ID. | integer |
This call is part of the "Quantities in Bins" API. It allows you to keep more precise track of inventory quantities — at aisle, shelf and bin level, not just at warehouse level.
To successfully make use of this API, you need to build an end-to-end integration yourself: make API calls every time inventory is removed from or added to shelves, or relocated in the warehouse, and build a custom report to display current quantities and their locations.
Standard operations in Erply (like confirming a sales or purchase invoice) that otherwise automatically adjust inventory levels, do not make any changes to the quantities in bins. Instead, API commands should be sent to remove inventory from bins when an employee goes and actually picks up the items for the shipment.
The calls that make up the "Quantities in Bins" API are: