system.mes.inventory.newConsumeRequest

Description

Generates an empty Consume Request to provide the structure required by the API to save a new record into the database. This method must be combined with the consume method in order to persist the record.

Permissions

This method does not require any permissions.

Syntax

system.mes.inventory.newConsumeRequest()

Parameters

Parameter	Type	Nullable	Description
None	-	-	This method does not take any parameters.

Returns

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

Key	Default Value
type	CONSUME
quantity	null
unitOfMeasureSymbol	null
lotIdOrName	null
materialIdOrPath	null
sourceLocationIdOrPath	null
consumingLotIdOrName	null
consumingMaterialIdOrPath	null
destinationLocationIdOrPath	null
createIfNotExists	false
operationId	null
inventoryOperationId	null
productionOrderIdOrName	null
materialReasonCodeId	null
startDate	Current Time
endDate	null
ongoing	false
inventoryName	null
notes	null
spare1	null
spare2	null
spare3	null

Code Examples

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

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

# Consume the request
consumedRequest = system.mes.inventory.consume(**newRequest)

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