ChangeStateGQL
Changed on:
2 Jan 2024
Overview
The changes the state of the incoming to the status provided in the input parameter using the generic update status mutation in .
Plugin Name | Order Reference Module |
---|---|
Namespace | [[account.id]].order |
The is the foundation for order-related implementations. It provides reference workflows for , 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 in the incoming |
Event attributes
This does not directly identify any attributes.
Exceptions
This may result in the following exceptions:
IllegalArgumentException: When any required details are missing from the incoming .
ActionException: When an unsupported 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}
Version History
v1.0.0
refers to