SplitInventoryUpdates ( Deprecated )

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Rule

Changed on:

14 Feb 2025

Overview

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

Plugin Name	Inventory 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

Inventory Reference Module

The Inventory Module includes the following areas:

Product Catalog workflow
Inventory Catalog workflow
Control Group workflows
Virtual Catalog workflows

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

Parameter	Description	Notes
eventName	The name of the event to be triggered	Required

Event attributes

Parameter	Description	Data Type	Required?
InventoryUpdates	Array of InventoryPosition records to be updated	[InventoryPosition]	No

InventoryPosition sub-attributes

Parameter	Description	Data Type	Required?
ref	ref	String	No, unused
type	The inventory position type	String	No, unused
productRef	The ref of the variant product associated to the inventory position	String	No
locationRef	The location ref associated to the inventory position	String	No
qty	The quantity	Integer	No
correctedQty	corrected quantity	Integer	No, unused
inventoryQuantity	inventoryQuantityUpdate	POJO	No

InventoryQuiantity sub-attributes

Parameter	Description	Data Type	Required?
ref	Inventor Quantity ref	String	No
type	Inventory Quantity type	String	No
qty	Quantity	Integer	No
status	Status	String	No

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}

Language: json

Detailed Technical Description

Important Notice: Deprecation of INVENTORY_UPDATE Event

Deprecation Notice
Effective with Inventory Module Release 2.2.0, the

`INVENTORY_UPDATE`

event is now deprecated and not available as part of the reference workflow. With the enhanced Inventory Batch API —which supports ruleset names, enhanced attributes, and upcoming features like batch monitoring—this older direct-update approach has become redundant. We also recommend not using the rule SplitinventoryUpdates to split inventory payload .

We strongly recommend migrating to the Inventory Batch API with enhanced attributes to send full-load updates rather than relying on the

`INVENTORY_UPDATE`

event. This will ensure access to future enhancements and improved scalability once you upgrade to the latest Inventory Module.

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.

Warning

This rule has been limited to only accept up to 1000 position updates per event execution. Any updates past the first 1000 will be dropped and not processed.

InventoryUpdate DTO Definition

1    public class InventoryUpdate {
2
3        private String ref;
4        private String productRef;
5        private String locationRef;
6        private Integer qty;
7        private Integer correctedQty;
8        private String type;
9        private InventoryQuantityUpdate inventoryQuantity;
10    };
11    
12    public class InventoryQuantityUpdate {
13    
14        private String ref;
15        private Integer qty;
16        private String type;
17        private String status;
18        private Map<String, Object> attributes;
19    }

Language: java

Name: InventoryUpdate

Description:

[Warning: empty required content area]

Version History

2023-08-03

v2.0.0

refers to the plugin