Search

deleteBinRecords

Delete a previously created record (or records). After a record is deleted, API will also update the cumulative quantity of that product in that bin.

Input parameters

Parameter nameDescriptionPossible valueRequired
binIDsDelete all records from specified bins. Multiple bin IDs, separated by commas, such as: "1,2,3,4,5".String
recordIDsDelete records by ID. Multiple record IDs, separated by commas, such as: "1,2,3,4,5".String
warehouseIDDelete records from entire warehouse.Integer
documentIDsIf you want to delete all records that are associated with one document, or even multiple documents, use input parameters "documentIDs" and "documentType". Multiple document IDs, separated by commas, such as: "1,2,3,4,5".String
documentTypePossible values:
  • SALES_DOCUMENT - Sales Document
  • PURCHASE_DOCUMENT - Purchase Document
  • INVENTORY_REGISTRATION - Inventory Registration
  • INVENTORY_WRITE_OFF - Inventory Write-Off
  • INVENTORY_TRANSFER - Inventory Transfer
String

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: