Fluent Commerce Logo
Docs
Sign In

ForwardIfPickupLocationNotValid

Rule

Changed on:

10 Apr 2024

Overview

The rule sends an event if the pickup location is not part of the network specified or doesn’t match the specified location status. 

Plugin NameOrder Reference Module
Namespace{{accountId}}.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.

UI Description

Sends event “eventName”if the pickup location is outside of the network “networkRef” or not in the status “locationStatuses”.

Accepts

  • ORDER
  • FULFILMENT_CHOICE

Actions

  • Sends an event if the pickup location (
    `pickupLocationRef`
    )  doesn’t exist or it is not 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 that will be considered



Event attributes

This rule does not directly identify any event attributes.

Configuration example

1  {
2          "name": "{{account}}.order.ForwardIfPickupLocationNotValid",
3          "props": {
4            "locationStatuses": ["ACTIVE"],
5            "networkRef": "{{network.ref}}",
6            "eventName": "ProcessError"
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.

Fluent Logo