Returns channel-specific information regarding the types of refund that can be applied to the given order
| Name | Type | Description |
|---|---|---|
| request | GetReturnOptionsRequest | The request class for this call |
The following request format is required for this method.
POST https://eu-ext.linnworks.net/api/ReturnsRefunds/GetReturnOptionsConnection: 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={
"OrderId": "fee50ff7-79a0-478c-9b8b-fa8876b8eccf",
"RMAHeaderId": 1
}This is an example of the response JSON. Results will vary depending on your data.
{
"ReturnOptions": {
"CanReturn": false,
"CanReturnInternally": true,
"MustHaveRefund": false,
"RefundAutoPopulated": false,
"CanHaveRefund": false,
"ReturnReasons": [],
"SubStatuses": [
{
"StatusTag": "BOOKED_BY_SELLER",
"StatusDescription": "RMA 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 RMA Notes feature is enabled in the config.",
"EditableFields": []
},
{
"StatusTag": "BOOKED_BY_BUYER",
"StatusDescription": "RMA 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 RMA Notes feature is enabled in the config.",
"EditableFields": []
},
{
"StatusTag": "PENDING",
"StatusDescription": "RMA is currently pending to be sent to the channel",
"Actionable": false,
"ActionDescription": null,
"EditableFields": []
},
{
"StatusTag": "SUBMITTED",
"StatusDescription": "RMA was submitted to the channel and awaiting confirmation.",
"Actionable": false,
"ActionDescription": null,
"EditableFields": []
},
{
"StatusTag": "REFUNDED_ON_CHANNEL",
"StatusDescription": "RMA has been processed as part of the return.",
"Actionable": false,
"ActionDescription": null,
"EditableFields": []
}
],
"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": "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": "aa9bf324-13b7-48f1-ac97-2135aa7d0661",
"NumOrderId": 3,
"ExternalReference": "sample string 4",
"CreatedDate": "2021-07-29T09:24:14.1907457+01: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": "2021-07-29T09:24:14.1907457+01:00",
"OrderSource": "sample string 10",
"OrderSubSource": "sample string 11",
"ChannelInitiated": true,
"RefundLines": null,
"RefundLink": "sample string 13"
},
"AllExistingRefunds": null,
"Errors": []
},
"CannotReturnReason": 0,
"Order": null,
"RMAHeader": {
"RMAHeaderId": 1,
"OrderId": "af27e251-cced-4845-87a2-5fa405af3ab3",
"NumOrderId": 3,
"OrderSource": "sample string 4",
"OrderSubSource": "sample string 5",
"ExternalReference": "sample string 6",
"ChannelInitiated": true,
"CreatedDate": "2021-07-29T09:24:14.2097474+01:00",
"Status": {
},
"Actioned": true,
"LastActionDate": "2021-07-29T09:24:14.2097474+01:00",
"RMALines": [
{
"RMARowId": 1,
"RMAHeaderId": 2,
"Type": 0,
"Status": {
},
"ExternalReference": "sample string 3",
"CreatedDate": "2021-07-29T09:24:14.2097474+01:00",
"Actioned": true,
"ActionedDate": "2021-07-29T09:24:14.2097474+01:00",
"Deleted": true,
"ResendQuantity": 7,
"NewOrderId": "52ea85b9-0330-4b28-9f1f-c43ed76b52f3",
"ValidationError": "sample string 10",
"Error": "sample string 10",
"Errors": [
{
"RMARowId": 1,
"ErrorMessage": "sample string 2",
"DateStamp": "2021-07-29T09:24:14.2097474+01:00",
"Acknowledged": true
}
],
"Info": "sample string 11",
"ExchangeStockItemId": "0c935f19-8f8a-4614-91e0-1c21ddac0d89",
"ExchangeSKU": "sample string 13",
"ExchangeTitle": "sample string 14",
"ExchangeQuantity": 15,
"DespatchLocationId": "35919d74-37a1-4be5-9495-c6eae120dae1",
"AdditionalCost": 17.0,
"OrderItemRowId": "fa8b7dea-86c6-459b-a35d-b0ae14bdd9cb",
"ReturnItemSKU": "sample string 19",
"ReturnItemTitle": "sample string 20",
"BatchInventoryId": 1,
"ReturnLocation": "f18d2dd7-d5ec-4fed-8b00-a689eea67357",
"ReturnQuantity": 22,
"RefundAmount": 23.0,
"RefundRowId": "47e05f59-192f-459c-bc3a-24701c3de7c3",
"ScrapQuantity": 24,
"ReasonCategory": "sample string 25",
"IsFreeText": true,
"Reason": "sample string 26",
"ReasonTag": "sample string 27",
"SubReasonTag": "sample string 28",
"BinrackOverride": "sample string 29"
}
]
},
"AllExistingRMAs": null,
"Errors": [],
"Info": []
}
}