Fluent Commerce Logo
Docs
Sign In

ForwardIfInventoryQuantityOfTypeExists

Rule

Changed on:

29 Aug 2024

Overview

Conditionally another when the Position and Quantity of the specified type exist.

Plugin NameInventory 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

Forward event {eventName} if the inventory position and quantity of {type} exists.

Accepts

  • INVENTORY_POSITION

Actions

Rule parameters

Name

Type

Description

`eventName`

`String`

The name of to be triggered if position and quantity exists

`type`

`String`

Type of the quantity

Event attributes

Name

Type

Description

Required

`inventoryQuantityExists`

Boolean

Indicates if the quantity exists or not

No

`inventoryQuantityTypes`

List<String>

All the quantity types that exist for the given position

No

`inventoryPostionRef`

String

The reference of the position

No

Exceptions

This does NOT throw any exceptions.

Configuration example

1{
2  "name": "[[account.id]].globalinventory.ForwardIfInventoryQuantityOfTypeExists",
3  "props": {
4    "eventName": "BatchInventoryPositionUpdate",
5    "type": "LAST_ON_HAND"
6  }
7}

Detailed Technical Description

This will conditionally produce a SendEventAction with entitySubtype derived from {entitySubtype}. If {entitySubtype} is null, entitySubtype would be hardcoded to 'DEFAULT'.  

The condition is defined by the existence of the Position and Quantity of `type` parameter. When the condition is met, the will be produced with a name defined by the `eventName` parameter.

Version History

2024-07-04

v24.7.4

Refers to the Product Release Version