Author:
Kirill Gaiduk
Changed on:
24 Sept 2024
1. Create a Control Group.
Use the `createControlGroup`
2. Activate the Control Group.
Use the `updateControlGroup`
3. Assign the Control Group to a target Catalog(s):
`updateInventoryCatalogue`
`updateVirtualCatalogue`
`attributes`
1{
2"attributes": {
3 "name": "controlGroups",
4 "type": "JSON",
5 "value": "[\"yourControlGroupRef\"]"
6 }
7}
Language: json
Name: Assigning a Control Group to a Catalog with Attributes sample
Description:
Specify the Reference of the Control Group created during the Step 1.
The
`value`
4. (Optional) Repeat the Steps 1-3 for all the Inventory and Virtual (
`BASE`
`AGGREGATE`
`ACTIVE`
`OUT_OF_STOCK`
`AT_RISK`
1. Create a Bulk Threshold Control to manage
`OUT_OF_STOCK`
Use the `createControl`
`CreateControlInput`
1{
2"input": {
3 "ref": "BULK_TIOOS",
4 "type": "BULK_THRESHOLD",
5 "name": "Bulk Threshold Inventory Out of Stock",
6 "description": "",
7 "values": [
8 {
9 "name": "context",
10 "type": "CONTEXT",
11 "value": [
12 {
13 "type": "CATALOGUE",
14 "property": "ref",
15 "value": "yourInventoryCatalogueRef"
16 }
17 ]
18 },
19 {
20 "name": "threshold",
21 "type": "NUMBER",
22 "value": 0
23 },
24 {
25 "name": "status",
26 "type": "STRING",
27 "value": "OUT_OF_STOCK"
28 }
29 ],
30 "controlGroup": {
31 "ref": "yourControlGroupRef"
32 },
33 "executionOrder": 10
34 }
35}
Language: json
Name: CreateControlInput for Out of Stock Bulk Threshold Control sample
Description:
The Control will be attempted to apply to all the Inventory Positions of the specified Inventory Catalog. That is managed with a
`context`
`values`
The Control will set the
`OUT_OF_STOCK`
`threshold`
The Control will be attempted to apply after the Controls of
`EXCLUSION`
`QUANTITY_BUFFER`
`BULK_THRESHOLD`
`AT_RISK`
`ACTIVE`
`executionOrder`
`BULK_THRESHOLD`
2. Create a Bulk Threshold Control to manage
`AT_RISK`
Use the `createControl`
`CreateControlInput`
1{
2"input": {
3 "ref": "BULK_TIAR",
4 "type": "BULK_THRESHOLD",
5 "name": "Bulk Threshold Inventory At Risk",
6 "description": "",
7 "values": [
8 {
9 "name": "context",
10 "type": "CONTEXT",
11 "value": [
12 {
13 "type": "CATALOGUE",
14 "property": "ref",
15 "value": "yourInventoryCatalogueRef"
16 }
17 ]
18 },
19 {
20 "name": "threshold",
21 "type": "NUMBER",
22 "value": 10
23 },
24 {
25 "name": "status",
26 "type": "STRING",
27 "value": "AT_RISK"
28 }
29 ],
30 "controlGroup": {
31 "ref": "yourControlGroupRef"
32 },
33 "executionOrder": 20
34 }
35}
Language: json
Name: CreateControlInput for At Risk Bulk Threshold Control sample
Description:
The Control will be attempted to apply to all the Inventory Positions of the specified Inventory Catalog.
The Control will set the
`AT_RISK`
`threshold`
The Control will be attempted to apply after the
`BULK_THRESHOLD`
`OUT_OF_STOCK`
`BULK_THRESHOLD`
`ACTIVE`
3. Create a Bulk Threshold Control to manage the default
`ACTIVE`
Use the `createControl`
`CreateControlInput`
1{
2"input": {
3 "ref": "BULK_TIA",
4 "type": "BULK_THRESHOLD",
5 "name": "Bulk Threshold Inventory Active",
6 "description": "",
7 "values": [
8 {
9 "name": "context",
10 "type": "CONTEXT",
11 "value": [
12 {
13 "type": "CATALOGUE",
14 "property": "ref",
15 "value": "yourInventoryCatalogueRef"
16 }
17 ]
18 },
19 {
20 "name": "status",
21 "type": "STRING",
22 "value": "ACTIVE"
23 }
24 ],
25 "controlGroup": {
26 "ref": "yourControlGroupRef"
27 },
28 "executionOrder": 30
29 }
30}
Language: json
Name: CreateControlInput for Active Bulk Threshold Control sample
Description:
The Control will be attempted to apply to all the Inventory Positions of the specified Inventory Catalog.
The Control will revert the Inventory Position Status to
`ACTIVE`
The Control will be attempted to apply after the
`BULK_THRESHOLD`
`OUT_OF_STOCK`
`AT_RISK`
4. Repeat the Steps 1-3 to populate all the created Control Groups with Bulk Threshold Controls.
5. Activate all the Bulk Threshold Controls created during the Steps 1-4.
Use the `updateControl`
`ACTIVE`
1. Update your Inventory with:
to ensure that the target Inventory And Virtual Catalogs have been recalculated and the created Bulk Threshold Controls have been executed.
2. Verify the Inventory and Virtual Position Statuses.
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.