Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /GetRefundHeadersByOrderId

Response: GetRefundHeadersByOrderIdResponse


Parameters

NameTypeDescription
requestGetRefundHeadersByOrderIdRequest

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": "93e6f25e-b0cd-4527-8626-ea04c2246d2e"
}

Response

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

{
  "RefundHeaders": [
    {
      "RefundHeaderId": 1,
      "OrderId": "1b052df9-5970-41b8-91ef-9e62de99e8ff",
      "NumOrderId": 3,
      "ExternalReference": "sample string 4",
      "CreatedDate": "2018-10-03T11:12:35.0669083+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": "2018-10-03T11:12:35.0669083+01:00",
      "OrderSource": "sample string 10",
      "OrderSubSource": "sample string 11",
      "ChannelInitiated": true,
      "RefundLines": [
        {
          "RefundRowId": "2bcb5d35-43e2-485f-b859-664644a59f8f",
          "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": "76a40ac0-4899-4086-a455-219223e0da58",
            "ReturnRowId": 1,
            "ItemSKU": "sample string 2",
            "ChannelSKU": "sample string 3",
            "ItemTitle": "sample string 4",
            "Cost": 5.0,
            "CancelledQuantity": 6
          },
          "Error": "sample string 2",
          "ExternalReference": "sample string 3",
          "Actioned": true,
          "ActionedDate": "2018-10-03T11:12:35.0669083+01:00",
          "ChannelInitiated": true,
          "Deleted": true,
          "IsFreeText": false,
          "FreeTextOrNote": "sample string 7",
          "Amount": 8.0,
          "ReasonTag": "sample string 9",
          "SubReasonTag": "sample string 10",
          "InsufficientRefundTag": "sample string 11",
          "InsufficientRefundNote": "sample string 12"
        },
        {
          "RefundRowId": "2bcb5d35-43e2-485f-b859-664644a59f8f",
          "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": "76a40ac0-4899-4086-a455-219223e0da58",
            "ReturnRowId": 1,
            "ItemSKU": "sample string 2",
            "ChannelSKU": "sample string 3",
            "ItemTitle": "sample string 4",
            "Cost": 5.0,
            "CancelledQuantity": 6
          },
          "Error": "sample string 2",
          "ExternalReference": "sample string 3",
          "Actioned": true,
          "ActionedDate": "2018-10-03T11:12:35.0669083+01:00",
          "ChannelInitiated": true,
          "Deleted": true,
          "IsFreeText": false,
          "FreeTextOrNote": "sample string 7",
          "Amount": 8.0,
          "ReasonTag": "sample string 9",
          "SubReasonTag": "sample string 10",
          "InsufficientRefundTag": "sample string 11",
          "InsufficientRefundNote": "sample string 12"
        }
      ],
      "RefundLink": "sample string 13"
    },
    {
      "RefundHeaderId": 1,
      "OrderId": "1b052df9-5970-41b8-91ef-9e62de99e8ff",
      "NumOrderId": 3,
      "ExternalReference": "sample string 4",
      "CreatedDate": "2018-10-03T11:12:35.0669083+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": "2018-10-03T11:12:35.0669083+01:00",
      "OrderSource": "sample string 10",
      "OrderSubSource": "sample string 11",
      "ChannelInitiated": true,
      "RefundLines": [
        {
          "RefundRowId": "2bcb5d35-43e2-485f-b859-664644a59f8f",
          "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": "76a40ac0-4899-4086-a455-219223e0da58",
            "ReturnRowId": 1,
            "ItemSKU": "sample string 2",
            "ChannelSKU": "sample string 3",
            "ItemTitle": "sample string 4",
            "Cost": 5.0,
            "CancelledQuantity": 6
          },
          "Error": "sample string 2",
          "ExternalReference": "sample string 3",
          "Actioned": true,
          "ActionedDate": "2018-10-03T11:12:35.0669083+01:00",
          "ChannelInitiated": true,
          "Deleted": true,
          "IsFreeText": false,
          "FreeTextOrNote": "sample string 7",
          "Amount": 8.0,
          "ReasonTag": "sample string 9",
          "SubReasonTag": "sample string 10",
          "InsufficientRefundTag": "sample string 11",
          "InsufficientRefundNote": "sample string 12"
        },
        {
          "RefundRowId": "2bcb5d35-43e2-485f-b859-664644a59f8f",
          "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": "76a40ac0-4899-4086-a455-219223e0da58",
            "ReturnRowId": 1,
            "ItemSKU": "sample string 2",
            "ChannelSKU": "sample string 3",
            "ItemTitle": "sample string 4",
            "Cost": 5.0,
            "CancelledQuantity": 6
          },
          "Error": "sample string 2",
          "ExternalReference": "sample string 3",
          "Actioned": true,
          "ActionedDate": "2018-10-03T11:12:35.0669083+01:00",
          "ChannelInitiated": true,
          "Deleted": true,
          "IsFreeText": false,
          "FreeTextOrNote": "sample string 7",
          "Amount": 8.0,
          "ReasonTag": "sample string 9",
          "SubReasonTag": "sample string 10",
          "InsufficientRefundTag": "sample string 11",
          "InsufficientRefundNote": "sample string 12"
        }
      ],
      "RefundLink": "sample string 13"
    }
  ]
}