Fluent Commerce Logo
Docs
Sign In

DownToInventoryPositionIfExists

Rule

Changed on:

11 Sept 2024

Overview

Forward event

`{eventName}`
if the inventory position exists.

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 position exists.

Accepts

  • INVENTORY_CATALOGUE

Actions

Rule parameters

Parameter

Type

Description

`eventType`

String

The name of event to be triggered

Event attributes

Parameter

Description

Data Type

Required?

`inventoryPositionExists`

If the inventory position exists.

Boolean

Yes

`inventoryPositionRef`

The associated inventory position ref.

String

Yes

Exceptions

This rule will throw a RubixException if 

`eventName`
 property is not provided.

Configuration example

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

Language: json

Detailed Technical Description

The rule checks the value of 

`inventoryPositionExists`
 from incoming event attributes. If 
`inventoryPositionExists`
 is true, it will forward the event with name 
`{eventName}`
 to the corresponding inventory position which is identified by the
`inventoryPositionRef`
.
If the
`entitySubtype`
is available in the event it will be used in the new event, otherwise
`eventSubtype`
will default to
`DEFAULT`
.

Version History

2023-07-28

v2.0.0

refers to plugin