Docs
Changed on:
3 Oct 2024
| Setting Area | UI component |
|---|---|
| Supported context levels: | ACCOUNT, RETAILER |
This setting is utilized in the Pack component to configure the Pack Wizard.
| Data Type | Values |
|---|---|
| JSON | See the Configuration Example below |
Enabling this setting will override the default component parameters. To update one or more parameters, a setting must be created according to the structure below. It is not necessary to include parameters that match the default values—only those that need to be changed should be listed.
Name | Type | Required | Description |
|
| No | This property allows you to modify the Unpacked table: extend the displayed columns, e.g., attribute 'fragile.' |
|
| No | This property allows you to modify the Parcels table, configure parcel types, and define the parcel type to be applied by default. |
|
| No | This property allows you to modify the Rejected Items table and change the modal window label in the Pack Component default configuration. |
| Standard type for
| No | Override the Product Card setting in the Pack Component configuration. |
|
| No | Enables barcode scanning and filtering of items. |
Name | Type | Required | Description |
|
| No | The data path from the request. |
|
| No | Labels for the unpacked list. |
|
| No | The Attributes section is built with the List, so you have access to the same properties to configure For example, you can customize the columns displayed in the table. Refer to the UX Configuration guide under the dynamic attributes section for more information about configuring this field. |
Name | Type | Required | Description |
|
| No | Title of the unpacked table. |
|
| No | A message that appears if there are no items in the table. |
Name | Type | Required | Description |
|
| No | Labels for parcels. |
|
| No | The Attributes section is built with the List, so you have access to the same properties to configure For example, you can customize the columns displayed in the table. Refer to the UX Configuration guide under the dynamic attributes section for more information about configuring this field. |
|
| No | Removes the limit of one parcel per item. With this property enabled, you can have many parcels per item being packed. By default, the value when unspecified is false to ensure that only one parcel per item is packed. |
|
| No | Automatically adds all items to the first package when the Pack component is opened, streamlining the packing process. By default, the value is
|
|
| No | The default parcel type. This value will be preselected on the parcel type dropdown when the page first loads. This creates a more efficient packing process, but it may increase user error. If
|
|
| No | Configured parcel types with the dimensions. Each entry in the array represents one option in the dropdown. If types are not specified, only the custom type will be displayed. |
Name | Type | Required | Description |
|
| No | Title of the parcel table. |
|
| No | Label of the "Add Parcel" button. |
|
| No | A message that appears if there are no items in the parcel. |
Name | Type | Required | Description |
|
| Yes | Name of the parcel type. |
|
| Yes | Length of the parcel in cm. |
|
| Yes | Width of the parcel in cm. |
|
| Yes | Height of the parcel in cm. |
|
| No | Barcode of the parcel (box). |
|
| No | The default weight of the parcel in kg. |
|
| No | Maximum weight of the parcel in kg. |
|
| No | Minimum weight of the parcel in kg. |
Name | Type | Required | Description |
|
| No | Modal window configuration for Rejection Reason choice. |
|
| No | Reject Item List Configuration for the Pack Component |
Name | Type | Required | Description |
|
| No | Labels for the modal window. |
Name | Type | Required | Description |
|
| No | Title for the list/modal. |
Name | Type | Required | Description |
|
| No | Labels for the modal window. |
|
| No | The Attributes section is built with the List, so you have access to the same properties to configure For example, you can customize the columns displayed in the table. Refer to the UX Configuration guide under the dynamic attributes section for more information about configuring this field. |
Name | Type | Required | Description |
|
| No | The property enables the phone’s camera to initiate scanning, allowing it to detect and capture images or codes quickly and accurately. |
|
| No | The decoder in the barcode scanner specifies what kind of barcode it's searching for. It has a list (array) of possible barcode types that it checks one by one, in the order given. The decoding process stops at the first successful result. The array can include multiple barcode types, but performance decreases with each additional type. The scanner reads the entire barcode, including leading and ending zeros, without trimming it. Possible values are: |
|
| No | Specify the fields that upon scan, the item field searches against. Successful scans will attempt to increment the associated item quantity.
|
|
| No | The timeout time in milliseconds before a toast message will disappear. |
|
| No | The confidence value ranges between 0 and 1, with precision up to two decimal points. Confidence serves as a trade-off between accuracy and error margin. A higher confidence level corresponds to a reduced margin for error, especially in scenarios where the camera quality may not be excellent. |
|
| No | Frequency is the number of scan attempts per second. The frequency is an integer ranging from 1 to 10, and its default setting is 10. Opting for a higher frequency enhances scanning accuracy but also leads to greater utilization of the phone battery. To preserve the phone's battery life, it is advisable to choose a lower value. |
1{
2 "unpackedList": {
3 "dataSource": "fulfilmentById.items",
4 "labels": {
5 "title": "i18n:fc.sf.ui.pack.list.unpackedItems.title",
6 "noItems": "i18n:fc.sf.ui.pack.list.unpackedItems.noItems"
7 },
8 "attributes": [
9 {
10 "value": "{{orderItem.product.attributes.byName.imageUrl}}",
11 "type": "image",
12 "options": {
13 "width": 50,
14 "height": 50
15 }
16 },
17 {
18 "label": "i18n:fc.sf.pack.index.list.column.productName.heading",
19 "value": "{{orderItem.product.name}}"
20 },
21 {
22 "label": "i18n:fc.sf.pack.index.list.column.sku.heading",
23 "value": "{{orderItem.product.ref}}"
24 }
25 ]
26 },
27 "parcels": {
28 "labels": {
29 "title": "i18n:fc.sf.ui.pack.list.packed.title",
30 "add": "i18n:fc.sf.ui.pack.list.addParcel.button",
31 "noItems": "i18n:fc.sf.ui.pack.list.packed.noItems"
32 },
33 "attributes": [
34 {
35 "value": "{{orderItem.product.attributes.byName.imageUrl}}",
36 "type": "image",
37 "options": {
38 "width": 50,
39 "height": 50
40 }
41 },
42 {
43 "label": "i18n:fc.sf.pack.index.list.column.productName.heading",
44 "value": "{{orderItem.product.name}}"
45 },
46 {
47 "label": "i18n:fc.sf.pack.index.list.column.sku.heading",
48 "value": "{{orderItem.product.ref}}"
49 }
50 ],
51 "allowMultipleParcelsPerItem": false,
52 "autoAssignAllItemsToFirstParcel": false
53 },
54 "rejectedItems": {
55 "modal": {
56 "labels": {
57 "title": "i18n:fc.sf.ui.pack.modal.rejectItem.title"
58 }
59 },
60 "list": {
61 "labels": {
62 "title": "i18n:fc.sf.ui.pack.list.rejectedItems.title"
63 },
64 "attributes": [
65 {
66 "value": "{{orderItem.product.attributes.byName.imageUrl}}",
67 "type": "image",
68 "options": {
69 "width": 50,
70 "height": 50
71 }
72 },
73 {
74 "label": "i18n:fc.sf.pack.index.list.column.productName.heading",
75 "value": "{{orderItem.product.name}}"
76 },
77 {
78 "label": "i18n:fc.sf.pack.index.list.column.sku.heading",
79 "value": "{{orderItem.product.ref}}"
80 }
81 ]
82 }
83 },
84 "productCard": {
85 "cardImage": {
86 "imageUrl": "{{orderItem.product.attributes.byName.imageUrl}}"
87 },
88 "title": "{{orderItem.product.name}}",
89 "attributes": [
90 {
91 "value": "{{orderItem.product.ref}}"
92 },
93 {
94 "value": "{{orderItem.product.gtin}}"
95 }
96 ]
97 },
98 "scanner": {
99 "enableCameraScanner": false,
100 "defaultDecoders": ["code_128_reader", "ean_reader"],
101 "scannerFields": ["orderItem.product.gtin"],
102 "toastTimeout": 3000,
103 "confidence": 0.85,
104 "frequency": 10
105 }
106}Language: graphqlschema
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.
