Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ReturnsRefunds /UpdateRMABooking

Allows 150 calls per minute

Response: UpdateRMABookingResponse



Updates an RMA booking in the system

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": "574f59e5-4859-4729-b31f-c1bd6f4e73ce",
  "RMAHeaderId": 2,
  "ReturnItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "OrderItemRowId": "5462d31c-e49e-45c2-a9b5-fa595b64c69f",
      "ReturnItemSKU": "sample string 4",
      "ReturnItemTitle": "sample string 5",
      "BatchInventoryId": 1,
      "ReturnLocation": "82c22045-e4c5-4a1e-b543-a8fc4ff48b03",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "RefundRowId": "07ba8dcd-ef9e-46ec-a68f-e44c2d75cbf4",
      "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": "c71bc2d0-0211-46c0-a067-b912f9c166e1",
      "ExchangeSKU": "sample string 4",
      "ExchangeTitle": "sample string 5",
      "ExchangeQuantity": 6,
      "DespatchLocationId": "816d04aa-d85c-44f5-9118-546c1d2f740a",
      "AdditionalCost": 8.0,
      "OrderItemRowId": "8bfe25cd-3a05-465d-8f72-b120623152ac",
      "ReturnItemSKU": "sample string 10",
      "ReturnItemTitle": "sample string 11",
      "BatchInventoryId": 1,
      "ReturnLocation": "823ce090-07cd-44d1-9ef6-1c7eb21e948a",
      "ReturnQuantity": 13,
      "RefundAmount": 14.0,
      "RefundRowId": "9dff1d41-5aab-4292-b4fa-74103c9c8ba3",
      "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": "122855a7-8315-4001-bfcc-cb5f02bbc07f",
      "AdditionalCost": 5.0,
      "OrderItemRowId": "1d70d69d-ba6b-46f4-99c2-0df9e7c1ba70",
      "ReturnItemSKU": "sample string 7",
      "ReturnItemTitle": "sample string 8",
      "BatchInventoryId": 1,
      "ReturnLocation": "3018ccee-b81b-489e-8517-1c0a8421abe6",
      "ReturnQuantity": 10,
      "RefundAmount": 11.0,
      "RefundRowId": "42995b4a-37fb-46c0-a1bd-c64b1be3024c",
      "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 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": "2021-07-29T09:24:14.2677671+01:00",
      "Actioned": true,
      "ActionedDate": "2021-07-29T09:24:14.2677671+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "49bcaca5-2060-42ec-87ad-e71a27e86a05",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2021-07-29T09:24:14.2677671+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "211f66fb-6bec-4726-a53a-31cabfbf8621",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "5ceffa91-534c-4da4-b3f4-70f15cfe93d2",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "6b29066a-7437-43ea-b4d3-050aa718a47e",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "33911ef6-10a9-4baa-b3aa-b0e62eec1ee4",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "0852bed0-e79d-490c-9c4d-b380f48646b9",
      "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"
  ],
  "Info": [
    "sample string 1"
  ]
}