Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ReturnsRefunds /GetActionableRMAHeaders

Allows 150 calls per minute

Response: GetActionableRMAHeadersResponse



Returns a paged list of booked refund headers

Parameters

NameTypeDescription
requestGetActionableRMAHeadersRequestThe request class for this call

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.ReturnsExchanges.ViewReturnsExchangesNode

Example Request

The following request format is required for this method.

Endpoint URL

GET | POST https://eu-ext.linnworks.net/api/ReturnsRefunds/GetActionableRMAHeaders

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

request={
  "Page": 1,
  "Filters": {
    "Actionable": true,
    "Type": 0,
    "Value": "sample string 1"
  }
}

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "Page": 1,
  "TotalHeaders": 2,
  "HeadersPerPage": 3,
  "RMAHeaders": [
    {
      "RMAHeaderId": 1,
      "OrderId": "e8f19227-fcd4-4f05-9518-da5869ac4808",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2022-09-05T15:10:02.9536814+03:00",
      "Status": {
        "StatusHeader": 0,
        "StatusDetail": {
          "StatusTag": "sample string 1",
          "StatusDescription": "sample string 2",
          "Actionable": true,
          "ActionDescription": "sample string 4",
          "EditableFields": [
            "sample string 1"
          ]
        }
      },
      "Actioned": true,
      "LastActionDate": "2022-09-05T15:10:02.9536814+03:00",
      "RMALines": [
        {
          "RMARowId": 1,
          "RMAHeaderId": 2,
          "Type": 0,
          "Status": {
          },
          "ExternalReference": "sample string 3",
          "CreatedDate": "2022-09-05T15:10:02.9536814+03:00",
          "Actioned": true,
          "ActionedDate": "2022-09-05T15:10:02.9536814+03:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "4a7ff4e7-d6e6-48b4-ae4b-cb7bebaff4c7",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2022-09-05T15:10:02.9536814+03:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "8f29ccc7-9eaa-426b-8c9e-1783d870acf4",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "e0d7441c-aed3-4b50-8827-a63b20f3747f",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "a459d9d6-7b10-42a8-814b-c47cbe40885c",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "ce807475-b8b0-4bb1-a873-8386a745f877",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "6c124789-6687-4af7-926d-9642e6149370",
          "ScrapQuantity": 24,
          "ReasonCategory": "sample string 25",
          "IsFreeText": false,
          "Reason": "sample string 26",
          "ReasonTag": "sample string 27",
          "SubReasonTag": "sample string 28",
          "BinrackOverride": "sample string 29"
        }
      ]
    }
  ]
}