LoadInventoryPositionData
Changed on:
17 Feb 2025
Overview
Send an inline event including the
`inventoryPositionExists`This Rule is a simplified version of the `LoadInventoryPosition`
- Retrieving Inventory Quantity data of type in status
`LAST_ON_HAND`or`ACTIVE``CREATED` - Setting and forwarding the flag (true or false)
`inventoryQuantityExists`
| 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
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 |
| | The name of the event to be triggered |
Event attributes
Name | Type | Description | Required? |
| | 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 |
| | The Reference of the Inventory Position | No |
| | The Type of the Inventory Position. | No Unused because the Inventory Position Type is inherited from the Inventory Catalog Sub Type. |
| | The Reference of the Variant Product associated to the Inventory Position | Yes |
| | The Reference of the Location associated to the Inventory Position | Yes |
| | The quantity | Yes |
| | The quantity value of the Inventory Quantity of the | No, unused |
| | The Object that contains the Inventory Quantity specific data. See the Sub-attributes below. | No |
InventoryQuantityUpdate Object Sub-attributes
Name | Type | Description | Required |
| | The Reference of the Inventory Quantity | No |
| | The quantity value of the Inventory Quantity | No |
| | The Type of the Inventory Quantity | No |
| | The Status of the Inventory Quantity | No |
| | The following attributes are supported:
| No |
Exceptions
- This Rule throws a when the Rule parameter(s) is not provided.
`PropertyNotFoundException`
- This Rule throws an when the required Event attribute(s) is not provided.
`EventAttributeNotFoundException`
Configuration example
1{
2 "name": "[[account.id]].globalinventory.LoadInventoryPosition",
3 "props": {
4 "eventName": "CheckInventoryPositionExists"
5 }
6}Language: json
Detailed Technical Description
This Rule execution includes the following steps:
1. Validate that:
- The Rule parameter has been provided
`eventName` - The mandatory Event attributes have been provided:
- and its Sub-attributes:
`inventoryPosition``productRef``locationRef``qty`
2. Load the Inventory Position in one GraphQL API request based on the following:
- Inventory Position Reference
The value is taken from theSub-attribute.`inventoryPosition.ref` - 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``{eventName}`Event Attribute Key | Event Attribute Value |
|
|
| |
| |
| |
| |
| |
|
|
|
|
|
|
|
|
*The first option will occur when the Inventory Position already exists; otherwise, the second option will occur.
Version History
v25.2.18
Refers to the Product Release Version.
