Fluent Commerce Logo
Docs
Sign In

LoadProductAndLocationStatus

Rule

Changed on:

2 Nov 2023

Overview

Forward event {eventName} (inline event) with the attribute "productStatus" and "locationStatus" if the product and location exist.

Plugin NameInventory 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:

  • Product Catalogue workflow
  • Inventory Catalogue workflow
  • Control Group workflow
  • Virtual Catalogue workflow

UI Description

Forward event {eventName} (inline event) with the attribute "productStatus" and "locationStatus" if the product and location exist.

Accepts

  • INVENTORY_POSITION

Actions

  • This rule produces a SendEventAction with name = "eventName" with "productStatus" and "locationStatus" attributes

Rule parameters

Parameter

Description

eventName

The name of event to be triggered

productCatalogueRef

The product catalogue ref for loading the variant product information.

Event attributes

Parameter

Description

Data Type

Required?

productRef

Variant product ref for the inventory position

String

Required

locationRef

Location ref for the inventory position

String

Required

Exceptions

  • This rule will throw a PropertyNotFoundException if 
    `eventName`
     property is not provided.
  • This rule will throw a PropertyNotFoundException which is a subclass of RubixException if the 
    `productCatalogueRef`
     property is not provided.

Configuration example

1{
2  "name": "FLUENTRETAIL.globalinventory.LoadProductAndLocationStatus",
3  "props": {
4    "eventName": "CheckProductStatus",
5    "productCatalogueRef": "PRODUCT_CATALOGUE_001"
6  }
7}

Language: json

Detailed Technical Description

Based on the product catalogue 

`ref`
 (rule property), product ref (event attributes) and location ref (event attributes), the rule loads the corresponding variant product and location in one GraphQL API query request. Then the rule adds the "productStatus" and "locationStatus" into event attributes and produces one 
`SendEventAction`
 with the event name from rule property.

Version History

2023-08-02

v2.0.0

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.

Fluent Logo