Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /ActionRefund

Response: ActionRefundResponse



Sends a refund to the channel for actioning

Parameters

NameTypeDescription
requestActionRefundRequestThe request class for this call

HTTP Endpoint

Server /ReturnsRefunds / ActionRefund

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.Refunds.ApproveRefundsNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ReturnsRefunds/ActionRefund 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={
  "RefundHeaderId": 1,
  "OrderId": "317d50da-55ed-4b27-aa12-019476f94a8a",
  "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"
      },
      {
        "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 response. Results may vary depending on your data.

{
  "RefundHeaderId": 1,
  "RefundReference": "sample string 1",
  "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"
      ]
    }
  },
  "CannotRefundReason": 0,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "RefundLines": [
    {
      "RefundRowId": "f481575c-eff0-4267-b9b9-bef7a402a2b7",
      "RefundHeaderId": 2,
      "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"
          ]
        }
      },
      "RefundedUnit": 0,
      "IsShippingRefund": false,
      "IsAdditionalRefund": false,
      "RefundedItem": {
        "OrderItemRowId": "edf2276a-6625-46df-9f1b-2b931538a45e",
        "ReturnRowId": 1,
        "ItemSKU": "sample string 2",
        "ChannelSKU": "sample string 3",
        "ItemTitle": "sample string 4",
        "Cost": 5.0,
        "CancelledQuantity": 6
      },
      "ValidationError": "sample string 4",
      "Error": "sample string 4",
      "Errors": [
        {
          "RefundRowId": "b12dfd2c-d603-4436-af23-736aaba5bfa0",
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-10-09T15:11:41.8233785+01:00",
          "Acknowledged": true
        },
        {
          "RefundRowId": "b12dfd2c-d603-4436-af23-736aaba5bfa0",
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-10-09T15:11:41.8233785+01:00",
          "Acknowledged": true
        }
      ],
      "ExternalReference": "sample string 5",
      "Actioned": true,
      "ActionedDate": "2019-10-09T15:11:41.8233785+01:00",
      "ChannelInitiated": true,
      "Deleted": true,
      "IsFreeText": false,
      "FreeTextOrNote": "sample string 9",
      "Amount": 10.0,
      "Quantity": 11,
      "ReasonTag": "sample string 12",
      "SubReasonTag": "sample string 13",
      "InsufficientRefundTag": "sample string 14",
      "InsufficientRefundNote": "sample string 15"
    },
    {
      "RefundRowId": "f481575c-eff0-4267-b9b9-bef7a402a2b7",
      "RefundHeaderId": 2,
      "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"
          ]
        }
      },
      "RefundedUnit": 0,
      "IsShippingRefund": false,
      "IsAdditionalRefund": false,
      "RefundedItem": {
        "OrderItemRowId": "edf2276a-6625-46df-9f1b-2b931538a45e",
        "ReturnRowId": 1,
        "ItemSKU": "sample string 2",
        "ChannelSKU": "sample string 3",
        "ItemTitle": "sample string 4",
        "Cost": 5.0,
        "CancelledQuantity": 6
      },
      "ValidationError": "sample string 4",
      "Error": "sample string 4",
      "Errors": [
        {
          "RefundRowId": "b12dfd2c-d603-4436-af23-736aaba5bfa0",
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-10-09T15:11:41.8233785+01:00",
          "Acknowledged": true
        },
        {
          "RefundRowId": "b12dfd2c-d603-4436-af23-736aaba5bfa0",
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-10-09T15:11:41.8233785+01:00",
          "Acknowledged": true
        }
      ],
      "ExternalReference": "sample string 5",
      "Actioned": true,
      "ActionedDate": "2019-10-09T15:11:41.8233785+01:00",
      "ChannelInitiated": true,
      "Deleted": true,
      "IsFreeText": false,
      "FreeTextOrNote": "sample string 9",
      "Amount": 10.0,
      "Quantity": 11,
      "ReasonTag": "sample string 12",
      "SubReasonTag": "sample string 13",
      "InsufficientRefundTag": "sample string 14",
      "InsufficientRefundNote": "sample string 15"
    }
  ]
}