Fluent Commerce Logo
Docs
Sign In

UpdateInventoryQuantitiesStatus

Rule

Changed on:

13 Nov 2023

Overview

Updates the status of inventory quantities to status {status} which belong to the inventory position and are of type {filterTypes} and in statuses {filterStatuses}

Plugin NameInventory Reference Module
Namespace[[account.id]].globalinventory

The Inventory Reference Module is the foundation for inventory related implementations. It provides reference Workflows for inventory ingestion and processing. Extensible by design, use this Module as a base to build a solution to the needs of your customers.

The Inventory Module includes the following areas:

  • Product Catalogue workflow
  • Inventory Catalogue workflow
  • Control Group workflow
  • Virtual Catalogue workflow

UI Description

Updates the status of inventory quantities to status {status} which belong to the inventory position and are of type {filterTypes} and in statuses {filterStatuses}

Accepts

  • INVENTORY_POSITION

Actions

  • This rule produces a MutationAction that will update the status of all Inventory Quantities that are one of the given statuses in {filterStatuses} and one of the given types in {filterTypes} to the given {status}

Rule parameters

Parameter

Description

status

The status to which inventory quantities will be updated

filterTypes

List of inventory quantity types that should be updated

filterStatuses

A list of statuses to filter inventory quantities

Event attributes

Not Applicable for this rule.

Exceptions

This rule will throw a PropertyNotFoundException which is a subclass of RubixException if the 

`type`
/
`filterTypes`
/
`filterStatuses`
 property is not provided.

Configuration example

1{
2  "name": "FLUENTRETAIL.globalinventory.UpdateInventoryQuantitiesStatus",
3  "props": {
4    "filterTypes": ["SALE","CORRECTION"],
5    "status": "INVALID",
6    "filterStatuses": ["CREATED","ACTIVE"]
7  }
8}

Language: json

Detailed Technical Description

The rule will execute a single bulk action GQL mutation which will update all Inventory Quantities tied to the specific Inventory Position that are in the array of types given in 

`{filterTypes}`
 AND are of a current status given in 
`{filterStatuses}`
, these filtered Inventory Quantities will be updated to be of status 
`{status}`
 given in the rule Input Parameters.

Version History

2023-08-03

v2.0.0

refers to plugin