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.

Endpoint URL

GET | 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": "baf51e5b-a402-4e48-bf23-15c40f8d3e49"
}

Response

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

{
  "RefundHeaders": [
    {
      "RefundHeaderId": 1,
      "OrderId": "3ede9c34-a366-4b4a-b6fb-fcfb36cd9045",
      "NumOrderId": 3,
      "ExternalReference": "sample string 4",
      "CreatedDate": "2022-09-05T15:10:02.782757+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.782757+03:00",
      "OrderSource": "sample string 10",
      "OrderSubSource": "sample string 11",
      "ChannelInitiated": true,
      "RefundLines": null,
      "RefundLink": "sample string 13"
    }
  ]
}