Fluent Commerce Logo
Docs
Sign In

NotifyFulfilmentsInWave

Rule

Changed on:

2 Nov 2023

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

Properties

Type

Description

eventName

`string`

The name of the outgoing event sent for each Fulfilment

Event attributes

Name

Type

Required?

Default

Description

allFulfilmentArticles

`allFulfilmentArticles`
 OR 
`Map<Number,List<ArticleDetails>>`

Yes

N/A

The details of all the Articles packed by the Store associate which are keyed by the Fulfilment.id they relate to within a Wave.

fulfilmentArticles

Array of 

`ArticleDetails`

No

N/A

If the rule is used during the packing step, then the dimensions and weight specified by the Store Associate are sent.

Attribute Types

ArticleDetails

Name

Type

Required?

Description

packaging_name

`string`

Yes

The name of an article belonging to Fulfilments in a Wave.

length

`string`

Yes

The length of an article in cm.

width

`string`

Yes

The width of an article in cm.

height

`string`

Yes

The height of an article in cm.

weight

`string`

Yes

The weight of an article in kg.

maxWeight

`string`

No

The maximum weight of an article.

Configuration example

1N/A

Language: json

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

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