Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ReturnsRefunds /CreateRMABooking

Allows 150 calls per minute

Response: CreateRMABookingResponse



Creates an RMA booking in the system

Parameters

NameTypeDescription
requestCreateRMABookingRequestThe 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/CreateRMABooking

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={
  "ChannelInitiated": true,
  "OrderId": "9c326a8c-2881-471c-940c-c25aef65d7d9",
  "ReturnItems": [
    {
      "OrderItemRowId": "dbe93d33-8c3f-4696-8f12-8145951d25cb",
      "ReturnItemSKU": "sample string 2",
      "ReturnItemTitle": "sample string 3",
      "BatchInventoryId": 1,
      "ReturnLocation": "bf78b43e-7701-4a6f-a4ff-4b3986e50c0d",
      "ReturnQuantity": 5,
      "RefundAmount": 6.0,
      "RefundRowId": "e2bbb381-215f-459c-a931-49b369a8c48f",
      "ScrapQuantity": 7,
      "ReasonCategory": "sample string 8",
      "IsFreeText": true,
      "Reason": "sample string 9",
      "ReasonTag": "sample string 10",
      "SubReasonTag": "sample string 11",
      "BinrackOverride": "sample string 12"
    }
  ],
  "ExchangeItems": [
    {
      "ExchangeStockItemId": "1c1368ac-6c9b-41af-beb8-be0316f03ac3",
      "ExchangeSKU": "sample string 2",
      "ExchangeTitle": "sample string 3",
      "ExchangeQuantity": 4,
      "DespatchLocationId": "7f01e205-4a2d-4a6a-9459-6b0f3c934ffc",
      "AdditionalCost": 6.0,
      "OrderItemRowId": "96e08aa1-64c3-4970-ba2c-765cbecbcd72",
      "ReturnItemSKU": "sample string 8",
      "ReturnItemTitle": "sample string 9",
      "BatchInventoryId": 1,
      "ReturnLocation": "c0aa2e4c-d18d-4eda-beaf-226901111e42",
      "ReturnQuantity": 11,
      "RefundAmount": 12.0,
      "RefundRowId": "b005567c-3a67-4fa6-a8cf-4dd010cd0cff",
      "ScrapQuantity": 13,
      "ReasonCategory": "sample string 14",
      "IsFreeText": true,
      "Reason": "sample string 15",
      "ReasonTag": "sample string 16",
      "SubReasonTag": "sample string 17",
      "BinrackOverride": "sample string 18"
    }
  ],
  "ResendItems": [
    {
      "ResendQuantity": 1,
      "DespatchLocationId": "669cbc81-2ebb-4aa0-ab8a-1d6900a035dd",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "5462e9fe-8290-4553-8226-024dcf64a0aa",
      "ReturnItemSKU": "sample string 5",
      "ReturnItemTitle": "sample string 6",
      "BatchInventoryId": 1,
      "ReturnLocation": "4cbcc88f-8cb5-426a-9308-e25b7f9a946d",
      "ReturnQuantity": 8,
      "RefundAmount": 9.0,
      "RefundRowId": "40a56f11-2359-4a42-b1fa-83b30ec66742",
      "ScrapQuantity": 10,
      "ReasonCategory": "sample string 11",
      "IsFreeText": true,
      "Reason": "sample string 12",
      "ReasonTag": "sample string 13",
      "SubReasonTag": "sample string 14",
      "BinrackOverride": "sample string 15"
    }
  ],
  "Reference": "sample string 3"
}

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.2577476+01:00",
      "Actioned": true,
      "ActionedDate": "2021-07-29T09:24:14.2577476+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "fadef0f4-87f5-46de-b067-7b8fcceb4dc8",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2021-07-29T09:24:14.2577476+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "6dfe084d-8e8c-48c7-bacd-b9994f90395e",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "d1e0cccd-e3f7-4880-ba13-878dcddc94ed",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "1e8c7b65-cc95-4e4a-9149-33d566b7ca1e",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "d27c2f8d-b1a6-4e5b-99a0-ad3bce9a4e1f",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "25024f24-dd9c-4a42-98e9-39fa2e14203f",
      "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"
  ]
}