Fluent Commerce Logo
Docs
Sign In

NotifyInventoryCatalogueForProduct

Rule

Changed on:

2 Nov 2023

Overview

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

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

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 to be sent to the catalogue

inventoryCatalogueRef

The reference of the catalogue

retailerId

retailerId

Event attributes

This has no Attributes.

Exceptions

If `{eventName}`  property or `{inventoryCatalogueRef}`  property are not set in the , 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}

Detailed Technical Description

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

Version History

2023-08-02

v2.0.0

refers to the