UpdateInventoryQuantity

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Rule

Changed on:

29 Aug 2024

Overview

Updates an inventory quantity of type {type} using the event attributes.

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

Inventory Reference Module

The Inventory Module includes the following areas:

Product Catalog workflow
Inventory Catalog workflow
Control Group workflows
Virtual Catalog workflows

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}

Language: json

Detailed Technical Description

Note

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`

If the inventory quantity type in not provided as

`inventoryQuantity.type`

, the

`{type}`

rule property will be used.

The rule will construct a MutationAction to update the inventory quantity with the following attributes (if present in the incoming event attributes):

```
`qty`
```
```
`condition`
```
```
`expectedOn`
```
```
`storageAreaRef`
```

Version History

2023-08-03

v2.0.0

refers to plugin