Fluent Commerce Logo
Docs

ForwardIfInventoryQuantityOfTypeExists

Rule

Changed on:

12 Aug 2025

Overview

Conditionally trigger another Ruleset when the Inventory Position and Quantity of the specified type exist.
Plugin NameInventory Reference Module
Namespace[[account.id]].globalinventory
The Inventory Reference Module is the foundation for inventory related implementations. It provides reference Workflows for inventory ingestion and processing. Extensible by design, use this Module as a base to build a solution to the needs of your customers.The Inventory Module includes the following areas:
  • Product Catalogue workflow
  • Inventory Catalogue workflow
  • Control Group workflow
  • Virtual Catalogue workflow

UI Description

Forward event {eventName} if the inventory position and quantity of {type} exists.

Accepts

  • INVENTORY_POSITION

Actions

Rule parameters

NameTypeDescription
`eventName``String`The name of event to be triggered if inventory position and quantity exists
`type``String`Type of the inventory quantity

Event attributes

NameTypeDescriptionRequired
`inventoryQuantityExists`BooleanIndicates if the inventory quantity exists or notNo
`inventoryQuantityTypes`List<String>All the inventory quantity types that exist for the given inventory positionNo
`inventoryPostionRef`StringThe reference of the inventory positionNo

Exceptions

This rule does NOT throw any exceptions.

Configuration example

1{
2  "name": "[[account.id]].globalinventory.ForwardIfInventoryQuantityOfTypeExists",
3  "props": {
4    "eventName": "BatchInventoryPositionUpdate",
5    "type": "LAST_ON_HAND"
6  }
7}

Detailed Technical Description

This Rule will conditionally produce a SendEventAction with entitySubtype derived from {entitySubtype}. If {entitySubtype} is null, entitySubtype would be hardcoded to 'DEFAULT'.  The Rule condition is defined by the existence of the Inventory Position and Quantity of `type` parameter. When the Rule condition is met, the Event will be produced with a name defined by the `eventName` parameter.

Version History

2024-07-04

v24.7.4

Refers to the Product Release Version