Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /ActionRMABooking

Response: ActionRMABookingResponse



Accepts a booked return or exchange in the system

Parameters

NameTypeDescription
requestActionRMABookingRequestThe request class for this call

HTTP Endpoint

Server /ReturnsRefunds / ActionRMABooking

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.ReturnsExchanges.AcceptReturnsExchangesNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ReturnsRefunds/ActionRMABooking 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={
  "RMAHeaderId": 1,
  "OrderId": "9f24e3e6-39f0-418f-b8e8-ca817b4332bf",
  "Request": {
    "caption": "sample string 1",
    "controls": [
      {
        "id": "sample string 1",
        "caption": "sample string 2",
        "description": "sample string 3",
        "type": "sample string 4",
        "value": "sample string 5",
        "group": "sample string 6"
      },
      {
        "id": "sample string 1",
        "caption": "sample string 2",
        "description": "sample string 3",
        "type": "sample string 4",
        "value": "sample string 5",
        "group": "sample string 6"
      }
    ]
  }
}

Response

This is an example response. Results may vary depending on your data.

{
  "RefundHeaderId": 1,
  "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"
      ]
    }
  },
  "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.5931934+00:00",
      "Actioned": true,
      "ActionedDate": "2019-11-28T09:45:59.5931934+00:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "fcff0214-088f-4303-b1bd-658d5f257b08",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-11-28T09:45:59.5931934+00:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-11-28T09:45:59.5931934+00:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "af794254-f71f-46a1-b253-a4791b921e15",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "2865e560-ef54-45ab-9df5-9a7a5bb02266",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "5e6719df-a446-4a7d-9e6a-6c30b40e5fbc",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "bbb68307-b779-46a6-9ea1-51fb2947d4fe",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "03133403-9722-4142-a92d-a2b6b0d2ef8d",
      "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.5931934+00:00",
      "Actioned": true,
      "ActionedDate": "2019-11-28T09:45:59.5931934+00:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "fcff0214-088f-4303-b1bd-658d5f257b08",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-11-28T09:45:59.5931934+00:00",
          "Acknowledged": true
        },
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2019-11-28T09:45:59.5931934+00:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "af794254-f71f-46a1-b253-a4791b921e15",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "2865e560-ef54-45ab-9df5-9a7a5bb02266",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "5e6719df-a446-4a7d-9e6a-6c30b40e5fbc",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "bbb68307-b779-46a6-9ea1-51fb2947d4fe",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "03133403-9722-4142-a92d-a2b6b0d2ef8d",
      "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"
  ]
}