Enable Storage Scanning

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

How-to Guide

Author:

Fluent Commerce

Changed on:

18 Jan 2024

Key Points

To enable the storage scanning feature in Service Point the following setup and workflow changes are required

Steps

Workflow changes

ARTICLE_ARRIVED Ruleset In the “ARTICLE_ARRIVED” ruleset the rules AddStorageArea and AddEventAttributesToEntity rules need to be added as well as the user actions need to be configured.

1{
2 "name": "ARTICLE_ARRIVED",
3 "description": "ArticleReadyForCollection after executing this ruleset",
4 "type": "ARTICLE",
5 "subtype": "DEFAULT",
6 "eventType": "NORMAL",
7 "rules": [
8  {
9   "name": "FLUENTRETAIL.base.AddStorageArea",
10   "props": null
11  },
12  {
13   "name": "FLUENTRETAIL.base.ChangeStateGQL",
14   "props": {
15    "status": "AWAITING_COLLECTION"
16   }
17  },
18  {
19   "name": "FLUENTRETAIL.base.AddEventAttributesToEntity",
20   "props": {
21    "attributeNames": [
22     {
23      "name": "storageAreaRef",
24      "type": "STRING"
25     }
26    ]
27   }
28  },
29  {
30   "name": "FLUENTRETAIL.base.SendEventForFulfilment",
31   "props": {
32    "eventName": "ArticleAwaitingCollection"
33   }
34  }
35 ],
36 "triggers": [
37  {
38   "status": "AWAITING_ARRIVAL"
39  }
40 ],
41 "userActions": [
42  {
43   "eventName": "ARTICLE_ARRIVED",
44   "context": [
45    {
46     "label": "SCAN TO STORAGE AREA",
47     "type": "PRIMARY",
48     "modules": [
49      "servicepoint"
50     ],
51     "confirm": true
52    }
53   ],
54   "attributes": [
55    {
56     "name": "storageAreaRef",
57     "label": "Storage Area",
58     "type": "STRING",
59     "source": "storageAreaRef",
60     "mandatory": true
61    }
62   ]
63  },
64  {
65   "context": [
66    {
67     "label": "Mark As Arrived",
68     "type": "SECONDARY",
69     "modules": [
70      "adminconsole"
71     ],
72     "confirm": true
73    }
74   ],
75   "attributes": [
76    {
77     "name": "storageAreaRef",
78     "label": "Storage Area",
79     "type": "STRING",
80     "source": "storageAreaRef",
81     "mandatory": true
82    }
83   ]
84  }
85 ]
86}

ARTICLE_COLLECTED Ruleset Add the the DeleteFromStorageArea rule to remove the article from the storage area.

1{
2  "name": "ARTICLE_COLLECTED",
3  "description": "Article State Change Awaiting_Collection to Collected",
4  "type": "ARTICLE",
5  "subtype": "DEFAULT",
6  "eventType": "NORMAL",
7  "rules": [
8    {
9      "name": "FLUENTRETAIL.base.ChangeStateGQL",
10      "props": {
11        "status": "COLLECTED"
12      }
13    },
14    {
15      "name": "FLUENTRETAIL.base.DeleteFromStorageArea",
16      "props": null
17    },
18    {
19      "name": "FLUENTRETAIL.base.SendEventForFulfilment",
20      "props": {
21        "eventName": "ArticleCollected"
22      }
23    }
24  ],
25  "triggers": [
26    {
27      "status": "AWAITING_COLLECTION"
28    }
29  ],
30  "userActions": [
31    {
32      "eventName": "ARTICLE_COLLECTED",
33      "context": [
34        {
35          "label": "COLLECT",
36          "type": "PRIMARY",
37          "modules": [
38            "servicepoint"
39          ],
40          "confirm": false
41        }
42      ],
43      "attributes": []
44    }
45  ]
46}

Create Storage Areas

For the storage areas to show up in Service Point they need to be created and assigned to a location.

