system.mes.inventory.editInventoryQuantity

Description

Edit inventory quantity from the MES based on the provided parameters.

Permissions

This method requires the INVENTORY.WRITE.EDIT permission.

Syntax

system.mes.inventory.editInventoryQuantity(**editInventoryQuantityRequest)

Parameters

Parameter	Type	Nullable	Description
type	String	True	The type of request defined by the LotRecordType Enum. It is internally set and must not be modified, as changes may break functionality.
newQuantity	Double	False	The new quantity to be assigned to the inventory.
unitOfMeasureSymbol	String	True	The symbol of the unit of measure for the quantity.
lotIdOrName	String	True	The ID or name of the inventory lot whose quantity is being edited.
materialIdOrPath	String	False	The ID or path of the material whose quantity is being edited.
sourceLocationIdOrPath	String	False	The ID or path of the location from the inventory quantity is being edited.
destinationLotIdOrName	String	True	The ID or name of the inventory lot the adjusted quantity is accounted to, for example the lot a miscounted quantity actually belonged to. Recorded as the lot record's secondary lot so track and trace can draw an edge from the edited lot to this lot. Leave it unset for an ordinary recount that involves no other lot. A name that matches no existing lot creates one. Recorded for traceability only, the named lot's quantities are untouched. See the note below on the direction of the recorded edge.
destinationMaterialIdOrPath	String	True	The ID or path of the material for the destination lot. Only needed when it differs from materialIdOrPath.
operationId	String (ULID)	True	The ID of the operation editing the quantity of this inventory.
inventoryOperationId	String (ULID)	True	The ID of the inventory operation related to this edit inventory quantity action.
notes	String	True	Notes related to the edit inventory quantity request.
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.

Lot genealogy

Name destinationLotIdOrName to record the lot the adjusted quantity is accounted to, so track and trace can follow the correction from the edited lot into that lot. The link is recorded on the inventory lot record as its secondary lot, and is what getLotTraceGraph follows when it draws the genealogy. Naming a lot that does not exist yet creates it. No quantity arithmetic changes, the link is recorded for traceability only.

Edge direction on an upward correction

The recorded edge always points away from the edited lot, towards the lot named in destinationLotIdOrName. That reads correctly for a downward correction, where quantity leaves the edited lot. For an upward correction the material conceptually arrives from the other lot, so the edge points the opposite way to the real flow. Either record the correcting pair from the other lot's side as well, or read the edge as an association between the two lots rather than as a direction of flow.

Returns

Returns a JSON representation of an inventory lot record for an Edit Inventory Quantity Request.

Name	Type	Description
lotRecordType	String	The type of change for the record.
inventoryLotId	String (ULID)	The ULID of the primary inventory lot for the inventory lot record.
inventoryLotName	String	The name of the primary inventory lot for the inventory lot record.
secondaryInventoryLotId	String (ULID)	The ULID of the secondary inventory lot for the inventory lot record.
secondaryInventoryLotName	String	The name of the secondary inventory lot for the inventory lot record.
operationRecordId	String (ULID)	The ULID of the operation record for the inventory lot record.
inventoryOperationId	String (ULID)	The ULID of the inventory operation for the inventory lot record.
inventoryOperationName	String	The name of the inventory operation for the inventory lot record.
productionOrderId	String (ULID)	The ULID of the production order for the inventory lot record.
productionOrderName	String	The name of the production order for the inventory lot record.
materialReasonCodeId	String (ULID)	The ULID of the material reason code for the inventory lot record.
materialReasonCodeName	String	The name of the material reason code for the inventory lot record.
sourceLocationId	String (ULID)	The source location of the inventory or lot being operated.
sourceLocationName	String	The name of the source location of the inventory or lot being operated.
sourceLocationPath	String	The path of the source location of the inventory or lot being operated.
destinationLocationId	String (ULID)	The destination location of the inventory or lot being operated.
destinationLocationName	String	The name of the destination location of the inventory or lot being operated.
destinationLocationPath	String	The path of the destination location of the inventory or lot being operated.
lotStatus	String	The status of the inventory lot.
quantity	Double	The quantity of units being changed depending on the lotRecordType.
unitOfMeasureId	String	The ID of the unit of measure for the quantity.
unitOfMeasureName	String	The name of the unit of measure for the quantity.
unitOfMeasureSymbol	String	The symbol of the unit of measure for the quantity.
startDate	Instant	The beginning timestamp of the inventory lot change.
endDate	Instant	The end timestamp of the inventory lot change.
status	String	The status of the inventory lot record (e.g. Running, Completed, Faulted).
duration	Long	The duration in seconds.
shiftRecordId	String	The shift the inventory lot record occurred in.
id	String (ULID)	The ULID of the inventory lot record (optional, used for updating an existing inventory lot record).
notes	String	Notes related to the inventory lot.
enabled	Boolean	Indicates if the inventory lot is active and enabled.
spare1	String	Additional field for user-defined context.
spare2	String	Additional field for user-defined context.
spare3	String	Additional field for user-defined context.

Code Examples

# Generate the object structure for a new edit inventory quantity request object with no initial arguments
newRequest = system.mes.inventory.newEditInventoryQuantityRequest()

# Set basic attributes for the new edit inventory quantity request
newRequest['materialIdOrPath'] = 'Bottle/Milk'
newRequest['sourceLocationIdOrPath'] = 'DairyCo'
newRequest['newQuantity'] = 610
# (You can continue setting other properties as needed here)

# Edit the quantity of the inventory
editInventoryLotRecord = system.mes.inventory.editInventoryQuantity(**newRequest)

# Output the JSON representation of the lot record of the edit quantity action
print(editInventoryLotRecord)