Back

Search

Search

Methods

Inventory

Orders

ProcessedOrders /RefundFreeText

Response: List<RefundInfo>



Use this call to add or update a free text refund. This method can also be used to change the refund amount for any pending manual refund. Please check any automated refunds are valid prior to calling this method.

Parameters

NameTypeDescription
pkOrderIdGuidThe id of the order to add/update refunds for
refundItemsList<RefundItem>The new/altered refund items

HTTP Endpoint

Server /ProcessedOrders / RefundFreeText

Permissions


Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ProcessedOrders/RefundFreeText 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

pkOrderId=6f6f16c2-77a2-426c-8a75-845eb8e8b5ab&refundItems=[
  {
    "pkRefundRowId": "dee14bdb-00c8-45a8-94f9-19c688852db6",
    "IsManualRefund": true,
    "Type": 1,
    "fkOrderItemId": "36112c9e-92e1-454c-a2f9-9ff89a8fe89e",
    "RefundQty": 2,
    "RefundAmount": 3.1,
    "Reason": "sample string 4",
    "ChannelReason": "sample string 5",
    "ChannelReasonSec": "sample string 6"
  },
  {
    "pkRefundRowId": "dee14bdb-00c8-45a8-94f9-19c688852db6",
    "IsManualRefund": true,
    "Type": 1,
    "fkOrderItemId": "36112c9e-92e1-454c-a2f9-9ff89a8fe89e",
    "RefundQty": 2,
    "RefundAmount": 3.1,
    "Reason": "sample string 4",
    "ChannelReason": "sample string 5",
    "ChannelReasonSec": "sample string 6"
  }
]

Response

This is an example response. Results may vary depending on your data.

[
  {
    "pkRefundRowId": "4616e273-babc-44af-84b0-e4bf8137d2b9",
    "SKU": "sample string 1",
    "ItemTitle": "sample string 2",
    "IsItem": true,
    "IsService": true,
    "Amount": 5.1,
    "Reason": "sample string 6",
    "Actioned": true,
    "ActionDate": "2018-02-19T16:57:07.7667345+00:00",
    "ReturnReference": "sample string 8",
    "Cost": 1.1,
    "RefundStatus": 0,
    "IgnoredValidation": true,
    "fkOrderItemRowId": "2b76fa09-4f21-4a15-82e9-7406087b9c33",
    "ShouldSerializeChannelReason": false,
    "ChannelReason": "sample string 10",
    "ShouldSerializeChannelReasonSec": false,
    "ChannelReasonSec": "sample string 11"
  },
  {
    "pkRefundRowId": "4616e273-babc-44af-84b0-e4bf8137d2b9",
    "SKU": "sample string 1",
    "ItemTitle": "sample string 2",
    "IsItem": true,
    "IsService": true,
    "Amount": 5.1,
    "Reason": "sample string 6",
    "Actioned": true,
    "ActionDate": "2018-02-19T16:57:07.7667345+00:00",
    "ReturnReference": "sample string 8",
    "Cost": 1.1,
    "RefundStatus": 0,
    "IgnoredValidation": true,
    "fkOrderItemRowId": "2b76fa09-4f21-4a15-82e9-7406087b9c33",
    "ShouldSerializeChannelReason": false,
    "ChannelReason": "sample string 10",
    "ShouldSerializeChannelReasonSec": false,
    "ChannelReasonSec": "sample string 11"
  }
]