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": "2fd7a5b8-d4df-402a-b102-1b4cdd9be76e",
  "RMAHeaderId": 2,
  "ReturnItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "OrderItemRowId": "36167806-01d9-4a7a-8cc9-7298de9e6f67",
      "ReturnItemSKU": "sample string 4",
      "ReturnItemTitle": "sample string 5",
      "BatchInventoryId": 1,
      "ReturnLocation": "ddf8490a-9028-419b-a17f-5fb6bb55d57c",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "RefundRowId": "a1b0ccb5-c612-4f55-8df9-41df4dd1881f",
      "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": "36167806-01d9-4a7a-8cc9-7298de9e6f67",
      "ReturnItemSKU": "sample string 4",
      "ReturnItemTitle": "sample string 5",
      "BatchInventoryId": 1,
      "ReturnLocation": "ddf8490a-9028-419b-a17f-5fb6bb55d57c",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "RefundRowId": "a1b0ccb5-c612-4f55-8df9-41df4dd1881f",
      "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": "55a4e8c0-0601-474c-8cc2-3f8a98d87c80",
      "ExchangeSKU": "sample string 4",
      "ExchangeTitle": "sample string 5",
      "ExchangeQuantity": 6,
      "DespatchLocationId": "0b646313-f7f6-473c-87de-1f310a3f8955",
      "AdditionalCost": 8.0,
      "OrderItemRowId": "50017148-ee20-4efe-96a0-057837a9603b",
      "ReturnItemSKU": "sample string 10",
      "ReturnItemTitle": "sample string 11",
      "BatchInventoryId": 1,
      "ReturnLocation": "6e50c458-cfe3-42b0-854b-fbabd7336737",
      "ReturnQuantity": 13,
      "RefundAmount": 14.0,
      "RefundRowId": "18165974-f642-402c-b0c3-b1dd810cb32a",
      "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": "55a4e8c0-0601-474c-8cc2-3f8a98d87c80",
      "ExchangeSKU": "sample string 4",
      "ExchangeTitle": "sample string 5",
      "ExchangeQuantity": 6,
      "DespatchLocationId": "0b646313-f7f6-473c-87de-1f310a3f8955",
      "AdditionalCost": 8.0,
      "OrderItemRowId": "50017148-ee20-4efe-96a0-057837a9603b",
      "ReturnItemSKU": "sample string 10",
      "ReturnItemTitle": "sample string 11",
      "BatchInventoryId": 1,
      "ReturnLocation": "6e50c458-cfe3-42b0-854b-fbabd7336737",
      "ReturnQuantity": 13,
      "RefundAmount": 14.0,
      "RefundRowId": "18165974-f642-402c-b0c3-b1dd810cb32a",
      "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": "836c83dc-ce7f-44e6-be37-46e9c71ef9eb",
      "AdditionalCost": 5.0,
      "OrderItemRowId": "d5a543e9-be16-44a5-bffb-b1b9f370c6e8",
      "ReturnItemSKU": "sample string 7",
      "ReturnItemTitle": "sample string 8",
      "BatchInventoryId": 1,
      "ReturnLocation": "e876d831-774a-4753-b9e1-af3218482d94",
      "ReturnQuantity": 10,
      "RefundAmount": 11.0,
      "RefundRowId": "c1dc82db-9d28-4514-9640-b10911c8af0e",
      "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": "836c83dc-ce7f-44e6-be37-46e9c71ef9eb",
      "AdditionalCost": 5.0,
      "OrderItemRowId": "d5a543e9-be16-44a5-bffb-b1b9f370c6e8",
      "ReturnItemSKU": "sample string 7",
      "ReturnItemTitle": "sample string 8",
      "BatchInventoryId": 1,
      "ReturnLocation": "e876d831-774a-4753-b9e1-af3218482d94",
      "ReturnQuantity": 10,
      "RefundAmount": 11.0,
      "RefundRowId": "c1dc82db-9d28-4514-9640-b10911c8af0e",
      "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-06-12T09:27:51.42521+01:00",
      "Actioned": true,
      "ActionedDate": "2019-06-12T09:27:51.42521+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "5bce2eb9-4db4-469f-8bbf-efc5a5b25774",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-06-12T09:27:51.42521+01:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-06-12T09:27:51.42521+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "65468f86-5e08-454c-935a-3d07db22911b",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "20b15a75-7936-4334-b2c6-a928321cd9d6",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "fef9049e-7a8c-443e-9d32-18e5cc1fa30a",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "3d3ed25d-76a6-4df6-bce7-8810d5cf1d44",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "aab574c7-2c84-4b25-bf01-54abe0c134d0",
      "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-06-12T09:27:51.42521+01:00",
      "Actioned": true,
      "ActionedDate": "2019-06-12T09:27:51.42521+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "5bce2eb9-4db4-469f-8bbf-efc5a5b25774",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-06-12T09:27:51.42521+01:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-06-12T09:27:51.42521+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "65468f86-5e08-454c-935a-3d07db22911b",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "20b15a75-7936-4334-b2c6-a928321cd9d6",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "fef9049e-7a8c-443e-9d32-18e5cc1fa30a",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "3d3ed25d-76a6-4df6-bce7-8810d5cf1d44",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "aab574c7-2c84-4b25-bf01-54abe0c134d0",
      "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"
  ]
}