SendEventOnVerifyingAllOrderItemsProcessed

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Rule

Changed on:

29 Nov 2023

Overview

The rule sends an event to current Order when for all items in the Order, sum of

`filledQty`

of fulfilments in defined statuses,

`rejectedQty`

of fulfilments in defined statuses and

`requestedQty`

of fulfilments in defined statuses matches the

`requestedQty`

of the Items in the Order.

Plugin Name	Order Reference Module
Namespace	[[account.id]].order

The Order Reference Module is the foundation for order-related implementations. It provides reference workflows for click & collect, home delivery and mixed baskets and those needed to build your own. Extensible by design, use this Module as a base to build a solution to your customers' needs.

Order Reference Module

UI Description

Sends an event to current Order when for all items in the Order, sum of 'filledQty' of fulfillments in statuses defined in parameter {filledQtyStatuses}, 'rejectedQty' of fulfillments in statuses defined in parameter {rejectedQtyStatuses} and 'requestedQty' of fulfillments in statuses defined in parameter {requestedQtyStatuses} matches the 'requestedQty' of the Items in the Order.

Accepts

ORDER

Actions

This rule produces a sendEvent action for order.

Rule parameters

Parameter	Description
eventName	The name of event to be triggered.
filledQtyStatuses	List of fulfilment status for which `filledQty` of the Fulfilment should be considered as processed.
rejectedQtyStatuses	List of fulfilment status for which `rejectedQty` of the Fulfilment should be considered as processed.
requestedQtyStatuses	List of fulfilment status for which `requestedQty` of the Fulfilment should be considered as processed.

Event attributes

This rule does not directly identify any event attributes.

Exceptions

This rule will throw an IllegalArgumentException if

`entityType`

is not supported.

Configuration example

1{
2  "name": "<ACCOUNTID>.order.SendEventOnVerifyingAllOrderItemsProcessed",
3  "props": {
4    "eventName": "The name of event to be triggered",
5    "filledQtyStatuses": "List of fulfilment status for which `filledQty` of the Fulfilment should be considered as processed",
6    "rejectedQtyStatuses": "List of fulfilment status for which 'rejectedQty' of the Fulfilment should be considered as processed",
7    "requestedQtyStatuses": "List of fulfilment status for which 'requestedQty' of the Fulfilment should be considered as processed"
8  }
9}

Language: json

Version History

2023-08-03

v1.0.0

refers to plugin