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": "3e26414f-e90a-44d5-bdba-ada0da10a656",
  "ReturnItems": [
    {
      "OrderItemRowId": "b6e079e7-ae0b-427e-9537-d369be34b0a8",
      "ReturnItemSKU": "sample string 2",
      "ReturnItemTitle": "sample string 3",
      "BatchInventoryId": 1,
      "ReturnLocation": "50335cfc-760d-4639-bf64-5e871ccb436e",
      "ReturnQuantity": 5,
      "RefundAmount": 6.0,
      "RefundRowId": "106bf1d9-c658-4868-9c7a-b452685b48f0",
      "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": "b6e079e7-ae0b-427e-9537-d369be34b0a8",
      "ReturnItemSKU": "sample string 2",
      "ReturnItemTitle": "sample string 3",
      "BatchInventoryId": 1,
      "ReturnLocation": "50335cfc-760d-4639-bf64-5e871ccb436e",
      "ReturnQuantity": 5,
      "RefundAmount": 6.0,
      "RefundRowId": "106bf1d9-c658-4868-9c7a-b452685b48f0",
      "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": "25786432-edb0-4fcb-8e18-a77f706b3a99",
      "ExchangeSKU": "sample string 2",
      "ExchangeTitle": "sample string 3",
      "ExchangeQuantity": 4,
      "DespatchLocationId": "a5794b4d-6652-4b8d-a9a9-df2d761c6ba9",
      "AdditionalCost": 6.0,
      "OrderItemRowId": "8dadf1d8-f86f-4756-a7ce-bec6d395a0f7",
      "ReturnItemSKU": "sample string 8",
      "ReturnItemTitle": "sample string 9",
      "BatchInventoryId": 1,
      "ReturnLocation": "17328020-7e1c-40ab-9c8a-a627f406634f",
      "ReturnQuantity": 11,
      "RefundAmount": 12.0,
      "RefundRowId": "082f39bf-f542-47ff-bc67-ac9f16afa63a",
      "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": "25786432-edb0-4fcb-8e18-a77f706b3a99",
      "ExchangeSKU": "sample string 2",
      "ExchangeTitle": "sample string 3",
      "ExchangeQuantity": 4,
      "DespatchLocationId": "a5794b4d-6652-4b8d-a9a9-df2d761c6ba9",
      "AdditionalCost": 6.0,
      "OrderItemRowId": "8dadf1d8-f86f-4756-a7ce-bec6d395a0f7",
      "ReturnItemSKU": "sample string 8",
      "ReturnItemTitle": "sample string 9",
      "BatchInventoryId": 1,
      "ReturnLocation": "17328020-7e1c-40ab-9c8a-a627f406634f",
      "ReturnQuantity": 11,
      "RefundAmount": 12.0,
      "RefundRowId": "082f39bf-f542-47ff-bc67-ac9f16afa63a",
      "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": "049e096d-c6bd-4fd3-acc6-22c37a3799cf",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "ccff9cbd-77e8-493d-b2ef-1c5bd98da961",
      "ReturnItemSKU": "sample string 5",
      "ReturnItemTitle": "sample string 6",
      "BatchInventoryId": 1,
      "ReturnLocation": "fca6ecad-b895-4279-996b-23149dbb757e",
      "ReturnQuantity": 8,
      "RefundAmount": 9.0,
      "RefundRowId": "72de697b-01a1-4c31-9c34-ecb37058a71b",
      "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": "049e096d-c6bd-4fd3-acc6-22c37a3799cf",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "ccff9cbd-77e8-493d-b2ef-1c5bd98da961",
      "ReturnItemSKU": "sample string 5",
      "ReturnItemTitle": "sample string 6",
      "BatchInventoryId": 1,
      "ReturnLocation": "fca6ecad-b895-4279-996b-23149dbb757e",
      "ReturnQuantity": 8,
      "RefundAmount": 9.0,
      "RefundRowId": "72de697b-01a1-4c31-9c34-ecb37058a71b",
      "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-07-23T15:31:55.4428076+01:00",
      "Actioned": true,
      "ActionedDate": "2019-07-23T15:31:55.4428076+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "ef31ecad-aede-4327-ba9f-2e1dd72132de",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-07-23T15:31:55.4428076+01:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-07-23T15:31:55.4428076+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "87b67eaf-5856-4299-a35c-51003e754574",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "8937e96f-cdcd-487a-ac3d-88d99895a4b2",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "1a3bbde5-ca5d-423d-93d5-e76a4edb8a17",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "27603171-c127-4a1d-a781-cebf7fae2d83",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "c86d772f-4a17-48a3-8286-5e1ede52ff28",
      "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-07-23T15:31:55.4428076+01:00",
      "Actioned": true,
      "ActionedDate": "2019-07-23T15:31:55.4428076+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "ef31ecad-aede-4327-ba9f-2e1dd72132de",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-07-23T15:31:55.4428076+01:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-07-23T15:31:55.4428076+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "87b67eaf-5856-4299-a35c-51003e754574",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "8937e96f-cdcd-487a-ac3d-88d99895a4b2",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "1a3bbde5-ca5d-423d-93d5-e76a4edb8a17",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "27603171-c127-4a1d-a781-cebf7fae2d83",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "c86d772f-4a17-48a3-8286-5e1ede52ff28",
      "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"
  ]
}