EvaluateFulfilmentsForAddressChange
Changed on:
8 Aug 2025
Overview
The rule defines whether the address change is major based on the address fields that have been modified.
| Plugin Name | Order 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
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 | Event name for outgoing event. |
Event attributes
This rule does not directly identify any event attributes.
Exceptions
This rule 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}