Consolidate API

The new Consolidation API supports the consolidation phase of the consolidation and distribution flow. This API allows for incremental picking and provides a flexible way to manage the consolidation process. This API integrates with MHE systems and handles various scenarios, including batch, expiry, attribute, and serial number tracking.

URL

POST ...lgfapi/v10/pick_pack/consolidate/

Request Parameters

The API accepts a JSON payload with the following parameters:

Parameter	Description
pick_list	a list of pick/short operations
mhe_mode_flg	a flag to enforce MHE system code (default: True)
async_flg	a flag to run the API asynchronously (default: True)
Request-Level Flags	mhe_mode_flg and async_flg

Pick List Parameters

These represent the parameters required for a single pick/short:

Name	Required	Type	Default	Description
facility_id		Integer		Facility context by id.
facility_id__code		String		Facility context by code.
company_id		Integer		Company context by id.
company_id___code		String		Company context by code.
task_nbr		String		Associated Task.
order_nbr		String		Internal picking order associated with the consolidation allocations
wave_nbr		String		Associated Wave.
item_alternate_code	C	String		Item identifier.
item_barcode	C	String		Item identifier.
qty	X	Number	0	Quantity to be picked.
batch_nbr		String		batch/lot of inventory to be picked.
expiry_date		String		expiry date of inventory to be picked.
invn_attr_a to invn_attr_o		String		attributes on inventory to be picked.
serial_list{...}		List of strings		serials of the inventory to be picked.
suppress_serial_warning _flg (refer other API)		Boolean	False
allocation_uom		String		allocated uom or the non std uom picked, for the consolidated allocation
uom_qty		Number		Filter on Case or Pack quantity when searching for allocations.
distribution_uom	C	String		"UNITS", if different from the allocation UOM. System assumes alloc_uom if not passed/blank OR explicitly passing ORIG_UOM derives the same result. For anything other than alloc uom/units passed or some failure, fall back to units
pick_location	C	String		From Active location.
from_container_nbr	C	String		From container.
to_container_nbr	C	String		Intermediate IBLPN number to which inventory is being picked into. Not required for short.
mhe_system_code	C	String		MHE system.
short_flg		Boolean	False	short_flg = false; Qty sent will be picked/packed. short_flg= true; Qty sent will be shorted.
reason_code		String		Reason for Short
close_flg		Boolean	False
update_inventory_on_short_flg	C	Boolean	False
location_barcode	C	String		location of type drop, to locate the intermediate LPN. This is conditional and is required when close_flg = Yes.

Request Level Flags

Name	Required	Type	Default	Description
mhe_mode_flg		Boolean	True	When true, enforce that "mhe_system_code" is provided.
async_flg		Boolean	True	Run API asynchronously?