Use this call to refund one or more services on an order. Please check that any automated refunds are valid prior to calling this method.
Name | Type | Description |
---|---|---|
pkOrderId | Guid | The id of the order to refund services for. |
refundItems | List<RefundItem> | Refunds for service items |
The following request format is required for this method.
GET | POST https://eu-ext.linnworks.net/api/ProcessedOrders/RefundServices
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
This is an example of the request structure. Results will vary depending on your data.
pkOrderId=fb99ddd2-19d7-4183-b5ae-bd5cb12d27f5&refundItems=[
{
"pkRefundRowId": "7e7db1dc-4aaa-4082-9e60-68792896d09d",
"IsManualRefund": true,
"Type": 1,
"fkOrderItemId": "726d6831-c417-432d-80ec-496b41da0641",
"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": "dfa5e211-8ce9-4016-b38f-79e512b5e0ad",
"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.1309163+00:00",
"ReturnReference": "sample string 8",
"Cost": 1.1,
"RefundStatus": 0,
"IgnoredValidation": true,
"fkOrderItemRowId": "a6999ecb-08ac-4f92-97c3-6d89bfc59181",
"ShouldSerializeChannelReason": false,
"ChannelReason": "sample string 10",
"ShouldSerializeChannelReasonSec": false,
"ChannelReasonSec": "sample string 11"
}
]