ChangeStateGQL
Changed on:
2 Jan 2024
Overview
The rule changes the state of the incoming entity to the status provided in the input parameter using the generic update status mutation in GraphQL.
| 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
Changes the state of any type of incoming entity to the status provided in the input parameter using the generic update status mutation in GraphQL.
Accepts
- ALL
Actions
- This rule performs an update mutation on any type of incoming entity to update the status.
Rule parameters
Parameter | Description |
status | The status to be applied to the entity in the incoming event |
Event attributes
This rule does not directly identify any event attributes.
Exceptions
This rule may result in the following exceptions:
IllegalArgumentException: When any required entity details are missing from the incoming event.
ActionException: When an unsupported entity type is provided for update status mutation.
RubixException: When the update mutation operation fails.
Configuration example
1{
2 "name":"<ACCOUNTID>.order.ChangeStateGQL",
3 "props":{
4 "status":"PENDING_PAYMENT"
5 }
6}Language: json
Version History
v1.0.0
refers to plugin
