Docs

Search

Sign In

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

ProducePositionEventsForLocation

Rule

Changed on:

3 Nov 2023

Overview

Send a scheduled event to each inventory position using the locationRef from the event attributes.

Plugin Name	Inventory 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

Inventory Reference Module

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

Send a scheduled event to each inventory position using the locationRef from the event attributes.

Accepts

INVENTORY_CATALOGUE

Actions

This rule produces a SendEventAction that sends a scheduled event with attribute retailer-id

Rule parameters

Parameter	Description
eventName	The name of event to be triggered

Event attributes

Parameter	Description	Data Type	Required?
locationRef	The associated location ref of the Inventory Position	String	Required

Exceptions

If the

`eventName`

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

Configuration example

1{
2  "name": "FLUENTRETAIL.globalinventory.ProducePositionEventsForLocation",
3  "props": {
4    "eventName": "LocationStatusChanged"
5  }
6}

Language: json

Detailed Technical Description

This rule extracts the

`locationRef`

from incoming attributes. It will send scheduled events to all inventory positions that are related to the location. The event name is given from the rule input parameters property

`{eventName}`

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.