Fluent Commerce Logo
Docs
Sign In

ResolveFulfilmentChoiceCoordinates

Rule

Changed on:

29 Nov 2023

Overview

The rule resolves the longitude and latitude of the fulfilment choice delivery address. It sends specific event depending on whether the coordinates could be resolved or not.

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

Resolves the longitude and latitude of the delivery based on its address. It sends the event with the name “validAddress” if the coordinates could be resolved, or it sends the event with the name “invalidAddress” if coordinates could not be resolved.

Accepts

  • FULFILMENT_CHOICE

Actions

  • This rule resolves the longitude and latitude of the delivery address and sends the event with the name validAddress if the coordinates could be resolved or it sends another event with the name invalidAddress if coordinates could not be resolved.

Rule parameters

Parameter

Description

validAddress

Event to be triggered in case of valid address

invalidAddress

Event to be triggered in case of invalid address


Event attributes

Parameter

Description

Data Type

Required?

fulfilmentChoiceRef

Reference to the fulfilment choice

String

Required

Exceptions

This rule does not directly throw any exception.

Configuration example

1{
2 "name": "<ACCOUNTID>.order.ResolveFulfilmentChoiceCoordinates",
3    "props": {
4        "validAddress": "ProcessOrder",
5        "invalidAddress": "ProcessError"
6    }
7}

Language: json

Detailed Technical Description

  • Get 
    `fulfilmentChoiceRef`
     from incoming event attributes (fulfilmentChoiceRef).
  • Get 
    `fulfilmentChoice`
     by 
    `fulfilmentChoiceRef`
     via GQL query.
  • Get 
    `deliveryAddress`
     from the 
    `fulfilmentChoice`
    .
  • Send 
    `validAddress`
     event if the coordinates are valid or 
    `invalidAddress`
     event on condition that the coordinates are invalid.

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