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.

Get

Endpoint URL

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

GET https://eu-ext.linnworks.net/api/ReturnsRefunds/GetActionableRMAHeaders?request=%7B%0D%0A%20%20%22Page%22%3A%201%2C%0D%0A%20%20%22Filters%22%3A%20%7B%0D%0A%20%20%20%20%22Actionable%22%3A%20true%2C%0D%0A%20%20%20%20%22Type%22%3A%200%2C%0D%0A%20%20%20%20%22Value%22%3A%20%22sample%20string%201%22%0D%0A%20%20%7D%0D%0A%7D

Headers

Connection: keep-alive
Accept: application/json
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Post

Endpoint URL

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": "bc6dedea-dac7-4f4c-ad2b-5c53d442427e",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2022-01-13T12:45:41.8941998+00: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-01-13T12:45:41.8941998+00:00",
      "RMALines": [
        {
          "RMARowId": 1,
          "RMAHeaderId": 2,
          "Type": 0,
          "Status": {
          },
          "ExternalReference": "sample string 3",
          "CreatedDate": "2022-01-13T12:45:41.8941998+00:00",
          "Actioned": true,
          "ActionedDate": "2022-01-13T12:45:41.8941998+00:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "c5d26ef5-477a-47e3-b1bb-681805242031",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2022-01-13T12:45:41.8941998+00:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "8593d2b5-743a-44d4-bf09-f28c802a08f6",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "31e7df82-13c4-485f-b6ee-416dd7948deb",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "4ea1059b-b6f5-476f-8883-22a3c3f2bf39",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "12b302d8-d1fc-4c92-8afa-c18ff26b78fa",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "de150783-cd56-47e2-a3c9-3074c8b90e2d",
          "ScrapQuantity": 24,
          "ReasonCategory": "sample string 25",
          "IsFreeText": true,
          "Reason": "sample string 26",
          "ReasonTag": "sample string 27",
          "SubReasonTag": "sample string 28",
          "BinrackOverride": "sample string 29"
        }
      ]
    }
  ]
}