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": "f33b660e-9c46-4637-a1dc-8e78f26d7c34",
  "RMAHeaderId": 2,
  "ReturnItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "OrderItemRowId": "5e742aa6-b6d7-487e-8ab0-828ff59f5f61",
      "ReturnItemSKU": "sample string 4",
      "ReturnItemTitle": "sample string 5",
      "BatchInventoryId": 1,
      "ReturnLocation": "da36d1d3-7f87-4540-bb80-f97c992c3678",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "RefundRowId": "184f422e-023e-4931-9e66-42eab40e81d4",
      "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": "5e742aa6-b6d7-487e-8ab0-828ff59f5f61",
      "ReturnItemSKU": "sample string 4",
      "ReturnItemTitle": "sample string 5",
      "BatchInventoryId": 1,
      "ReturnLocation": "da36d1d3-7f87-4540-bb80-f97c992c3678",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "RefundRowId": "184f422e-023e-4931-9e66-42eab40e81d4",
      "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": "cf9f7bc8-0f30-4019-9be7-b95606c5f85c",
      "ExchangeSKU": "sample string 4",
      "ExchangeTitle": "sample string 5",
      "ExchangeQuantity": 6,
      "DespatchLocationId": "d8315eb6-d20d-4283-8f2c-0e5f742784c7",
      "AdditionalCost": 8.0,
      "OrderItemRowId": "a0f18663-e009-4343-ba81-a1b0dff1e289",
      "ReturnItemSKU": "sample string 10",
      "ReturnItemTitle": "sample string 11",
      "BatchInventoryId": 1,
      "ReturnLocation": "6321876e-aea6-4360-b95c-8e515951fd77",
      "ReturnQuantity": 13,
      "RefundAmount": 14.0,
      "RefundRowId": "5f2b5ed0-f647-47cb-99b6-3d6a15c48ed1",
      "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": "cf9f7bc8-0f30-4019-9be7-b95606c5f85c",
      "ExchangeSKU": "sample string 4",
      "ExchangeTitle": "sample string 5",
      "ExchangeQuantity": 6,
      "DespatchLocationId": "d8315eb6-d20d-4283-8f2c-0e5f742784c7",
      "AdditionalCost": 8.0,
      "OrderItemRowId": "a0f18663-e009-4343-ba81-a1b0dff1e289",
      "ReturnItemSKU": "sample string 10",
      "ReturnItemTitle": "sample string 11",
      "BatchInventoryId": 1,
      "ReturnLocation": "6321876e-aea6-4360-b95c-8e515951fd77",
      "ReturnQuantity": 13,
      "RefundAmount": 14.0,
      "RefundRowId": "5f2b5ed0-f647-47cb-99b6-3d6a15c48ed1",
      "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": "c84439eb-978a-41b6-a933-342bcf23fd83",
      "AdditionalCost": 5.0,
      "OrderItemRowId": "7a27f96d-e688-4d8e-af6b-d05050a4ba33",
      "ReturnItemSKU": "sample string 7",
      "ReturnItemTitle": "sample string 8",
      "BatchInventoryId": 1,
      "ReturnLocation": "90ada6a2-26b3-4c6f-ac2f-dbe976fc5623",
      "ReturnQuantity": 10,
      "RefundAmount": 11.0,
      "RefundRowId": "f945f6f4-8952-4070-8e7b-152064d575d0",
      "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": "c84439eb-978a-41b6-a933-342bcf23fd83",
      "AdditionalCost": 5.0,
      "OrderItemRowId": "7a27f96d-e688-4d8e-af6b-d05050a4ba33",
      "ReturnItemSKU": "sample string 7",
      "ReturnItemTitle": "sample string 8",
      "BatchInventoryId": 1,
      "ReturnLocation": "90ada6a2-26b3-4c6f-ac2f-dbe976fc5623",
      "ReturnQuantity": 10,
      "RefundAmount": 11.0,
      "RefundRowId": "f945f6f4-8952-4070-8e7b-152064d575d0",
      "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-10-09T15:11:41.8699835+01:00",
      "Actioned": true,
      "ActionedDate": "2019-10-09T15:11:41.8699835+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "c13217e8-d22e-4165-81df-0c53ebb7706f",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-10-09T15:11:41.8699835+01:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-10-09T15:11:41.8699835+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "6355a3f2-53c8-4a4c-b099-507c521ee75d",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "5e76cd99-1340-45df-85b6-3357442f3b25",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "146f120d-bba1-4c0e-bf26-dfdd5ffe66a6",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "44a553f9-8f4a-4ac4-a497-6fde6d510e17",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "71ab2a87-6c86-4315-84c8-5c591b138009",
      "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-10-09T15:11:41.8699835+01:00",
      "Actioned": true,
      "ActionedDate": "2019-10-09T15:11:41.8699835+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "c13217e8-d22e-4165-81df-0c53ebb7706f",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-10-09T15:11:41.8699835+01:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-10-09T15:11:41.8699835+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "6355a3f2-53c8-4a4c-b099-507c521ee75d",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "5e76cd99-1340-45df-85b6-3357442f3b25",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "146f120d-bba1-4c0e-bf26-dfdd5ffe66a6",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "44a553f9-8f4a-4ac4-a497-6fde6d510e17",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "71ab2a87-6c86-4315-84c8-5c591b138009",
      "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"
  ]
}