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": "e4da2b70-2437-4b65-81ed-3fdc72cd3557"
}

Response

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

{
  "RMAHeaders": [
    {
      "RMAHeaderId": 1,
      "OrderId": "35bc881a-c7fa-46a7-ac0e-e5f9b21c619e",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2019-10-09T15:11:41.7706943+01: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-10-09T15:11:41.7717081+01: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-10-09T15:11:41.7717081+01:00",
          "Actioned": true,
          "ActionedDate": "2019-10-09T15:11:41.7717081+01:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "7e130f82-b4cd-4bb1-8de9-ea7557fb2783",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-10-09T15:11:41.7727202+01:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-10-09T15:11:41.7727202+01:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "4301b3ca-fc3a-41df-abef-f310e58b9875",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "d0e147a2-9864-4d23-86b5-b803d3e00381",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "3df5ab40-f626-4182-8d5b-d80494f0a054",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "8a85a8a4-91bd-489b-9f01-918e70ea5e5e",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "369f4046-f866-47d0-af9e-86f8368cd9fb",
          "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-10-09T15:11:41.7717081+01:00",
          "Actioned": true,
          "ActionedDate": "2019-10-09T15:11:41.7717081+01:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "7e130f82-b4cd-4bb1-8de9-ea7557fb2783",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-10-09T15:11:41.7727202+01:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-10-09T15:11:41.7727202+01:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "4301b3ca-fc3a-41df-abef-f310e58b9875",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "d0e147a2-9864-4d23-86b5-b803d3e00381",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "3df5ab40-f626-4182-8d5b-d80494f0a054",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "8a85a8a4-91bd-489b-9f01-918e70ea5e5e",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "369f4046-f866-47d0-af9e-86f8368cd9fb",
          "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": "35bc881a-c7fa-46a7-ac0e-e5f9b21c619e",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2019-10-09T15:11:41.7706943+01: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-10-09T15:11:41.7717081+01: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-10-09T15:11:41.7717081+01:00",
          "Actioned": true,
          "ActionedDate": "2019-10-09T15:11:41.7717081+01:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "7e130f82-b4cd-4bb1-8de9-ea7557fb2783",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-10-09T15:11:41.7727202+01:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-10-09T15:11:41.7727202+01:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "4301b3ca-fc3a-41df-abef-f310e58b9875",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "d0e147a2-9864-4d23-86b5-b803d3e00381",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "3df5ab40-f626-4182-8d5b-d80494f0a054",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "8a85a8a4-91bd-489b-9f01-918e70ea5e5e",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "369f4046-f866-47d0-af9e-86f8368cd9fb",
          "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-10-09T15:11:41.7717081+01:00",
          "Actioned": true,
          "ActionedDate": "2019-10-09T15:11:41.7717081+01:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "7e130f82-b4cd-4bb1-8de9-ea7557fb2783",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-10-09T15:11:41.7727202+01:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-10-09T15:11:41.7727202+01:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "4301b3ca-fc3a-41df-abef-f310e58b9875",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "d0e147a2-9864-4d23-86b5-b803d3e00381",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "3df5ab40-f626-4182-8d5b-d80494f0a054",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "8a85a8a4-91bd-489b-9f01-918e70ea5e5e",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "369f4046-f866-47d0-af9e-86f8368cd9fb",
          "ScrapQuantity": 24,
          "ReasonCategory": "sample string 25",
          "IsFreeText": true,
          "Reason": "sample string 26",
          "ReasonTag": "sample string 27",
          "SubReasonTag": "sample string 28",
          "BinrackOverride": "sample string 29"
        }
      ]
    }
  ]
}