CreateInventoryQuantity
Rule
Changed on:
12 Aug 2025
Overview
Create an inventory quantity based on the incoming event attributes| Plugin Name | Inventory Reference Module |
|---|---|
| Namespace | [[account.id]].globalinventory |
- Product Catalogue workflow
- Inventory Catalogue workflow
- Control Group workflow
- Virtual Catalogue workflow
UI Description
Create an inventory quantity based on the incoming event attributes
Accepts
- INVENTORY_POSITION
Actions
- This rule produces a MutationAction that will create an inventory quantity.
Rule parameters
| Parameter | Description |
`type` | The type of the inventory quantity that will be created. |
Event attributes
| Parameter | Description | Data Type | Required? |
`inventoryPositionRef` | The associated inventory position ref | String | Yes |
`qty` | The quantity value of the Inventory Quantity | Integer | Yes |
`expectedOn` | The date when the quantity is expected to be available | Date (ISO-8601 format) | No |
`storageAreaRef` | The ref of the storage area where the quantity will be located | String | No |
`condition` | The condition of the quantity | String | No |
`locationRef` | Location of the Inventory Position | String | No |
`inventoryQuantity` | inventoryQuantityUpdate | [InventoryQuantity] | No |
InventoryQuantity sub-attributes
| Parameter | Description | Data Type | Required? |
`ref` | The reference of the inventory quantity | String | No |
`type` | The type of the inventory quantity | String | No |
`qty` | The quantity value of the inventory quantity | Integer | No |
`status` | The status of the inventory quantity | String | No |
Exceptions
- This rule will throw a PropertyNotFoundException, which is a subclass of RubixException, if the type property is not provided.
- If
`inventoryPositionRef`or`qty`values are not provided, EventAttributeNotFoundException (subclass of RubixException) will be thrown. If the`qty`is not an integer, InvalidAttributeTypeException will be thrown. - If the
`expectedOn`value cannot be parsed to valid date (or null), InvalidAttributeValueException(subclass of RubixException) will be thrown. If the type of the value cannot be identified, InvalidAttributeTypeException (subclass of RubixException) will be thrown
Configuration example
1{
2 "name": "[[account.id]].globalinventory.CreateInventoryQuantity",
3 "props": {
4 "type":"SALE"
5 }
6}Detailed Technical Description
Creates an inventory quantity based on the incoming event attributes.If the inventory quantity reference is not provided as
`inventoryQuantity.ref`, the reference for the new inventory quantity is created by combining the inventory position reference, a colon, and the inventory quantity type. For example, if the inventory position reference is `PRD:LOC:DEFAULT` and the quantity type is 'SALE', the inventory quantity reference will be `PRD:LOC:DEFAULT:SALE`.