1mutation{
2  createStorageArea(input:{ref:"C1" location:{id:<locationId>} type:"CONSOLIDATION" }) {
3    id
4  }
5}

1mutation{
2  updateStorageArea(input:{id:<storageAreaId> status:"ENABLED"}){
3    id
4  }
5}

Result

Service Point After the workflow changes have been done and the storage areas have been created articles in the “Arrivals” screen can be scanned into storage areas.

Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.

1{
2 "name": "ARTICLE_ARRIVED",
3 "description": "ArticleReadyForCollection after executing this ruleset",
4 "type": "ARTICLE",
5 "subtype": "DEFAULT",
6 "eventType": "NORMAL",
7 "rules": [
8  {
9   "name": "FLUENTRETAIL.base.AddStorageArea",
10   "props": null
11  },
12  {
13   "name": "FLUENTRETAIL.base.ChangeStateGQL",
14   "props": {
15    "status": "AWAITING_COLLECTION"
16   }
17  },
18  {
19   "name": "FLUENTRETAIL.base.AddEventAttributesToEntity",
20   "props": {
21    "attributeNames": [
22     {
23      "name": "storageAreaRef",
24      "type": "STRING"
25     }
26    ]
27   }
28  },
29  {
30   "name": "FLUENTRETAIL.base.SendEventForFulfilment",
31   "props": {
32    "eventName": "ArticleAwaitingCollection"
33   }
34  }
35 ],
36 "triggers": [
37  {
38   "status": "AWAITING_ARRIVAL"
39  }
40 ],
41 "userActions": [
42  {
43   "eventName": "ARTICLE_ARRIVED",
44   "context": [
45    {
46     "label": "SCAN TO STORAGE AREA",
47     "type": "PRIMARY",
48     "modules": [
49      "servicepoint"
50     ],
51     "confirm": true
52    }
53   ],
54   "attributes": [
55    {
56     "name": "storageAreaRef",
57     "label": "Storage Area",
58     "type": "STRING",
59     "source": "storageAreaRef",
60     "mandatory": true
61    }
62   ]
63  },
64  {
65   "context": [
66    {
67     "label": "Mark As Arrived",
68     "type": "SECONDARY",
69     "modules": [
70      "adminconsole"
71     ],
72     "confirm": true
73    }
74   ],
75   "attributes": [
76    {
77     "name": "storageAreaRef",
78     "label": "Storage Area",
79     "type": "STRING",
80     "source": "storageAreaRef",
81     "mandatory": true
82    }
83   ]
84  }
85 ]
86}

1{
2  "name": "ARTICLE_COLLECTED",
3  "description": "Article State Change Awaiting_Collection to Collected",
4  "type": "ARTICLE",
5  "subtype": "DEFAULT",
6  "eventType": "NORMAL",
7  "rules": [
8    {
9      "name": "FLUENTRETAIL.base.ChangeStateGQL",
10      "props": {
11        "status": "COLLECTED"
12      }
13    },
14    {
15      "name": "FLUENTRETAIL.base.DeleteFromStorageArea",
16      "props": null
17    },
18    {
19      "name": "FLUENTRETAIL.base.SendEventForFulfilment",
20      "props": {
21        "eventName": "ArticleCollected"
22      }
23    }
24  ],
25  "triggers": [
26    {
27      "status": "AWAITING_COLLECTION"
28    }
29  ],
30  "userActions": [
31    {
32      "eventName": "ARTICLE_COLLECTED",
33      "context": [
34        {
35          "label": "COLLECT",
36          "type": "PRIMARY",
37          "modules": [
38            "servicepoint"
39          ],
40          "confirm": false
41        }
42      ],
43      "attributes": []
44    }
45  ]
46}

Enable Storage Scanning

Key Points

Steps

Workflow changes

Create Storage Areas

Result

Fluent Commerce

Building Blocks

Browse By Type

Helpful Resources

Quick Links