Return list

Displays returned order list based on specified conditions

API Endpoint

URL	{base url}/api/Return/GetOrdersReturn
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
ReturnBy	string	false	Return request source DEL=Delivery CUS=Customer TRN=Lost
From_Date	string	true	Return request start date (dd-mm-yyyy)
To_Date	string	true	Return request end date (dd-mm-yyyy)
ReturnId	string	false	Return ID
OrderId	string	false	Order ID
OrderNo	string	false	Order number
TrackingNo	string	false	Tracking number
ReturnType	string	false	Return type RET=Return product REJ=Rejected LOS=Lost
ReturnStatus	string	false	Return status
FindText	string	false	Additional search text
Received	boolean	false	Has the item been received back?
Limit	int	true	Maximum number of records to return (max 50)
LoadIndex	int	true	Request load index (pagination)

Request JSON Example

{
  "From_Date": "25-05-2025",
  "To_Date": "27-05-2025",
  "OrderId": "ORD0012345",
  "OrderNo": "ON-99887766",
  "TrackingNo": "TRK1234567890",
  "ReturnStatus": "01",
  "ReturnType": "RET",
  "FindText": "Somchai",
  "Received": false,
  "Limit": 50,
  "LoadIndex": 1
}

Response Parameters

Parameter	Type	Description
Id	integer	Error status (0 = No error)
Success	boolean	Request status
Message	string	Response message
RequestId	string	Request reference ID
Size	integer	Number of returned records
Data	object	Returned data

Data

Parameter	Type	Description
Id	string	Return record ID
ReturnBy	string	Returned by
ReturnDate	Datetime	Return request date
OrderId	string	Order ID
OrderNo	string	Order number
Campaign	string	Campaign
Barcode	string	Return barcode
TrackingNo	string	Tracking number
OrderSource	string	Sales channel
Platform	object	Platform info
Courier	object	Carrier info
Deliver	string	Delivery provider name
CustomerId	string	Customer ID
Customer	string	Customer name
Reason	string	Return reason
Tag	string	Search tag
ReturnType	string	Return type
ReturnStatus	string	Return status 01 = under inspection 02 = the warehouse has received the return and inspected the goods
ReturnStatusDesc	string	Status Description
Received	boolean	Is it received?
RefOrderId	string	Reference sales ID
RefOrderNo	string	Reference sales number
RefTracking	string	Refer to the original parcel number
ReturnItem	object	Returned item details

ReturnItem

Parameter	Type	Description
Sku	string	Product SKU
Barcode	string	Product barcode
OrderQty	int	Ordered quantity
ReturnQty	int	Quantity to return
ReceivedQty	int	Quantity received
ReceivedDate	Datetime	Refund Date
ReceivedGood	int	Complete product quantity
ReceivedDamage	int	Number of damaged goods
ReturnStatus	string	Item return status
Reason	string	Return reason
Tag	string	Search tag

Response JSON Example

{
    "Id": 0,
    "Success": true,
    "Message": "SUCCESS",
    "RequestId": "6FB2FD3D-B030-4EC2-BE64-376B42188D38",
    "Size": 1,
    "Data": [
        {
            "Id": "1142FD5D-E34B-4466-88D1-4CABCB797A3E",
            "ReturnBy": "DEL",
            "ReturnDate": "2025-05-26T14:30:00",
            "OrderId": "ORD0012345",
            "OrderNo": "ON-99887766",
            "Campaign": "SummerSale",
            "Barcode": "BRC123456789",
            "TrackingNo": "TRK1234567890",
            "OrderSource": "Lazada",
                     "Platform": {
                "Key": "SHP",
                "Value": "Shopee"
            },
            "Courier": {
                "Key": "FLASH",
                "Value": "Flash Express"
            },
            "Deliver": null,
            "CustomerId": null,
            "Customer": "คุณสมชาย ลูกค้า",
            "Reason": "ของเสียหาย",
            "Tag": "TAG123",
            "ReturnType": "RET",
            "ReturnStatus": "01",
            "Received": false,
            "RefOrderId": null,
            "RefOrderNo": null,
            "RefTracking": null,
            "ReturnItem": [
                {
                    "Sku": "SKU001",
                    "Barcode": "BRC123456789",
                    "OrderQty": 2,
                    "ReturnQty": 1,
                    "ReceivedQty": 0,
                    "ReceivedDate": null,
                    "ReceivedGood": 0,
                    "ReceivedDamage": 0,
                    "ReturnStatus": "01",
                    "Reason": "สินค้าแตกหัก",
                    "Tag": "TAG001"
                },
                {
                    "Sku": "SKU002",
                    "Barcode": "BRC987654321",
                    "OrderQty": 1,
                    "ReturnQty": 1,
                    "ReceivedQty": 0,
                    "ReceivedDate": null,
                    "ReceivedGood": 0,
                    "ReceivedDamage": 0,
                    "ReturnStatus": "01",
                    "Reason": "ของไม่ครบ",
                    "Tag": "TAG002"
                }
            ]
        }
    ]
}