Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /GetRefundHeadersByOrderId

Response: GetRefundHeadersByOrderIdResponse



Returns all refund headers associated with the given order ID

Parameters

NameTypeDescription
requestGetRefundHeadersByOrderIdRequestThe request class for this call

HTTP Endpoint

Server /ReturnsRefunds / GetRefundHeadersByOrderId

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.Refunds.ViewRefundsNode

Example Code

Example Request

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": "5dbd0ea4-14af-498d-b9b3-0a8e629e57e7"
}

Response

This is an example response. Results may vary depending on your data.

{
  "RefundHeaders": [
    {
      "RefundHeaderId": 1,
      "OrderId": "a63b83a5-14c3-4e3a-8f8e-25412600cf2f",
      "NumOrderId": 3,
      "ExternalReference": "sample string 4",
      "CreatedDate": "2019-06-12T09:27:51.3771763+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-06-12T09:27:51.3771763+01:00",
      "OrderSource": "sample string 10",
      "OrderSubSource": "sample string 11",
      "ChannelInitiated": true,
      "RefundLines": [
        {
          "RefundRowId": "83b5da77-5f7c-4dd0-b36e-e3beb816c57d",
          "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": "eacca9f9-fe94-4080-96c1-d4cc3a8d13ab",
            "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": "104138c1-fbf1-402f-bc94-993b52390ffa",
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3771763+01:00",
              "Acknowledged": true
            },
            {
              "RefundRowId": "104138c1-fbf1-402f-bc94-993b52390ffa",
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3771763+01:00",
              "Acknowledged": true
            }
          ],
          "ExternalReference": "sample string 5",
          "Actioned": true,
          "ActionedDate": "2019-06-12T09:27:51.3771763+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": "83b5da77-5f7c-4dd0-b36e-e3beb816c57d",
          "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": "eacca9f9-fe94-4080-96c1-d4cc3a8d13ab",
            "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": "104138c1-fbf1-402f-bc94-993b52390ffa",
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3771763+01:00",
              "Acknowledged": true
            },
            {
              "RefundRowId": "104138c1-fbf1-402f-bc94-993b52390ffa",
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3771763+01:00",
              "Acknowledged": true
            }
          ],
          "ExternalReference": "sample string 5",
          "Actioned": true,
          "ActionedDate": "2019-06-12T09:27:51.3771763+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": "a63b83a5-14c3-4e3a-8f8e-25412600cf2f",
      "NumOrderId": 3,
      "ExternalReference": "sample string 4",
      "CreatedDate": "2019-06-12T09:27:51.3771763+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-06-12T09:27:51.3771763+01:00",
      "OrderSource": "sample string 10",
      "OrderSubSource": "sample string 11",
      "ChannelInitiated": true,
      "RefundLines": [
        {
          "RefundRowId": "83b5da77-5f7c-4dd0-b36e-e3beb816c57d",
          "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": "eacca9f9-fe94-4080-96c1-d4cc3a8d13ab",
            "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": "104138c1-fbf1-402f-bc94-993b52390ffa",
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3771763+01:00",
              "Acknowledged": true
            },
            {
              "RefundRowId": "104138c1-fbf1-402f-bc94-993b52390ffa",
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3771763+01:00",
              "Acknowledged": true
            }
          ],
          "ExternalReference": "sample string 5",
          "Actioned": true,
          "ActionedDate": "2019-06-12T09:27:51.3771763+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": "83b5da77-5f7c-4dd0-b36e-e3beb816c57d",
          "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": "eacca9f9-fe94-4080-96c1-d4cc3a8d13ab",
            "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": "104138c1-fbf1-402f-bc94-993b52390ffa",
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3771763+01:00",
              "Acknowledged": true
            },
            {
              "RefundRowId": "104138c1-fbf1-402f-bc94-993b52390ffa",
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3771763+01:00",
              "Acknowledged": true
            }
          ],
          "ExternalReference": "sample string 5",
          "Actioned": true,
          "ActionedDate": "2019-06-12T09:27:51.3771763+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"
    }
  ]
}