Catalyst Fire Ignition Documentation
Product
Checks a product's inventory in netFORUM against a requested quantity
Definition
Namespace: Ignition.Commerce.Products
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
The results of the requested check. See InventoryCheckResult for detailed descriptions of the possible results.
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
public InventoryCheckResult CheckInventory(
IInventoryTrackable product,
out decimal quantityAvailable,
[OptionalAttribute] decimal quantityRequested
)VB
Public Function CheckInventory (
product As IInventoryTrackable,
<OutAttribute> ByRef quantityAvailable As Decimal,
<OptionalAttribute> quantityRequested As Decimal
) As InventoryCheckResultC++
public:
virtual InventoryCheckResult CheckInventory(
IInventoryTrackable^ product,
[OutAttribute] Decimal% quantityAvailable,
[OptionalAttribute] Decimal quantityRequested
) sealedF#
abstract CheckInventory :
product : IInventoryTrackable *
quantityAvailable : decimal byref *
[<OptionalAttribute>] quantityRequested : decimal -> InventoryCheckResult
override CheckInventory :
product : IInventoryTrackable *
quantityAvailable : decimal byref *
[<OptionalAttribute>] quantityRequested : decimal -> InventoryCheckResult Parameters
- product IInventoryTrackable
- The product whose inventory is to be checked
- quantityAvailable Decimal
- If inventory tracking is enabled for this product (ie, the method returned anything but InventoryNotTracked), then this is the actual quantity available for this product; otherwise 0 if tracking is not enabled.
- quantityRequested Decimal (Optional)
- The quantity in which the product is being requested
Return Value
InventoryCheckResultThe results of the requested check. See InventoryCheckResult for detailed descriptions of the possible results.