UpdateInventoryQuantity
Rule
Changed on:
12 Aug 2025
Overview
Updates an inventory quantity of type {type} using the 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
Updates an inventory quantity of type {type} using the event attributes.
Accepts
- INVENTORY_POSITION
Actions
- This rule produces a MutationAction that updates the inventory quantity of the corresponding type and inventory position.
Rule parameters
| Parameter | Type | Description |
`type` | String | The type of the inventory quantity to be updated. |
Event attributes
| Parameter | Description | Data Type | Required? |
`inventoryPositionRef` | Inventory position reference that the Inventory Quantity is related to | String | Yes |
`qty` | Quantity for the Inventory Quantity to be updated to | Integer | Yes |
`condition` | Condition for the Inventory Quantity to be updated to | String | Yes |
`expectedOn` | Expected date for the Inventory Quantity to be updated to | Date (ISO-8601 format) | No |
`storageAreaRef` | Storage area for the Inventory Quantity to be updated to | String | No |
`inventoryQuantity` | inventoryQuantityUpdate | [InventoryQuantity] | No |
InventoryQuantity sub-attribute
| 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 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.UpdateInventoryQuantity",
3 "props": {
4 "type": "LAST_ON_HAND"
5 }
6}