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

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": "4a1dff2c-1373-4fba-aead-5a1b7d316804",
  "RMAHeaderId": 2,
  "ReturnItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "OrderItemRowId": "2c7e9921-b2d5-4acb-8b35-58f8810d0da0",
      "ReturnItemSKU": "sample string 4",
      "ReturnItemTitle": "sample string 5",
      "BatchInventoryId": 1,
      "ReturnLocation": "f61dac29-c104-4c9b-8c9e-f037ac2b6190",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "RefundRowId": "3a0b862b-3c98-47d1-b4d8-5aaf18a10e16",
      "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": "39aa3d78-a732-4a87-9946-40090cbac7d6",
      "ExchangeSKU": "sample string 4",
      "ExchangeTitle": "sample string 5",
      "ExchangeQuantity": 6,
      "DespatchLocationId": "b83b613c-67a5-4c94-982d-76e5dcd15542",
      "AdditionalCost": 8.0,
      "OrderItemRowId": "6ee11b15-0d96-4e5b-8a05-fbd368813ac9",
      "ReturnItemSKU": "sample string 10",
      "ReturnItemTitle": "sample string 11",
      "BatchInventoryId": 1,
      "ReturnLocation": "03f9da9d-6395-4a50-ab39-983602b54ba6",
      "ReturnQuantity": 13,
      "RefundAmount": 14.0,
      "RefundRowId": "7f921a35-11a3-4bc6-a346-25011dff9dd8",
      "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": "11fd5fd9-a99f-4ce2-b79b-bbd987115678",
      "AdditionalCost": 5.0,
      "OrderItemRowId": "b9622a3c-8dd0-43e6-b8e9-c62aacfc9449",
      "ReturnItemSKU": "sample string 7",
      "ReturnItemTitle": "sample string 8",
      "BatchInventoryId": 1,
      "ReturnLocation": "459425ac-341f-4599-971d-c19b76e473be",
      "ReturnQuantity": 10,
      "RefundAmount": 11.0,
      "RefundRowId": "7296fe60-c96e-4af3-8a0d-0c7336bad7d1",
      "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-03-09T13:04:03.8082222+00:00",
      "Actioned": true,
      "ActionedDate": "2022-03-09T13:04:03.8082222+00:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "71dd063a-a7f4-4cec-a66a-7b305a9dce05",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2022-03-09T13:04:03.8082222+00:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "2ca422a8-5107-47c8-8347-ff2916dc5eac",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "58e31a70-5e5d-4b93-811c-d9c183fdba66",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "648ea103-2613-4c4f-b0c0-b024aeb1e671",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "496ff643-59cf-4a25-9331-b53fd4c1f860",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "3e803dee-9810-4837-9af4-e4db81546dc3",
      "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"
  ]
}