SendEventOnVerifyingConsignment

Rule

Changed on:

28 Nov 2023

Overview

The rule verifies if the incoming consignment entity has the label URL and the consignment status from input parameter is a success or failure and sends an event.

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

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.

UI Description

Sends an event {eventName} on verifying the consignment {BookingStatus}.

Accepts

CONSIGNMENT

Actions

This rule produces and sends an event eventName for consignment.

Rule parameters

Parameter	Description
eventName	The name of event to be triggered.
BookingStatus	The status of consignment booking to verify.

Event attributes

This rule does not directly identify any event attributes.

Exceptions

This rule will throw an RubixException: 400

if couldn't find the name of event
```
`eventName`
```
to be triggered
if couldn't find the status of consignment booking
```
`BookingStatus`
```

Configuration example

1{
2  "name": "<ACCOUNTID>.order.SendEventOnVerifyingConsignment",
3  "props": {
4    "eventName":"ConsignmentBooked",
5    "BookingStatus":"LODGED"
6  }
7}

Language: json

Version History

2023-08-03

v1.0.0

refers to 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.