Create Return

Create a return request for inspection and pending claim process.

API Endpoint

URL	{base url}/api/Return/CreateOrderReturn
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	true	Return request source DEL=Delivery CUS=Customer TRN=Lost
ReturnDate	string	true	Date of return request (dd-mm-yyyy hh:mm)
OrderId	string	true	Order ID
OrderNo	string	true	Order Number
Campaign	string	false	Campaign name
Barcode	string	false	Reference barcode
TrackingNo	string	true	Tracking number
OrderSource	string	false	Order source or sales channel
PlatformCode	string	false	Sales platform code
CourierCode	string	false	Courier code (if unknown, specify in "Deliver")
Deliver	string	false	Delivery provider
CustomerId	string	false	Customer ID (if unknown, specify in "Customer")
Customer	string	false	Customer name
Reason	string	true	Return reason
Tag	string	false	Search tag (#special #free etc..)
ReturnType	string	true	Return type RET=Product Return REJ=Rejected/Undelivered LOS=Lost
RefOrderId	string	false	Reference sales ID
RefOrderNo	string	false	Reference sales number
RefTracking	string	false	Refer to the original parcel number
ReturnItem	object	true	Item detail

ReturnItem

Parameter	Type	Required	Description
Sku	string	true	SKU ID or code
Barcode	string	true	Product barcode
OrderQty	integer	true	Quantity ordered (If there is no information, do not specify.)
ReturnQty	integer	true	Quantity to return
Reason	string	true	Return reason
Tag	string	false	Search tag (#damage etc.)

Request JSON Example

{
  "ReturnDate": "26-05-2025 14:30",
  "ReturnBy": "DEL",
  "ReturnType": "RET",
  "TrackingNo": "TRK1234567890",
  "Barcode": "BRC123456789",
  "Campaign": "SummerSale",
  "Customer": "Mr. Somchai",
  "CustomerId": null,
  "Deliver": null,
  "CourierCode": "DHL",
  "OrderId": "ORD0012345",
  "OrderNo": "ON-99887766",
  "OrderSource": "Lazada",
  "PlatformCode": "LZD",
  "Reason": "Damaged product",
  "Tag": "TAG123",
  "RefOrderId": "ORD00330242",
  "RefOrderNo": "ON-55667788",
  "RefTracking": "TRK9988776655",
  "ReturnItem": [
    {
      "Sku": "SKU001",
      "Barcode": "BRC123456789",
      "OrderQty": 2,
      "ReturnQty": 1,
      "Reason": "Broken item",
      "Tag": "TAG001"
    },
    {
      "Sku": "SKU002",
      "Barcode": "BRC987654321",
      "OrderQty": 1,
      "ReturnQty": 1,
      "Reason": "Incomplete item",
      "Tag": "TAG002"
    }
  ]
}

Response Parameters

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

Response JSON Example

{
  "Id": 0,
  "Success": true,
  "Message": "SUCCESS",
  "RequestId": "30B2A080-E1E0-424A-AD0E-748AD5F78957",
  "Size": 1,
  "Data": {
        "ReturnId": "3EAA1D47-1841-4BE7-9FED-1BE2E922A9AA",
        "ReturnOrderId": "579311135594218771",
        "ReturnOrderNo": "1022839115773732",
        "TrackingNo": "TH256929970493H",
    }
}