getBins

Retrieve the list of bins (for one warehouse, or all warehouses, or specific bins by ID).

Input parameters

Parameter name Description Possible value Required
warehouseID  Get bins that belong to a specific warehouse.  Integer    
code  Bin code.  String    
status  Possible values: "ACTIVE", "ARCHIVED" (by default returns both).  String    
preferred  Get preferred or unnpreferred bins only. 0 or 1.  Integer    
allowedProduct    String    
binIDs  Retrieve multiple bins, IDs separated by commas. Eg. "1,2,3,4,5".  String    

Response

Field name Type Description
binID  Integer  Bin ID.  
warehouseID  Integer  Warehouse ID.  
code  String  Bin code.  
status  String  Possible values: "ACTIVE", "ARCHIVED".  
preferred  Integer (0 or 1)  Indicates if this bin is preferred.  
allowedProduct  String  A textual description; may be used to indicate that this bin is only meant for storing a specific product or products.  
replenishmentMinimum  Decimal (6 places)  If the quantity in this bin falls below this value, the item should be reordered. (API does not indicate what is the product that is kept in this bin and needs to be reordered.)  
maximumAmount  Decimal (6 places)  Maximum capacity of this bin. (Products come in different sizes; API does not indicate what product is being assumed here.)  
order  Integer    

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: