---
title: "GetRefundsOptions"
method: GET
path: "/api/ProcessedOrders/GetRefundsOptions"
tags: ["ProcessedOrders"]
---

# GetRefundsOptions

`GET /api/ProcessedOrders/GetRefundsOptions`

## Request

- Base URL: `https://eu-ext.linnworks.net`
- URL: `https://eu-ext.linnworks.net/api/ProcessedOrders/GetRefundsOptions`
- Auth: API key in header `Authorization`

Use this call to get information about manual/automated refunds (which kinds of refunds are possible) for a given order.
<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

## Query parameters

- `pkOrderId` string, uuid

## Response `200`

OK

- RefundScreenOptions
  - `FreeTextOption` 'OK' | 'ChannelRefundFunctionalityNotImplemented' | 'ChannelRefundsDisabled' | 'NotAllowed': Information about channel refund functionality
  - `CanRefundShipping` boolean: If shipping can be refunded
  - `OrderHasServiceItems` boolean: If order got service items
  - `IsShippingRefundAutomated` boolean: If order shipping cost refund automated
  - `IsServiceRefundAutomated` boolean: AIf order service refund autoamted
  - `SupportsAutomatedRefunds` boolean: If automated refund is supported

---

[API](https://skmtc.dev/linnworks/apis/processed-orders-api.md) - [All operations](https://skmtc.dev/linnworks/apis/processed-orders-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linnworks/apis/processed-orders-api/revisions/0389e091f52f?raw)