Return Items

Displays returned items based on the specified conditions.

API Endpoint

URL	{base url}/api/Return/GetReturnItems
Method	POST
Authorization	Bearer Token
Content-Type	application/json

Request Headers

Parameter	Type	Required	Description
APIKEY	string	true	System key code

Request Parameters

Parameter	Type	Required	Description
From_Date	string	true	Return request date (start), format: dd-mm-yyyy
To_Date	string	true	Return request date (end), format: dd-mm-yyyy
Sku	string	false	SKU code
Barcode	string	false	Product barcode
ReturnType	string	false	Return type RET = Return REJ = Rejected/Undelivered LOS = Lost
ReturnStatus	string	false	Return status
Received	boolean	false	Whether the returned item has been received
Limit	int	true	Number of records to return (max 50)
LoadIndex	int	true	Load batch index

Request JSON Example

{
  "From_Date": "20-05-2025",
  "To_Date": "04-06-2025",
  "Limit": 50,
  "LoadIndex": 1
}

Response Parameters

Parameter	Type	Description
Id	integer	Error code (0 = no error)
Success	boolean	Request success flag
Message	string	Response message
RequestId	string	Reference ID of the request
Size	integer	Number of records returned
Data	object	Returned items

Data

Parameter	Type	Description
Sku	string	SKU code
SkuName	string	Product name
Barcode	string	Product barcode
ReturnQty	int	Quantity returned
ReceivedQty	int	Quantity received
ReceivedDate	Datetime	Refund Date
ReceivedGood	int	Complete product quantity
ReceivedDamage	int	Number of damaged goods
ReturnStatus	string	Return status
Reason	string	Reason for return
OrderId	string	Order ID
OrderNo	string	Order number
TrackingNo	string	Tracking number

Response JSON Example

{
    "Id": 0,
    "Success": true,
    "Message": "SUCCESS",
    "RequestId": "0A92F613-F4B9-423F-8CBC-E1EDDE7F6CC6",
    "Size": 2,
    "Data": [
        {
            "Sku": "SKU001",
            "SkuName": "",
            "Barcode": "BRC123456789",
            "ReturnQty": 1,
            "ReceivedQty": 0,
            "ReceivedDate": null,
            "ReceivedGood": 0,
            "ReceivedDamage": 0,
            "ReturnStatus": "01",
            "Reason": "Broken item",
            "OrderId": "ORD0012345",
            "OrderNo": "ON-99887766",
            "TrackingNo": "TRK1234567890"
        },
        {
            "Sku": "SKU002",
            "SkuName": "",
            "Barcode": "BRC987654321",
            "ReturnQty": 1,
            "ReceivedQty": 0,
            "ReceivedDate": null,
            "ReceivedGood": 0,
            "ReceivedDamage": 0,
            "ReturnStatus": "01",
            "Reason": "Missing item",
            "OrderId": "ORD0012345",
            "OrderNo": "ON-99887766",
            "TrackingNo": "TRK1234567890"
        }
    ]
}