Inventory Reference Module

Key Changes

• The CreateBaseVirtualPosition, UpdateBaseVirtualPosition, CreateAggregateVirtualPosition, and UpdateAggregateVirtualPosition rules now apply control-specific logic only if the event includes a Control Group reference (

  `virtualCatalogueControlGroupRef`

  event attribute). The Control Group reference is initially loaded from the Virtual Catalog (see LoadVirtualPositionAndVirtualCatalogueDetails).
  • Before this enhancement, the rules would run control logic even when a Control Group reference was absent, which could cause errors during updates.
  • Now, if a Control Group reference is not present in the event payload, the control logic is skipped, which matches the expected optional behavior.
• The rule descriptions have been updated to clearly show that

  `virtualCatalogueControlGroupRef`

  is optional and to avoid confusion about required fields.

Key Changes:

• Rules and Utilities

  • `ApplyThresholdControlsToInventoryPosition`

    and

    `ApplyThresholdControlsToVirtualPosition`

    Rules have been enhanced to apply fallback logic that imitates the presence of an Active Bulk Threshold Control (applicable to all the Inventory and Virtual Catalogs) to ensure the correct management of Position Statuses when no Bulk Threshold Controls are configured. Previously, Inventory and Virtual Positions remained in the

    `CREATED`

    Status when no Active Bulk Threshold Control(s) was available for a corresponding Inventory or Virtual Catalog.
  • New

    `UpsertInventoryQuantity`

    and

    `LoadInventoryPositionData`

    Rules have been introduced to enable Inventory Quantity Type configuration for Inventory Quantity creation or update via the Batch.
• Reference Workflows
  • Reference Inventory Catalog Workflow has been improved to:
    • Support loading Inventory Quantities of any Type via the Enhanced Inventory Batch.
    • Ensure correct

      `onHand`

      calculation when Inventory is loaded before the Product is created in Fluent
  • Direct Inventory Updates have been deprecated.
  • 📖 See the Inventory Catalog Workflow Template Version History section for details.

Note:

• An upgrade to the Core Reference Module 2.0.0+ is mandatory for correct Reference Inventory Catalog Workflow functioning.

Key Changes:

• Rules and Utilities
  • New Rules have been introduced to enable Cross-Retailer events sending for Master/Sub-Retailer(s) setup:

    • `NotifyVirtualCataloguesByRefsOnNetworksMatch`

    • `NotifyVirtualCataloguesOnNetworksMatch`

    • `NotifyVirtualCataloguesByTypesOnNetworksMatch`

  • `CreateAggregateVirtualPosition`

    and

    `UpdateAggregateVirtualPosition`

    Rules have been optimized to load all the related Controls (by Product, its Categories, and list of Locations) at once for efficient Aggregate Virtual Position Available-to-Sell (ATS) calculations.
  • Attribute Utils have been updated to use a plain

    `string`

    type instead of the

    `enum`

    , ensuring that a Product attribute

    `type`

    is saved in the same way as it was sent via the

    `UPSERT_PRODUCT`

    event.

  • `NotifyVirtualCatalogueOnNetworkMatch`

    and

    `ValidateProductCategoriesExist`

    Rules have been extended with a pagination logic to ensure correct execution for the following scenarios:
    • A given Location belongs to more than 10 Networks, and the Virtual Catalog to be updated has a Network outside the first 10 Networks fetched.
    • A given Product has more than 100 Categories assigned. 
• Reference Workflows
  • All the Workflows:

    • `SendEventGQL`

      Rules have been switched to the

      `SendEvent`

      (Core Reference Module).
    • “Deactivate” Rulesets have been removed:

      • `DeactivateProductCatalogue`

      • `DeactivateIC`

      • `DeactivateIP`

      • `DeactivateIQ`

      • `DeactivateVC`

  • Inventory Catalog Workflow:

    • `NotifyVirtualCatalogueOnNetworkMatch`

      Rules have been replaced with the new

      `NotifyVirtualCataloguesByRefsOnNetworksMatch`

      Rule for the

      `NotifyVirtualCatalogues`

      Ruleset.

    • `CalculateOnHandForFulfilment`

      Ruleset has been replaced with a generic

      `CalculateOnHand`

      one.

      `UpdateOnHandForFulfilment`

      Ruleset has been removed.

    • `UpdateInventoryQuantitiesStatus`

      Rule has been removed from the

      `BatchInventoryQuantityCreate`

      Ruleset.

Key Changes:

• Inventory and Virtual Position Reference Statuses have been extended with

  `OUT_OF_STOCK`

  and

  `AT_RISK`

  Statuses.
• A New Reference Control Type

  `BULK_THRESHOLD`

  has been introduced. It is driven by threshold-based logic and applicable to both Inventory and Virtual Positions, empowering Inventory stock Status management.
