Return Order Information

The GetReturnOrderInfo endpoint returns information for a specific return order in the MIMS system.

---

How to query Return Order information

HTTP POST Request

Request Type	Example URL
POST	{{url_base}}/GetReturnOrderInfo
Example	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetReturnOrderInfo"

Input Parameters

Parameter	Type	Required	Description
ReturnOrderNo	String(25)	Yes	External return order code
BranchNo	String(25)	Yes	External branch code

---

Return

Parameter	Type	Required	Description
WebServiceReturn	WebServiceReturn	Yes	Standard WebService response information on method execution
ReturnOrderInfo	GetReturnOrderInfoData	Yes	Object containing return order data

📝 GetReturnOrderInfoData Object

The GetReturnOrderInfoData object represents a return order.

Return Parameters

Parameter	Type	Required	Description
ReturnOrderNo	String(25)	Yes	External return order code
SalesOrderNo	String(25)	Yes	External sales order code
BranchNo	String(25)	Yes	External branch code
ReturnOrderReasonNo	String(25)	Yes	External return reason code
ReturnOrderDate	DataHora	Yes	Return order date
ReturnOrderCloseDate	DataHora	Yes	Return order close date
ReturnOrderType	ReturnOrderType	Yes	Enumerator with possible values for Return Type: rtPartial (Partial), rtTotal (Total) or rtLeftovers (Load Leftovers)
ReturnOrderStatus	String(2)	Yes	Return order status
Notes	String(2000)	Yes	Return order observations
DestinationQty	Integer	Yes	Quantity of Destined Boxes
ItemList	GetReturnOrderItemInfoList	Yes	List of all return order items

📝 GetReturnOrderItemInfoList Object

The GetReturnOrderItemInfoList object represents a return order item.

Return Parameters

Parameter	Type	Required	Description
ItemNo	String(25)	Yes	External return order item code
ProductNo	String(25)	Yes	External product code
Qty	Integer	Yes	Quantity of boxes scheduled for return
Weight	Float	Yes	Weight of scheduled returned boxes
ReturnedQty	Integer	Yes	Quantity of read (identified) boxes
ReturnedWeight	Float	Yes	Weight of read (identified) boxes
ReturnRealQty	Integer	Yes	Real quantity of returned boxes
ReturnRealWeight	Float	Yes	Real returned weight
DispatchedQty	Integer	Yes	Quantity of delivered boxes
DispatchedWeight	Float	Yes	Expected quantity of boxes
DeliveredQty	Integer	Yes	Delivered quantity
DeliveredWeight	Float	Yes	Delivered weight
OperationValue	Float	Yes	Product unit value
ReturnTotalValue	Float	Yes	Total returned value
DispatchedTotalValue	Float	Yes	Expected total value
AdjustedQty	Integer	Yes	Quantity of adjusted boxes
AdjustedReasonNo	String(25)	Yes	External adjustment reason code
AdjustedReasonFactor	Integer	Yes	Adjustment reason factor
AdjustedReasonNotes	String(2000)	Yes	Adjustment reason observations
ShrinkPercentage	Float	Yes	Shrinkage percentage
ShrinkTotalValue	Float	Yes	Total shrinkage value
ShrinkWeight	Float	Yes	Shrinkage weight

---

Request Example

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetReturnOrderInfo"' \
--header 'Content-Type: application/json' \
--data '{
    "BranchNo": "0102",
    "ReturnOrderNo": "2406145"
}'

---

Response Example

{
  "WebServiceReturn": {
    "Status": "wrsSuccess",
    "ErrorCode": "",
    "Message": "",
    "Actor": "",
    "ReturnQuestion": null
  },
  "ReturnOrderInfo": {
    "ReturnOrderNo": "RET123",
    "SalesOrderNo": "SO456",
    "BranchNo": "BR001",
    "ReturnOrderDate": "2025-02-07T14:30:00Z",
    "ReturnOrderCloseDate": "2025-02-10T12:00:00Z",
    "ReturnOrderReasonNo": "REAS001",
    "ReturnOrderType": "rtPartial",
    "ReturnOrderStatus": "T",
    "Notes": "Return due to product defect.",
    "DestinationQty": 10,
    "ItemList": [
      {
        "ItemNo": "ITEM001",
        "ProductNo": "PROD001",
        "Qty": 5,
        "Weight": 10.0,
        "ReturnedQty": 5,
        "ReturnedWeight": 10.0,
        "ReturnRealQty": 5,
        "ReturnRealWeight": 10.0,
        "DispatchedQty": 5,
        "DispatchedWeight": 10.0,
        "DeliveredQty": 5,
        "DeliveredWeight": 10.0,
        "OperationValue": 25.50,
        "ReturnTotalValue": 127.50,
        "DispatchedTotalValue": 127.50,
        "AdjustedQty": 0,
        "AdjustedReasonNo": "",
        "AdjustedReasonFactor": 0,
        "AdjustedReasonNotes": "",
        "ShrinkPercentage": 0.0,
        "ShrinkTotalValue": 0.0,
        "ShrinkWeight": 0.0
      }
    ]
  }
}

---

🐞 Possible Errors

Code	Message
GRO‑001	The informed "ReturnOrderNo" ([value sent in request]) does not exist in branch "BranchNo" ([value sent in request]) informed

---