Skip to main content

Load Information

The GetLoadInfo endpoint returns information about a specific load in the MIMS system


How to query a load

HTTP POST Request

Request TypeExample URL
POST{{url_base}}/GetLoadInfo
Examplehttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetLoadInfo"

Input Parameters

ParameterTypeRequiredDescription
LoadNoString(25)YesExternal code of the load
BranchNoString(25)YesExternal code of the branch
ReturnDispatchOriginTypeBooleanNoFlag indicating if the method should return product origin information

Return

ParameterTypeRequiredDescription
WebServiceReturnWebServiceReturnYesStandard WebService response information in method execution
LoadInfoDataGetLoadInfoDataYesLoad information

📝 GetLoadInfoData Object

The GetLoadInfoData object represents all information about a load.

Return Parameters

ParameterTypeRequiredDescription
LoadStatusString(2)YesLoad status
LoadClosureDateDataHoraYesLoad closure date/time
PalletBaseTotalWeightFloatYesTotal weight of pallet bases in the load
PalletAdditionalBaseTotalWeightFloatYesTotal weight of additional pallet bases in the load
PackageAdditionalBaseTotalWeightFloatYesTotal weight of additional package bases in the load
PalletQtyIntegerYesTotal boxes in the load
SealNoString(160)YesSeal number
LoadNetWeightFloatYesNet weight of the load obtained at the road scale
VehicleTareFloatYesVehicle tare
LoadTotalWeightFloatYesTotal shipping weight
WeighingStatusWeighingStatusYesEnumerator with possible values for Weighing Status: wssNotAssigned (Not Assigned), wssOpened (Open), wssClosed (Closed), wssExcluded (Excluded) or wssExit (Exit)
InitialWeighingOfTareDateDataHoraYesInitial Truck Tare Weighing Date/Time
IsBlockedForLogisticsBooleanYesFlag indicating that the load is blocked for logistics
SalesOrderListGetLoadInfoSalesOrderListYesList of all orders contained in the load

📝 GetLoadInfoSalesOrder Object

The GetLoadInfoSalesOrder object represents a sales order contained in the load.

Return Parameters

ParameterTypeRequiredDescription
SalesOrderNoString(25)YesExternal code of the sales order in the load
ItemListGetLoadInfoSalesOrderItemListYesList of all order items contained in the load

📝 GetLoadInfoSalesOrderItem Object

The GetLoadInfoSalesOrderItem object represents a sales order item contained in the load.

Return Parameters

ParameterTypeRequiredDescription
ItemNoString(25)YesExternal code of the sales order item in the load
ProdutoNoString(25)YesExternal code of the product
DispatchQtyIntegerYesQuantity of boxes shipped
DispatchWeightFloatYesShipped weight
DispatchTareFloatYesShipped tare
DispatchRealWeightFloatYesReal shipped weight
DispatchOriginTypeDispatchOriginTypeYesEnumerator with possible values for product origin: dotNotAssigned (Not Assigned), dotOwnProduction (Own Production) or dotTransfer (Transfer).
Note

If the ReturnDispatchOriginType parameter is set to false or not provided, the DispatchOriginType parameter will always be filled with the value dotNotAssigned (Not Assigned).


Request Example

curl --location 'http://10.5.1.4:8082/datasnap/rest/RESTWebServiceMethods/"GetLoadInfo"' \
--header 'Content-Type: application/json' \
--data '{
"BranchNo": "0102",
"LoadNo": "07072"
}'

Response Example

{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"LoadInfoData": {
"LoadStatus": "AB",
"LoadClosureDate": null,
"PalletBaseTotalWeight": 0.0,
"PalletAdditionalBaseTotalWeight": 0.0,
"PackageAdditionalBaseTotalWeight": 0.0,
"PalletQty": 0,
"SealNo": "SEAL123",
"LoadNetWeight": -21100.0,
"VehicleTare": 21100.0,
"LoadTotalWeight": 0.0,
"WeighingStatus": "wssOpened",
"InitialWeighingOfTareDate": "2025-11-14T09:52:16.510Z",
"IsBlockedForLogistics": false,
"SalesOrderList": [
{
"SalesOrderNo": "9DNZP1",
"ItemList": [
{
"ItemNo": "23314081",
"ProdutoNo": "160217",
"DispatchQty": 0,
"DispatchWeight": 0.0,
"DispatchTare": 0.0,
"DispatchRealWeight": 0.0,
"DispatchOriginType": "dotNotAssigned"
}
]
}
]
}
}