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": "a9361b7a-efac-4276-8c48-3f00195982d7",
"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": "0ffb3c9d-749b-4fc5-9b92-58337c769758",
"NumOrderId": 3,
"ExternalReference": "sample string 4",
"CreatedDate": "2022-03-09T13:04:03.7174652+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": "2022-03-09T13:04:03.7174652+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."
]
},
"CannotReturnReason": 0,
"Order": null,
"RMAHeader": {
"RMAHeaderId": 1,
"OrderId": "d778f09f-ec3b-4801-8f46-3e98e101f3b3",
"NumOrderId": 3,
"OrderSource": "sample string 4",
"OrderSubSource": "sample string 5",
"ExternalReference": "sample string 6",
"ChannelInitiated": true,
"CreatedDate": "2022-03-09T13:04:03.7344199+00:00",
"Status": {
},
"Actioned": true,
"LastActionDate": "2022-03-09T13:04:03.7344199+00:00",
"RMALines": [
{
"RMARowId": 1,
"RMAHeaderId": 2,
"Type": 0,
"Status": {
},
"ExternalReference": "sample string 3",
"CreatedDate": "2022-03-09T13:04:03.7344199+00:00",
"Actioned": true,
"ActionedDate": "2022-03-09T13:04:03.7344199+00:00",
"Deleted": true,
"ResendQuantity": 7,
"NewOrderId": "f931325e-8dd1-44c8-ac9b-4834721a1f57",
"ValidationError": "sample string 10",
"Error": "sample string 10",
"Errors": [
{
"RMARowId": 1,
"ErrorMessage": "sample string 2",
"DateStamp": "2022-03-09T13:04:03.7344199+00:00",
"Acknowledged": true
}
],
"Info": "sample string 11",
"ExchangeStockItemId": "bf552baa-efbd-441d-ae2d-33d97a986283",
"ExchangeSKU": "sample string 13",
"ExchangeTitle": "sample string 14",
"ExchangeQuantity": 15,
"DespatchLocationId": "17b20600-0f7f-4208-b563-e2e4c10ad2cc",
"AdditionalCost": 17.0,
"OrderItemRowId": "6e30aa19-2c3c-4196-a213-3c5874afe1a3",
"ReturnItemSKU": "sample string 19",
"ReturnItemTitle": "sample string 20",
"BatchInventoryId": 1,
"ReturnLocation": "6481a476-455e-41c9-9673-e91394756ded",
"ReturnQuantity": 22,
"RefundAmount": 23.0,
"RefundRowId": "0b631112-7d15-4fef-a2c5-fa31bb8ba1d0",
"ScrapQuantity": 24,
"ReasonCategory": "sample string 25",
"IsFreeText": false,
"Reason": "sample string 26",
"ReasonTag": "sample string 27",
"SubReasonTag": "sample string 28",
"BinrackOverride": "sample string 29"
}
]
},
"AllExistingRMAs": null,
"Errors": [
"The ConnectionString property has not been initialized."
],
"Info": []
}
}