Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ReturnsRefunds /GetRefundOptions

Allows 150 calls per minute

Response: GetRefundOptionsResponse



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

Parameters

NameTypeDescription
requestGetRefundOptionsRequestThe request class for this call

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.Refunds.ViewRefundsNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/ReturnsRefunds/GetRefundOptions

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={
  "RefundHeaderId": 1,
  "OrderId": "ffd0b0b3-6661-42bc-9181-4dc3bd016014"
}

Response

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": "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": "18864a4f-edc1-4c0b-b674-e24069a3b4af",
      "NumOrderId": 3,
      "ExternalReference": "sample string 4",
      "CreatedDate": "2021-07-29T09:24:13.9547546+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:13.9547546+01:00",
      "OrderSource": "sample string 10",
      "OrderSubSource": "sample string 11",
      "ChannelInitiated": true,
      "RefundLines": null,
      "RefundLink": "sample string 13"
    },
    "AllExistingRefunds": null,
    "Errors": []
  }
}