ValidateAppeasementAmount
Changed on:
30 Nov 2023
Overview
The rule validates that appeasement amount does not exceed the original total order price.
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
Validates that appeasement amount does not exceed the original total order price.
Accepts
- ORDER
Actions
- This rule produces an IllegalArgumentException exception in case of failure and no action if validation passes.
Rule parameters
This rule does not directly identify any input parameters.
Event attributes
Parameter | Description | Data Type | Required? |
appeasementAmount | The appeasement amount | AppeasementAttributes object | Required |
appeasementReason | The appeasement reason | AppeasementAttributes object | Required |
comment | The comment of appeasement | AppeasementAttributes object | Required |
Exceptions
This rule will throw an IllegalArgumentException
- if order or entity id is not found
- if totalPrice for order is null
- if appeasement amount is not a positive numeric value or if appeasement amount is more than totalPrice of order
All generated exceptions will be wrapped with RubixException: 422.
Configuration example
1{
2 "name": "<ACCOUNTID>.order.ValidateAppeasementAmount",
3 "props": {}
4}
Language: json
Version History
v1.1.0
refers to plugin