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": "fac91d1f-57a3-4b46-962b-2869c63aa93e"
}

Response

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

{
  "RMAHeaders": [
    {
      "RMAHeaderId": 1,
      "OrderId": "a58172ff-5fef-4e4a-9cc7-cd50326d1655",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2019-06-12T09:27:51.3591638+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-06-12T09:27:51.3591638+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-06-12T09:27:51.3601644+01:00",
          "Actioned": true,
          "ActionedDate": "2019-06-12T09:27:51.3601644+01:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "3ed9f7e3-733c-4024-b5d9-b4da584e5f49",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3601644+01:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3601644+01:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "120f883e-982b-4991-97c8-f9ccb68ab332",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "29f0ff2b-f70c-402d-bcc9-057b43317c12",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "ada571d8-cded-430b-9159-8393fb89ccbe",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "e8d63c91-2525-4aaf-8304-3a3ed2f7f60d",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "ff7326df-beff-4336-b6d8-017ecc3b84e2",
          "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-06-12T09:27:51.3601644+01:00",
          "Actioned": true,
          "ActionedDate": "2019-06-12T09:27:51.3601644+01:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "3ed9f7e3-733c-4024-b5d9-b4da584e5f49",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3601644+01:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3601644+01:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "120f883e-982b-4991-97c8-f9ccb68ab332",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "29f0ff2b-f70c-402d-bcc9-057b43317c12",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "ada571d8-cded-430b-9159-8393fb89ccbe",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "e8d63c91-2525-4aaf-8304-3a3ed2f7f60d",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "ff7326df-beff-4336-b6d8-017ecc3b84e2",
          "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": "a58172ff-5fef-4e4a-9cc7-cd50326d1655",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2019-06-12T09:27:51.3591638+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-06-12T09:27:51.3591638+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-06-12T09:27:51.3601644+01:00",
          "Actioned": true,
          "ActionedDate": "2019-06-12T09:27:51.3601644+01:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "3ed9f7e3-733c-4024-b5d9-b4da584e5f49",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3601644+01:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3601644+01:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "120f883e-982b-4991-97c8-f9ccb68ab332",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "29f0ff2b-f70c-402d-bcc9-057b43317c12",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "ada571d8-cded-430b-9159-8393fb89ccbe",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "e8d63c91-2525-4aaf-8304-3a3ed2f7f60d",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "ff7326df-beff-4336-b6d8-017ecc3b84e2",
          "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-06-12T09:27:51.3601644+01:00",
          "Actioned": true,
          "ActionedDate": "2019-06-12T09:27:51.3601644+01:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "3ed9f7e3-733c-4024-b5d9-b4da584e5f49",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3601644+01:00",
              "Acknowledged": true
            },
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2019-06-12T09:27:51.3601644+01:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "120f883e-982b-4991-97c8-f9ccb68ab332",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "29f0ff2b-f70c-402d-bcc9-057b43317c12",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "ada571d8-cded-430b-9159-8393fb89ccbe",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "e8d63c91-2525-4aaf-8304-3a3ed2f7f60d",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "ff7326df-beff-4336-b6d8-017ecc3b84e2",
          "ScrapQuantity": 24,
          "ReasonCategory": "sample string 25",
          "IsFreeText": true,
          "Reason": "sample string 26",
          "ReasonTag": "sample string 27",
          "SubReasonTag": "sample string 28",
          "BinrackOverride": "sample string 29"
        }
      ]
    }
  ]
}