LoadInventoryPosition
Rule
Changed on:
12 Aug 2025
Overview
Forward event`{eventName}` (inline event) with the attribute 'inventoryPositionExists' set to true or false if the inventory position exists or not respectively.| 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
| Parameter | Type | Description |
`eventName` | `String` | The name of event to be triggered |
Event attributes
| Name | Type | Description | Required? |
`inventoryPosition` | InventoryPosition | One single item of inventory batch request | Yes |
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 | [InventoryQuantity] | No |
InventoryQuantity sub-attributes
| Parameter | Description | Data Type | Required? |
`ref` | Inventory Quantity ref | String | No |
`type` | Inventory Quantity type | String | No |
`qty` | Quantity | Integer | No |
`status` | Status | String | No |
Exceptions
This rule will throw a RubixException if
`{eventName}` property is not provided.Configuration example
1{
2 "name": "[[account.id]].globalinventory.LoadInventoryPosition",
3 "props": {
4 "eventName": "CheckInventoryPositionExists"
5 }
6}Detailed Technical Description
Based on the inventory position`ref` (from inventory batch) and inventory catalogue ref (from event root entity ref) the rule loads the corresponding inventory position in one GraphQL API request. The rule then adds all the following information into event attributes and produces one `SendEventAction` with the event `{eventName}`.| Event Attribute Key | Event Attribute Value |
`type` | `entitySubtype`, if undefined (null) sets to `DEFAULT` |
`ref` | `<productRef>:<locationRef>:type` |
`qty` | inventoryPosition.qty (from incoming event attributes) |
`productRef` | inventoryPosition.productRef (from incoming event attributes) |
`locationRef` | inventoryPosition.locationRef (from incoming event attributes) |
`inventoryPositionStatus` | inventoryPosition.status from GraphQL query*, otherwise set to CREATED |
`inventoryPositionRef` | inventoryPosition.ref from GraphQL query*, otherwise generated to `<productRef>:<locationRef>:type` |
`inventoryPositionOnHand` | inventoryPosition.onHand from GraphQL query*, otherwise set to 0 |
`inventoryPositionExists` | TRUE if position exists, FALSE if position doesn't exist |
`correctedQty` | inventoryPosition.correctedQty (from incoming event attributes) - UNUSED |
`inventoryQuantityExists` | TRUE if quantity exists, FALSE if quantity doesn't exist |
`inventoryQuantityTypes` | The List<String> of all the inventory quantity types that exist for the given inventory position. Currently, the rule is restricted to picking only LAST_ON_HAND Inventory Quantity type for performance reasons |
Version History
See previous versions
2024-07-04
v24.7.4
Refers to the Product Release Version2023-11-02
