Docs
Changed on:
25 Oct 2023
When Controls need to be updated, activated, deactivated, etc. These contracts are how to interact with the workflows to triggers these updates.
This event is used anytime an external (anything from outside this workflow) control activation is triggered.
1{
2 "retailerId": "<retailerId>",
3 "name": "ActivateControl",
4 "entityType": "CONTROL",
5 "entityRef":"<control_ref>",
6 "rootEntityType": "CONTROL_GROUP",
7 "rootEntityRef": "<control_group_ref>",
8 "entitySubtype": "<type>"
9}Language: json
Name: ActivateControl - event Request Example
Description:
[Warning: empty required content area]This event is used anytime an external (anything from outside this workflow) control deactivation is triggered.
1{
2 "retailerId": "<retailerId>",
3 "name": "DeactivateControl",
4 "entityType": "CONTROL",
5 "entityRef":"<control_ref>",
6 "rootEntityType": "CONTROL_GROUP",
7 "rootEntityRef": "<control_group_ref>",
8 "entitySubtype": "<type>"
9}Language: json
Name: DeactivateControl - request sample
Description:
[Warning: empty required content area]This event is used anytime an external (anything from outside this workflow) update of a QUANTITY_BUFFER control is triggered.
Property | Description | Type | Required? |
controlValue | The buffer value | Int | Required |
executionOrder | The order of the execution of controls | Int | Required |
1{
2 "retailerId": "<retailerId>",
3 "name": "UpdateControl",
4 "entityType": "CONTROL",
5 "entityRef":"<control_ref>",
6 "rootEntityType": "CONTROL_GROUP",
7 "rootEntityRef": "<control_group_ref>",
8 "entitySubtype": "QUANTITY_BUFFER",
9 "attributes": {
10 "controlValue": -555,
11 "executionOrder": 1
12 }
13}Language: json
Name: UpdateControl request example
Description:
[Warning: empty required content area]`
`1{
2 "retailerId": "<retailerId>",
3 "name": "CREATE",
4 "entityType": "<entity type>",
5 "entityRef":"<control_ref>",
6 "rootEntityType": "CONTROL_GROUP",
7 "rootEntityRef": "<control_group_ref>",
8 "entitySubtype": "<subtype>"
9}Language: json
Name: Create Control Group example
Description:
[Warning: empty required content area]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.
