Fluent Commerce Logo
Docs

SendEventForInventoryPosition

Rule

Changed on:

5 Nov 2026

Overview

Sends an Event from an Inventory Quantity to its parent Inventory Position, inline.Use it after the SetState Rule in the ruleset that deactivates an Inventory Quantity, so on hand is recalculated without that Inventory Quantity.
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

Send {eventName} to the inventory quantity's parent inventory position

Accepts

  • INVENTORY_QUANTITY

Actions

  • This Rule produces an inline SendEventAction for the parent Inventory Position

Rule parameters

NameTypeDescriptionRequired
`eventName``String`The name of the Event to send to the parent Inventory PositionYes

Event attributes

NameTypeDescriptionRequired
`inventoryPositionRef``String`The Inventory Position Reference. If not provided, it is taken from the Inventory Quantity Reference.No

Exceptions

  • This Rule throws a `PropertyNotFoundException` when the Rule parameter(s) is not provided.

Configuration example

1{
2  "name": "[[account.id]].globalinventory.SendEventForInventoryPosition",
3  "props": {
4    "eventName": "CalculateOnHand"
5  }
6}

Detailed Technical Description

This Rule execution includes the following steps:
  • Validate that `eventName` has been provided
  • Resolve the Inventory Position Reference:
    • From the `inventoryPositionRef` Event attribute, when provided
    • Otherwise from the Inventory Quantity Reference, which must follow `{inventoryPositionRef}:{quantityType}:{fulfilmentId}`
  • Retrieve the Inventory Position, so its status and on hand are current
  • Send `eventName` inline to the Inventory Position:
    • Entity subtype: the Inventory Catalog type, so the Event matches the `INVENTORY_POSITION` rulesets of the Inventory Catalog workflow
    • Entity status: the Inventory Position status
    • Attributes: the incoming Event attributes plus `inventoryPositionRef`, `inventoryPositionType`, `inventoryPositionStatus` and `inventoryPositionOnHand`

Version History

2026-11-09

v26.11.9

Initial release.The Rule Version refers to the Product Release Version.