Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ReturnsRefunds /GetRefundHeadersByOrderId

Allows 150 calls per minute

Response: GetRefundHeadersByOrderIdResponse



Returns all refund headers associated with the given order ID

Parameters

NameTypeDescription
requestGetRefundHeadersByOrderIdRequestThe 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/GetRefundHeadersByOrderId?request=%7B%0D%0A%20%20%22OrderId%22%3A%20%22c17fc38a-9ece-4b4e-9ecd-25fe08859d8a%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/GetRefundHeadersByOrderId

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": "c17fc38a-9ece-4b4e-9ecd-25fe08859d8a"
}

Response

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

{
  "RefundHeaders": [
    {
      "RefundHeaderId": 1,
      "OrderId": "2bbbd6c2-cbfc-466c-8893-055b768daa0d",
      "NumOrderId": 3,
      "ExternalReference": "sample string 4",
      "CreatedDate": "2022-01-13T12:45:41.778768+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.778768+00:00",
      "OrderSource": "sample string 10",
      "OrderSubSource": "sample string 11",
      "ChannelInitiated": true,
      "RefundLines": null,
      "RefundLink": "sample string 13"
    }
  ]
}