Fluent Commerce Logo
Docs
Sign In

ForwardIfInventoryQuantityOfTypeNotExists

Rule

Changed on:

25 Aug 2024

Overview

Conditionally trigger another Ruleset when the Inventory Quantity of the specified type does NOT exist.

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

UI Description

Forward event {eventName} if the inventory quantity of the type {type} does NOT exist.

Accepts

  • INVENTORY_POSITION

Actions

Rule parameters

Name

Type

Description

`eventName`

`String`

The name of event to be triggered if inventory quantity of the specified type does not exist

`type`

`String`

Inventory quantity type

Event attributes

Name

Type

Description

Required?

inventoryQuantityExists

Boolean

Indicates if the inventory quantity exists or not

Optional

inventoryQuantityTypes

List<String>

All the inventory quantity types that exist for the given inventory position

Optional

Exceptions

This rule does NOT throw any exceptions.

Configuration example

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

Language: json

Detailed Technical Description

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

The Rule condition is defined by the existence of the Inventory Quantity of

`type`
parameter. When the Rule condition is met, the Event 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