Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ReturnsRefunds /UpdateRMABooking

Allows 150 calls per minute

Response: UpdateRMABookingResponse



Updates an RMA booking in the system. Requires create and delete permissions

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

PUT | 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": "698b47e2-6add-46b8-acd4-55e7c8927d4a",
  "RMAHeaderId": 2,
  "ReturnItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "OrderItemRowId": "0e9051af-2204-4a28-b530-afdcaa4dd60e",
      "ReturnItemSKU": "sample string 4",
      "ReturnItemTitle": "sample string 5",
      "BatchInventoryId": 1,
      "ReturnLocation": "60d9f90d-71e9-4baa-9d2a-fe74357ec87e",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "RefundRowId": "9a580f1c-ace7-4205-a4db-61549ec8b8af",
      "ScrapQuantity": 9,
      "ReasonCategory": "sample string 10",
      "IsFreeText": false,
      "Reason": "sample string 11",
      "ReasonTag": "sample string 12",
      "SubReasonTag": "sample string 13",
      "BinrackOverride": "sample string 14"
    }
  ],
  "ExchangeItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "ExchangeStockItemId": "3ca84b67-14dd-407e-b8e2-e5ace3a8f6ae",
      "ExchangeSKU": "sample string 4",
      "ExchangeTitle": "sample string 5",
      "ExchangeQuantity": 6,
      "DespatchLocationId": "f3acbe65-84e7-42da-851e-4c57c3f02364",
      "AdditionalCost": 8.0,
      "OrderItemRowId": "86f35223-6023-449a-9816-57ce4edf0e22",
      "ReturnItemSKU": "sample string 10",
      "ReturnItemTitle": "sample string 11",
      "BatchInventoryId": 1,
      "ReturnLocation": "dc1c58f7-f07c-4777-bc33-54f6b804b330",
      "ReturnQuantity": 13,
      "RefundAmount": 14.0,
      "RefundRowId": "0724536c-b7e2-40f6-84db-a5f48f034dad",
      "ScrapQuantity": 15,
      "ReasonCategory": "sample string 16",
      "IsFreeText": false,
      "Reason": "sample string 17",
      "ReasonTag": "sample string 18",
      "SubReasonTag": "sample string 19",
      "BinrackOverride": "sample string 20"
    }
  ],
  "ResendItems": [
    {
      "RMARowId": 1,
      "RemoveFromBooking": true,
      "ResendQuantity": 3,
      "DespatchLocationId": "df9295e9-8de4-41ef-81b2-68656c336336",
      "AdditionalCost": 5.0,
      "OrderItemRowId": "77460b5f-6270-4e5f-aea0-4493c47b94d7",
      "ReturnItemSKU": "sample string 7",
      "ReturnItemTitle": "sample string 8",
      "BatchInventoryId": 1,
      "ReturnLocation": "5193ef8c-0b38-46b6-b47d-1a1bd5a0a92d",
      "ReturnQuantity": 10,
      "RefundAmount": 11.0,
      "RefundRowId": "439d115c-bc08-43ae-9aed-3b5a84365c89",
      "ScrapQuantity": 12,
      "ReasonCategory": "sample string 13",
      "IsFreeText": false,
      "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": "2023-01-10T13:49:46.8310952+00:00",
      "Actioned": true,
      "ActionedDate": "2023-01-10T13:49:46.8310952+00:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "e17ea960-9a50-4984-9fd1-9e8a51520f50",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2023-01-10T13:49:46.8310952+00:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "349c1e60-7ace-4399-b02a-789008e307ae",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "dbdeddca-f93f-49d8-92a1-c46d4ae9b81e",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "ad037d8b-b188-487a-91ff-bce114bce51e",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "b81f3499-045d-447e-9f18-48afa7209eee",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "c4fcaa48-1e66-441a-b890-ab5730db9892",
      "ScrapQuantity": 24,
      "ReasonCategory": "sample string 25",
      "IsFreeText": false,
      "Reason": "sample string 26",
      "ReasonTag": "sample string 27",
      "SubReasonTag": "sample string 28",
      "BinrackOverride": "sample string 29"
    }
  ],
  "Errors": [
    "sample string 1"
  ],
  "Info": [
    "sample string 1"
  ]
}