LoadInventoryPositionData
Rule
Changed on:
12 Aug 2025
Overview
Send an inline event including the`inventoryPositionExists` flag indicating whether the corresponding Inventory Position exists or not.This Rule is a simplified version of the `LoadInventoryPosition` rule, excluding the logic for:- Retrieving Inventory Quantity data of type
`LAST_ON_HAND`in status`ACTIVE`or`CREATED` - Setting and forwarding the
`inventoryQuantityExists`flag (true or false)
| Plugin Name | Inventory Reference Module |
|---|---|
| Namespace | [[account.id]].globalinventory |
- Product Catalogue workflow
- Inventory Catalogue workflow
- Control Group workflow
- Virtual Catalogue workflow
UI Description
Forward event {eventName} (inline event) with the attribute `inventoryPositionExists` set to true or false if the inventory position exists or not respectively.
Accepts
- INVENTORY_CATALOGUE
Actions
- This Rule produces a SendEventAction with name
`{eventName}`
Rule parameters
| Name | Type | Description |
`eventName` | `String` | The name of the event to be triggered |
Event attributes
| Name | Type | Description | Required? |
`inventoryPosition` | `InventoryUpdate` | A single item of the Inventory Batch request.This Object contains the Inventory Position specific data. See the Sub-attributes below. | Yes |
InventoryUpdate Object Sub-attributes
| Name | Type | Description | Required |
`ref` | `String` | The Reference of the Inventory Position | No |
`type` | `String` | The Type of the Inventory Position. | NoUnused because the Inventory Position Type is inherited from the Inventory Catalog Sub Type. |
`productRef` | `String` | The Reference of the Variant Product associated to the Inventory Position | Yes |
`locationRef` | `String` | The Reference of the Location associated to the Inventory Position | Yes |
`qty` | `Integer` | The quantity | Yes |
`correctedQty` | `Integer` | The quantity value of the Inventory Quantity of the `CORRECTED` Type | No, unused |
`inventoryQuantity` | `InventoryQuantityUpdate` | The Object that contains the Inventory Quantity specific data. See the Sub-attributes below. | No |
InventoryQuantityUpdate Object Sub-attributes
| Name | Type | Description | Required |
`ref` | `String` | The Reference of the Inventory Quantity | No |
`qty` | `Integer` | The quantity value of the Inventory Quantity | No |
`type` | `String` | The Type of the Inventory Quantity | No |
`status` | `String` | The Status of the Inventory Quantity | No |
`attributes` | `Map<String, Object>` | The following attributes are supported:
| No |
Exceptions
- This Rule throws a
`PropertyNotFoundException`when the Rule parameter(s) is not provided.
- This Rule throws an
`EventAttributeNotFoundException`when the required Event attribute(s) is not provided.
Configuration example
1{
2 "name": "[[account.id]].globalinventory.LoadInventoryPosition",
3 "props": {
4 "eventName": "CheckInventoryPositionExists"
5 }
6}Detailed Technical Description
This Rule execution includes the following steps:1. Validate that:- The
`eventName`Rule parameter has been provided - The mandatory Event attributes have been provided:
`inventoryPosition`and its Sub-attributes:`productRef``locationRef``qty`
- Inventory Position Reference
The value is taken from the`inventoryPosition.ref`Sub-attribute. - Inventory Catalog Reference
The value is taken from the incoming event`rootEntityRef`
3. Add the retrieved information into the event attributes and produce a
`SendEventAction` with the event `{eventName}`:| Event Attribute Key | Event Attribute Value |
`type` |
|
`ref` | `inventoryPosition.ref` (from the incoming event attributes) |
`qty` | `inventoryPosition.qty` (from the incoming event attributes) |
`productRef` | `inventoryPosition.productRef` (from the incoming event attributes) |
`locationRef` | `inventoryPosition.locationRef` (from the incoming event attributes) |
`correctedQty` | `inventoryPosition.correctedQty` (from the incoming event attributes) - UNUSED |
`inventoryPositionStatus` |
|
`inventoryPositionRef` |
|
`inventoryPositionOnHand` |
|
`inventoryPositionExists` |
|
