Consolidate

The Consolidate replenishment API picks by directing inventory from active locations or specific source containers into an intermediate IBLPN, with options for shorting and closing in the same flow.

 POST .../lgfapi/v10/replenishment/consolidate/

Request Parameters

Parameter Type Required/Default Description
mhe_mode_flg Boolean Default: true If true, mhe_system_code is required and MHE validations apply.
async_flg Boolean Default: true true = Async (202); false = Sync (204)
facility_id / facility_id__code Integer / String One required Facility context (use either ID or code).
company_id / company_id__code Integer / String One required Company context (use either ID or code).
task_nbr String Required (see notes) Picking task number.
order_nbr String Required (see notes) Internal order number.
wave_nbr String Optional Associated wave number.
item_alternate_code/item_barcode String Required (pick one) Item identifier (either code or barcode).
qty Number Required Quantity to pick or short.
batch_nbr String Optional Batch/Lot.
expiry_date String Optional Expiry date.
invn_attr_a ... invn_attr_o String Optional Inventory attribute filters.
serial_nbr_list Array of String Optional For serialized items.
suppress_serial_warning_flg Boolean Default: false Suppress serial warning.
allocation_uom String Optional UOM for allocation.
uom_qty Number Optional Pack/case quantity filter for allocations.
distribution_uom String Optional UNITS or leaves blank for allocation UOM.
pick_location/from_container_nbr String One required Pick from location or container (pick one).
to_container_nbr String Required (for pick) Intermediate IBLPN to pick into.
mhe_system_code String Required if mhe_mode_flg true MHE system code.
short_flg Boolean Default: false Short the allocation.
reason_code String Optional Reason code for short.
close_flg Boolean Default: false Close IBLPN in this call.
update_inventory_on_short_flg Boolean Optional Inventory update on short.
location_barcode String Required if close_flg true Drop location on close.

Sample Payload

{
  "mhe_mode_flg": false,
  "async_flg": false,
  "pick_list": [
    {
      "facility_id__code": "FAC",
      "company_id": 1,
      "wave_nbr": "RWWAVE001",
      "task_nbr": "TSK001",
      "order_nbr": "PKFAC_ORDER001",
      "item_barcode": "ITEM1234",
      "distribution_uom": "UNITS",
      "qty": 10,
      "from_container_nbr": "IBLPN0001",
      "to_container_nbr": "OBLPN0001",
      "short_flg": false,
      "close_flg": false
    }
  ]
}