Fluent Commerce Logo
Docs
Sign In

FilterLocationsByRadius

Rule

Changed on:

30 Nov 2023

Overview

The finds locations which are outside the radius provided in the .

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

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

Parameter

Description

eventName

The name triggered by this

Event attributes

Parameter

Description

Data Type

Required?

locations

The Map of objects with distance property

Map

Required

attributes

The list of attributes. This needs `radius` 

List of Attributes

Optional

Exceptions

This 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