Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /GetRefundLinesByHeaderId

Response: GetRefundLinesByHeaderIdResponse



Returns a refund, given its header ID

Parameters

NameTypeDescription
requestGetRefundLinesByHeaderIdRequestThe request class for this call

HTTP Endpoint

Server /ReturnsRefunds / GetRefundLinesByHeaderId

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/GetRefundLinesByHeaderId 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={
  "RefundHeaderId": 1,
  "OrderId": "e592549b-3074-47e5-8e0c-45bea1388e09"
}

Response

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

{
  "RefundHeaderId": 1,
  "RefundLines": [
    {
      "RefundRowId": "f8cd1def-e9c7-49c4-a1ff-82e2f320e3a7",
      "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": "b19ff313-c871-4483-8f09-b687528f4929",
        "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": "4eecdc17-003c-456b-9eb3-34246be4681f",
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-08-21T13:34:05.0316845+01:00",
          "Acknowledged": true
        },
        {
          "RefundRowId": "4eecdc17-003c-456b-9eb3-34246be4681f",
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-08-21T13:34:05.0316845+01:00",
          "Acknowledged": true
        }
      ],
      "ExternalReference": "sample string 5",
      "Actioned": true,
      "ActionedDate": "2019-08-21T13:34:05.0316845+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": "f8cd1def-e9c7-49c4-a1ff-82e2f320e3a7",
      "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": "b19ff313-c871-4483-8f09-b687528f4929",
        "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": "4eecdc17-003c-456b-9eb3-34246be4681f",
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-08-21T13:34:05.0316845+01:00",
          "Acknowledged": true
        },
        {
          "RefundRowId": "4eecdc17-003c-456b-9eb3-34246be4681f",
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-08-21T13:34:05.0316845+01:00",
          "Acknowledged": true
        }
      ],
      "ExternalReference": "sample string 5",
      "Actioned": true,
      "ActionedDate": "2019-08-21T13:34:05.0316845+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"
    }
  ],
  "RefundOptions": null
}