Changed on:
2 Nov 2023
Loads the virtual position details and then sends an event {eventName}
Plugin Name | Inventory Reference Module |
---|---|
Namespace | [[account.id]].globalinventory |
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:
Loads the virtual position details and then sends an event {eventName}
Parameter | Description |
eventName | The name of event to be triggered |
type | The type of Virtual Position & Virtual Catalogue* |
*This needs to be either “BASE” or “AGGREGATE” for the 2 types of Virtual Catalogue. |
Parameter | Description | Data Type | Required? |
virtualCatalogueInventoryCatalogueRef | The ref of the inventory catalogue this virtual position goes | String | Optional |
virtualPositionProductRef | The product ref of the virtual position | String | Optional |
virtualPositionGroupRef | The group reference value of the virtual position | String | Optional |
No Exceptions are generated from this rule
1{
2 "name": "FLUENTRETAIL.globalinventory.LoadVirtualPositionAndVirtualCatalogueDetails",
3 "props": {
4 "eventName": "CheckVirtualPositionExists",
5 "type": "BASE"
6 }
7}
Language: json
The generated event contains the following event attributes:
Parameter | Description | Notes |
virtualCatalogueRef | The ref of the virtual catalogue | |
virtualCatalogueType | The type of the virtual catalogue | |
virtualCatalogueInventoryCatalogueRef | The inventory catalogue ref this virtual catalogue is made of | |
virtualCatalogueProductCatalogueRef | The product catalogue ref this virtual catalogue is made of | |
virtualCatalogueControlGroupRef | The control group ref this virtual catalogue is made of | |
virtualCatalogueNetworkIds | The network references this virtual catalogue is made of | |
virtualPositionRef | The ref of the virtual position | |
virtualPositionProductRef | The product ref of the virtual position | |
virtualPositionQuantity | The quantity of the virtual position | |
virtualPositionGroupRef | The group reference value of the virtual position | |
virtualPositionType | The virtual position type | |
targetVirtualPositionRef | The ref of the virtual position | same as the value of virtualPositionRef |
locationRef | The ref of the location | Contains the same value as the {locationRef} incoming event attribute |
productRef | The product ref of the virtual position | Same value as the value of {productRef} incoming event attribute |
`{entityRef}`
`{entityRef}`
`ref`
`ref`
`ref`
`{productRef}:{locationRef}:BASE`
`{type}`
`{productRef}:{rootEntityRef}:BASE`
`{type}`
`{eventName}`
First release
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.