UOM Input Interface

This API is used to interface UOMs in JSON format. The UOM Input Interface allows you to create UOMs.

URL

POST .../wms/lgfapi/v10/stage/uom/

Request Parameters

Parameter/Field Name	Type	Required	Maximum Length	Description
async_flg	Boolean (True/False)			By default, the value will be considered as false. If the value is true, then interface will run in async mode. If the value is false, then interface will run synchronously.
uom_code	String	Yes	10	Define UOM code. This field supports only uppercase letters.
uom_name	String	Yes	25	Define UOM name.
uom_class_code	String	Yes	20	The value should be an existing UOM_CLASS_CODE from UOM_CLASS table.
base_uom_conversion_factor	Number (Decimal)	Yes		Define the base UOM conversion factor.
is_package_uom_flag	Boolean	No		By default, the value will be considered as false.
base_uom_flg	Boolean	Yes		This will be used to define the Base UOM of a specific UOM Class.

Note:

• The system records the interfaced UOMs with “Predefined Flag” = “False”.
• The API processes Unit of Measure (UOM) entries in a specific order:
  • Entries with base_uom_flg=true (base UOMs) are processed first, followed by entries with base_uom_flg=false (non-base UOMs). This ensures that the base UOM of a UOM class is defined before creating any non-base UOMs.
  • Each uom_class must have only one base UOM.
  • For a base UOM, the base_uom_conversion_factor must be set to 1.
• The API enforces the following update rules for existing UOMs:
  • If the existing UOM is a base UOM (base_uom_flg=true), updates are allowed only for uom_name and is_package_uom_flg. Updates to other UOM fields are restricted to prevent impacting non-base UOM configurations.
  • If the existing UOM is a non-base UOM (base_uom_flg=false), updates are allowed for uom_name, uom_class, is_package_uom_flg, and base_uom_flg.

Request Body

{     
    "async_flg":false,
    
    "header": 
        {
        "document_version":"26A",
        "origin_system":"ENV1",
        "client_env_code":"ENV1",
        "parent_company_code": "COMP01",
        "entity": "uom",
        "timestamp": "2025-11-01T12:12:12",
        "company_code": "COMP01",
        "messageid": "uom"
        },
    "stage_uom_list": 
        [
            {
            "uom_code": "Pack",
            "uom_name": "pack",
            "uom_class_code": "QUANTITY",
            "base_uom_conversion_factor":6,
            "is_package_uom_flg":false,
            "base_uom_flg":false
            }
        ]
}

Sample Response

{
    "success": true,
    "response": {
        "message": "1 records were processed and 0 records had errors."
    }
}