API Reference
Start typing to search…

GetActionableRefundHeaders

post https://eu-ext.linnworks.net/api/ReturnsRefunds/GetActionableRefundHeaders

Returns a paged list of booked refund headers
Permissions Required: GlobalPermissions.OrderBook.ReturnsRefunds.Refunds.ViewRefundsNode
Rate limit: 150 / minute

Log in to see full request history
Body Params
request
object
Response

Response body
object
int32

The page number returned

int32

A count of the total number of refund headers matching the filter set by the request

int32

A count of the number of refund headers returned per page

RefundHeaders
array of objects

A collection of refund headers matching the filter set by the request

RefundHeaders
object
int32
string
double
RefundLines
array of objects
RefundLines
object
uuid

A unique identifier for the refund line

int32

A unique identifier for the refund header this line belongs to

Status
object
string

Identifies the type of refund for this line

Item Shipping Service Additional

boolean

Identifies whether the refund is a shipping refund

boolean

Identifies whether the refund is an additional refund

boolean

Identifies whether the refund row is a cancellation

RefundedItem
object
string

If validation has failed for this item, the field will be populated with the appropriate error message

string
Errors
array of objects
Errors
object
uuid
string
date-time
boolean
boolean

Line-level indicator of whether the refund has been actioned

date-time

If a refund has been actioned, this denotes the date it was actioned. For not actioned lines, this value is null

boolean

Identifies whether the refund was created manually in Linnworks, or downloaded from the channel automatically

boolean

Identifies whether the line is processed only internally or also on a third-party channel

boolean

Identifies whether the line has been removed from the refund, and is pending an update to the database to reflect this

string

The channel reference number for this refund

boolean

Identifies whether the refund reason is provided in freetext, or as one of a predefined set of options

string

For freetext refund reasons, this is the reason that will be sent to the channel. Otherwise, it is considered an internal note

double

The amount to be refunded for this line

int32

Used when the refund is part of a return

string

For channels that support predefined refund reasons, this is the tag that identifies a predefined reason

string

For channels that support a secondary predefined refund reason, this is the tag that identifies a predefined secondary reason

string

For channels that require a reason when the refund is lower than the full line amount, this is the tag that identifies a predefined insufficient refund reason

string

For channels that require a reason when the refund is lower than the full line amount, and support a freetext note, this field populates that note

string

Internal reason category

string
uuid
int32
Status
object
string
string
string
boolean
date-time
boolean
date-time

Updated over 1 year ago

Did this page help you?
Language
Credentials

Updated over 1 year ago

Did this page help you?