---
title: "RefundFreeText"
method: POST
path: "/api/ProcessedOrders/RefundFreeText"
tags: ["ProcessedOrders"]
---

# RefundFreeText

`POST /api/ProcessedOrders/RefundFreeText`

Use this call to add or update a free text refund. This method can also be used to change the refund amount for any pending manual refund. Please check any automated refunds are valid prior to calling this method.
<b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

## Request body

- ProcessedOrdersRefundFreeTextRequest
  - `pkOrderId` string, uuid — The id of the order to add/update refunds for
  - `refundItems` RefundItem[] — The new/altered refund items
    - `pkRefundRowId` string, uuid — For updating refund amounts
    - `IsManualRefund` boolean — Manual refunds will never be passed to the channel validation routines
    - `Type` 'Item' | 'Service' | 'Shipping' | 'FreeText' — The type of refund item
    - `fkOrderItemId` string, uuid — The order item or service to refund
    - `RefundQty` integer — In the case of item refunds, the number of items
    - `RefundAmount` number, double — The amount of money the refund is for.
    - `Reason` string — The seller's text reason for the refund
    - `ChannelReason` string — The primary channel reason
    - `ChannelReasonSec` string — The secondary channel reason

## Response `200`

OK

- RefundInfo[]
  - `pkRefundRowId` string, uuid — Refund record ID
  - `SKU` string — Product SKU
  - `ItemTitle` string — Product title
  - `IsItem` boolean — If its an item that is refunded
  - `IsService` boolean — If its a service that is refunded
  - `Amount` number, double — Refund amount
  - `Reason` string — Reason for a refund
  - `Actioned` boolean — If refund has been actioned
  - `ActionDate` string, date-time — When refund was actioned
  - `ReturnReference` string — return reference number
  - `Cost` number, double — Cost
  - `RefundStatus` 'OPEN' | 'PROCESSED' | 'ERROR' | 'ERROR_ACKED' | 'PENDING'
  - `IgnoredValidation` boolean — Status of refund
  - `fkOrderItemRowId` string, uuid — Order item record ID
  - `ShouldSerializeChannelReason` boolean
  - `ChannelReason` string — Channel refund reason
  - `ShouldSerializeChannelReasonSec` boolean
  - `ChannelReasonSec` string — Secondary channel reason for a refund
  - `IsNew` boolean

---

[API](https://skmtc.net/linnworks/apis/authenticate-api.md) · [All operations](https://skmtc.net/linnworks/apis/authenticate-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/linnworks/authenticate-api/versions/0123569a22fb/schema)