Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /GetRMAHeadersByOrderId

Response: GetRMAHeadersByOrderIdResponse



Returns all RMA headers associated with the given order ID

Parameters

NameTypeDescription
requestGetRMAHeadersByOrderIdRequestThe request class for this call

HTTP Endpoint

Server /ReturnsRefunds / GetRMAHeadersByOrderId

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/GetRMAHeadersByOrderId 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": "239507b2-3ec4-486b-b291-32c664fdff9d"
}

Response

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

{
  "RMAHeaders": [
    {
      "RMAHeaderId": 1,
      "OrderId": "24e74f58-5141-40bc-85d1-a13f3565d3a5",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2019-11-28T09:45:59.5095106+00:00",
      "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-11-28T09:45:59.5095106+00:00",
      "RMALines": [
        {
          "RMARowId": 1,
          "RMAHeaderId": 2,
          "Type": 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"
              ]
            }
          },
          "ExternalReference": "sample string 3",
          "CreatedDate": "2019-11-28T09:45:59.5095106+00:00",
          "Actioned": true,
          "ActionedDate": "2019-11-28T09:45:59.5105062+00:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "ed1a8e0a-2709-4ec6-bb27-17cc22e64c32",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-11-28T09:45:59.5105062+00:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-11-28T09:45:59.5105062+00:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "ff610ff5-f5b1-409c-838f-6b6e9fab7e5e",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "be641fb1-5d52-4831-b400-d57dd5a8a2d4",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "a85cec2a-f56c-4b89-bfc3-ce11ccfc7015",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "dd9f95d8-8a2a-4734-900a-630f6e33e81b",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "1c1e2386-0aa3-4973-be8c-9ffacb6e7cf0",
          "ScrapQuantity": 24,
          "ReasonCategory": "sample string 25",
          "IsFreeText": true,
          "Reason": "sample string 26",
          "ReasonTag": "sample string 27",
          "SubReasonTag": "sample string 28",
          "BinrackOverride": "sample string 29"
        },
        {
          "RMARowId": 1,
          "RMAHeaderId": 2,
          "Type": 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"
              ]
            }
          },
          "ExternalReference": "sample string 3",
          "CreatedDate": "2019-11-28T09:45:59.5095106+00:00",
          "Actioned": true,
          "ActionedDate": "2019-11-28T09:45:59.5105062+00:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "ed1a8e0a-2709-4ec6-bb27-17cc22e64c32",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-11-28T09:45:59.5105062+00:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-11-28T09:45:59.5105062+00:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "ff610ff5-f5b1-409c-838f-6b6e9fab7e5e",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "be641fb1-5d52-4831-b400-d57dd5a8a2d4",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "a85cec2a-f56c-4b89-bfc3-ce11ccfc7015",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "dd9f95d8-8a2a-4734-900a-630f6e33e81b",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "1c1e2386-0aa3-4973-be8c-9ffacb6e7cf0",
          "ScrapQuantity": 24,
          "ReasonCategory": "sample string 25",
          "IsFreeText": true,
          "Reason": "sample string 26",
          "ReasonTag": "sample string 27",
          "SubReasonTag": "sample string 28",
          "BinrackOverride": "sample string 29"
        }
      ]
    },
    {
      "RMAHeaderId": 1,
      "OrderId": "24e74f58-5141-40bc-85d1-a13f3565d3a5",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2019-11-28T09:45:59.5095106+00:00",
      "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-11-28T09:45:59.5095106+00:00",
      "RMALines": [
        {
          "RMARowId": 1,
          "RMAHeaderId": 2,
          "Type": 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"
              ]
            }
          },
          "ExternalReference": "sample string 3",
          "CreatedDate": "2019-11-28T09:45:59.5095106+00:00",
          "Actioned": true,
          "ActionedDate": "2019-11-28T09:45:59.5105062+00:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "ed1a8e0a-2709-4ec6-bb27-17cc22e64c32",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-11-28T09:45:59.5105062+00:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-11-28T09:45:59.5105062+00:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "ff610ff5-f5b1-409c-838f-6b6e9fab7e5e",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "be641fb1-5d52-4831-b400-d57dd5a8a2d4",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "a85cec2a-f56c-4b89-bfc3-ce11ccfc7015",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "dd9f95d8-8a2a-4734-900a-630f6e33e81b",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "1c1e2386-0aa3-4973-be8c-9ffacb6e7cf0",
          "ScrapQuantity": 24,
          "ReasonCategory": "sample string 25",
          "IsFreeText": true,
          "Reason": "sample string 26",
          "ReasonTag": "sample string 27",
          "SubReasonTag": "sample string 28",
          "BinrackOverride": "sample string 29"
        },
        {
          "RMARowId": 1,
          "RMAHeaderId": 2,
          "Type": 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"
              ]
            }
          },
          "ExternalReference": "sample string 3",
          "CreatedDate": "2019-11-28T09:45:59.5095106+00:00",
          "Actioned": true,
          "ActionedDate": "2019-11-28T09:45:59.5105062+00:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "ed1a8e0a-2709-4ec6-bb27-17cc22e64c32",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-11-28T09:45:59.5105062+00:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-11-28T09:45:59.5105062+00:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "ff610ff5-f5b1-409c-838f-6b6e9fab7e5e",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "be641fb1-5d52-4831-b400-d57dd5a8a2d4",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "a85cec2a-f56c-4b89-bfc3-ce11ccfc7015",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "dd9f95d8-8a2a-4734-900a-630f6e33e81b",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "1c1e2386-0aa3-4973-be8c-9ffacb6e7cf0",
          "ScrapQuantity": 24,
          "ReasonCategory": "sample string 25",
          "IsFreeText": true,
          "Reason": "sample string 26",
          "ReasonTag": "sample string 27",
          "SubReasonTag": "sample string 28",
          "BinrackOverride": "sample string 29"
        }
      ]
    }
  ]
}