Fluent Commerce Logo
Docs
Sign In

Enable Sorting in a Picklist

How-to Guide

Author:

Fluent Commerce staff

Changed on:

13 Dec 2023

Key Points

  • Properties of CUSTOM_PICK_LIST_SORT_CONFIG Setting

Steps

Step arrow right iconOverview

Fluent Commerce enables store managers and business users to define sorting criteria based on priority fields for items in a wave. This ability to sort makes the picking process efficient and reduces the time to process orders.

This functionality is currently available as a Retailer setting. A business user can define their preferences for the picking process across all stores. This can be done by customising the way items are displayed in the picklist.

For example, a sports retailer might prefer the items to be categorised based on the following criteria:

Parent department: MEN

Child department: SHOES

Category: Sneakers

This preference enables a retailer to sort by the parent department at level 1, by the child department at level 2 and at category level at 3. The sorting preference also helps the in-store staff to pick all items in the same area in one go instead of going from one area to the other after each item.

If there is no sorting applied, the default behaviour is to display the pick list sorted by the 

`sku.reference`
 field (variantProduct.reference).

Step arrow right iconPrerequisite

This following is a prerequisite to enable sorting on a custom picklist:

Ensure that the PICK_N_PACK_CUSTOM_PICK_LIST setting is enabled. For more information, see the How to customise a picklist topic.

The following image shows a custom picklist:

No alt provided

The sorting criteria is defined in the CUSTOM_PICK_LIST_SORT_CONFIG retailer settings and can have the following sample JSON values:

1{
2    "sort": [
3        { "field":"sku.attributes.subDepartment", "order": "DESC"},
4        { "field":"sku.attributes.CreatedOn" },
5        { "field":"sku.attributes.total", "type": "number"}
6    ]
7} 

Language: json

Name: CUSTOM_PICK_LIST_SORT_CONFIG

Description:

[Warning: empty required content area]

The above example is for sorting the picklist at three levels with SubDepartment at level 1, CreatedOn at level two, and Total field is at level three. This sorting hierarchy depends on the number of entries in the sort array. For example, the first entry (index 0) is the first level of sorting.

Properties of CUSTOM_PICK_LIST_SORT_CONFIG Setting

The settings has field, type, and order properties.

Field 

field is a mandatory property.

Following are the acceptable values for the fields that can be displayed on a custom picklist:

  • requiredQty
  • sku.category
  • sku.imageUrlRef
  • sku.name
  • sku.productRef
  • sku.skuRef
  • sku.onHand
  • sku.orderPrice
  • sku.orderPriceWithTax
  • sku.references.
  • sku.attributes.
Type

type is an optional property. By default, data type which is defined while creating the product variant data in the Fluent system is used by the sorting algorithm.

However, the data type can be modified for sorting by using the field type in the setting. A field value on the product variant can be provided as the ** data type** string but you may want to sort it as a number or a boolean.

For example, 

`sku.attribute.total`
 is a string field but needs to be sorted as a number in the following example:

1{
2    "sort": [
3        { "field":"sku.attributes.subDepartment", "type": "string", "order": "DESC" },
4        { "field":"sku.attributes.total", "type": "number" }
5    ]
6}

Language: json

Name: Sorting Type code

Description:

[Warning: empty required content area]
  • In the Sorting Type code, the following values are accepted for the type property:
    • String
    • Number
    • Boolean
    • Object

For Boolean fields the default ascending sort order is true --> false and the descending order is false --> true.

Order 

order is an optional property used to set the sorting order (

`ASC`
 or 
`DESC`
). By default, sorting is in the ascending order.

The following image shows a custom picklist sorted by SubDepartment and createdOn fields:

No alt providedNo alt provided
Fluent Commerce staff

Fluent Commerce staff

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