UpdateRevisedOrderAttribute
Changed on:
16 Sept 2025
Overview
Update original Order attribute with link to new revised Order reference.
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
Updates original order attribute with link to new revised order reference.
Accepts
- ORDER
Actions
- This Rule produces an action that triggers a GraphQL
`updateOrder`
mutation
Rule parameters
This Rule does not identify any input parameters.
Event attributes
This Rule does not identify any event attributes.
Exceptions
This Rule will throw an IllegalArgumentException
- if the
`accountId/entityRef`
property is not provided - if the Order is not found or invalid
- if the attribute
`RevisedOrderLink`
is not found or invalid
All generated exceptions will be wrapped with RubixException: 422.
Configuration example
1{
2 "name": "[[account.id]].order.UpdateRevisedOrderAttribute"
3}
Detailed Technical Description
This Rule execution includes the following steps:
- Validate that the Event contains the mandatory fields:
`entityRef`
(the revised Order reference)`accountId`
- Retrieve the revised Order using the
`entityRef`
from the Event. - Extract the original Order reference from the revised Order’s
`RevisedOrderLink`
attribute. - Retrieve the original Order using the extracted reference.
- Execute a MutateAction to update the original Order with the new attribute.
Version History
See previous versions
v1.0.0
refers to plugin