system.mes.inventory.consume

Consumes inventory from the MES based on the provided parameters.

Syntax

system.mes.inventory.consume(**consume_request)

Parameters

Parameter	Type	Description
type	String	The type of request defined by the LotRecordType Enum. It is internally set and must not be modified, as changes may break functionality.
quantity	Double	The quantity to consume from the location.
unitOfMeasureSymbol	String	The symbol of the unit of measure for the quantity.
lotIdOrName	String	The ID or name of the inventory lot that will be consuming the given lot.
materialIdOrPath	String	The ID or path of the material being consumed.
sourceLocationIdOrPath	String	The ID or path of the location from which inventory will be consumed.
consumingLotIdOrName	String	The ID or name of the inventory lot from which the material is being consumed.
destinationLocationIdOrPath	String	The ID or path of the location the consumed inventory goes to.
createIfNotExists	Boolean	Indicates whether the system should create the lot if it does not exist.
operationId	String (ULID)	The ID of the operation consuming this inventory.
productionOrderIdOrName	String	The ID or name of the production order associated with the consumption.
materialReasonCodeId	String (ULID)	The ID of the material reason code to add additional context.
startDate	Instant	The start date and time of the consumption.
endDate	Instant	The end date and time of the consumption.
ongoing	Boolean	Indicates whether this request is ongoing.
inventoryName	String	The name of the inventory.
notes	String	Notes related to the consume request.
spare1	String	Additional field for user-defined context.
spare2	String	Additional field for user-defined context.
spare3	String	Additional field for user-defined context.

Returns

Returns a JSON representation of an inventory lot record for a Consume Request.

Code Examples

# Generate the object structure for a new consume request object with no initial arguments
new_request = system.mes.inventory.newConsumeRequest()

# Set basic attributes for the new consume request
new_request['materialIdOrPath'] = 'Bottle/Milk'
new_request['sourceLocationIdOrPath'] = 'DairyCo'
new_request['quantity'] = 610
new_request['createIfNotExists'] = True
# (You can continue setting other properties as needed here)

# Consume the request
consumed_request = system.mes.inventory.consume(**new_request)

# Output the JSON representation of the consumed request
print(consumed_request)