Fluent Commerce Logo
Docs
Sign In

ForwardIfPickupLocationValid

Rule

Changed on:

10 Apr 2024

Overview

The sends an if the pickup is part of the specified and matches the specified status. 

Plugin NameOrder Reference Module
Namespace[[account.id]].order

The is the foundation for order-related implementations. It provides reference workflows for , 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 to be triggered

networkRef

The ref from which the locations will be retrieved

locationStatuses

The statuses which will be considered

Event attributes

This does not directly identify any attributes.

Exceptions

This 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        }

Version History

2024-04-00

v1.0.0

refers to