Configure Bulk Threshold Controls to manage Inventory and Virtual Positions Statuses

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

How-to Guide

Author:

Kirill Gaiduk

Changed on:

28 Feb 2025

Key Points

Use Bulk Threshold Controls to manage Out of Stock and At Risk Statuses for Inventory and Virtual Positions
Create Control Groups for Inventory and/or Virtual Catalogs to respectively apply Bulk Threshold Controls
Configure Bulk Threshold Controls with:
- Context
- Threshold
- Status
- and Execution Order

Steps

Create a Control Group

Note

Controls of `BULK_THRESHOLD` type are applicable to both Inventory and Virtual Positions. Thus, you could use corresponding Control Groups for Inventory and Virtual Catalogs.At the same time, it is also possible to use a single Control Group for multiple Inventory and Virtual Catalogs.

1. Create a Control Group.Use the `createControlGroup` mutation or do it via the UI.2. Activate the Control Group.Use the `updateControlGroup` mutation or do it via the UI.3. Assign the Control Group to a target Catalog(s):

Use the `updateInventoryCatalogue` mutation (or `updateVirtualCatalogue` mutation) or do it via the UI (Check the correspondent guides for Inventory and Virtual Catalogs update if needed).
Extend the Catalog(s) `attributes` using the following example:

1{
2"attributes": {
3     "name": "controlGroups",
4     "type": "JSON",
5     "value": ["yourControlGroupRef"]
6 }
7}

Alternative

You could also use the `controlGroupRef` field to specify the Control Group for `BASE` and `AGGREGATE` Virtual Catalogs.

4. (Optional) Repeat the Steps 1-3 for all the Inventory and Virtual (`BASE` and `AGGREGATE`) Catalogs where Position Statuses (`ACTIVE`, `OUT_OF_STOCK`, `AT_RISK`) to be defined with Bulk Threshold Controls: No alt provided

Create Bulk Threshold Controls

Note

Controls of `BULK_THRESHOLD` type are designed to be applied to multiple Inventory or Virtual Positions that belong to "wide groups" specified with the `context` parameter.

1. Create a Bulk Threshold Control to manage `OUT_OF_STOCK` Status for Inventory or Virtual Positions.Use the `createControl` mutation with the following `CreateControlInput` input parameter configuration:

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` parameter (to be set within the `values` input field).The Control will set the `OUT_OF_STOCK` Status to all the Inventory Positions with On Hand quantity lower than or equal to (<=) the `threshold` value specified (0).The Control will be attempted to apply after the Controls of `EXCLUSION` and `QUANTITY_BUFFER` types but before the `BULK_THRESHOLD` Controls for `AT_RISK` and `ACTIVE` Statuses which is managed through the `executionOrder` input field. Note that only a single Control of `BULK_THRESHOLD` type will be applied to a specific Inventory or Virtual Position.

Bulk Threshold Controls Context Configuration Options

Manage an application area (groups of Inventory or Virtual Positions to which a correspondent Control is to be attempted to apply) for Bulk Threshold Controls with the `context` parameter `value`:

The following Context Types are available:
- `CATALOGUE`
- `NETWORK`
- `LOCATION`
- `CATEGORY`
- `PRODUCT`
- `VARIANT`
- `POSITION`
The following Context Properties are available:
- `ref`
- `status`
- `type`
- `attributes` (e.g., `"property": "attributes.byName.Size"`)

2. Create a Bulk Threshold Control to manage `AT_RISK` Status for Inventory or Virtual Positions.Use the `createControl` mutation with the following `CreateControlInput` input parameter configuration:

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` Status to all the Inventory Positions with On Hand quantity lower than or equal to (<=) the `threshold` value specified (10).The Control will be attempted to apply after the `BULK_THRESHOLD` Control for `OUT_OF_STOCK` Status but before the `BULK_THRESHOLD` Control for `ACTIVE` Status.

3. Create a Bulk Threshold Control to manage the default `ACTIVE` Status for Inventory or Virtual Positions.

Note

It is mandatory to define a default Bulk Threshold Control which is applied when the Out of Stock or At Risk conditions are not met.
This Bulk Threshold Control will define the status `ACTIVE` when neither the Out of Stock nor the At Risk controls are applicable
No `threshold` value is needed for these default Bulk Threshold Controls.

Use the `createControl` mutation with the following `CreateControlInput` input parameter configuration:

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}

Tip

At least one compatible Active Bulk Threshold Control is mandatory for each Inventory and Virtual Position to ensure Out of Stock and At Risk Controls correct behavior.
To achieve that:

Create a dedicated Control Group for a Fallback Active Bulk Threshold Control
Assign the Control Group to all your Inventory and Virtual Catalogs
Create a Fallback Active Bulk Threshold Control compatible with all the Inventory and Virtual Positions:

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` mutation to set the `ACTIVE` Status for the Controls: No alt provided

Update your Inventory

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.

Note

Explore the available customization with the ⁠Add colours to statuses to highlight important information⁠ and ⁠Colorful Dots Statuses Configuration Guide⁠.

Configure Bulk Threshold Controls to manage Inventory and Virtual Positions Statuses

Key Points

Steps

Create a Control Group

Create Bulk Threshold Controls

Update your Inventory

Related artifacts

Inventory Catalog Workflow Template

Virtual Catalog Workflow Templates

ApplyThresholdControlsToInventoryPosition

ApplyThresholdControlsToVirtualPosition

Related content

Inventory Interface

Inventory Reference Module

Control Groups and Controls Management

Control Groups

Kirill Gaiduk

Building Blocks

By Type

Helpful Resources

Quick Links