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": "7f7868f3-341a-4cd5-beea-b276e5557335"
}

Response

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

{
  "RMAHeaders": [
    {
      "RMAHeaderId": 1,
      "OrderId": "4bb6c3ed-6716-4a6e-9434-244cc2d42c76",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2019-07-23T15:31:55.3777664+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-07-23T15:31:55.3777664+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-07-23T15:31:55.3787671+01:00",
          "Actioned": true,
          "ActionedDate": "2019-07-23T15:31:55.3787671+01:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "e11a3ffe-468d-4df5-bb3f-7e1b66f7818c",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-07-23T15:31:55.3787671+01:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-07-23T15:31:55.3787671+01:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "fab63d33-b7d0-4120-9c7c-c47992c14265",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "ba940dda-bacd-4553-9f52-9b3f0fd50f25",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "05a3c6e4-6ed2-4c62-8b12-8b0fc820f633",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "580a974f-8cac-42ff-ac3e-9989393b241b",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "9e6a7b38-99dd-4887-9f69-f80977184fed",
          "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-07-23T15:31:55.3787671+01:00",
          "Actioned": true,
          "ActionedDate": "2019-07-23T15:31:55.3787671+01:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "e11a3ffe-468d-4df5-bb3f-7e1b66f7818c",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-07-23T15:31:55.3787671+01:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-07-23T15:31:55.3787671+01:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "fab63d33-b7d0-4120-9c7c-c47992c14265",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "ba940dda-bacd-4553-9f52-9b3f0fd50f25",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "05a3c6e4-6ed2-4c62-8b12-8b0fc820f633",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "580a974f-8cac-42ff-ac3e-9989393b241b",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "9e6a7b38-99dd-4887-9f69-f80977184fed",
          "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": "4bb6c3ed-6716-4a6e-9434-244cc2d42c76",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2019-07-23T15:31:55.3777664+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-07-23T15:31:55.3777664+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-07-23T15:31:55.3787671+01:00",
          "Actioned": true,
          "ActionedDate": "2019-07-23T15:31:55.3787671+01:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "e11a3ffe-468d-4df5-bb3f-7e1b66f7818c",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-07-23T15:31:55.3787671+01:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-07-23T15:31:55.3787671+01:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "fab63d33-b7d0-4120-9c7c-c47992c14265",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "ba940dda-bacd-4553-9f52-9b3f0fd50f25",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "05a3c6e4-6ed2-4c62-8b12-8b0fc820f633",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "580a974f-8cac-42ff-ac3e-9989393b241b",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "9e6a7b38-99dd-4887-9f69-f80977184fed",
          "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-07-23T15:31:55.3787671+01:00",
          "Actioned": true,
          "ActionedDate": "2019-07-23T15:31:55.3787671+01:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "e11a3ffe-468d-4df5-bb3f-7e1b66f7818c",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-07-23T15:31:55.3787671+01:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-07-23T15:31:55.3787671+01:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "fab63d33-b7d0-4120-9c7c-c47992c14265",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "ba940dda-bacd-4553-9f52-9b3f0fd50f25",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "05a3c6e4-6ed2-4c62-8b12-8b0fc820f633",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "580a974f-8cac-42ff-ac3e-9989393b241b",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "9e6a7b38-99dd-4887-9f69-f80977184fed",
          "ScrapQuantity": 24,
          "ReasonCategory": "sample string 25",
          "IsFreeText": true,
          "Reason": "sample string 26",
          "ReasonTag": "sample string 27",
          "SubReasonTag": "sample string 28",
          "BinrackOverride": "sample string 29"
        }
      ]
    }
  ]
}