Virtual Catalogue Workflow Templates

Interface Contract Flow

Changed on:

13 Dec 2023

Overview

These are the standard Virtual Catalogue Workflows provided in the Global Inventory Module. The workflows work with the plugin

`FLUENTRETAIL.globalinventory`

, available in the Global Inventory Module Getting Started guide, including defined configuration availabilities.

Fluent provides Workflow JSON that can be imported directly into any account to use the out-of-the-box workflow template. It is also possible to update and configure workflows to fit your specific client requirements using our Workflow Framework

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

0000-00-00

v1.0.0

Initial changelog entry.

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