Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ReturnsRefunds /ActionRefund

Allows 150 calls per minute

Response: ActionRefundResponse



Sends a refund to the channel for actioning

Parameters

NameTypeDescription
requestActionRefundRequestThe request class for this call

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.Refunds.ApproveRefundsNode

Example Request

The following request format is required for this method.

Endpoint URL

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

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={
  "RefundHeaderId": 1,
  "OrderId": "4477aee8-802c-4725-9e7b-45bfcf35701c",
  "Request": {
    "caption": "sample string 1",
    "controls": [
      {
        "id": "sample string 1",
        "caption": "sample string 2",
        "description": "sample string 3",
        "type": "sample string 4",
        "value": "sample string 5",
        "group": "sample string 6"
      }
    ]
  }
}

Response

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

{
  "SuccessfullyActioned": true,
  "RefundHeaderId": 1,
  "RefundReference": "sample string 2",
  "Status": {
    "StatusHeader": 0,
    "StatusDetail": {
      "StatusTag": "sample string 1",
      "StatusDescription": "sample string 2",
      "Actionable": true,
      "ActionDescription": "sample string 4",
      "EditableFields": [
        "sample string 1"
      ]
    }
  },
  "CannotRefundReason": 0,
  "Errors": [
    "sample string 1"
  ],
  "RefundLines": null
}