ChangeOrderDeliveryAddress
Changed on:
28 Nov 2023
Overview
The rule changes the order delivery address and creates a comment for the order.
| 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
Change the order delivery address and create a comment for the order with the following template:"Customer Address changed from <%s> to <%s>"
Accepts
- ORDER
Actions
- This rule triggers UpdateCustomerAddressMutation, which updates the order's delivery address, and CreateCommentMutation if changeReason exists.
Rule parameters
This rule does not directly identify any parameters.
Event attributes
Parameter | Description | Data Type | Required? |
deliveryAddress | New delivery address of the order | ADDRESS | Required |
changeReason | Reason for changing the delivery address | String | No |
Exceptions
This rule may result in the following exceptions:
IllegalArgumentException: When
`deliveryAddress`Configuration example
1{
2 "name":"<ACCOUNTID>.order.ChangeOrderDeliveryAddress",
3 "props":{}
4}Language: json
Version History
v1.0.0
refers to plugin
