Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ReturnsRefunds /GetRMAHeadersByOrderId

Allows 150 calls per minute

Response: GetRMAHeadersByOrderIdResponse



Returns all RMA headers associated with the given order ID

Parameters

NameTypeDescription
requestGetRMAHeadersByOrderIdRequestThe 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/GetRMAHeadersByOrderId

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": "c216d0c3-ef28-438c-9a28-dad979b3bcac"
}

Response

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

{
  "RMAHeaders": [
    {
      "RMAHeaderId": 1,
      "OrderId": "4a1ba63d-16ef-45e0-8370-a2ebc708f8ed",
      "NumOrderId": 3,
      "OrderSource": "sample string 4",
      "OrderSubSource": "sample string 5",
      "ExternalReference": "sample string 6",
      "ChannelInitiated": true,
      "CreatedDate": "2023-01-10T13:49:46.6704372+00:00",
      "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": "2023-01-10T13:49:46.6704372+00:00",
      "RMALines": [
        {
          "RMARowId": 1,
          "RMAHeaderId": 2,
          "Type": 0,
          "Status": {
          },
          "ExternalReference": "sample string 3",
          "CreatedDate": "2023-01-10T13:49:46.6704372+00:00",
          "Actioned": true,
          "ActionedDate": "2023-01-10T13:49:46.6704372+00:00",
          "Deleted": true,
          "ResendQuantity": 7,
          "NewOrderId": "f5559332-80b0-4577-9446-e2f4f3091edc",
          "ValidationError": "sample string 10",
          "Error": "sample string 10",
          "Errors": [
            {
              "RMARowId": 1,
              "ErrorMessage": "sample string 2",
              "DateStamp": "2023-01-10T13:49:46.671434+00:00",
              "Acknowledged": true
            }
          ],
          "Info": "sample string 11",
          "ExchangeStockItemId": "269ba5ef-1002-4602-b1ff-5f11be12317e",
          "ExchangeSKU": "sample string 13",
          "ExchangeTitle": "sample string 14",
          "ExchangeQuantity": 15,
          "DespatchLocationId": "33057ca6-50ae-4084-936f-b378e09480da",
          "AdditionalCost": 17.0,
          "OrderItemRowId": "fda3289e-379d-4916-8441-10f68b6d79be",
          "ReturnItemSKU": "sample string 19",
          "ReturnItemTitle": "sample string 20",
          "BatchInventoryId": 1,
          "ReturnLocation": "c3b2cc05-4453-4f2a-861a-417e6c70c297",
          "ReturnQuantity": 22,
          "RefundAmount": 23.0,
          "RefundRowId": "0a939dca-c2e5-42b1-af26-8b381f262c79",
          "ScrapQuantity": 24,
          "ReasonCategory": "sample string 25",
          "IsFreeText": false,
          "Reason": "sample string 26",
          "ReasonTag": "sample string 27",
          "SubReasonTag": "sample string 28",
          "BinrackOverride": "sample string 29"
        }
      ]
    }
  ]
}