Fluent Commerce Logo
Docs

NotifyFulfilmentsInWave

Rule

Changed on:

12 Aug 2025

Overview

Sends an event to all Fulfilments in a Wave. Optionally, it can also send each event with a list of Articles and their dimensions, such as length, width, height, and weight.
Plugin NameFulfilment Reference Module
Namespace{{accountId}}.fulfilment
The Fulfilment Reference Module is the foundation for in-store operations. It provides a reference Workflow for pickpack, and shipping of orders for in-store staff. Extensible by design, use this Module as a base to build a solution to the needs of your customers.

UI Description

Sends an event to all Fulfilments in a Wave. Optionally, it can also send each event with a list of Articles and their dimensions, such as length, width, height, and weight.

Accepts

  • Wave

Actions

  • Type: sendEvent
  • Condition: Always
  • Description: Sends an event for each Fulfilment within a Wave

Rule parameters

PropertiesTypeDescription
eventName`string`The name of the outgoing event sent for each Fulfilment

Event attributes

NameTypeRequired?DefaultDescription
allFulfilmentArticles`allFulfilmentArticles` OR `Map<Number,List<ArticleDetails>>`YesN/AThe details of all the Articles packed by the Store associate which are keyed by the Fulfilment.id they relate to within a Wave.
fulfilmentArticlesArray of `ArticleDetails`NoN/AIf the rule is used during the packing step, then the dimensions and weight specified by the Store Associate are sent.

Attribute Types

ArticleDetails
NameTypeRequired?Description
packaging_name`string`YesThe name of an article belonging to Fulfilments in a Wave.
length`string`YesThe length of an article in cm.
width`string`YesThe width of an article in cm.
height`string`YesThe height of an article in cm.
weight`string`YesThe weight of an article in kg.
maxWeight`string`NoThe maximum weight of an article.

Configuration example

1N/A

Detailed Technical Description

  • Sends an event for all Fulfilments in the Wave
  • If the event attribute `allFulfilmentArticles` has a list of Articles for the Fulfilment; then that list and its details are placed into the event attribute `fulfilmentArticles`

Version History

2023-08-02

v23.8.2

refers to the plugin