Return Status (SearchReturnStatus)
Get Of Return Status
To view the current status of your returns in the Rooster systems, the SearchReturnStatus() method is used. It supports both return number-based and bulk status listing.
- Before the return statuses can be listed using this method, you must have active returns in Horoz Logistics systems.
- To retrieve all returns in bulk, the returnCode parameter must be left blank.
POST SearchReturnStatus
Use
Parameter Descriptions & Rules
The following table lists the input and output parameters of the SearchReturnStatus() operation and the
types and formats of these parameters.
- Request Fields
- Response Fields
- Example Request
- Example Response
| Parameter | Mandatory | Description | Data Type |
|---|---|---|---|
processKey | Yes | Information provided to you for processKey | string |
returnCode | No | return code for single query | string |
| Parameter | Description | Data Type |
|---|---|---|
result | Transaction status (0-Successful / 1-Failed) | string |
errorCode | Error Message | string |
systemMessage | System Message | string |
resultData[] | Result Array | array |
resultData[]
| Parameter | Description | Data Type |
|---|---|---|
returnCode | Return Code | string |
statusDate | Return Date | datetime |
dataTransfer | Transfer Info | string |
status | Statu | string |
waybillNumber | Waybill Number | string |
waybillDate | Waybill Date | string |
parameter01/20 | Parameter Fields | string |
itemDetails[] | Item Detail Array | array |
itemDetails[]
| Parameter | Description | Data Type |
|---|---|---|
itemCode | Item Code | string |
quantity | Quantity | int |
reason | Description | string |
parameter01/20 | Parameter Fields | string |
{
"processKey": "A1389BF5246943ED8F40DEF725E0EE84",
"returnCode": ""
}
{
"resultData": [
{
"returnCode": "RTNLOREM",
"statusDate": "2026-04-14T00:00:00",
"dataTransfer": "TRANSFERINFO",
"status": "OK",
"waybillNumber": "HRZWAYBILLTEST",
"waybillDate": "2026-04-14T00:00:00",
"parameter01": "TESTPARAMETRIK",
"itemDetails": [
{
"itemCode": "PRO1",
"quantity": 1
}
]
}
],
"result": "1",
"errorCode": "",
"systemMessage": ""
}
Service Responses
| result | errorCode | systemMessage | Description |
|---|---|---|---|
| 0 | The return statuses were successfully brought. | ||
| 1 | 101 | A mistake has occurred! | Error messages are displayed in status displays. |