Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /GetRMAHeadersByOrderId

Response: GetRMAHeadersByOrderIdResponse


Parameters

NameTypeDescription
requestGetRMAHeadersByOrderIdRequest

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": "39f56d0a-1529-4620-8b39-738b1690a123"
}

Response

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

{
  "RMAHeaders": [
    {
      "RMAHeaderId": 1,
      "OrderId": "e1b56c23-b78e-4ab9-a237-1a5872faea5c",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2018-10-03T11:12:35.0478956+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": "2018-10-03T11:12:35.0488963+01:00",
      "RMALines": [
        {
          "RMARowId": 1,
          "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 2",
          "Actioned": true,
          "ActionedDate": "2018-10-03T11:12:35.0488963+01:00",
          "Deleted": true,
          "ResendQuantity": 5,
          "NewOrderId": "b0687b96-3701-43d0-9b1c-654d1d52bbd2",
          "Error": "sample string 7",
          "Info": "sample string 8",
          "ExchangeStockItemId": "fc5149c6-5231-4832-8319-6fbc6ce898a8",
          "ExchangeQuantity": 10,
          "DespatchLocationId": "965f68a3-6597-435b-87b6-85cbdc6a8af7",
          "AdditionalCost": 12.0,
          "OrderItemRowId": "9fdbfedc-d21a-4eca-bf07-e641ae247c0e",
          "BatchInventoryId": 1,
          "ReturnLocation": "ad45b39d-6f69-4f7e-8c8b-7c01875c3d2c",
          "ReturnQuantity": 15,
          "RefundAmount": 16.0,
          "ScrapQuantity": 17,
          "ReasonCategory": "sample string 18",
          "IsFreeText": true,
          "Reason": "sample string 19",
          "ReasonTag": "sample string 20",
          "SubReasonTag": "sample string 21"
        },
        {
          "RMARowId": 1,
          "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 2",
          "Actioned": true,
          "ActionedDate": "2018-10-03T11:12:35.0488963+01:00",
          "Deleted": true,
          "ResendQuantity": 5,
          "NewOrderId": "b0687b96-3701-43d0-9b1c-654d1d52bbd2",
          "Error": "sample string 7",
          "Info": "sample string 8",
          "ExchangeStockItemId": "fc5149c6-5231-4832-8319-6fbc6ce898a8",
          "ExchangeQuantity": 10,
          "DespatchLocationId": "965f68a3-6597-435b-87b6-85cbdc6a8af7",
          "AdditionalCost": 12.0,
          "OrderItemRowId": "9fdbfedc-d21a-4eca-bf07-e641ae247c0e",
          "BatchInventoryId": 1,
          "ReturnLocation": "ad45b39d-6f69-4f7e-8c8b-7c01875c3d2c",
          "ReturnQuantity": 15,
          "RefundAmount": 16.0,
          "ScrapQuantity": 17,
          "ReasonCategory": "sample string 18",
          "IsFreeText": true,
          "Reason": "sample string 19",
          "ReasonTag": "sample string 20",
          "SubReasonTag": "sample string 21"
        }
      ]
    },
    {
      "RMAHeaderId": 1,
      "OrderId": "e1b56c23-b78e-4ab9-a237-1a5872faea5c",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2018-10-03T11:12:35.0478956+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": "2018-10-03T11:12:35.0488963+01:00",
      "RMALines": [
        {
          "RMARowId": 1,
          "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 2",
          "Actioned": true,
          "ActionedDate": "2018-10-03T11:12:35.0488963+01:00",
          "Deleted": true,
          "ResendQuantity": 5,
          "NewOrderId": "b0687b96-3701-43d0-9b1c-654d1d52bbd2",
          "Error": "sample string 7",
          "Info": "sample string 8",
          "ExchangeStockItemId": "fc5149c6-5231-4832-8319-6fbc6ce898a8",
          "ExchangeQuantity": 10,
          "DespatchLocationId": "965f68a3-6597-435b-87b6-85cbdc6a8af7",
          "AdditionalCost": 12.0,
          "OrderItemRowId": "9fdbfedc-d21a-4eca-bf07-e641ae247c0e",
          "BatchInventoryId": 1,
          "ReturnLocation": "ad45b39d-6f69-4f7e-8c8b-7c01875c3d2c",
          "ReturnQuantity": 15,
          "RefundAmount": 16.0,
          "ScrapQuantity": 17,
          "ReasonCategory": "sample string 18",
          "IsFreeText": true,
          "Reason": "sample string 19",
          "ReasonTag": "sample string 20",
          "SubReasonTag": "sample string 21"
        },
        {
          "RMARowId": 1,
          "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 2",
          "Actioned": true,
          "ActionedDate": "2018-10-03T11:12:35.0488963+01:00",
          "Deleted": true,
          "ResendQuantity": 5,
          "NewOrderId": "b0687b96-3701-43d0-9b1c-654d1d52bbd2",
          "Error": "sample string 7",
          "Info": "sample string 8",
          "ExchangeStockItemId": "fc5149c6-5231-4832-8319-6fbc6ce898a8",
          "ExchangeQuantity": 10,
          "DespatchLocationId": "965f68a3-6597-435b-87b6-85cbdc6a8af7",
          "AdditionalCost": 12.0,
          "OrderItemRowId": "9fdbfedc-d21a-4eca-bf07-e641ae247c0e",
          "BatchInventoryId": 1,
          "ReturnLocation": "ad45b39d-6f69-4f7e-8c8b-7c01875c3d2c",
          "ReturnQuantity": 15,
          "RefundAmount": 16.0,
          "ScrapQuantity": 17,
          "ReasonCategory": "sample string 18",
          "IsFreeText": true,
          "Reason": "sample string 19",
          "ReasonTag": "sample string 20",
          "SubReasonTag": "sample string 21"
        }
      ]
    }
  ]
}