Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

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

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": "9ae14662-0a3e-4c00-998b-bd3096cf5a36",
  "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": "2021-07-29T09:24:14.2767451+01:00",
      "Actioned": true,
      "ActionedDate": "2021-07-29T09:24:14.2767451+01:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "e0b3ed83-4466-4000-b74a-c0cb83d24316",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2021-07-29T09:24:14.2767451+01:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "df62fa19-7c33-4592-ae33-6f3b984f6a86",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "50293c9a-114d-4fc5-9cd7-dd5e41e93c4e",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "6c68381f-215d-4340-8eb2-d358f269fddf",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "fa037224-6ac7-4dbd-9864-7d084a81be1c",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "7bbd712f-61a8-4445-9812-26e642692997",
      "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"
  ],
  "Info": [
    "sample string 1"
  ]
}