Fluent Commerce Logo
Docs
Sign In

Virtual Catalogue Workflow Interface Contracts

Interface Contract

Changed on:

12 Nov 2023

Detailed Description

When virtual positions have to be updated, this event should be sent to the virtual catalog workflow to invoke the default logic.

VirtualCatalogueEvent Event

This event is used anytime an external (anything from outside this workflow) update of Virtual Positions is triggered.

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


Event Request 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

Name: VirtualCatalogueEvent Event Request Example

Description:

[Warning: empty required content area]