• Reference Inventory Workflows have been updated with New Rules:

  `ApplyThresholdControlsToInventoryPosition`

  and

  `ApplyThresholdControlsToVirtualPosition`

  , utilized in the following Rulesets:
  • Inventory Catalog:

    `UpdateOnHand`

    ,

    `ActivateInventoryPosition`

    ,

    `UpdateOnHandForFulfilment`

  • Virtual Catalogs: 
    • Base:

      `CREATE`

      ,

      `UpdateBaseVirtualPosition`

    • Aggregate:

      `CREATE`

      ,

      `UpdateAggregateVirtualPosition`

  • Rulesets' Triggers and Status Properties have been updated to reflect the introduction of the new Statuses.

Limitations:

• Control Group(s) assignment to Inventory and Virtual Catalogs and Bulk Threshold Controls configuration are mandatory for correct Workflows functioning.
  UPDATED: Bulk Threshold Controls configuration is no longer mandatory (starting from the Inventory Module 2.2.0 version).
• The

  `retailerRefs`

  argument in the

  `productCatalogues`

  ,

  `inventoryCatalogues`

  ,

  `virtualCatalogues`

  , and

  `controlGroups`

  GraphQL queries is not supported for the Inventory Reference Module Rule Plugin because of the utilized Apollo Client restrictions.

Enhanced Rules: The following inventory rules have been updated to support flexible inventory catalog types and to remove the dependency on the default catalog type:

• `SplitInventoryUpdates`

• `InventoryChanged`

• `LoadInventoryPosition`

• `CheckIfInventoryPositionExists`

• `DownToInventoryPositionIfExists`

• `CheckInventoryQuantityExists`

• `ForwardIfInventoryQuantityTypeExists`

• `BatchInventoryPositionUpdate`

• `UpdateInventoryQuantity`

• `CreateBaseVirtualPosition`

• `UpdateBaseVirtualPosition`

• `LoadVirtualPositionAndVirtualCatalogueDetails`

• `NotifyVirtualCatalogueOnNetworkMatch`

Key Changes:

• Inventory position types now inherit from the inventory catalog type, enabling workflows and plugins to function across different catalog types without rule modifications.
• The subtype in the inventory catalog workflow must be correctly set to leverage this flexibility, ensuring rules are no longer limited to the default catalog type.
• Rule updates have removed the hard-coded inventory catalog type (DEFAULT), increasing the usability of these rules with non-default catalogs.
• A new field,

  `inventoryQuantity`

  , has been introduced for the

  `InventoryChanged`

  event. This field aggregates all attributes under "attributes" from inventory batches and related rulesets like

  `INVENTORY_UPDATE`

  . Specific keys like "condition," "expectedOn," and "storageAreaRef" will be updated at the inventory quantity level, while other attributes will be available in workflows for further actions.

• Rule Enhancement: Updated the

  `LoadInventoryPosition`

  rule to limit retrieval to the

  `LAST_ON_HAND`

  inventory quantity type.
  • This change reduces unnecessary data fetching, focusing only on relevant inventory quantities.
• Improved Performance:
  • By narrowing the data retrieval scope, the module processes inventory data more efficiently.
• No Workflow Changes:
  • The update involves only a change to the inventory rule, with no impact on existing workflows or operations from the 1.3.0 version

Module release including:

• Reference Module Structure Improvements:
  • The Module File and Folder Organization has been updated
  • The Naming and Versioning have been improved
  • The Core Module dependency has been established, utilizing its Reference Rules
  • The Workflows Ruleset Key Fields have been arranged
  • The Workflows Placeholder and Default Value Formats have been modified
• Reference Workflows Enhancements and Fixes:
  • Inventory Catalog Workflow has been extended, ensuring proper Inventory Updates with:
    • Additional attributes for the

      `LoadInventoryPosition`

      Rule:
      • inventoryQuantityExists
      • inventoryQuantityTypes
    • New Ruleset

      `CheckInventoryQuantityExists`

    • New Rules:

      • `ForwardIfInventoryQuantityOfTypeNotExists`

      • `ForwardIfInventoryQuantityOfTypeExists`

  • Product Catalog Workflow has been fixed:

    • `ACTIVE`

      Status Trigger has been removed from the

      `ActivateProduct`

      Ruleset

Minor Module release with fixes

Minor Module release with the following fixes:

• `SplitUpdatesAndDownToInventoryPosition`

   rule has been updated to 

  `SplitInventoryUpdates`

   to correctly send the following events to the right entity level

• `SplitDeltasAndDownToInventoryPosition`

   rule will correctly work with more than 10 delta updates
• New 

  `CreateBaseVirtualPositionIfNotPresent`

   rule & reference workflow were introduced to handle an edge case where a Virtual Position won't be created when creating a new Inventory Position

Minor Module release including Reference Inventory Catalog Workflow update

Module release including reference implementations of Inventory Delta updates and direct Last on Hand Inventory Updates.

Module release with reference implementation of Product Catalog domain.

Initial Inventory Reference Module release.