Docs

Search

Sign In

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Virtual Catalogue Workflow Templates

Interface Contract Flow

Changed on:

3 July 2024

Overview

These are the Reference Virtual Catalogue 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 Account 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

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 catalogue type is BASE

`productRef`

The product reference associated with the virtual position

String

Required

Version History

2024-07-04

v1.0

The v1.0 is relevant for the initial Workflow installation.

In case the Virtual Catalogue Workflow already exists, the version will be upgraded: vx.x -> vx.(x+1).

The correspondent Inventory Module version is 1.3.0 (mentioned in the

`versionComment`

).

0000-00-00

v1.0.0

Initial changelog entry.

Related content

Inventory Module Overview

Edited 60 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 3 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 Catalogue workflow
Inventory Catalogue workflow
Control Group workflow
Virtual Catalogue workflow

Inventory Module Getting Started Guide

Edited 4 days ago