Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

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": "0f912994-38e4-4edc-b9c7-9be2c6b7e1b3",
  "ReturnItems": [
    {
      "OrderItemRowId": "c5552fa6-0ece-4641-b6d0-3e48b4ccce40",
      "ReturnItemSKU": "sample string 2",
      "ReturnItemTitle": "sample string 3",
      "BatchInventoryId": 1,
      "ReturnLocation": "5d9bfbe0-b6b4-4aa4-b660-cc68dbab3185",
      "ReturnQuantity": 5,
      "RefundAmount": 6.0,
      "RefundRowId": "93b46674-7842-4fa9-ad7a-38594a5a085f",
      "ScrapQuantity": 7,
      "ReasonCategory": "sample string 8",
      "IsFreeText": false,
      "Reason": "sample string 9",
      "ReasonTag": "sample string 10",
      "SubReasonTag": "sample string 11",
      "BinrackOverride": "sample string 12"
    }
  ],
  "ExchangeItems": [
    {
      "ExchangeStockItemId": "3ef02469-09aa-4eb8-889d-4e1a809f8ef6",
      "ExchangeSKU": "sample string 2",
      "ExchangeTitle": "sample string 3",
      "ExchangeQuantity": 4,
      "DespatchLocationId": "93934262-e902-4d39-a66b-0ff4909695c7",
      "AdditionalCost": 6.0,
      "OrderItemRowId": "7ab28ea6-cb4b-4e43-a0cd-1c3cd71eab02",
      "ReturnItemSKU": "sample string 8",
      "ReturnItemTitle": "sample string 9",
      "BatchInventoryId": 1,
      "ReturnLocation": "47246a0b-59d0-46a4-9e57-f3748d4baaf2",
      "ReturnQuantity": 11,
      "RefundAmount": 12.0,
      "RefundRowId": "3c3c48d0-d163-4005-abb1-4ef30c2eff88",
      "ScrapQuantity": 13,
      "ReasonCategory": "sample string 14",
      "IsFreeText": false,
      "Reason": "sample string 15",
      "ReasonTag": "sample string 16",
      "SubReasonTag": "sample string 17",
      "BinrackOverride": "sample string 18"
    }
  ],
  "ResendItems": [
    {
      "ResendQuantity": 1,
      "DespatchLocationId": "95971d21-7ef8-4951-a8a8-6a7ae82a543c",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "acf0f66d-ca43-4d5d-86c1-05f1d05069bf",
      "ReturnItemSKU": "sample string 5",
      "ReturnItemTitle": "sample string 6",
      "BatchInventoryId": 1,
      "ReturnLocation": "e2cd3cd9-d9e2-4561-9db7-f145208533c3",
      "ReturnQuantity": 8,
      "RefundAmount": 9.0,
      "RefundRowId": "d88c3026-01f2-43b4-b43c-c5744701b13c",
      "ScrapQuantity": 10,
      "ReasonCategory": "sample string 11",
      "IsFreeText": false,
      "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": "2022-09-05T15:10:02.9735069+03:00",
      "Actioned": true,
      "ActionedDate": "2022-09-05T15:10:02.974354+03:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "b3da2554-1e9b-4c98-a99c-688eaf9a4bb3",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2022-09-05T15:10:02.9743693+03:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "6ae60e91-7297-4993-b514-b8958738deb2",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "4a97df3b-6ee6-4b4c-98bf-aa18e01ee879",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "b161fd9e-df5c-4a35-adfc-3bb5c0369d87",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "d97ffab4-e931-40a5-a76e-718ced446162",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "17761966-4679-4a1d-ab71-135742d7511f",
      "ScrapQuantity": 24,
      "ReasonCategory": "sample string 25",
      "IsFreeText": false,
      "Reason": "sample string 26",
      "ReasonTag": "sample string 27",
      "SubReasonTag": "sample string 28",
      "BinrackOverride": "sample string 29"
    }
  ],
  "Errors": [
    "sample string 1"
  ],
  "Info": [
    "sample string 1"
  ]
}