CreateInventoryQuantity
Changed on:
29 Aug 2024
Overview
Create an quantity based on the incoming 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
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 |
| The type of the quantity that will be created. |
Event attributes
Parameter | Description | Data Type | Required? |
| The associated position ref | String | Yes |
| The quantity value of the Quantity | Integer | Yes |
| The date when the quantity is expected to be available | Date (ISO-8601 format) | No |
| The ref of the storage area where the quantity will be located | String | No |
| The condition of the quantity | String | No |
| of the Position | String | No |
| inventoryQuantityUpdate | [InventoryQuantity] | No |
InventoryQuantity sub-attributes
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
`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 quantity based on the incoming attributes.
If the quantity reference is not provided as `inventoryQuantity.ref`, the reference for the new quantity is created by combining the position reference, a colon, and the quantity type. For example, if the position reference is `PRD:LOC:DEFAULT` and the quantity type is 'SALE', the quantity reference will be `PRD:LOC:DEFAULT:SALE`.
Version History
v2.0.0
refers to
