This call is deprecated. We recommend to use WMS API instead.
The corresponding new call is: POST /v1/bin.
Create or update a bin. Each bin belongs to one specific warehouse.
Bin codes must be per-warehouse unique. If you attempt to assign a duplicate code, API will return error 1012.
It is not possible to move a bin to another warehouse.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| binID | Leave this field empty when creating a new bin. | integer | |
| warehouseID | Warehouse ID. For new bins, this field is required. For existing bins, warehouse cannot be changed. If you edit an existing bin and pass the "warehouseID" parameter, it will be ignored. | integer | |
| code | Bin code. For new bins, this field is required. | string | |
| status | Possible values: "ACTIVE", "ARCHIVED", by default "ACTIVE". | string | |
| preferred | 0 or 1. | integer | |
| allowedProduct | A textual description; use it to indicate if this bin is only meant for storing a specific product or products. | string | |
| replenishmentMinimum | If the quantity in this bin falls below this value, the item should be reordered. (API client must itself establish a system what product is being referred here. This field could be used in conjunction with "allowedProduct".) | Decimal (6 places) | |
| maximumAmount | Maximum capacity of this bin. (API client must itself establish a system what product is being referred here. This field could be used in conjunction with "allowedProduct".) | Decimal (6 places) | |
| order | integer |
| Field name | Type | Description |
|---|---|---|
| binID | integer | ID of the created/updated item. |
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: