Fluent Commerce Logo
Docs
Sign In

DownToInventoryPositionIfExists

Rule

Changed on:

11 Sept 2024

Overview

Forward `{eventName}` if the position exists.

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

Accepts

  • INVENTORY_CATALOGUE

Actions

Rule parameters

Parameter

Type

Description

`eventType`

String

The name of to be triggered

Event attributes

Parameter

Description

Data Type

Required?

`inventoryPositionExists`

If the position exists.

Boolean

Yes

`inventoryPositionRef`

The associated position ref.

String

Yes

Exceptions

This 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}

Detailed Technical Description

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

Version History

2023-07-28

v2.0.0

refers to