system.mes.inventory.newReturnRequest

Description

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

Permissions

This method does not require any permissions.

Syntax

system.mes.inventory.newReturnRequest()

Parameters

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

Returns

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

Key	Default Value
type	RETURN
quantity	null
unitOfMeasureSymbol	null
lotIdOrName	null
materialIdOrPath	null
sourceLocationIdOrPath	null
destinationLotIdOrName	null
destinationMaterialIdOrPath	null
destinationLocationIdOrPath	null
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 return request object with no initial arguments
newRequest = system.mes.inventory.newReturnRequest()

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

# Return the request
returnedRequest = system.mes.inventory.returnInventory(**newRequest)

# Output the JSON representation of the returned request
print(returnedRequest)