Creates a refund in the system for approval
Name | Type | Description |
---|---|---|
request | CreateRefundRequest | The request class for this call |
The following request format is required for this method.
POST https://eu-ext.linnworks.net/api/ReturnsRefunds/CreateRefund
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.
request={
"ChannelInitiated": true,
"OrderId": "9dbc0c37-c15f-4b84-9b0e-14d2ba83c55f",
"RefundLines": [
{
"ReturnRowId": 1,
"OrderItemRowId": "8bf1ffe1-5f02-4bea-940f-f6e81858e09f",
"RefundedUnit": 0,
"CancelledQuantity": 1,
"IsFreeText": false,
"FreeTextOrNote": "sample string 1",
"Amount": 2.0,
"Quantity": 3,
"ReasonTag": "sample string 4",
"SubReasonTag": "sample string 5",
"InsufficientRefundTag": "sample string 6",
"InsufficientRefundNote": "sample string 7"
}
]
}
This is an example of the response JSON. Results will 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"
]
}
},
"CannotRefundReason": 0,
"Errors": [
"sample string 1"
],
"RefundLines": null
}