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.

Post

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": "f294bf4b-d5ce-430e-9cc7-28262b898998",
  "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-01-13T12:45:41.9236269+00:00",
      "Actioned": true,
      "ActionedDate": "2022-01-13T12:45:41.9236269+00:00",
      "Deleted": true,
      "ResendQuantity": 7,
      "NewOrderId": "e64fbcd6-84d8-49db-a4e3-f324c4c03454",
      "ValidationError": "sample string 10",
      "Error": "sample string 10",
      "Errors": [
        {
          "RMARowId": 1,
          "ErrorMessage": "sample string 2",
          "DateStamp": "2022-01-13T12:45:41.9236269+00:00",
          "Acknowledged": true
        }
      ],
      "Info": "sample string 11",
      "ExchangeStockItemId": "2db2c6a0-6009-49bb-bf88-2c166739b06f",
      "ExchangeSKU": "sample string 13",
      "ExchangeTitle": "sample string 14",
      "ExchangeQuantity": 15,
      "DespatchLocationId": "e6b1630d-605a-4184-bc33-d35377c83d8c",
      "AdditionalCost": 17.0,
      "OrderItemRowId": "ecc32e09-1ca1-4339-aedd-7a81cab48d23",
      "ReturnItemSKU": "sample string 19",
      "ReturnItemTitle": "sample string 20",
      "BatchInventoryId": 1,
      "ReturnLocation": "ad29747b-8d54-44d5-b90d-f09febe2a0df",
      "ReturnQuantity": 22,
      "RefundAmount": 23.0,
      "RefundRowId": "074248a4-cbbc-42d8-9c47-0fd36013a0bf",
      "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"
  ]
}