Fluent Commerce Logo
Docs
Sign In

ForwardIfLocationStatusEquals

Rule

Changed on:

28 Nov 2023

Overview

Forwards an event if the location has a different status compared to the inventory position and the location status is the same as the given {status} in the input parameters

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

Forwards an event if the location has a different status compared to the inventory position and the location status is the same as the given {status} in the input parameters

Accepts

  • INVENTORY_POSITION

Actions

  • This rule produces a SendEventAction that will send an inline event

Rule parameters

Parameter

Description

eventName

The name of event to be triggered

status

Expected location status

Event attributes

Not Applicable for this rule.

Exceptions

If 

`eventName`
 rule property and 
`status`
 are not set in the workflow, a PropertyNotFoundException will be thrown.

Configuration example

1{
2  "name": "FLUENTRETAIL.globalinventory.ForwardIfLocationStatusEquals",
3  "props": {
4    "eventName": "event name",
5    "status" : "predefined status"
6  }
7}

Language: json

Detailed Technical Description

This rule queries a location for a given inventory position, it then sends an inline event of 

`{eventName}`
 only if the location status does not equal the current inventory position status and the location status is the same as the 
`{status}`
 given in the input parameters.

Version History

2023-08-02

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.

Fluent Logo