Docs

Search

Sign In

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

CreateInventoryQuantity

Rule

Changed on:

29 Nov 2023

Overview

Create an inventory quantity based on the incoming 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 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

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
type	Inventory quantity type

Event attributes

Parameter	Description	Data Type	Required?
inventoryPositionRef	The associated inventory position ref	String	Required
qty	The quantity value of the Inventory Quantity	Integer	Required
expectedOn	The date when the quantity is expected to be available	`java.util.Date` OR String(Formatted in ISO_8601)	Optional
storageAreaRef	The ref of the storage area where the quantity will be located	String	Optional
condition	The condition of the quantity	String	Optional

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 optional
```
`expectedOn`
```
value is a String and cannot be parsed to a valid date, InvalidAttributeValueException will be thrown. In case some other object other than a
```
`java.util.Date`
```
or
```
`java.lang.String`
```
object is passed as
```
`expectedOn`
```
value, InvalidAttributeTypeException will be thrown.

Configuration example

1{
2  "name": "{{accountId}}.globalinventory.CreateInventoryQuantity",
3  "props": {
4    "type":"SALE"
5  }
6}

Language: json

Detailed Technical Description

Creates an inventory quantity based on the incoming event attributes. The

`ref`

of the new inventory quantity being created is derived by concatenating inventory position ref, a colon, and inventory quantity type. E.g.: inventory position ref = "IVP_REF" and quantity type = "SALE", the inventory quantity ref will be

`IVP_REF:SALE`

Version History

2023-07-28

v2.0.0

refers to plugin

Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.