Returns information regarding the quantity of product in inventory.
| URL | https://cap.crainwalnut.com/api/inventory/lotbalance |
|---|---|
| Method | GET |
| Name | Data Type | Description |
|---|---|---|
| cutoff | DateTime |
Specifies a date limiting Transaction activity considered for the computation of balances. Any Transaction that occurs after the specified date is excluded |
| locationKey | Nullable<Integer> |
System assigned key that uniquely identifies the Location for which balance information should be returned. Valid values include any key returned by the Locations endpoint or null to use the primary Location without specifying its key |
An array of objects of anonymous type with the following definition
| Name | Data Type | Description |
|---|---|---|
| Lot | Lot |
Refer to data type’s documentation for further information |
| PhysicalQuantity | Decimal |
Physical balance of the Lot expressed in terms of the product’s PackagingType |
| PhysicalPounds | Decimal |
Physical balance of the Lot expressed in terms of the system's base UnitOfMeasure |
| AvailableQuantity | Decimal |
Available balance of the Lot, taking into account reserved quantities, expressed in terms of the product’s PackagingType |
| AvailablePounds | Decimal |
Available balance of the Lot, taking into account reserved quantities, expressed in terms of the system's base UnitOfMeasure |
Physical amounts are computed based on transactional data up to and including the date of cutoff. As such, they represent an accurate picture of product on hand as of a specified date. Available amounts subtract remaining reserved product for all time. As such, they are only useful when the cut off is greater than or equal to the current date.