Split LPN for Replenishment

The new split LPN for Replenishment API allows third party integration systems or Product as a service (PAAS) to do split an existing replenishment allocation of type “REPLEN_CS_PK_UNITS” into multiple smaller tasks as FULL LPN replenishments. This would be most conducive if you have an LPN that contains more than one unit of an UOM, and it does not fit for example on a conveyor belt.

You can split the LPN by it’s UOM, and it can fit on the conveyor and be used for allocations created during Mode 2 Replenishment. You can pass a fully or partly allocated container number in the API call. This container number is considered your source LPN. In the request parameter, you can pass inventory information (such as item, batch, expiry date, or inventory attributes a-o), quantities for the source LPN UOM that is being tracked, and more. This information will be used to track the new LPN along the conveyor, and it will create a new task with task type “REPLEN_LPN.”Note: The Split LPN for Replenishment API does not support serial number, and it will be added in a future release.

POST .../wms/lgfapi/v10/entity/iblpn/<id>/split_lpn_for_replen
POST .../wms/lgfapi/v10/entity/iblpn/split_lpn_for_replen

Name	Type	Required	Description
facility_id	Integer	C	Facility context by id. one of id or code should be provided
facility_id__code	String	C	Facility context by code. one of id or code should be provided
company_id	String	C	Company context by id. one of id or code should be provided
company_id__code	String	N	Company context by code. one of id or code should be provided
container_nbr	String	Y	Container/Source LPN pulled for split

If facility and/or company are provided, set login context accordingly.
Only one of `facility_id` or `facility_id__code` may be provided.
Only one of `company_id` or `company_id__code` may be provided.

Example:

{
    "parameters": {
        "facility_id__code": "FAC",
        "company_id": 1,
        "container_nbr": "LPN123"
    }
}

Request Parameters - Options

Name	Required	Type	Default	Description
item_barcode	C	String		one of item_barcode or item_alternate_code is required
item_alternate_code	C	String		one of item_barcode or item_alternate_code is required
batch_nbr		String		batch specified on the inventory in the source LPN
expiry_date		String		expiry of inventory in the source LPN
invn_attr_a to invn_attr_o		String		inventory attributes A to O specified on the inventory
qty_in_uom	X	integer		new parameter. Total Qty in UOM.(2 units/2 cs/2pks)
new_container_nbr_list	X	list of Strings		new parameter. List of new LPN numbers
location_barcode	Optional	String		must be of location type DROP
task_type_description	X	String		Description of REPLEN_LPN task type

Example

{
    "options": {
        "item_barcode": "ITEM123"
        "batch_nbr": "BTCH123"
        "invn_attr_a": "AA123"
        "qty_in_uom": 2
        "new_container_nbr_list": ["lpn1","lpn2"],
        "location_barcode": "LOC1",
        "task_type_description": "Full LPN Replenishment - PM"
    }
}

Full Request Body Examples

Request with `id` in URL

POST .../wms/lgfapi/v10/entity/iblpn/<id>/split_lpn_for_replen
{
    "options": {
        "item_barcode": "LOAD123",
        "batch_nbr": "BTCH123",
        "invn_attr_a": "AA123",
        "qty_in_uom": 4,
        "new_container_nbr_list": ["lpn1","lpn2","lpn3","lpn4"],
        "location_barcode": "LOC1",
        "task_type_description": "Full LPN Replenishment - PM"
    }
}

Request without ID in URL:

POST .../wms/lgfapi/v10/entity/iblpn/split_lpn_for_replen
{
    "parameters": {
        "facility_id__code": "FAC",
        "company_id": 1,
        "container_nbr": "LPN123"
    },
    "options": {
        "item_alternate_code": "ITEM123"
        "qty_in_uom": 4, 
        "new_container_nbr_list": ["lpn1","lpn2","lpn3","lpn4"], 
        "location_barcode": "LOC1",
        "task_type_description": "Full LPN Replenishment - PM"
    }
}

Track User Activity

If you have purchased WFM (Oracle Workforce Management), you can also send user activity data using the following parameters in the Split LPN for Replenishment API

Screen_name: Name of the application or screen in the external system that was used by the user to split LPN.
Begin_ts: Time at which the user started split LPN.
End_ts: Time at which the user completed split LPN.

If all the three parameters are sent in the API, and if WFM is enabled, user activity is written to the WMS Activity view and subsequently interfaced to WFM, enabling you to analyze user productivity through productivity reports in WFM.

Note:

All three parameters must be sent for WMS Activity to be written.
If WFM is not enabled, WMS Activity is not written even if the three parameters are sent.
In order for WMS Activity data to interface successfully to WFM, screen_name that is sent in the API has to be configured as a screen in WMS using an RF module and mapped to a work area activity in WFM.
Screen_name sent on the API is also written on the corresponding IHTs that are written with this API.
If only screen_name is sent without begin_ts and end_ts, the screen_name is written on the IHT, even if WFM is not enabled.
Begin_ts and End_ts cannot be greater than the current timestamp of the facility in the API.

Request Body with User Activity Data

{
"parameters": {
    "facility_id": 101,
    "company_id": 102,
    "container_nbr": "LPN123"
},
"options": {
    "item_alternate_code": "ITEM123"
    "qty_in_uom": 4,
    "new_container_nbr_list": ["lpn1","lpn2","lpn3","lpn4"],
    "location_barcode": "LOC1",
    "task_type_description": "Full LPN Replenishment - PM",
    "begin_ts": "2024-05-27T18:30:00",
    "end_ts": "2024-05-27T18:45:00",
    "screen_name": "Split LPN For Replen Screen"
}
}