Search

getBinRecords

Retrieve the list of bin records.

Input parameters

Parameter nameDescriptionPossible valueRequired
binIDsMultiple bin IDs, separated by commas, such as: "1,2,3,4,5".String
warehouseIDFilter by warehouse ID.Integer
documentIDsFilter by multiple document IDs, separated by commas, such as: "1,2,3,4,5".String
documentTypeFilter by document type. Possible values:
  • SALES_DOCUMENT - Sales Document
  • PURCHASE_DOCUMENT - Purchase Document
  • INVENTORY_REGISTRATION - Inventory Registration
  • INVENTORY_WRITE_OFF - Inventory Write-Off
  • INVENTORY_TRANSFER - Inventory Transfer
String
timestampStartInteger (Unix timestamp)
timestampEnd:Integer (Unix timestamp)
preferredGet records from preferred or unnpreferred bins only. 0 or 1.Integer
changedSinceRetrieve only records that have been added or modified since the specified timestamp.Integer (Unix timestamp)

Response

Field nameTypeDescription
binIDIntegerBin ID.
binCodeStringBin code.
binPreferredInteger (0 or 1)Indicates if this bin is preferred.
warehouseIDIntegerWarehouse ID.
productIDIntegerProduct ID.
productCodeStringFirst code of the product (by convention, this is used for company's internal code).
productCode2StringSecond code of the product (by convention, this is used for EAN/UPC barcode).
productCode3StringThird code of the product.
productSupplierCodeStringSupplier's product code.
productCode5StringCode 5 of the product. "Extra product codes" module must be enabled.
productCode6StringCode 6 of the product. "Extra product codes" module must be enabled.
productCode7StringCode 7 of the product. "Extra product codes" module must be enabled.
productCode8StringCode 8 of the product. "Extra product codes" module must be enabled.
recordIDIntegerRecord ID.
amountDecimal (6 places)
timestampInteger (Unix timestamp)
documentIDIntegerDocument ID.
documentTypeStringDocument type. Possible values:
  • SALES_DOCUMENT - Sales Document
  • PURCHASE_DOCUMENT - Purchase Document
  • INVENTORY_REGISTRATION - Inventory Registration
  • INVENTORY_WRITE_OFF - Inventory Write-Off
  • INVENTORY_TRANSFER - Inventory Transfer
creatorIDIntegerCreator (employee) ID.
reasonCodeIDIntegerReason 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: