Fluent Commerce Logo
Docs
Sign In

DownToCategory

Rule

Changed on:

2 Jan 2024

Overview

Forward the incoming event with event name {eventName} to the category entity with the provided ref

Plugin NameInventory Reference Module
Namespace{{accountId}}.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 Modules includes the following areas:

  • Inventory Catalogue workflow
  • Virtual Catalogue workflow
  • Control Group workflow
  • Product Catalogue workflow

UI Description

Forward the incoming event with event name {eventName} to the category entity with the provided ref

Accepts

  • PRODUCT_CATALOGUE

Actions

  • This rule produces a SendEventAction that forwards the incoming event as an inline event with the given name {eventName} to the category entity with {ref} event attribute value.

Rule parameters

Parameter

Description

eventName

The name of the event to be triggered

Event attributes

Parameter

Description

Data Type

Required?

ref

The ref of the category

String

Required

Exceptions

If 

`eventName`
 rule property is not set in the workflow, a PropertyNotFoundException will be thrown

Configuration example

1{
2  "name": "<AccountID>.globalinventory.DownToCategory",
3  "props": {
4    "eventName": "CheckCategoryStatusChange"
5  }
6}

Language: json

Detailed Technical Description

This rule will produce an inline event with 

`{eventName}`
 to the category with 
`{ref}`
 event attribute value. The subtype of the new event is set to 
`DEFAULT`
.

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