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.
| Name | Type | Description |
|---|---|---|
| pkOrderId | Guid | The id of the order to add/update refunds for |
| refundItems | List<RefundItem> | The new/altered refund items |
The following request format is required for this method.
GET | POST https://eu-ext.linnworks.net/api/ProcessedOrders/RefundFreeTextConnection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE
This is an example of the request structure. Results will vary depending on your data.
pkOrderId=43607a9b-5b8c-4252-ac06-3e3ee3c365aa&refundItems=[
{
"pkRefundRowId": "93381a5b-8955-4848-8b7b-086e49d3426a",
"IsManualRefund": true,
"Type": 1,
"fkOrderItemId": "4097af7b-0238-47fe-99da-41756823e549",
"RefundQty": 2,
"RefundAmount": 3.1,
"Reason": "sample string 4",
"ChannelReason": "sample string 5",
"ChannelReasonSec": "sample string 6"
}
]This is an example of the response JSON. Results will vary depending on your data.
[
{
"pkRefundRowId": "a595bdb4-6465-43ec-894a-2da6a312fe3b",
"SKU": "sample string 1",
"ItemTitle": "sample string 2",
"IsItem": true,
"IsService": true,
"Amount": 5.1,
"Reason": "sample string 6",
"Actioned": true,
"ActionDate": "2023-01-10T13:49:50.115252+00:00",
"ReturnReference": "sample string 8",
"Cost": 1.1,
"RefundStatus": 0,
"IgnoredValidation": true,
"fkOrderItemRowId": "05a49be7-dfe4-433d-89f4-5c8a6b8920a8",
"ShouldSerializeChannelReason": false,
"ChannelReason": "sample string 10",
"ShouldSerializeChannelReasonSec": false,
"ChannelReasonSec": "sample string 11"
}
]