Returns channel-specific information regarding the types of refund that can be applied to the given order
| Name | Type | Description |
|---|---|---|
| request | GetRefundOptionsRequest | The request class for this call |
The following request format is required for this method.
GET | POST https://eu-ext.linnworks.net/api/ReturnsRefunds/GetRefundOptionsConnection: 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={
"RefundHeaderId": 1,
"OrderId": "6821be50-4baa-482a-8c9c-50a8b7e1598b"
}This is an example of the response JSON. Results will vary depending on your data.
{
"RefundOptions": {
"CanRefund": false,
"CanRefundInternally": true,
"CanRefundItems": true,
"CanRefundServices": true,
"CanRefundShipping": true,
"CanRefundShippingIndependently": true,
"CanRefundAdditionally": true,
"CanRefundFreeText": true,
"CanInsufficientRefundFreeText": true,
"RefundFreeTextOrNoteMaxLength": 255,
"SubStatuses": [
{
"StatusTag": "BOOKED_BY_SELLER",
"StatusDescription": "Refund is booked in the system by the seller. Awaiting confirmation.",
"Actionable": true,
"ActionDescription": "Actioning this refund will trigger it to be sent to the channel, if Refund Notes feature is enabled in the config.",
"EditableFields": []
},
{
"StatusTag": "BOOKED_BY_BUYER",
"StatusDescription": "Refund request created by the buyer and is booked in the system. Awaiting confirmation.",
"Actionable": true,
"ActionDescription": "Actioning this refund will trigger it to be confirmed on the channel, if Refund Notes feature is enabled in the config.",
"EditableFields": []
},
{
"StatusTag": "UNKNOWN",
"StatusDescription": "Status is unknown, please check on the channel",
"Actionable": false,
"ActionDescription": null,
"EditableFields": []
},
{
"StatusTag": "PENDING",
"StatusDescription": "Refund is currently pending to be sent to the channel",
"Actionable": false,
"ActionDescription": null,
"EditableFields": []
},
{
"StatusTag": "SUBMITTED",
"StatusDescription": "Refund was submitted to the channel and awaiting confirmation.",
"Actionable": false,
"ActionDescription": null,
"EditableFields": []
},
{
"StatusTag": "REFUNDED_ON_CHANNEL",
"StatusDescription": "Refund has been processed as part of the return.",
"Actionable": false,
"ActionDescription": null,
"EditableFields": []
}
],
"InsufficientRefundReasons": [],
"ItemRefundReasons": [],
"ServiceRefundReasons": [],
"ShippingRefundReasons": [],
"CannotRefundReason": 0,
"Order": null,
"RefundHeader": {
"RefundHeaderId": 1,
"OrderId": "f8e7c3cd-02e4-4672-8304-8229cb2d100e",
"NumOrderId": 3,
"ExternalReference": "sample string 4",
"CreatedDate": "2023-01-10T13:49:46.6093571+00:00",
"Currency": "sample string 6",
"Amount": 7.0,
"Status": {
"StatusHeader": 0,
"StatusDetail": {
"StatusTag": "sample string 1",
"StatusDescription": "sample string 2",
"Actionable": true,
"ActionDescription": "sample string 4",
"EditableFields": [
"sample string 1"
]
}
},
"Actioned": true,
"LastActionDate": "2023-01-10T13:49:46.6103539+00:00",
"OrderSource": "sample string 10",
"OrderSubSource": "sample string 11",
"ChannelInitiated": true,
"RefundLines": null,
"RefundLink": "sample string 13"
},
"AllExistingRefunds": null,
"Errors": [
"The ConnectionString property has not been initialized."
]
}
}