Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ReturnsRefunds /GetReturnOptions

Allows 150 calls per minute

Response: GetReturnOptionsResponse



Returns channel-specific information regarding the types of refund that can be applied to the given order

Parameters

NameTypeDescription
requestGetReturnOptionsRequestThe request class for this call

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.ReturnsExchanges.ViewReturnsExchangesNode

Example Request

The following request format is required for this method.

Endpoint URL

GET | POST https://eu-ext.linnworks.net/api/ReturnsRefunds/GetReturnOptions

Headers

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

Request Body

This is an example of the request structure. Results will vary depending on your data.

request={
  "OrderId": "0e99400a-e374-4e00-b2f5-56034fe822ac",
  "RMAHeaderId": 1
}

Response

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": "UNKNOWN",
        "StatusDescription": "Status is unknown, please check on the channel",
        "Actionable": false,
        "ActionDescription": null,
        "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": "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": "4658e124-b803-4f18-b9d9-15dd9fd01975",
        "NumOrderId": 3,
        "ExternalReference": "sample string 4",
        "CreatedDate": "2022-09-05T15:10:02.9247926+03: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-09-05T15:10:02.9247926+03: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": "12ab4e50-5585-4309-926b-a1351cc61f09",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2022-09-05T15:10:02.930794+03:00",
      "Status": {
      },
      "Actioned": true,
      "LastActionDate": "2022-09-05T15:10:02.930794+03:00",
      "RMALines": [
        {
          "RMARowId": 1,
          "RMAHeaderId": 2,
          "Type": 0,
          "Status": {
          },
          "ExternalReference": "sample string 3",
          "CreatedDate": "2022-09-05T15:10:02.930794+03:00",
          "Actioned": true,
          "ActionedDate": "2022-09-05T15:10:02.930794+03:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "4959907d-a665-4962-a47d-05ad995e87af",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2022-09-05T15:10:02.930794+03:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "afb747e6-b5de-435b-9776-760c4d31495f",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "4de787b9-f88e-4014-b6fa-e75eda66d491",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "1e00b66e-f519-4ea6-98f3-5308be518ba9",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "0164ad65-6f6a-4c64-a509-54d6393e976b",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "46ea343a-9acb-4ad5-b14d-7d486feced34",
          "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": []
  }
}