Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ProcessedOrders /GetRefundsOptions

Allows 150 calls per minute

Response: RefundScreenOptions



Use this call to get information about manual/automated refunds (which kinds of refunds are possible) for a given order.

Parameters

NameTypeDescription
pkOrderIdGuidThe id of the order

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/ProcessedOrders/GetRefundsOptions

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.

pkOrderId=fd078ac8-57ed-4b92-8736-34aa08d355f7

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "FreeTextOption": 1,
  "CanRefundShipping": true,
  "OrderHasServiceItems": true,
  "IsShippingRefundAutomated": true,
  "IsServiceRefundAutomated": true,
  "SupportsAutomatedRefunds": true
}