Fluent Commerce Logo
Docs
Sign In

FilterLocationsByRadius

Rule

Changed on:

30 Nov 2023

Overview

The rule finds locations which are outside the radius provided in the event attribute.

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

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 event name triggered by this rule

Event attributes

Parameter

Description

Data Type

Required?

locations

The Map of location objects with distance property

Map

Required

attributes

The list of attributes. This rule needs 

`radius`
 attribute

List of Attributes

Optional

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}

Language: json

Version History

2023-08-04

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