UpdateInventoryQuantity
Changed on:
29 Aug 2024
Overview
Updates an quantity of type {type} using the attributes.
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
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 |
| String | The type of the quantity to be updated. |
Event attributes
Parameter | Description | Data Type | Required? |
| position reference that the Quantity is related to | String | Yes |
| Quantity for the Quantity to be updated to | Integer | Yes |
| Condition for the Quantity to be updated to | String | Yes |
| Expected date for the Quantity to be updated to | Date (ISO-8601 format) | No |
| Storage area for the Quantity to be updated to | String | No |
| inventoryQuantityUpdate | [InventoryQuantity] | No |
InventoryQuantity sub-attribute
Parameter | Description | Data Type | Required? |
| The reference of the quantity | String | No |
| The type of the quantity | String | No |
| The quantity value of the quantity | Integer | No |
| The status of the 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}
Detailed Technical Description
Version History
v2.0.0
refers to