UpdateInventoryQuantity

Rule

Changed on:

13 Nov 2023

Overview

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

Plugin Name	Inventory Reference Module
Namespace	{{accountId}}.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 Modules includes the following areas:

Inventory Catalogue workflow
Virtual Catalogue workflow
Control Group workflow
Product Catalogue workflow

Inventory Reference Module

The inventory Modules includes the following areas:

Inventory Catalogue workflow
Virtual Catalogue workflow
Control Group workflow
Product 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 will update the inventory quantity identified by inventory position reference and inventory quantity reference

Rule parameters

Parameter	Description
type	The type of the inventory quantity to be updated by the rule

Event attributes

Parameter	Description	Data Type	Required?
inventoryPositionRef	Inventory position reference that the Inventory Quantity is related to	String	Required
qty	Quantity for the Inventory Quantity to be updated to	Integer	Required
condition	Condition for the Inventory Quantity to be updated to	String	Optional
expectedOn	Expected Date for the Inventory Quantity to be updated to	java.util.Date OR String(Formatted in ISO_8601)	Optional
storageAreaRef	Storage area for the Inventory Quantity to be updated to	String	Optional

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 value is something other than a
```
`java.lang.String`
```
or a
```
`java.util.Date`
```
, InvalidAttributeTypeException (subclass of RubixException) will be thrown

Configuration example

1{
2  "name": "FLUENTRETAIL.globalinventory.UpdateInventoryQuantity",
3  "props": {
4    "type": "LAST_ON_HAND"
5  }
6}

Language: json

Detailed Technical Description

Note

This rule does not take inventory quantity reference from event attributes. Instead, it derives the inventory quantity reference by following the convention below. Inventory position reference (received from incoming event attributes) + : + inventory quantity type (received from workflow rule input parameters) E.g.:

`IVT_REF:LAST_ON_HAND`

Based on the inventory position ref (from event attributes) and inventory quantity type (from workflow rule input parameters) the rule derives the inventory quantity ref by concatenating inventory position ref, a colon and inventory quantity type. Then it constructs a GraphQL Mutate action to update the following attributes if they are present in the incoming event attributes:

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

Version History

2023-08-03

v2.0.0

refers to plugin