This call is deprecated. We recommend to use WMS API instead.
The corresponding new call is: POST /v1/bin-inventory-record.
Create a set of bin records. This is the recommended way to place items into bins (which have arrived with a Purchase Invoice or Inventory Registration) or remove sold items.
After saving and processing each record, API will also update the cumulative quantity of that product in that bin.
This call can also be used for editing existing records. In that case, API will also adjust the summarized quantity of that bin accordingly.
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, amount1 for the first record, binID2, productID2, amount2 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 |
|---|---|---|---|
| recordID# | Leave this field empty when creating a new bin record. | integer | |
| binID# | Bin ID. For new bin records, this field is required. | integer | |
| productID# | Product ID. For new bin records, this field is required. | integer | |
| amount# | Amount. For new bin records, this field is required. | Decimal (6 places) | |
| timestamp# | Integer (Unix timestamp) | ||
| documentID# | Document ID. | integer | |
| documentType# | Document Type. Possible values:
|
string | |
| creatorID# | Creator (employee) ID. For new bin records, this field is required. | integer | |
| 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: