Docs
Changed on:
29 Aug 2024
Forward 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:
Forward event {eventName} (inline event) with the attribute 'inventoryPositionExists' set to true or false if the inventory position exists or not respectively.
`{eventName}`Parameter | Type | Description |
| | The name of event to be triggered |
Name | Type | Description | Required? |
| InventoryPosition | One single item of inventory batch request | Yes |
Parameter | Description | Data Type | Required? |
| ref | String | No, unused |
| The inventory position type | String | No, unused |
| The ref of the variant product associated to the inventory position | String | No |
| The location ref associated to the inventory position | String | No |
| The quantity | Integer | No |
| corrected quantity | Integer | No, unused |
| inventoryQuantityUpdate | [InventoryQuantity] | No |
Parameter | Description | Data Type | Required? |
| Inventory Quantity ref | String | No |
| Inventory Quantity type | String | No |
| Quantity | Integer | No |
| Status | String | No |
This rule will throw a RubixException if
`{eventName}`1{
2 "name": "[[account.id]].globalinventory.LoadInventoryPosition",
3 "props": {
4 "eventName": "CheckInventoryPositionExists"
5 }
6}Language: json
Based on the inventory position
`ref``SendEventAction``{eventName}`Event Attribute Key | Event Attribute Value |
| |
|
|
| inventoryPosition.qty (from incoming event attributes) |
| inventoryPosition.productRef (from incoming event attributes) |
| inventoryPosition.locationRef (from incoming event attributes) |
| inventoryPosition.status from GraphQL query*, otherwise set to CREATED |
| inventoryPosition.ref from GraphQL query*, otherwise generated to |
| inventoryPosition.onHand from GraphQL query*, otherwise set to 0 |
| TRUE if position exists, FALSE if position doesn't exist |
| inventoryPosition.correctedQty (from incoming event attributes) - UNUSED |
| TRUE if quantity exists, FALSE if quantity doesn't exist |
| The List<String> of all the inventory quantity types that exist for the given inventory position. Currently, the rule is restricted to picking only LAST_ON_HAND Inventory Quantity type for performance reasons |
*The first option will occur when an Inventory Position already exists, otherwise the second option will occur.
Refers to the Product Release Version
Refers to the Product Release Version
refers to the plugin
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.
