Skip to main content

system.mes.inventory.newProduceRequest

Generates an empty non-persisted Produce Request to provide the structure required by the API to save a new record into the database. This method must be combined with the produce method in order to persist the record.

Syntax

system.mes.inventory.newProduceRequest()

Parameters

ParameterTypeDescription
None-This method does not take any parameters.

Returns

Returns a JSON representation of the newly created Produce Request object. The following is a list of keys and default values:

KeyDefault Value
typePRODUCE
quantitynull
unitOfMeasureSymbolnull
lotIdOrNamenull
materialIdOrPathnull
destinationLocationIdOrPathnull
producingLotIdOrNamenull
sourceLocationIdOrPathnull
createIfNotExistsfalse
operationIdnull
productionOrderIdOrNamenull
incrementProductionOrderCountfalse
materialReasonCodeIdnull
startDateCurrent Time
endDatenull
ongoingfalse
inventoryNamenull
notesnull
spare1null
spare2null
spare3null

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)