Retrieve the list of bin records.
|Parameter name||Description||Possible value||Required|
|binIDs||Multiple bin IDs, separated by commas, such as: "1,2,3,4,5".||String|
|warehouseID||Filter by warehouse ID.||Integer|
|documentIDs||Filter by multiple document IDs, separated by commas, such as: "1,2,3,4,5".||String|
|documentType||Filter by document type. Possible values:
|timestampStart||Integer (Unix timestamp)|
|timestampEnd||Integer (Unix timestamp)|
|preferred||Get records from preferred or unnpreferred bins only. 0 or 1.||Integer|
|changedSince||Retrieve only records that have been added or modified since the specified timestamp.||Integer (Unix timestamp)|
|binPreferred||Integer (0 or 1)||Indicates if this bin is preferred.|
|productCode||String||First code of the product (by convention, this is used for company's internal code).|
|productCode2||String||Second code of the product (by convention, this is used for EAN/UPC barcode).|
|productCode3||String||Third code of the product.|
|productSupplierCode||String||Supplier's product code.|
|productCode5||String||Code 5 of the product. "Extra product codes" module must be enabled.|
|productCode6||String||Code 6 of the product. "Extra product codes" module must be enabled.|
|productCode7||String||Code 7 of the product. "Extra product codes" module must be enabled.|
|productCode8||String||Code 8 of the product. "Extra product codes" module must be enabled.|
|amount||Decimal (6 places)|
|timestamp||Integer (Unix timestamp)|
|documentType||String||Document type. Possible values:
|creatorID||Integer||Creator (employee) ID.|
|reasonCodeID||Integer||Reason Code ID.|
This call is part of the "Quantities in Bins" API. It is an add-on to Erply's standard data model, and it allows you to keep more precise track of inventory quantities — at aisle, shelf and bin level, not just at warehouse level.
If that extra module is not enabled on your account, this API call will return error 1006.
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: