CreateInventoryPosition

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Rule

Changed on:

30 Nov 2023

Overview

Create an inventory position based on the incoming event attributes

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:

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

Inventory Reference Module

The Inventory Module includes the following areas:

Product Catalog workflow
Inventory Catalog workflow
Control Group workflows
Virtual Catalog workflows

UI Description

Create an inventory position based on the incoming event attributes

Accepts

INVENTORY_CATALOGUE

Actions

This rule produces a MutationAction that will create an inventory position.

Rule parameters

This rule has no Input Parameters

Event attributes

Parameter	Description	Data Type	Required?
inventoryPositionRef	The associated inventory position ref	String	Required
type	The inventory position type	String	Required
productRef	The ref of the variant product associated to the inventory position	String	Required
locationRef	The location ref associated to the inventory position	String	Required
qty	The initial quantity value for the Inventory Position	Integer	Required

Exceptions

No exceptions are currently thrown by this rule.

Configuration example

1{
2  "name": "{{accountId}}.globalinventory.CreateInventoryPosition"
3}

Language: json

Detailed Technical Description

The rule using a MutationAction to create an Inventory Position, the action uses the

`{inventoryPositionRef}`

the

`{type}`

and the

`{qty}`

to set the initial values of the Inventory Position.

Version History

2023-07-28

v2.0.0

refers to plugin