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": "71fe6ed6-2803-489d-832e-513ba899aad1",
  "ReturnItems": [
    {
      "OrderItemRowId": "a60e9494-c2c8-4832-99bc-1b2f51199a47",
      "ReturnItemSKU": "sample string 2",
      "ReturnItemTitle": "sample string 3",
      "BatchInventoryId": 1,
      "ReturnLocation": "399a8ceb-38f7-411e-9499-c7cf28af4f4d",
      "ReturnQuantity": 5,
      "RefundAmount": 6.0,
      "RefundRowId": "54d49749-7846-4231-9ba8-7bff2591491e",
      "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": "893fdc76-452d-4ea0-ad03-0e104250c11d",
      "ExchangeSKU": "sample string 2",
      "ExchangeTitle": "sample string 3",
      "ExchangeQuantity": 4,
      "DespatchLocationId": "3b90d46e-4a0e-4e9d-9d17-69de9a4cb9d6",
      "AdditionalCost": 6.0,
      "OrderItemRowId": "6311e645-4e12-4960-8850-010b64af29fe",
      "ReturnItemSKU": "sample string 8",
      "ReturnItemTitle": "sample string 9",
      "BatchInventoryId": 1,
      "ReturnLocation": "ae00ad75-2692-4555-ac51-d0f390b42373",
      "ReturnQuantity": 11,
      "RefundAmount": 12.0,
      "RefundRowId": "dbb82b04-8678-4208-8835-ce0bd2247ccc",
      "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": "7f42202e-414b-4fe8-af28-1abc8f7f00b5",
      "AdditionalCost": 3.0,
      "OrderItemRowId": "d918485c-de7a-4d6e-b100-4347c1609244",
      "ReturnItemSKU": "sample string 5",
      "ReturnItemTitle": "sample string 6",
      "BatchInventoryId": 1,
      "ReturnLocation": "1c1de23a-8101-48ad-8af8-d105bc49d520",
      "ReturnQuantity": 8,
      "RefundAmount": 9.0,
      "RefundRowId": "0c322b07-d628-4434-8354-55e0a3e4dbaf",
      "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-03-09T13:04:03.7992467+00:00",
      "Actioned": true,
      "ActionedDate": "2022-03-09T13:04:03.7992467+00:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "90d1ea3e-445b-4685-8782-9c49490c47dd",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2022-03-09T13:04:03.7992467+00:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "e7edd87e-c677-4386-bb1c-310bed65b156",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "9d6e2c6e-0992-415f-afc8-5593b912e7e8",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "fc9e444e-5198-4edc-b1d3-df3805673c40",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "d086860f-72f9-43e6-9bae-cb3dd6a80f0a",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "cdb61d57-35b9-40ad-897b-4d1a328c119b",
      "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"
  ]
}