Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /UpdateRMABooking

Response: UpdateRMABookingResponse



Updates an RMA booking in the system

Parameters

NameTypeDescription
requestUpdateRMABookingRequestThe request class for this call

HTTP Endpoint

Server /ReturnsRefunds / UpdateRMABooking

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.ReturnsExchanges.CreateReturnsExchangesNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ReturnsRefunds/UpdateRMABooking HTTP/1.1
Host: eu-ext.linnworks.net
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.linnworks.net
Accept-Language: en
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Referer: https://www.linnworks.net/
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

request={
  "OrderId": "b50ea977-4edc-4516-8ba4-ff8cc444de48",
  "RMAHeaderId": 2,
  "ReturnItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "OrderItemRowId": "9979a0ee-c401-49be-bc4e-4da6101dd9f3",
      "ReturnItemSKU": "sample string 4",
      "ReturnItemTitle": "sample string 5",
      "BatchInventoryId": 1,
      "ReturnLocation": "7e31f02a-49c5-4696-9e7d-f543dae0b68b",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "RefundRowId": "be16647b-a87b-4e09-af66-85f1af15e26a",
      "ScrapQuantity": 9,
      "ReasonCategory": "sample string 10",
      "IsFreeText": true,
      "Reason": "sample string 11",
      "ReasonTag": "sample string 12",
      "SubReasonTag": "sample string 13",
      "BinrackOverride": "sample string 14"
    },
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "OrderItemRowId": "9979a0ee-c401-49be-bc4e-4da6101dd9f3",
      "ReturnItemSKU": "sample string 4",
      "ReturnItemTitle": "sample string 5",
      "BatchInventoryId": 1,
      "ReturnLocation": "7e31f02a-49c5-4696-9e7d-f543dae0b68b",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "RefundRowId": "be16647b-a87b-4e09-af66-85f1af15e26a",
      "ScrapQuantity": 9,
      "ReasonCategory": "sample string 10",
      "IsFreeText": true,
      "Reason": "sample string 11",
      "ReasonTag": "sample string 12",
      "SubReasonTag": "sample string 13",
      "BinrackOverride": "sample string 14"
    }
  ],
  "ExchangeItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "ExchangeStockItemId": "e1affced-84f8-404e-9850-8d1b6e61ff35",
      "ExchangeSKU": "sample string 4",
      "ExchangeTitle": "sample string 5",
      "ExchangeQuantity": 6,
      "DespatchLocationId": "c46da61d-03e0-4598-a459-bdf1038c0297",
      "AdditionalCost": 8.0,
      "OrderItemRowId": "eb7c4dad-2d20-4a49-a4bb-c13e47147a98",
      "ReturnItemSKU": "sample string 10",
      "ReturnItemTitle": "sample string 11",
      "BatchInventoryId": 1,
      "ReturnLocation": "e62822b8-3784-4308-bbe3-b9e564c0e264",
      "ReturnQuantity": 13,
      "RefundAmount": 14.0,
      "RefundRowId": "ce69c06e-30e6-49f0-bbec-897837b69b34",
      "ScrapQuantity": 15,
      "ReasonCategory": "sample string 16",
      "IsFreeText": true,
      "Reason": "sample string 17",
      "ReasonTag": "sample string 18",
      "SubReasonTag": "sample string 19",
      "BinrackOverride": "sample string 20"
    },
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "ExchangeStockItemId": "e1affced-84f8-404e-9850-8d1b6e61ff35",
      "ExchangeSKU": "sample string 4",
      "ExchangeTitle": "sample string 5",
      "ExchangeQuantity": 6,
      "DespatchLocationId": "c46da61d-03e0-4598-a459-bdf1038c0297",
      "AdditionalCost": 8.0,
      "OrderItemRowId": "eb7c4dad-2d20-4a49-a4bb-c13e47147a98",
      "ReturnItemSKU": "sample string 10",
      "ReturnItemTitle": "sample string 11",
      "BatchInventoryId": 1,
      "ReturnLocation": "e62822b8-3784-4308-bbe3-b9e564c0e264",
      "ReturnQuantity": 13,
      "RefundAmount": 14.0,
      "RefundRowId": "ce69c06e-30e6-49f0-bbec-897837b69b34",
      "ScrapQuantity": 15,
      "ReasonCategory": "sample string 16",
      "IsFreeText": true,
      "Reason": "sample string 17",
      "ReasonTag": "sample string 18",
      "SubReasonTag": "sample string 19",
      "BinrackOverride": "sample string 20"
    }
  ],
  "ResendItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "ResendQuantity": 3,
      "DespatchLocationId": "15f04a69-fb53-42cb-b7b9-503cc7f3b881",
      "AdditionalCost": 5.0,
      "OrderItemRowId": "6421ee35-830f-419c-96ac-ab5b09531b30",
      "ReturnItemSKU": "sample string 7",
      "ReturnItemTitle": "sample string 8",
      "BatchInventoryId": 1,
      "ReturnLocation": "e8a579b9-fbdd-40e0-81e2-4067475be765",
      "ReturnQuantity": 10,
      "RefundAmount": 11.0,
      "RefundRowId": "fbddc9c8-1de2-4998-8c6e-60f95226ed5a",
      "ScrapQuantity": 12,
      "ReasonCategory": "sample string 13",
      "IsFreeText": true,
      "Reason": "sample string 14",
      "ReasonTag": "sample string 15",
      "SubReasonTag": "sample string 16",
      "BinrackOverride": "sample string 17"
    },
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "ResendQuantity": 3,
      "DespatchLocationId": "15f04a69-fb53-42cb-b7b9-503cc7f3b881",
      "AdditionalCost": 5.0,
      "OrderItemRowId": "6421ee35-830f-419c-96ac-ab5b09531b30",
      "ReturnItemSKU": "sample string 7",
      "ReturnItemTitle": "sample string 8",
      "BatchInventoryId": 1,
      "ReturnLocation": "e8a579b9-fbdd-40e0-81e2-4067475be765",
      "ReturnQuantity": 10,
      "RefundAmount": 11.0,
      "RefundRowId": "fbddc9c8-1de2-4998-8c6e-60f95226ed5a",
      "ScrapQuantity": 12,
      "ReasonCategory": "sample string 13",
      "IsFreeText": true,
      "Reason": "sample string 14",
      "ReasonTag": "sample string 15",
      "SubReasonTag": "sample string 16",
      "BinrackOverride": "sample string 17"
    }
  ],
  "AllowCreationOfNewOrder": true
}

Response

This is an example response. Results may 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",
            "sample string 2"
          ]
        }
      },
      "ExternalReference": "sample string 3",
      "CreatedDate": "2019-11-28T09:45:59.5892075+00:00",
      "Actioned": true,
      "ActionedDate": "2019-11-28T09:45:59.5892075+00:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "7fde2d52-1523-4679-bac6-cc4b05db5ac7",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-11-28T09:45:59.5892075+00:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-11-28T09:45:59.5892075+00:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "23fc71b6-56fc-4280-b9c8-b5ae3eeaa985",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "3079d11f-50f3-49e9-b018-fd282bd691b7",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "d8526a8b-bfea-4a2f-bd63-33e6bef3fc7d",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "f595a856-fb94-4a64-9966-c2dc805c7a5f",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "b3071136-db3a-45c4-905c-7d0f3f6cf2b9",
      "ScrapQuantity": 24,
      "ReasonCategory": "sample string 25",
      "IsFreeText": true,
      "Reason": "sample string 26",
      "ReasonTag": "sample string 27",
      "SubReasonTag": "sample string 28",
      "BinrackOverride": "sample string 29"
    },
    {
      "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",
            "sample string 2"
          ]
        }
      },
      "ExternalReference": "sample string 3",
      "CreatedDate": "2019-11-28T09:45:59.5892075+00:00",
      "Actioned": true,
      "ActionedDate": "2019-11-28T09:45:59.5892075+00:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "7fde2d52-1523-4679-bac6-cc4b05db5ac7",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-11-28T09:45:59.5892075+00:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-11-28T09:45:59.5892075+00:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "23fc71b6-56fc-4280-b9c8-b5ae3eeaa985",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "3079d11f-50f3-49e9-b018-fd282bd691b7",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "d8526a8b-bfea-4a2f-bd63-33e6bef3fc7d",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "f595a856-fb94-4a64-9966-c2dc805c7a5f",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "b3071136-db3a-45c4-905c-7d0f3f6cf2b9",
      "ScrapQuantity": 24,
      "ReasonCategory": "sample string 25",
      "IsFreeText": true,
      "Reason": "sample string 26",
      "ReasonTag": "sample string 27",
      "SubReasonTag": "sample string 28",
      "BinrackOverride": "sample string 29"
    }
  ],
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Info": [
    "sample string 1",
    "sample string 2"
  ]
}