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": "12e874a6-0bf1-4a28-a059-94f88868e859",
  "RMAHeaderId": 2,
  "ReturnItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "OrderItemRowId": "7219a144-3ceb-4b1d-be4a-7817dca8dd95",
      "ReturnItemSKU": "sample string 4",
      "ReturnItemTitle": "sample string 5",
      "BatchInventoryId": 1,
      "ReturnLocation": "c3039fad-e962-4d56-b802-bf12f82a3c41",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "RefundRowId": "87f91175-9314-4cb5-bd67-c015156156ce",
      "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": "7219a144-3ceb-4b1d-be4a-7817dca8dd95",
      "ReturnItemSKU": "sample string 4",
      "ReturnItemTitle": "sample string 5",
      "BatchInventoryId": 1,
      "ReturnLocation": "c3039fad-e962-4d56-b802-bf12f82a3c41",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "RefundRowId": "87f91175-9314-4cb5-bd67-c015156156ce",
      "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": "c2a241ac-ae64-41c7-ba09-c1b2ceebcc7f",
      "ExchangeSKU": "sample string 4",
      "ExchangeTitle": "sample string 5",
      "ExchangeQuantity": 6,
      "DespatchLocationId": "f9677d80-e653-422a-9699-20602818c6b1",
      "AdditionalCost": 8.0,
      "OrderItemRowId": "f4ba8a2e-0476-45fe-9a88-9a997e65ac3f",
      "ReturnItemSKU": "sample string 10",
      "ReturnItemTitle": "sample string 11",
      "BatchInventoryId": 1,
      "ReturnLocation": "fa3bb342-5e80-46b5-b77f-c55b35adf49d",
      "ReturnQuantity": 13,
      "RefundAmount": 14.0,
      "RefundRowId": "6a42e0be-118c-40ba-b412-95cb8ad9697d",
      "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": "c2a241ac-ae64-41c7-ba09-c1b2ceebcc7f",
      "ExchangeSKU": "sample string 4",
      "ExchangeTitle": "sample string 5",
      "ExchangeQuantity": 6,
      "DespatchLocationId": "f9677d80-e653-422a-9699-20602818c6b1",
      "AdditionalCost": 8.0,
      "OrderItemRowId": "f4ba8a2e-0476-45fe-9a88-9a997e65ac3f",
      "ReturnItemSKU": "sample string 10",
      "ReturnItemTitle": "sample string 11",
      "BatchInventoryId": 1,
      "ReturnLocation": "fa3bb342-5e80-46b5-b77f-c55b35adf49d",
      "ReturnQuantity": 13,
      "RefundAmount": 14.0,
      "RefundRowId": "6a42e0be-118c-40ba-b412-95cb8ad9697d",
      "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": "53267e64-dfaa-4a34-b649-c807b1ab2785",
      "AdditionalCost": 5.0,
      "OrderItemRowId": "543412d6-9f39-4289-b19d-ada64d399e6b",
      "ReturnItemSKU": "sample string 7",
      "ReturnItemTitle": "sample string 8",
      "BatchInventoryId": 1,
      "ReturnLocation": "c320cd14-3970-4c76-a315-14b45a4a4447",
      "ReturnQuantity": 10,
      "RefundAmount": 11.0,
      "RefundRowId": "8d5d7d82-0076-423c-8cb3-0eefc803d06d",
      "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": "53267e64-dfaa-4a34-b649-c807b1ab2785",
      "AdditionalCost": 5.0,
      "OrderItemRowId": "543412d6-9f39-4289-b19d-ada64d399e6b",
      "ReturnItemSKU": "sample string 7",
      "ReturnItemTitle": "sample string 8",
      "BatchInventoryId": 1,
      "ReturnLocation": "c320cd14-3970-4c76-a315-14b45a4a4447",
      "ReturnQuantity": 10,
      "RefundAmount": 11.0,
      "RefundRowId": "8d5d7d82-0076-423c-8cb3-0eefc803d06d",
      "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-08-21T13:34:05.100746+01:00",
      "Actioned": true,
      "ActionedDate": "2019-08-21T13:34:05.100746+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "3d14539a-5b26-407f-99e9-825e5983580c",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-08-21T13:34:05.100746+01:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-08-21T13:34:05.100746+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "4782c179-5402-4033-bb47-c5162dcbcc4c",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "ab8d9f96-8c0b-4163-b65a-29beefc7da5f",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "bcefb783-a0fb-4255-a4b0-d932cb974db5",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "4e294698-b584-47df-b0f9-9498a0593f14",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "514e44f0-ddb4-4bd4-ad3c-94f6036724a0",
      "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-08-21T13:34:05.100746+01:00",
      "Actioned": true,
      "ActionedDate": "2019-08-21T13:34:05.100746+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "3d14539a-5b26-407f-99e9-825e5983580c",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-08-21T13:34:05.100746+01:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-08-21T13:34:05.100746+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "4782c179-5402-4033-bb47-c5162dcbcc4c",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "ab8d9f96-8c0b-4163-b65a-29beefc7da5f",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "bcefb783-a0fb-4255-a4b0-d932cb974db5",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "4e294698-b584-47df-b0f9-9498a0593f14",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "514e44f0-ddb4-4bd4-ad3c-94f6036724a0",
      "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"
  ]
}