View batches in a store
A store associate can view batches of products from one or more orders, such that the store associate can select a batch and pick the products in an efficient manner, as compared to the traditional single order pick.
Batches can be created based on different criteria such as departments, batch type, which includes sort while pick and sort after pick, number of orders, SLA, and so on. The Batches screen displays new and existing batches.
Solution
The following section describes APIs, user exits, services, and other components.
When the store associate clicks Pick Batches on the Pick Orders portlet in the Order Fulfillment View, the getStoreBatchList API is called to display the batches in the Batches screen. The getStoreBatchList API must be called with a valid OrganizationCode attribute, otherwise an appropriate error message is displayed. This API fetches all batches, including new and in-progress. However, only the in-progress batches are retrieved from the database and the newly formed batches are only displayed, but batch records are not created in the database. The status of these batches is 1000, which indicates a draft batch. By default, batches are created based on SLA for the orders and the number of orders allowed in a batch. An SLA indicator is displayed for each batch on the user interface to show the store associate, the order in which the batches need to be picked.
Ready for Backroom Pickstatus, they are included along with sales orders in batches. Batch picking is done based on SLA priority and irrespective of the document type. The batch pick process for transfer orders follows the same logic as that of sales orders. If
Combine BOPUS and SFS orders in batches rule is disabled, then the transfer orders are combined with Ship from Store orders.- Configure and filter
- The store associate can configure and filter the batches. The store associate can click the Configure batches icon and select the sort method and the maximum number of orders per batch. The sort method can be
Sort while pick
orSort after pick
. If the store associate does not configure the preferences,Sort While Pick
is considered as the default sort method and the limit for the maximum number of orders in a batch is defaulted to 10.Note: Configuring a batch always applies to newly created batches and not the existing batches.The store associate can also click the Refine Batch List icon to filter the batches by status, either
Picked in last 24 hrs
,Not started
orIn progress
. By default,Not started
andIn-progress
batches are shown. If the store associate selectsPicked in last 24 hrs
, batches picked within the last 24 hours are displayed. When a store associate chooses a filter, it is saved for the current session and is applicable until either the store associate logs out or choose different filter options.
- Retrieve new batches
- When the Batches screen loads, the following logic is executed:
- The
getUserUiStateListAPI is called to fetch the user preferences that is used to determine the maximum number of orders in a batch. From the user preferences, theMaxNumberOfShipmentsattribute is retrieved. - The
getStoreBatchListAPI is called withGetNewBatchesset toY. The API queries theYFS_SHIPMENT_LINEtable to form batches of unpicked shipment lines that belong to shipments that are either inReady for Backroom Pick
orBackroom Pick in Progress
status. - The shipment lines are sorted into batches using the
ConfigureBatchByelement. TheConfigureBatchByelement that is passed in the input to thegetStoreBatchListAPI, can take multiple attributes as the batch criteria. EachConfigureBatchByelement consists of theAttributechild element. EveryAttributeelement has theEntityattribute which specifies the entity to which the attribute belongs. The allowed entities are
andShipment
. The batch is configured for the value passed in theShipmentLineNameattribute. For example,Entity=ShipmentLine Name=ItemID. - If
Combine BOPUS orders and SFS orders in batches
rule is enabled, the batch criteria is defaulted toDepartmentCode. If the rule is disabled, then theDepartmentCodeandDeliveryMethodare passed as batch criteria in theConfigureBatchByelement. - Batches are comprised of shipment lines, which are based on the criteria that is provided in the
ConfigureBatchByelement of the API input. If no criteria is provided for theConfigureBatchByelement, then batches are grouped by theDepartmentCodeattribute of the shipment lines. To ensure that separate batches are created for departments or department groups, you must ensure the following:- Configure Departments at the catalog organization level.
- Configure Department Groups at the store level.
- The
DepartmentCodeattribute is populated for all shipment lines.
- When the count of shipments reaches
MaxNumberOfShipmentspassed in the input, batches are formed based on the unique combinations of attributes in theConfigureBatchByelement.
- The
- Retrieve existing batches
- When the Batches screen loads, the
getStoreBatchListAPI is called with theGetExistingBatchesattribute set toYin the input. The API queries theYFS_STORE_BATCHtable to fetch the existing batches for the current store, that match theStatusand other attributes passed in the input. If theGetBatchesOfAllUsersattribute is passed asNin the input to the API, only the batches that belong to the current user are fetched.
- User exits
- If the
getStoreBatchListAPI is called and theGetNewBatchesattribute is set toY, then the user exitcom.yantra.pca.ycd.japi.ue.YCDGetNewBatchesis triggered. This user exit retrieves unpicked shipment lines, creates batches based on any user-input logic, and then returns the batch list.
Device-specific details
None
Implementation
The following section describes the rules that must be configured for the feature.
- A store associate with
Batch Pick Orders
resource permission can perform batch picking. - You can set the
Combine BOPUS orders and SFS ordersrule to Yes or No depending on whether you want to combine products fromPickup in Store
andShip from Store
orders in the same batch or separate them into different batches. An appropriate icon is displayed to distinguish the batches based on the order fulfillment type. This configuration affects only theNot started
batches while theIn progress
batches are not affected. Further, you can also configure department groups to logically group the departments in an organization. For more information, see Configuring batches. - For more information about administering user group permissions, see Administering User Group Permissions.
- For more information about the APIs, see Javadoc.