Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /CreateRMABooking

Response: CreateRMABookingResponse



Creates an RMA booking in the system

Parameters

NameTypeDescription
requestCreateRMABookingRequestThe request class for this call

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": "25301c75-4a2a-4346-89e6-abfbbfb480a4",
  "ReturnItems": [
    {
      "OrderItemRowId": "8458ee98-c8fc-462b-8d22-93560ec07786",
      "ReturnItemSKU": "sample string 2",
      "ReturnItemTitle": "sample string 3",
      "BatchInventoryId": 1,
      "ReturnLocation": "b1f18398-d0cc-4839-9d60-dd9b6cb626c7",
      "ReturnQuantity": 5,
      "RefundAmount": 6.0,
      "RefundRowId": "b7b8fd3e-61c9-4245-a2fe-303208da1582",
      "ScrapQuantity": 7,
      "ReasonCategory": "sample string 8",
      "IsFreeText": true,
      "Reason": "sample string 9",
      "ReasonTag": "sample string 10",
      "SubReasonTag": "sample string 11",
      "BinrackOverride": "sample string 12"
    },
    {
      "OrderItemRowId": "8458ee98-c8fc-462b-8d22-93560ec07786",
      "ReturnItemSKU": "sample string 2",
      "ReturnItemTitle": "sample string 3",
      "BatchInventoryId": 1,
      "ReturnLocation": "b1f18398-d0cc-4839-9d60-dd9b6cb626c7",
      "ReturnQuantity": 5,
      "RefundAmount": 6.0,
      "RefundRowId": "b7b8fd3e-61c9-4245-a2fe-303208da1582",
      "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": "c6893d1a-7979-4ae2-8651-7ad213b29839",
      "ExchangeSKU": "sample string 2",
      "ExchangeTitle": "sample string 3",
      "ExchangeQuantity": 4,
      "DespatchLocationId": "d6d5c2cd-ebc1-49ed-8fd1-a10cd20519f6",
      "AdditionalCost": 6.0,
      "OrderItemRowId": "9949b4dd-4749-44e3-97d3-8211c42a6750",
      "ReturnItemSKU": "sample string 8",
      "ReturnItemTitle": "sample string 9",
      "BatchInventoryId": 1,
      "ReturnLocation": "4fdf6946-4aaf-4834-adf6-0dec74c5b14e",
      "ReturnQuantity": 11,
      "RefundAmount": 12.0,
      "RefundRowId": "dd435f3b-cf2a-476c-acf7-acd406bb141f",
      "ScrapQuantity": 13,
      "ReasonCategory": "sample string 14",
      "IsFreeText": true,
      "Reason": "sample string 15",
      "ReasonTag": "sample string 16",
      "SubReasonTag": "sample string 17",
      "BinrackOverride": "sample string 18"
    },
    {
      "ExchangeStockItemId": "c6893d1a-7979-4ae2-8651-7ad213b29839",
      "ExchangeSKU": "sample string 2",
      "ExchangeTitle": "sample string 3",
      "ExchangeQuantity": 4,
      "DespatchLocationId": "d6d5c2cd-ebc1-49ed-8fd1-a10cd20519f6",
      "AdditionalCost": 6.0,
      "OrderItemRowId": "9949b4dd-4749-44e3-97d3-8211c42a6750",
      "ReturnItemSKU": "sample string 8",
      "ReturnItemTitle": "sample string 9",
      "BatchInventoryId": 1,
      "ReturnLocation": "4fdf6946-4aaf-4834-adf6-0dec74c5b14e",
      "ReturnQuantity": 11,
      "RefundAmount": 12.0,
      "RefundRowId": "dd435f3b-cf2a-476c-acf7-acd406bb141f",
      "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": "91734d96-dfa9-43c5-b2ca-a24bbfffcff9",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "7f89f59d-bf76-438d-91c0-39cfb4029f81",
      "ReturnItemSKU": "sample string 5",
      "ReturnItemTitle": "sample string 6",
      "BatchInventoryId": 1,
      "ReturnLocation": "e74668ba-0758-4264-8487-05e6b5da7e09",
      "ReturnQuantity": 8,
      "RefundAmount": 9.0,
      "RefundRowId": "0bcde1ac-2b5a-40ae-991c-4cd5244e5d6b",
      "ScrapQuantity": 10,
      "ReasonCategory": "sample string 11",
      "IsFreeText": true,
      "Reason": "sample string 12",
      "ReasonTag": "sample string 13",
      "SubReasonTag": "sample string 14",
      "BinrackOverride": "sample string 15"
    },
    {
      "ResendQuantity": 1,
      "DespatchLocationId": "91734d96-dfa9-43c5-b2ca-a24bbfffcff9",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "7f89f59d-bf76-438d-91c0-39cfb4029f81",
      "ReturnItemSKU": "sample string 5",
      "ReturnItemTitle": "sample string 6",
      "BatchInventoryId": 1,
      "ReturnLocation": "e74668ba-0758-4264-8487-05e6b5da7e09",
      "ReturnQuantity": 8,
      "RefundAmount": 9.0,
      "RefundRowId": "0bcde1ac-2b5a-40ae-991c-4cd5244e5d6b",
      "ScrapQuantity": 10,
      "ReasonCategory": "sample string 11",
      "IsFreeText": true,
      "Reason": "sample string 12",
      "ReasonTag": "sample string 13",
      "SubReasonTag": "sample string 14",
      "BinrackOverride": "sample string 15"
    }
  ]
}

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-10-09T15:11:41.8639047+01:00",
      "Actioned": true,
      "ActionedDate": "2019-10-09T15:11:41.8639047+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "b8483dcf-3db3-4124-9964-fd4c18ae128d",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-10-09T15:11:41.8639047+01:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-10-09T15:11:41.8639047+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "68846e8b-73dc-47cd-ac65-88f14fc5ae60",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "b5ee4c5d-a61f-4917-85ba-7296ddfde285",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "ecfa2df3-6e3d-4afb-beb1-9d6f720af264",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "bf28add8-9f4c-4fd7-ad2e-186efb1296c2",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "593f73e3-8af3-466f-a048-b1c722ddf1be",
      "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-10-09T15:11:41.8639047+01:00",
      "Actioned": true,
      "ActionedDate": "2019-10-09T15:11:41.8639047+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "b8483dcf-3db3-4124-9964-fd4c18ae128d",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-10-09T15:11:41.8639047+01:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-10-09T15:11:41.8639047+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "68846e8b-73dc-47cd-ac65-88f14fc5ae60",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "b5ee4c5d-a61f-4917-85ba-7296ddfde285",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "ecfa2df3-6e3d-4afb-beb1-9d6f720af264",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "bf28add8-9f4c-4fd7-ad2e-186efb1296c2",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "593f73e3-8af3-466f-a048-b1c722ddf1be",
      "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"
  ]
}