Fluent Commerce Logo
Docs

Virtual Catalog Workflow Templates

Interface Contract FlowInterface Contract Flow Overview

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

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}

Request Payload

PropertyDescriptionTypeRequired?Notes
`locationRef`The location reference associated with the virtual positionStringRequiredRequired when the Virtual Catalog type is BASE
`productRef`The product reference associated with the virtual positionStringRequired

Version History