Fluent Commerce Logo
Docs
Sign In

SplitInventoryUpdates

Rule

Changed on:

25 Aug 2024

Overview

Notifies the inventory positions of the incoming updates with event {eventName}

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

Notifies the inventory positions of the incoming updates with event {eventName}

Accepts

  • INVENTORY_CATALOGUE

Actions

  • This rule sends an individual event for each InventoryPosition record sent to the event up to the first 1000 records passed in the attributes.

Rule parameters

Parameter

Description

Notes

eventName

The name of the event to be triggered

Required

Event attributes

Parameter

Description

Data Type

Required?

InventoryUpdates

Array of InventoryPosition records to be updated

[InventoryPosition]

No

InventoryPosition sub-attributes

Parameter

Description

Data Type

Required?

ref

ref

String

No

type

The inventory position type

String

No

productRef

The ref of the variant product associated to the inventory position

String

No

locationRef

The location ref associated to the inventory position

String

No

qty

The quantity

Integer

No

correctedQty

corrected quantity

Integer

No

Exceptions

Exceptions will be thrown if attributes in the incoming event are missing or an event name is missing in a given workflow.

Configuration example

1{
2  "name": "globalinventory.SplitInventoryUpdates",
3  "props": {
4    "eventName": "InventoryChanged"
5  }
6}

Language: json

Detailed Technical Description

This rule parses/deserialises an 

`InventoryUpdates`
 event attribute into a list of 
`InventoryPosition`
 objects, then it produces 
`SendEventActions`
 for each individual 
`InventoryPosition`
 to create multiple new outgoing events for all inventory positions at 
`INVENTORY_CATALOGUE`
 level with the given event name.

InventoryPosition DTO Definition
1    public class InventoryPosition {
2
3        private String ref;
4        private String productRef;
5        private String locationRef;
6        private Integer qty;
7        private Integer correctedQty;
8        private String type;
9}

Language: java

Name: InventoryPosition

Description:

[Warning: empty required content area]


Version History

2023-08-03

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