Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ReturnsRefunds /UpdateRMABooking

Allows 150 calls per minute

Response: UpdateRMABookingResponse



Updates an RMA booking in the system. Requires create and delete permissions

Parameters

NameTypeDescription
requestUpdateRMABookingRequestThe request class for this call

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.ReturnsExchanges.CreateReturnsExchangesNode

Example Request

The following request format is required for this method.

Endpoint URL

PUT | POST https://eu-ext.linnworks.net/api/ReturnsRefunds/UpdateRMABooking

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": "32e2121f-d304-4a60-a4d4-f967c6ff7433",
  "RMAHeaderId": 2,
  "ReturnItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "OrderItemRowId": "ea00bbbd-e397-4e2e-b699-4769cf067f02",
      "ReturnItemSKU": "sample string 4",
      "ReturnItemTitle": "sample string 5",
      "BatchInventoryId": 1,
      "ReturnLocation": "ef6ff5c5-b412-45b2-99ef-f41d7d6a541e",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "RefundRowId": "bd5dfa5e-4fd6-46e1-a8c2-be0b66b08af9",
      "ScrapQuantity": 9,
      "ReasonCategory": "sample string 10",
      "IsFreeText": false,
      "Reason": "sample string 11",
      "ReasonTag": "sample string 12",
      "SubReasonTag": "sample string 13",
      "BinrackOverride": "sample string 14"
    }
  ],
  "ExchangeItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "ExchangeStockItemId": "fc456bba-3628-4c30-8b0e-591d0fec8c6d",
      "ExchangeSKU": "sample string 4",
      "ExchangeTitle": "sample string 5",
      "ExchangeQuantity": 6,
      "DespatchLocationId": "fd51804f-7eb8-4fde-91e9-1bafe184579f",
      "AdditionalCost": 8.0,
      "OrderItemRowId": "faba4db5-d4b9-4f16-8953-7172a01dbbf3",
      "ReturnItemSKU": "sample string 10",
      "ReturnItemTitle": "sample string 11",
      "BatchInventoryId": 1,
      "ReturnLocation": "09b135eb-caf6-4973-9704-ec02d3033332",
      "ReturnQuantity": 13,
      "RefundAmount": 14.0,
      "RefundRowId": "74b86dc1-b857-4709-bc36-d1bf082009d1",
      "ScrapQuantity": 15,
      "ReasonCategory": "sample string 16",
      "IsFreeText": false,
      "Reason": "sample string 17",
      "ReasonTag": "sample string 18",
      "SubReasonTag": "sample string 19",
      "BinrackOverride": "sample string 20"
    }
  ],
  "ResendItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "ResendQuantity": 3,
      "DespatchLocationId": "d273a9f3-5a71-4bae-bee9-0b85094fce06",
      "AdditionalCost": 5.0,
      "OrderItemRowId": "7b34692f-90ee-40dd-af7a-8b7e3348e937",
      "ReturnItemSKU": "sample string 7",
      "ReturnItemTitle": "sample string 8",
      "BatchInventoryId": 1,
      "ReturnLocation": "dfabe654-3223-41c8-8687-8fbf8c370e0c",
      "ReturnQuantity": 10,
      "RefundAmount": 11.0,
      "RefundRowId": "c1f6557e-4e16-4a7b-acc1-e5c9852517d8",
      "ScrapQuantity": 12,
      "ReasonCategory": "sample string 13",
      "IsFreeText": false,
      "Reason": "sample string 14",
      "ReasonTag": "sample string 15",
      "SubReasonTag": "sample string 16",
      "BinrackOverride": "sample string 17"
    }
  ],
  "AllowCreationOfNewOrder": true
}

Response

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

{
  "RMAHeaderId": 1,
  "Items": [
    {
      "RMARowId": 1,
      "RMAHeaderId": 2,
      "Type": 0,
      "Status": {
        "StatusHeader": 0,
        "StatusDetail": {
          "StatusTag": "sample string 1",
          "StatusDescription": "sample string 2",
          "Actionable": true,
          "ActionDescription": "sample string 4",
          "EditableFields": [
            "sample string 1"
          ]
        }
      },
      "ExternalReference": "sample string 3",
      "CreatedDate": "2022-09-05T15:10:02.9842264+03:00",
      "Actioned": true,
      "ActionedDate": "2022-09-05T15:10:02.9842264+03:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "1c255552-e1fa-4fda-bf58-9126ddf6b7e0",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2022-09-05T15:10:02.9842264+03:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "2e4d4a1f-248f-44fb-84cd-0c4ec5ab73a9",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "fea56596-c291-423c-a841-cda733a4fe0f",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "846c16b8-ab6a-417d-b6c7-2655eba018b3",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "45a23380-8a62-4b19-b59c-a70374d7acf5",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "9be65a58-f53a-432b-8576-0ac7ba3ce952",
      "ScrapQuantity": 24,
      "ReasonCategory": "sample string 25",
      "IsFreeText": false,
      "Reason": "sample string 26",
      "ReasonTag": "sample string 27",
      "SubReasonTag": "sample string 28",
      "BinrackOverride": "sample string 29"
    }
  ],
  "Errors": [
    "sample string 1"
  ],
  "Info": [
    "sample string 1"
  ]
}