Confirm Count LPN Scan

This API allows you to confirm the count of LPNs. This is if you to confirm the list of LPNs in the location.

URLs

POST .../wms/lgfapi/v10/entity/location/{id}/cc_confirm_count_lpn_scan
Note: With ID in the URL, there are no request parameters, just options.

OR

POST .../wms/lgfapi/v10/entity/location/cc_confirm_count_lpn_scan

with request parameters and options

Request Parameters

parameters(filters)
  • Only applicable when `id` is not present in the URL.
Name Required Type Default Description
facility_id C Integer

Facility context by id.

one of id or code should be provided

facility_id__code C String

Facility context by code.

one of id or code should be provided

barcode Y String Location user is doing Cycle Count
  • Only one of `facility_id` or `facility_id__code` may be provided.
If after applying the parameters it matches more than one location, it is an error condition.

Options

Name Required Type Default Description
lpn_nbr_list Y String List of LPNs
validate_only_flg Y Boolean true or false
deferred_mode_flg Y Boolean
  • If validate flag is set to true. We will return success message with details such as LPNs missing ( LPNs system expected to be scanned, but were not send in the request)
  • If validate flag is set to False, and user passes the same number of LPNs ( missing some lpns the system was expecting to be sent) then the system will take as those LPNs are not in the location.
  • If deferred_mode_flg is on. It would not matter the value in company parm INVN_ADJ_APPROVAL_REQUIRED. If this flag is set to YES. Approval is required if there is an Inventory adjustment in the location.
Note: deferred_mode_flg value will be irrelevant when validate_flg is true. In other words validation is the same regardless of the deferred_mode_flg.

Example:

POST .../wms/lgfapi/v10/entity/location/cc_confirm_count_lpn_scan
{
    "parameters": {
        "facility_id__code": "FAC",
        "barcode": "Location001"
    },
    "options": {
        "lpn_nbr_list": ["lpn1", "lpn2", "lpn3"],
        "validate_only_flg": "Y",
        "deferred_mode_flg": "Y"
    }
}

Request sent with an ID:

POST .../wms/lgfapi/v10/entity/location/{id}/cc_confirm_count_lpn_scan
{
   "options": {
        "lpn_nbr_list": ["lpn1", "lpn2", "lpn3"],
        "validate_only_flg": "Y",
        "deferred_mode_flg": "Y" 
    }
} 

Response

Response is not paginated as its only for one location whether the request uses parameters or ID

if validate is True and successful it will be a 200 response with the response JSON payload

if validate is False and successful, then response is 204, no payload

With 200 - OK (No Pagination) for validate True

{
    "new_lpn_nbr_list": ["lpn1"]     
    "matching_lpn_nbr_list": ["lpn2", "lpn3"]
    "missing_lpn_nbr_list": ["lpn4", "lpn5"]
}