Fluent Commerce Logo
Docs

FilterLocationsByRadius

Rule

Changed on:

8 Aug 2025

Overview

The rule finds locations which are outside the radius provided in the event attribute.
Plugin NameOrder 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.

UI Description

Filters locations which are outside of the radius provided in the event attribute. Sends event {eventName}.

Accepts

  • ORDER
  • FULFILMENT_OPTIONS

Actions

  • This rule finds locations which are outside the radius provided in the event attribute and forwards the input event with name eventName with location attribute

Rule parameters

ParameterDescription
eventNameThe event name triggered by this rule

Event attributes

ParameterDescriptionData TypeRequired?
locationsThe Map of location objects with distance propertyMapRequired
attributesThe list of attributes. This rule needs `radius` attributeList of AttributesOptional

Exceptions

This rule does not explicitly identify any exceptions.

Configuration example

1{
2  "name":"<ACCOUNTID>.order.FilterLocationsByRadius",
3  "props": {
4    "eventName":"UPDATE_ORDER"
5  }
6}

Version History

2023-08-04

v1.0.0

refers to plugin