ForwardIfPickupLocationValid

Rule

Changed on:

10 Apr 2024

Overview

The rule sends an event if the pickup location is part of the network specified and matches the specified location status.

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 event “eventName”if the pickup location is inside of the network “networkRef” and in the status “locationStatuses”.

Accepts

ORDER
FULFILMENT_CHOICE

Actions

Sends an event if the pickup location (
```
`pickupLocationRef`
```
) exists and it is part of the eligible network.

Rule parameters

Parameter	Description
eventName	The name of the event to be triggered
networkRef	The network ref from which the locations will be retrieved
locationStatuses	The location statuses which will be considered

Event attributes

This rule does not directly identify any event attributes.

Exceptions

This rule does not directly throw any exception.

Configuration example

1      {
2          "name": "{{account}}.order.ForwardIfPickupLocationValid",
3          "props": {
4            "locationStatuses": ["ACTIVE"],
5            "networkRef": "{{network.ref}}",
6            "eventName": "ProcessOrder"
7          }
8        }

Language: json

Version History

2024-04-00

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.