Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /CreateRMABooking

Response: CreateRMABookingResponse


Parameters

NameTypeDescription
requestCreateRMABookingRequest

HTTP Endpoint

Server /ReturnsRefunds / CreateRMABooking

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/CreateRMABooking 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={
  "ChannelInitiated": true,
  "OrderId": "c6dcaab0-e669-4c0b-86e8-81e97625dc3b",
  "ReturnItems": [
    {
      "OrderItemRowId": "1b2f26ef-5046-47c4-b97a-59201c3056b8",
      "BatchInventoryId": 1,
      "ReturnLocation": "ab908615-48f5-4e21-994b-11bf12389af9",
      "ReturnQuantity": 3,
      "RefundAmount": 4.0,
      "ScrapQuantity": 5,
      "ReasonCategory": "sample string 6",
      "IsFreeText": true,
      "Reason": "sample string 7",
      "ReasonTag": "sample string 8",
      "SubReasonTag": "sample string 9"
    },
    {
      "OrderItemRowId": "1b2f26ef-5046-47c4-b97a-59201c3056b8",
      "BatchInventoryId": 1,
      "ReturnLocation": "ab908615-48f5-4e21-994b-11bf12389af9",
      "ReturnQuantity": 3,
      "RefundAmount": 4.0,
      "ScrapQuantity": 5,
      "ReasonCategory": "sample string 6",
      "IsFreeText": true,
      "Reason": "sample string 7",
      "ReasonTag": "sample string 8",
      "SubReasonTag": "sample string 9"
    }
  ],
  "ExchangeItems": [
    {
      "ExchangeStockItemId": "3dac3347-759a-4b20-99ab-9f4dc62f5265",
      "ExchangeQuantity": 2,
      "DespatchLocationId": "4fa571ea-9ad6-41b3-a26d-be9e35bda0a4",
      "AdditionalCost": 4.0,
      "OrderItemRowId": "f09141d7-1a0b-47fc-8c4a-292d08147a39",
      "BatchInventoryId": 1,
      "ReturnLocation": "844dd8cc-a31e-490d-aa26-97100f0364a8",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "ScrapQuantity": 9,
      "ReasonCategory": "sample string 10",
      "IsFreeText": true,
      "Reason": "sample string 11",
      "ReasonTag": "sample string 12",
      "SubReasonTag": "sample string 13"
    },
    {
      "ExchangeStockItemId": "3dac3347-759a-4b20-99ab-9f4dc62f5265",
      "ExchangeQuantity": 2,
      "DespatchLocationId": "4fa571ea-9ad6-41b3-a26d-be9e35bda0a4",
      "AdditionalCost": 4.0,
      "OrderItemRowId": "f09141d7-1a0b-47fc-8c4a-292d08147a39",
      "BatchInventoryId": 1,
      "ReturnLocation": "844dd8cc-a31e-490d-aa26-97100f0364a8",
      "ReturnQuantity": 7,
      "RefundAmount": 8.0,
      "ScrapQuantity": 9,
      "ReasonCategory": "sample string 10",
      "IsFreeText": true,
      "Reason": "sample string 11",
      "ReasonTag": "sample string 12",
      "SubReasonTag": "sample string 13"
    }
  ],
  "ResendItems": [
    {
      "ResendQuantity": 1,
      "DespatchLocationId": "e90c023b-472b-4343-82f8-85ff0288ff97",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "a17613d6-e4dc-4e85-8733-df5f79160133",
      "BatchInventoryId": 1,
      "ReturnLocation": "9a1aa590-8d5c-4c9d-a91d-768eb570472f",
      "ReturnQuantity": 6,
      "RefundAmount": 7.0,
      "ScrapQuantity": 8,
      "ReasonCategory": "sample string 9",
      "IsFreeText": true,
      "Reason": "sample string 10",
      "ReasonTag": "sample string 11",
      "SubReasonTag": "sample string 12"
    },
    {
      "ResendQuantity": 1,
      "DespatchLocationId": "e90c023b-472b-4343-82f8-85ff0288ff97",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "a17613d6-e4dc-4e85-8733-df5f79160133",
      "BatchInventoryId": 1,
      "ReturnLocation": "9a1aa590-8d5c-4c9d-a91d-768eb570472f",
      "ReturnQuantity": 6,
      "RefundAmount": 7.0,
      "ScrapQuantity": 8,
      "ReasonCategory": "sample string 9",
      "IsFreeText": true,
      "Reason": "sample string 10",
      "ReasonTag": "sample string 11",
      "SubReasonTag": "sample string 12"
    }
  ]
}

Response

This is an example response. Results may vary depending on your data.

{
  "RMAHeaderID": 1,
  "Items": [
    {
      "RMARowId": 1,
      "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 2",
      "Actioned": true,
      "ActionedDate": "2018-10-03T11:12:35.1279516+01:00",
      "Deleted": true,
      "ResendQuantity": 5,
      "NewOrderId": "70878a11-d6d5-41a6-b37c-097eab6cc5e1",
      "Error": "sample string 7",
      "Info": "sample string 8",
      "ExchangeStockItemId": "72a19145-ab44-4693-865f-5671f64e5388",
      "ExchangeQuantity": 10,
      "DespatchLocationId": "7b4a2de4-6dbc-49c7-84cf-b5a6a93ee684",
      "AdditionalCost": 12.0,
      "OrderItemRowId": "eec7fd3f-b93a-43f0-9dc5-214b4f8c04db",
      "BatchInventoryId": 1,
      "ReturnLocation": "ef9dee01-b09a-47e9-b3d1-306dcdb4ea3b",
      "ReturnQuantity": 15,
      "RefundAmount": 16.0,
      "ScrapQuantity": 17,
      "ReasonCategory": "sample string 18",
      "IsFreeText": true,
      "Reason": "sample string 19",
      "ReasonTag": "sample string 20",
      "SubReasonTag": "sample string 21"
    },
    {
      "RMARowId": 1,
      "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 2",
      "Actioned": true,
      "ActionedDate": "2018-10-03T11:12:35.1279516+01:00",
      "Deleted": true,
      "ResendQuantity": 5,
      "NewOrderId": "70878a11-d6d5-41a6-b37c-097eab6cc5e1",
      "Error": "sample string 7",
      "Info": "sample string 8",
      "ExchangeStockItemId": "72a19145-ab44-4693-865f-5671f64e5388",
      "ExchangeQuantity": 10,
      "DespatchLocationId": "7b4a2de4-6dbc-49c7-84cf-b5a6a93ee684",
      "AdditionalCost": 12.0,
      "OrderItemRowId": "eec7fd3f-b93a-43f0-9dc5-214b4f8c04db",
      "BatchInventoryId": 1,
      "ReturnLocation": "ef9dee01-b09a-47e9-b3d1-306dcdb4ea3b",
      "ReturnQuantity": 15,
      "RefundAmount": 16.0,
      "ScrapQuantity": 17,
      "ReasonCategory": "sample string 18",
      "IsFreeText": true,
      "Reason": "sample string 19",
      "ReasonTag": "sample string 20",
      "SubReasonTag": "sample string 21"
    }
  ],
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Info": [
    "sample string 1",
    "sample string 2"
  ]
}