Fluent Commerce Logo
Docs
Help & Feedback
Sign In

Virtual Catalog Workflow Templates

Interface Contract Flow

Changed on:

24 Jan 2025

Overview

These are the Reference Virtual Catalog Workflows provided as part of the Inventory Reference Module. 

Fluent Commerce provides 

`fc-workflow-virtual-catalogue-base.json`
and 
`fc-workflow-virtual-catalogue-aggregate.json`
files that can be imported directly into any Retailer setup to use the Reference Workflow templates. It is also possible to update and configure Workflows to fit your specific client requirements using our OMX Workflow Framework.

The Inventory Module Getting Started Guide defines configuration capabilities for the Reference Inventory Workflows.

Interface Contract

Virtual Catalogue Workflow Interface Contracts

Diagram

No alt text provided

Configuration example

1{
2  "name": "VirtualCatalogueEvent",
3  "accountId": "<accountId>",
4  "retailerId": "<retailerId>",
5  "entityRef": "<VC_ref>",
6  "entitySubtype": "<VC_type>",
7  "entityType": "VIRTUAL_CATALOGUE",
8  "rootEntityRef": "<VC_ref>",
9  "rootEntityType": "VIRTUAL_CATALOGUE",
10  "attributes": {
11    "productRef": "<productRef>",
12    "locationRef": "<locationRef>"
13  }
14}

Language: json

Request Payload

Property

Description

Type

Required?

Notes

`locationRef`

The location reference associated with the virtual position

String

Required

Required when the Virtual Catalog type is BASE

`productRef`

The product reference associated with the virtual position

String

Required


Version History

2024-10-28

1.0

`DeactivateVC`
Ruleset has been removed.

The corresponding Inventory Module version is 2.1.0.

2024-09-19

1.0

Control Group(s) assignment to a Virtual Catalog and Bulk Threshold Controls configuration are mandatory for correct Workflows functioning.

The corresponding Inventory Module version is 2.0.0.

2024-07-04

1.0

The corresponding Inventory Module version is 1.3.0.

0000-00-00

v1.0.0

Initial changelog entry.

Related content

Inventory Module Overview
Edited 207 days ago

The Inventory module of the Fluent Web app provides comprehensive inventory management capabilities:

  • Inventory visibility
  • Inventory allocation
  • The total quantity of stock for a specific item (stock on hand(SOH)) and the status of that inventory
  • Available to promise inventory levels
  • Inventory buffers to reduce overselling of products
Inventory Reference Module
Edited 11 days ago

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 Catalog workflow
  • Inventory Catalog workflow
  • Control Group workflows
  • Virtual Catalog workflows
Inventory Module Getting Started Guide
Edited 28 days ago

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 your customers' needs.

Virtual Catalog Workflow Templates
  • Overview
  • Interface Contract
  • Virtual Catalogue Workflow Interface Contracts
  • Diagram
  • Configuration example
  • Request Payload
  • Version History
  • 1.0
  • 1.0
  • 1.0
  • v1.0.0
  • Related content
  • Inventory Module Overview
  • Inventory Reference Module
  • Inventory Module Getting Started Guide
    • Building Blocks
    Building Blocks
    Packages & Modules
    UI Components
    Workflows
    Settings
    Interface Contracts
    Rules
    By Type
    All Types
    Knowledge Tracks
    Extend Knowledge
    Glossary
    How-to Guides
    Sitemap
    Topics
    Use Cases
    Helpful Resources
    Platform Limits
    Support Policy
    Service Level Agreement (SLA) - Enterprise
    Deprecation Policy
    Extend Knowledge Content – Terms and Conditions
    System and Organization Controls (SOC) 3 Report
    Data Privacy Addendum
    Security Policy
    Quick Links
    For Partners
    Customer Resources
    Webinars and Events
    eLearning

    Copyright © 2025 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.

    Fluent Logo