Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ReturnsRefunds /ActionRMABooking

Allows 150 calls per minute

Response: ActionRMABookingResponse



Accepts a booked return or exchange in the system

Parameters

NameTypeDescription
requestActionRMABookingRequestThe request class for this call

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.ReturnsExchanges.AcceptReturnsExchangesNode

Example Request

The following request format is required for this method.

Endpoint URL

PUT | POST https://eu-ext.linnworks.net/api/ReturnsRefunds/ActionRMABooking

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={
  "RMAHeaderId": 1,
  "OrderId": "34f1026e-e369-4c48-a33b-97dd50f486d1",
  "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"
      }
    ]
  }
}

Response

This is an example of the response JSON. Results will 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"
      ]
    }
  },
  "SuccessfullyActioned": true,
  "RMAHeaderId": 1,
  "Items": [
    {
      "RMARowId": 1,
      "RMAHeaderId": 2,
      "Type": 0,
      "Status": {
      },
      "ExternalReference": "sample string 3",
      "CreatedDate": "2022-09-05T15:10:02.9902255+03:00",
      "Actioned": true,
      "ActionedDate": "2022-09-05T15:10:02.9902255+03:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "a0bb57f8-e52b-4791-a16f-0633388403a1",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2022-09-05T15:10:02.9902255+03:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "70f4f23f-62d5-4131-93de-23bb6c0152d2",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "25846ca6-1f3b-425b-ad1d-84eabc417441",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "59dcbe5c-e013-40a0-b00e-03253d7437c5",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "1391899a-52de-4e35-a80c-b3157996b275",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "37504863-7fc0-458a-8eb9-cbb1c20f312f",
      "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"
  ]
}