Use this call to retrieve the total value of refunds against an order.
Name | Type | Description |
---|---|---|
pkOrderId | Guid | The id of the order |
includeBookings | Nullable<Boolean> | If true, pending refunds against return bookings and exchange bookings will be included. (Optional, default is false.) |
The following request format is required for this method.
GET | POST https://eu-ext.linnworks.net/api/ProcessedOrders/GetTotalRefunds
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
This is an example of the request structure. Results will vary depending on your data.
pkOrderId=c09ea4ae-cf8b-4e7c-859f-2a01fc10bf6a&includeBookings=true
This is an example of the response JSON. Results will vary depending on your data.
{
"Amount": 1.1,
"TotalCharge": 2.1,
"Refundable": 1.0
}