Returns all refund headers associated with the given order ID
| Name | Type | Description |
|---|---|---|
| request | GetRefundHeadersByOrderIdRequest | The request class for this call |
The following request format is required for this method.
POST https://eu-ext.linnworks.net//api/ReturnsRefunds/GetRefundHeadersByOrderId HTTP/1.1
Host: eu-ext.linnworks.net
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.linnworks.net
Accept-Language: en
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Referer: https://www.linnworks.net/
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE
request={
"OrderId": "5a640fc3-cdaa-4161-9eef-426d02f3dba9"
}
This is an example response. Results may vary depending on your data.
{
"RefundHeaders": [
{
"RefundHeaderId": 1,
"OrderId": "5aa8e340-26e3-4837-bd95-f6010cafb221",
"NumOrderId": 3,
"ExternalReference": "sample string 4",
"CreatedDate": "2019-08-21T13:34:05.027682+01:00",
"Currency": "sample string 6",
"Amount": 7.0,
"Status": {
"StatusHeader": 0,
"StatusDetail": {
"StatusTag": "sample string 1",
"StatusDescription": "sample string 2",
"Actionable": true,
"ActionDescription": "sample string 4",
"EditableFields": [
"sample string 1",
"sample string 2"
]
}
},
"Actioned": true,
"LastActionDate": "2019-08-21T13:34:05.027682+01:00",
"OrderSource": "sample string 10",
"OrderSubSource": "sample string 11",
"ChannelInitiated": true,
"RefundLines": [
{
"RefundRowId": "d71c3479-674a-4fe4-ae4c-302cb38be6df",
"RefundHeaderId": 2,
"Status": {
"StatusHeader": 0,
"StatusDetail": {
"StatusTag": "sample string 1",
"StatusDescription": "sample string 2",
"Actionable": true,
"ActionDescription": "sample string 4",
"EditableFields": [
"sample string 1",
"sample string 2"
]
}
},
"RefundedUnit": 0,
"IsShippingRefund": false,
"IsAdditionalRefund": false,
"RefundedItem": {
"OrderItemRowId": "71e45c56-6f61-4435-9b58-d3699908207d",
"ReturnRowId": 1,
"ItemSKU": "sample string 2",
"ChannelSKU": "sample string 3",
"ItemTitle": "sample string 4",
"Cost": 5.0,
"CancelledQuantity": 6
},
"ValidationError": "sample string 4",
"Error": "sample string 4",
"Errors": [
{
"RefundRowId": "8f2d0b87-69aa-4fad-ba0e-938a29d4602a",
"ErrorMessage": "sample string 2",
"DateStamp": "2019-08-21T13:34:05.027682+01:00",
"Acknowledged": true
},
{
"RefundRowId": "8f2d0b87-69aa-4fad-ba0e-938a29d4602a",
"ErrorMessage": "sample string 2",
"DateStamp": "2019-08-21T13:34:05.027682+01:00",
"Acknowledged": true
}
],
"ExternalReference": "sample string 5",
"Actioned": true,
"ActionedDate": "2019-08-21T13:34:05.027682+01:00",
"ChannelInitiated": true,
"Deleted": true,
"IsFreeText": false,
"FreeTextOrNote": "sample string 9",
"Amount": 10.0,
"Quantity": 11,
"ReasonTag": "sample string 12",
"SubReasonTag": "sample string 13",
"InsufficientRefundTag": "sample string 14",
"InsufficientRefundNote": "sample string 15"
},
{
"RefundRowId": "d71c3479-674a-4fe4-ae4c-302cb38be6df",
"RefundHeaderId": 2,
"Status": {
"StatusHeader": 0,
"StatusDetail": {
"StatusTag": "sample string 1",
"StatusDescription": "sample string 2",
"Actionable": true,
"ActionDescription": "sample string 4",
"EditableFields": [
"sample string 1",
"sample string 2"
]
}
},
"RefundedUnit": 0,
"IsShippingRefund": false,
"IsAdditionalRefund": false,
"RefundedItem": {
"OrderItemRowId": "71e45c56-6f61-4435-9b58-d3699908207d",
"ReturnRowId": 1,
"ItemSKU": "sample string 2",
"ChannelSKU": "sample string 3",
"ItemTitle": "sample string 4",
"Cost": 5.0,
"CancelledQuantity": 6
},
"ValidationError": "sample string 4",
"Error": "sample string 4",
"Errors": [
{
"RefundRowId": "8f2d0b87-69aa-4fad-ba0e-938a29d4602a",
"ErrorMessage": "sample string 2",
"DateStamp": "2019-08-21T13:34:05.027682+01:00",
"Acknowledged": true
},
{
"RefundRowId": "8f2d0b87-69aa-4fad-ba0e-938a29d4602a",
"ErrorMessage": "sample string 2",
"DateStamp": "2019-08-21T13:34:05.027682+01:00",
"Acknowledged": true
}
],
"ExternalReference": "sample string 5",
"Actioned": true,
"ActionedDate": "2019-08-21T13:34:05.027682+01:00",
"ChannelInitiated": true,
"Deleted": true,
"IsFreeText": false,
"FreeTextOrNote": "sample string 9",
"Amount": 10.0,
"Quantity": 11,
"ReasonTag": "sample string 12",
"SubReasonTag": "sample string 13",
"InsufficientRefundTag": "sample string 14",
"InsufficientRefundNote": "sample string 15"
}
],
"RefundLink": "sample string 13"
},
{
"RefundHeaderId": 1,
"OrderId": "5aa8e340-26e3-4837-bd95-f6010cafb221",
"NumOrderId": 3,
"ExternalReference": "sample string 4",
"CreatedDate": "2019-08-21T13:34:05.027682+01:00",
"Currency": "sample string 6",
"Amount": 7.0,
"Status": {
"StatusHeader": 0,
"StatusDetail": {
"StatusTag": "sample string 1",
"StatusDescription": "sample string 2",
"Actionable": true,
"ActionDescription": "sample string 4",
"EditableFields": [
"sample string 1",
"sample string 2"
]
}
},
"Actioned": true,
"LastActionDate": "2019-08-21T13:34:05.027682+01:00",
"OrderSource": "sample string 10",
"OrderSubSource": "sample string 11",
"ChannelInitiated": true,
"RefundLines": [
{
"RefundRowId": "d71c3479-674a-4fe4-ae4c-302cb38be6df",
"RefundHeaderId": 2,
"Status": {
"StatusHeader": 0,
"StatusDetail": {
"StatusTag": "sample string 1",
"StatusDescription": "sample string 2",
"Actionable": true,
"ActionDescription": "sample string 4",
"EditableFields": [
"sample string 1",
"sample string 2"
]
}
},
"RefundedUnit": 0,
"IsShippingRefund": false,
"IsAdditionalRefund": false,
"RefundedItem": {
"OrderItemRowId": "71e45c56-6f61-4435-9b58-d3699908207d",
"ReturnRowId": 1,
"ItemSKU": "sample string 2",
"ChannelSKU": "sample string 3",
"ItemTitle": "sample string 4",
"Cost": 5.0,
"CancelledQuantity": 6
},
"ValidationError": "sample string 4",
"Error": "sample string 4",
"Errors": [
{
"RefundRowId": "8f2d0b87-69aa-4fad-ba0e-938a29d4602a",
"ErrorMessage": "sample string 2",
"DateStamp": "2019-08-21T13:34:05.027682+01:00",
"Acknowledged": true
},
{
"RefundRowId": "8f2d0b87-69aa-4fad-ba0e-938a29d4602a",
"ErrorMessage": "sample string 2",
"DateStamp": "2019-08-21T13:34:05.027682+01:00",
"Acknowledged": true
}
],
"ExternalReference": "sample string 5",
"Actioned": true,
"ActionedDate": "2019-08-21T13:34:05.027682+01:00",
"ChannelInitiated": true,
"Deleted": true,
"IsFreeText": false,
"FreeTextOrNote": "sample string 9",
"Amount": 10.0,
"Quantity": 11,
"ReasonTag": "sample string 12",
"SubReasonTag": "sample string 13",
"InsufficientRefundTag": "sample string 14",
"InsufficientRefundNote": "sample string 15"
},
{
"RefundRowId": "d71c3479-674a-4fe4-ae4c-302cb38be6df",
"RefundHeaderId": 2,
"Status": {
"StatusHeader": 0,
"StatusDetail": {
"StatusTag": "sample string 1",
"StatusDescription": "sample string 2",
"Actionable": true,
"ActionDescription": "sample string 4",
"EditableFields": [
"sample string 1",
"sample string 2"
]
}
},
"RefundedUnit": 0,
"IsShippingRefund": false,
"IsAdditionalRefund": false,
"RefundedItem": {
"OrderItemRowId": "71e45c56-6f61-4435-9b58-d3699908207d",
"ReturnRowId": 1,
"ItemSKU": "sample string 2",
"ChannelSKU": "sample string 3",
"ItemTitle": "sample string 4",
"Cost": 5.0,
"CancelledQuantity": 6
},
"ValidationError": "sample string 4",
"Error": "sample string 4",
"Errors": [
{
"RefundRowId": "8f2d0b87-69aa-4fad-ba0e-938a29d4602a",
"ErrorMessage": "sample string 2",
"DateStamp": "2019-08-21T13:34:05.027682+01:00",
"Acknowledged": true
},
{
"RefundRowId": "8f2d0b87-69aa-4fad-ba0e-938a29d4602a",
"ErrorMessage": "sample string 2",
"DateStamp": "2019-08-21T13:34:05.027682+01:00",
"Acknowledged": true
}
],
"ExternalReference": "sample string 5",
"Actioned": true,
"ActionedDate": "2019-08-21T13:34:05.027682+01:00",
"ChannelInitiated": true,
"Deleted": true,
"IsFreeText": false,
"FreeTextOrNote": "sample string 9",
"Amount": 10.0,
"Quantity": 11,
"ReasonTag": "sample string 12",
"SubReasonTag": "sample string 13",
"InsufficientRefundTag": "sample string 14",
"InsufficientRefundNote": "sample string 15"
}
],
"RefundLink": "sample string 13"
}
]
}