Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ReturnsRefunds /GetProcessedOrAckedErrorRefundHeaders

Allows 150 calls per minute

Response: GetProcessedOrAckedErrorRefundHeadersResponse



Returns a paged list of processed or acknowledged error refund headers

Parameters

NameTypeDescription
requestGetProcessedOrAckedErrorRefundHeadersRequestThe request class for this call

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.Refunds.ViewRefundsNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/ReturnsRefunds/GetProcessedOrAckedErrorRefundHeaders

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": false,
    "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,
  "RefundHeaders": [
    {
      "RefundHeaderId": 1,
      "OrderId": "a3de16a1-f887-4a20-b209-fd1ce2b24ace",
      "NumOrderId": 3,
      "ExternalReference": "sample string 4",
      "CreatedDate": "2021-07-29T09:24:14.0117455+01:00",
      "Currency": "sample string 6",
      "Amount": 7.0,
      "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": "2021-07-29T09:24:14.0117455+01:00",
      "OrderSource": "sample string 10",
      "OrderSubSource": "sample string 11",
      "ChannelInitiated": true,
      "RefundLines": null,
      "RefundLink": "sample string 13"
    }
  ]
}