Fluent Commerce Logo
Docs
Sign In

EvaluateFulfilmentsForAddressChange

Rule

Changed on:

30 Nov 2023

Overview

The defines whether the address change is major based on the address fields that have been modified.

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

Defines whether the address change is major based on the address fields that have been modified.

Accepts

  • ORDER

Actions

  • This rule produces a sentEvent action

Rule parameters

Parameter

Description

majorAddressChangeFields

Comma-separated values with the address fields used to determine a major change.

eventName

name for outgoing .

Event attributes

This does not directly identify any attributes.

Exceptions

This will throw an IllegalArgumentException

  • if the `accountId/retailerId/orderId/eventName` property is not provided
  • if `MAJOR_ADDRESS_CHANGE_FIELDS` setting and `majorAddressChangeFields` prop not found or if setting invalid
  • if `deliveryAddress` of the order or deliveryAddress in the incoming event are not found
  • if invalid address field
  • if error comparing field address

All generated exceptions will be wrapped with RubixException: 422.

Configuration example

1{
2  "name": "<ACCOUNTID>.order.EvaluateFulfilmentsForAddressChange",
3  "props": {
4    "eventName": "Event name for outgoing event",
5    "majorAddressChangeFields": "city, state"
6  }
7}

Version History

2023-08-04

v1.0.0

refers to