Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ReturnsRefunds /GetRefundLinesByHeaderId

Allows 150 calls per minute

Response: GetRefundLinesByHeaderIdResponse



Returns a refund, given its header ID

Parameters

NameTypeDescription
requestGetRefundLinesByHeaderIdRequestThe request class for this call

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.Refunds.ViewRefundsNode

Example Request

The following request format is required for this method.

Get

Endpoint URL

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

GET https://eu-ext.linnworks.net/api/ReturnsRefunds/GetRefundLinesByHeaderId?request=%7B%0D%0A%20%20%22RefundHeaderId%22%3A%201%2C%0D%0A%20%20%22OrderId%22%3A%20%22488f8fc4-690e-47e7-9271-0b7bd6cd0209%22%0D%0A%7D

Headers

Connection: keep-alive
Accept: application/json
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Post

Endpoint URL

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

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": "488f8fc4-690e-47e7-9271-0b7bd6cd0209"
}

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "RefundHeaderId": 1,
  "RefundLines": null,
  "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": "516b4ee9-ce5c-4354-a5f3-28f1a6b9c0ce",
      "NumOrderId": 3,
      "ExternalReference": "sample string 4",
      "CreatedDate": "2022-01-13T12:45:41.798714+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-01-13T12:45:41.7997109+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."
    ]
  }
}