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": "0fb63638-bad5-412a-8c1a-373b207a54ac",
  "ReturnItems": [
    {
      "OrderItemRowId": "61be092a-f3e9-4e1e-8e66-a1a67dcb14aa",
      "ReturnItemSKU": "sample string 2",
      "ReturnItemTitle": "sample string 3",
      "BatchInventoryId": 1,
      "ReturnLocation": "d3818b74-128a-4eb0-a25c-09f65e74857e",
      "ReturnQuantity": 5,
      "RefundAmount": 6.0,
      "RefundRowId": "a260b825-5a98-47d1-b7cc-db191dfced0e",
      "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": "61be092a-f3e9-4e1e-8e66-a1a67dcb14aa",
      "ReturnItemSKU": "sample string 2",
      "ReturnItemTitle": "sample string 3",
      "BatchInventoryId": 1,
      "ReturnLocation": "d3818b74-128a-4eb0-a25c-09f65e74857e",
      "ReturnQuantity": 5,
      "RefundAmount": 6.0,
      "RefundRowId": "a260b825-5a98-47d1-b7cc-db191dfced0e",
      "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": "4a73df68-36fa-4bf7-8c55-cd629915a7d1",
      "ExchangeSKU": "sample string 2",
      "ExchangeTitle": "sample string 3",
      "ExchangeQuantity": 4,
      "DespatchLocationId": "3d361e53-f749-4179-bac5-74475d47689c",
      "AdditionalCost": 6.0,
      "OrderItemRowId": "965260a0-18ab-406f-ae44-45d2274982c6",
      "ReturnItemSKU": "sample string 8",
      "ReturnItemTitle": "sample string 9",
      "BatchInventoryId": 1,
      "ReturnLocation": "6c190229-3987-42e4-a05e-3ecad2f8eb07",
      "ReturnQuantity": 11,
      "RefundAmount": 12.0,
      "RefundRowId": "dc258dd5-1ec9-4194-825f-6727500781e3",
      "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": "4a73df68-36fa-4bf7-8c55-cd629915a7d1",
      "ExchangeSKU": "sample string 2",
      "ExchangeTitle": "sample string 3",
      "ExchangeQuantity": 4,
      "DespatchLocationId": "3d361e53-f749-4179-bac5-74475d47689c",
      "AdditionalCost": 6.0,
      "OrderItemRowId": "965260a0-18ab-406f-ae44-45d2274982c6",
      "ReturnItemSKU": "sample string 8",
      "ReturnItemTitle": "sample string 9",
      "BatchInventoryId": 1,
      "ReturnLocation": "6c190229-3987-42e4-a05e-3ecad2f8eb07",
      "ReturnQuantity": 11,
      "RefundAmount": 12.0,
      "RefundRowId": "dc258dd5-1ec9-4194-825f-6727500781e3",
      "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": "cdb8406a-e29d-4907-94df-4121a11fced0",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "4c738ff3-9999-4761-ac35-8e9692d1e337",
      "ReturnItemSKU": "sample string 5",
      "ReturnItemTitle": "sample string 6",
      "BatchInventoryId": 1,
      "ReturnLocation": "87fd01fc-bbc6-4967-99cb-a7c207c3d633",
      "ReturnQuantity": 8,
      "RefundAmount": 9.0,
      "RefundRowId": "03eba80c-0163-42ca-886f-1ca5b57253e3",
      "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": "cdb8406a-e29d-4907-94df-4121a11fced0",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "4c738ff3-9999-4761-ac35-8e9692d1e337",
      "ReturnItemSKU": "sample string 5",
      "ReturnItemTitle": "sample string 6",
      "BatchInventoryId": 1,
      "ReturnLocation": "87fd01fc-bbc6-4967-99cb-a7c207c3d633",
      "ReturnQuantity": 8,
      "RefundAmount": 9.0,
      "RefundRowId": "03eba80c-0163-42ca-886f-1ca5b57253e3",
      "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-11-28T09:45:59.5842268+00:00",
      "Actioned": true,
      "ActionedDate": "2019-11-28T09:45:59.5842268+00:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "1430c745-8d8a-4c59-9d12-a72403de3682",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-11-28T09:45:59.5842268+00:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-11-28T09:45:59.5842268+00:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "5718eb31-961a-4869-8055-85c6659d9cf4",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "03872996-5b66-48d8-a93c-e07fa7d4ac24",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "372be104-73b7-4487-a393-d1818a77f60a",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "c72945fb-ff51-4fd5-b16d-c2afac3b7677",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "b20dccef-edaa-4c2f-9da8-95190c3aabb5",
      "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-11-28T09:45:59.5842268+00:00",
      "Actioned": true,
      "ActionedDate": "2019-11-28T09:45:59.5842268+00:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "1430c745-8d8a-4c59-9d12-a72403de3682",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-11-28T09:45:59.5842268+00:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-11-28T09:45:59.5842268+00:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "5718eb31-961a-4869-8055-85c6659d9cf4",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "03872996-5b66-48d8-a93c-e07fa7d4ac24",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "372be104-73b7-4487-a393-d1818a77f60a",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "c72945fb-ff51-4fd5-b16d-c2afac3b7677",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "b20dccef-edaa-4c2f-9da8-95190c3aabb5",
      "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"
  ]
}