Fluent Commerce Logo
Docs
Sign In

NotifyInventoryCatalogueForProduct

Rule

Changed on:

2 Nov 2023

Overview

Send {eventName} event with productRef attribute to the {inventoryCatalogueRef} inventory catalogue with retailer id {retailerId}

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

Send {eventName} event with productRef attribute to the {inventoryCatalogueRef} inventory catalogue with retailer id {retailerId}

Accepts

  • PRODUCT

Actions

  • This rule produces a SendEventAction that forwards the incoming event as a scheduled event with the given name {eventName} to the inventory catalogue with ref {inventoryCatalogueRef}

Rule parameters

Parameter

Description

eventName

The name of the event to be sent to the inventory catalogue

inventoryCatalogueRef

The reference of the inventory catalogue

retailerId

retailerId

Event attributes

This rule has no Event Attributes.

Exceptions

If 

`{eventName}`
 rule property or 
`{inventoryCatalogueRef}`
 rule property are not set in the workflow, a PropertyNotFoundException will be thrown

Configuration example

1{
2  "name": "FLUENTRETAIL.globalinventory.NotifyInventoryCatalogueForProduct",
3  "props": {
4    "eventName": "VariantProductStatusChanged",
5    "inventoryCatalogueRef": "INVT_CATALOGUE_123",
6    "retailerId": "1"
7  }
8}

Language: json

Detailed Technical Description

This rule creates an inventory catalogue event using 

`{inventoryCatalogueRef}`
 as the event's entity ref and 
`{retailerId}`
 as the event's retailer ID when the rule parameter presents. When the optional rule parameter doesn't present, the retailer ID from the incoming event will be used to construct the event. It adds the following two event attributes to the generated event. - 
`productRef`
 attribute with the value 
`{entityRef}`
 of incoming event - 
`productType`
 attribute with the value 
`{entitySubtype}`
 of incoming event

Version History

2023-08-02

v2.0.0

refers to the 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