CreateWaveByUserSelection

Rule

Changed on:

26 Mar 2024

Overview

Create a wave from fulfilments selected by the user.

Plugin Name	Fulfilment Reference Module
Namespace	{{accountId}}.fulfilment

The Fulfilment Reference Module is the foundation for in-store operations. It provides a reference Workflow for pick, pack, and shipping of orders for in-store staff. Extensible by design, use this Module as a base to build a solution to the needs of your customers.

Fulfilment Reference Module

UI Description

Creates a Wave based on Fulfilments selected by the user.

Actions

Type: CreateWave mutation
Condition: Always
Description: Sends a GraphQL mutation that creates a Wave with the selected Fulfilments.

Event attributes

Name	Type	Required?	Default	Description
maxCount	`integer`	Yes	N/A	The maximum number of Fulfilments that can be allocated to the Wave. Must be a positive integer.
userName	`string`	No	N/A	The login name of the store-associate that will process the Wave.
fulfilmentIds	`FULFILMENT_IDS`	Yes	N/A	The list of fulfilment Ids that will be included in the Wave.

Configuration example

1 {
2      "name": "CreateWaveByUserSelection",
3      "description": "Creates a wave based on fulfilments selected by the user",
4      "type": "LOCATION",
5      "subtype": "STORE",
6      "eventType": "NORMAL",
7      "rules": [
8        {
9          "name": "{{account}}.fulfilment.CreateWaveByFulfilmentIds",
10          "props": {}
11        }
12      ],
13      "triggers": [
14        {
15          "status": "ACTIVE"
16        }
17      ],
18      "userActions": [
19        {
20          "context": [
21            {
22              "label": "Create Custom Wave",
23              "type": "PRIMARY",
24              "modules": [
25                "servicepoint",
26                "store"
27              ],
28              "confirm": false
29            }
30          ],
31          "attributes": [
32            {
33              "name": "userName",
34              "label": "Wave Assignee",
35              "type": "String",
36              "mandatory": false
37            },
38            {
39              "name": "waveName",
40              "label": "Wave Name",
41              "type": "STRING",
42              "mandatory": false
43            },
44            {
45              "name": "fulfilmentIds",
46              "label": "Fulfilment Ids",
47              "type": "FULFILMENT_IDS",
48              "mandatory": true
49            }
50          ]
51        }
52      ]
53    }

Language: json

Detailed Technical Description

For a given list of Fulfilment Ids passed to it in an event
Any Fulfilments already in a Wave will be filtered out
Adds the list of filtered Fulfilments into a new Wave
If a name

Version History

2024-04-00

V1.0.0

Rule Creation.