Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /GetActionableRMAHeaders

Response: GetActionableRMAHeadersResponse


Parameters

NameTypeDescription
requestGetActionableRMAHeadersRequest

HTTP Endpoint

Server /ReturnsRefunds / GetActionableRMAHeaders

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.ReturnsExchanges.ViewReturnsExchangesNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ReturnsRefunds/GetActionableRMAHeaders 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={
  "Page": 1,
  "Filters": {
    "Actionable": true,
    "Type": 0,
    "Value": "sample string 1"
  }
}

Response

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

{
  "Page": 1,
  "TotalHeaders": 2,
  "HeadersPerPage": 3,
  "RMAHeaders": [
    {
      "RMAHeaderId": 1,
      "OrderId": "5e707d62-2ae4-41c0-a3d6-22a44684ad2e",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2018-10-03T11:12:35.1179449+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.1179449+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.1179449+01:00",
          "Deleted": true,
          "ResendQuantity": 5,
          "NewOrderId": "96c767b4-0cf1-443e-9cdb-d43eeb9e477c",
          "Error": "sample string 7",
          "Info": "sample string 8",
          "ExchangeStockItemId": "d4225c1c-1ebe-4845-ad71-eb6d7d2b9f85",
          "ExchangeQuantity": 10,
          "DespatchLocationId": "413cde09-6069-44b5-a3c4-414e9834cf6a",
          "AdditionalCost": 12.0,
          "OrderItemRowId": "797699eb-55f2-4a5b-9932-afff4bc504e0",
          "BatchInventoryId": 1,
          "ReturnLocation": "1531c7d4-f94d-469a-aa73-a661f22ecd8f",
          "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.1179449+01:00",
          "Deleted": true,
          "ResendQuantity": 5,
          "NewOrderId": "96c767b4-0cf1-443e-9cdb-d43eeb9e477c",
          "Error": "sample string 7",
          "Info": "sample string 8",
          "ExchangeStockItemId": "d4225c1c-1ebe-4845-ad71-eb6d7d2b9f85",
          "ExchangeQuantity": 10,
          "DespatchLocationId": "413cde09-6069-44b5-a3c4-414e9834cf6a",
          "AdditionalCost": 12.0,
          "OrderItemRowId": "797699eb-55f2-4a5b-9932-afff4bc504e0",
          "BatchInventoryId": 1,
          "ReturnLocation": "1531c7d4-f94d-469a-aa73-a661f22ecd8f",
          "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": "5e707d62-2ae4-41c0-a3d6-22a44684ad2e",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2018-10-03T11:12:35.1179449+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.1179449+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.1179449+01:00",
          "Deleted": true,
          "ResendQuantity": 5,
          "NewOrderId": "96c767b4-0cf1-443e-9cdb-d43eeb9e477c",
          "Error": "sample string 7",
          "Info": "sample string 8",
          "ExchangeStockItemId": "d4225c1c-1ebe-4845-ad71-eb6d7d2b9f85",
          "ExchangeQuantity": 10,
          "DespatchLocationId": "413cde09-6069-44b5-a3c4-414e9834cf6a",
          "AdditionalCost": 12.0,
          "OrderItemRowId": "797699eb-55f2-4a5b-9932-afff4bc504e0",
          "BatchInventoryId": 1,
          "ReturnLocation": "1531c7d4-f94d-469a-aa73-a661f22ecd8f",
          "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.1179449+01:00",
          "Deleted": true,
          "ResendQuantity": 5,
          "NewOrderId": "96c767b4-0cf1-443e-9cdb-d43eeb9e477c",
          "Error": "sample string 7",
          "Info": "sample string 8",
          "ExchangeStockItemId": "d4225c1c-1ebe-4845-ad71-eb6d7d2b9f85",
          "ExchangeQuantity": 10,
          "DespatchLocationId": "413cde09-6069-44b5-a3c4-414e9834cf6a",
          "AdditionalCost": 12.0,
          "OrderItemRowId": "797699eb-55f2-4a5b-9932-afff4bc504e0",
          "BatchInventoryId": 1,
          "ReturnLocation": "1531c7d4-f94d-469a-aa73-a661f22ecd8f",
          "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"
        }
      ]
    }
  ]
}