Docs
Changed on:
16 May 2024
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. It changes the state of the {event.entityType} to {status} using GraphQL.
The rule SetState is a newer version of
`ChangeStateGQL``setState``ChangeStateGQL`| 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.
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. It changes the state of the {event.entityType} to {status} using GraphQL.
Parameter | Description |
status | The status to be applied to the entity in the incoming event |
This rule does not directly identify any event attributes.
This rule may result in the following exceptions:
IllegalArgumentException: When any required entity details are missing from the incoming event, for example:
`entityId``entityRef``retailerId``rootEntityRef`ActionException (with code 422): When an unsupported entity type is provided for update status mutation.
RubixException: When the update mutation operation fails.
1{
2 "name":"<ACCOUNTID>.order.ChangeStateGQL",
3 "props":{
4 "status":"PENDING_PAYMENT"
5 }
6}Language: json
Based on the type of the incoming entity, this rule either calls GQL or REST API to update the status of the entity to the new
`{status}`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.
