LoadInventoryPosition
Changed on:
26 May 2025
Overview
Forward `{eventName}` () with the 'inventoryPositionExists' set to true or false if the position exists or not respectively.
| Plugin Name | Inventory Reference Module |
|---|---|
| Namespace | [[account.id]].globalinventory |
The is the foundation for 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 Module includes the following areas:
- 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 |
|
| The name of to be triggered |
Event attributes
Name | Type | Description | Required? |
| InventoryPosition | One single item of batch request | Yes |
InventoryPosition sub-attributes
Parameter | Description | Data Type | Required? |
| ref | String | No, unused |
| The position type | String | No, unused |
| The ref of the variant product associated to the position | String | No |
| The ref associated to the position | String | No |
| The quantity | Integer | No |
| corrected quantity | Integer | No, unused |
| inventoryQuantityUpdate | [InventoryQuantity] | No |
InventoryQuantity sub-attributes
Parameter | Description | Data Type | Required? |
| Quantity ref | String | No |
| Quantity type | String | No |
| Quantity | Integer | No |
| Status | String | No |
Exceptions
This 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 position `ref` (from batch) and catalogue ref (from ref) the loads the corresponding position in one API request. The then adds all the following information into attributes and produces one `SendEventAction` with the `{eventName}`.
Event Attribute Key | Event Attribute Value |
|
|
| |
| inventoryPosition.qty (from incoming attributes) |
| inventoryPosition.productRef (from incoming attributes) |
| inventoryPosition.locationRef (from incoming attributes) |
| inventoryPosition.status from query*, otherwise set to CREATED |
| inventoryPosition.ref from query*, otherwise generated to |
| inventoryPosition.onHand from query*, otherwise set to 0 |
| TRUE if position exists, FALSE if position doesn't exist |
| inventoryPosition.correctedQty (from incoming attributes) - UNUSED |
| TRUE if quantity exists, FALSE if quantity doesn't exist |
| The List<String> of all the quantity types that exist for the given position. Currently, the is restricted to picking only LAST_ON_HAND Quantity type for performance reasons |
*The first option will occur when an Position already exists, otherwise the second option will occur.
Version History
v24.8.15
Refers to the Product Release Version
v24.7.4
Refers to the Product Release Version
v1.0.0
refers to the
