system.mes.inventory.validateLot

Description

Validates the specified parameters for an Inventory Lots record and returns any validation errors. This only checks if the inventory lot can be saved based on the attributes given, without actually creating or modifying any inventory lots. Use this function to verify your parameters before executing a save lot operation.

Syntax

system.mes.inventory.validateLot(**lot_data)

Parameters

Parameter	Type	Nullable	Description
name	String	False	The name of the inventory lot.
materialId	String (ULID)	False	The ULID of the material associated with this inventory lot.
status	String	True	The status of the inventory lot.
totalQuantity	Double	False	The total quantity of material in the inventory lot. Must be greater than or equal to 0
unitOfMeasureId	String (ULID)	False	The ULID of the unit of measure for the quantity of the inventory lot.
expirationDate	Instant	True	The expected expiration date of the inventory lot.
closedDate	Instant	True	The date that the inventory lot was closed.
supplierId	String (ULID)	True	The ULID of the supplier for the inventory lot.
id	String (ULID)	True	The ULID of the inventory lot (optional, used for updating an existing inventory lot).
notes	String	True	Notes related to the inventory lot.
enabled	Boolean	True	Indicates if the inventory lot is active and enabled.
spare1	String	True	Additional field for user-defined context.
spare2	String	True	Additional field for user-defined context.
spare3	String	True	Additional field for user-defined context.

Returns

Returns a JSON object where keys are field names and values are lists of validation violation messages.

Code Examples

# Generate the object structure for a new inventory lot object
lot_data = system.mes.inventory.newLot()

# Set basic attributes for the new inventory lot
lot_data['name'] = 'L2824L9CO'
lot_data['materialId'] = '01JCH3GRA3-5ZYFZV5V-RW3FKFJX'
lot_data['unitOfMeasureId'] = '01JCH3T85P-KVCB8ZR5-0B83A3SX'
# (You can continue setting other properties as needed here)

# Validate inventory lot parameters
validation_errors = system.mes.inventory.validateLot(**lot_data)

if len(validation_errors) > 0:
    print('Validation errors found:', validation_errors)
else:
    print('Lot parameters are valid.')