Skip to main content

system.mes.inventory.produce

Produces inventory from the MES based on the provided parameters.

Syntax

system.mes.inventory.produce(**produce_request)

Parameters

ParameterTypeDescription
typeStringThe type of request defined by the LotRecordType Enum. It is internally set and must not be modified, as changes may break functionality.
quantityDoubleThe quantity to produce from the location.
unitOfMeasureSymbolStringThe symbol of the unit of measure for the quantity.
lotIdOrNameStringThe ID or name of the inventory lot from which the material is being produced.
materialIdOrPathStringThe ID or path of the material being produced.
destinationLocationIdOrPathStringThe ID or path of the location the produced inventory goes to.
producingLotIdOrNameStringThe ID or name of the inventory lot that will be producing the given lot.
sourceLocationIdOrPathStringThe ID or path of the location from which inventory will be produced.
createIfNotExistsBooleanIndicates whether the system should create the lot if it does not exist.
operationIdString (ULID)The ID of the operation producing this inventory.
productionOrderIdOrNameStringThe ID or name of the production order associated with the production.
incrementProductionOrderCountBooleanIndicates whether to increment the production order count.
materialReasonCodeIdString (ULID)The ID of the material reason code to add additional context.
startDateInstantThe start date and time of the production.
endDateInstantThe end date and time of the production.
ongoingBooleanIndicates whether this request is ongoing.
inventoryNameStringThe name of the inventory.
notesStringNotes related to the produce request.
spare1StringAdditional field for user-defined context.
spare2StringAdditional field for user-defined context.
spare3StringAdditional field for user-defined context.

Returns

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

Code Examples

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

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

# Produce the request
produced_request = system.mes.inventory.produce(**new_request)

# Output the JSON representation of the produced request
print(produced_request)