ChangeOrderDeliveryAddress

Rule

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	{{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.

Order Reference Module

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`

is missing or cannot retrieve the order's delivery address.

Configuration example

1{
2   "name":"<ACCOUNTID>.order.ChangeOrderDeliveryAddress",
3   "props":{}
4}

Language: json

Version History

2023-08-03

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.