Fluent Commerce Logo
Docs

SplitInventoryUpdates (Deprecated)

RuleRules are designed to be building blocks for workflow logic.

Changed on:

30 Apr 2025

Overview

Notifies the inventory positions of the incoming updates with event {eventName}
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

Notifies the inventory positions of the incoming updates with event {eventName}

Accepts

  • INVENTORY_CATALOGUE

Actions

  • This rule sends an individual event for each InventoryPosition record sent to the event up to the first 1000 records passed in the attributes.

Rule parameters

ParameterDescriptionNotes
eventNameThe name of the event to be triggeredRequired

Event attributes

ParameterDescriptionData TypeRequired?
InventoryUpdatesArray of InventoryPosition records to be updated[InventoryPosition]No
InventoryPosition sub-attributes
ParameterDescriptionData TypeRequired?
refrefStringNo, unused
typeThe inventory position typeStringNo, unused
productRefThe ref of the variant product associated to the inventory positionStringNo
locationRefThe location ref associated to the inventory positionStringNo
qtyThe quantityIntegerNo
correctedQtycorrected quantityIntegerNo, unused
inventoryQuantityinventoryQuantityUpdatePOJONo
InventoryQuiantity sub-attributes
ParameterDescriptionData TypeRequired?
refInventor Quantity refStringNo 
typeInventory Quantity typeStringNo 
qtyQuantityIntegerNo
statusStatusStringNo 

Exceptions

Exceptions will be thrown if attributes in the incoming event are missing or an event name is missing in a given workflow.

Configuration example

1{
2  "name": "globalinventory.SplitInventoryUpdates",
3  "props": {
4    "eventName": "InventoryChanged"
5  }
6}

Detailed Technical Description


This rule parses/deserialises an `InventoryUpdates` event attribute into a list of `InventoryUpdate` objects, then it produces `SendEventActions` for each individual `InventoryUpdate` to create multiple new outgoing events for all inventory positions at `INVENTORY_CATALOGUE` level with the given event name.
InventoryUpdate DTO Definition

Version History